From 45a1eb12ae407caf090294bc4bcb9645d82168a3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 09:58:42 +0000 Subject: [PATCH 1/6] chore: configure new SDK language --- .dockerignore | 59 + .github/workflows/ci.yml | 20 +- .github/workflows/publish-npm.yml | 22 +- .gitignore | 2 + .prettierignore | 3 +- .stats.yml | 4 +- README.md | 9 + eslint.config.mjs | 2 +- packages/mcp-server/Dockerfile | 78 + packages/mcp-server/README.md | 98 + packages/mcp-server/build | 56 + packages/mcp-server/jest.config.ts | 17 + packages/mcp-server/manifest.json | 53 + packages/mcp-server/package.json | 96 + .../mcp-server/scripts/copy-bundle-files.cjs | 36 + .../scripts/postprocess-dist-package-json.cjs | 12 + packages/mcp-server/src/auth.ts | 38 + packages/mcp-server/src/code-tool-paths.cts | 5 + packages/mcp-server/src/code-tool-types.ts | 17 + packages/mcp-server/src/code-tool-worker.ts | 1260 + packages/mcp-server/src/code-tool.ts | 392 + packages/mcp-server/src/docs-search-tool.ts | 138 + packages/mcp-server/src/http.ts | 227 + packages/mcp-server/src/index.ts | 67 + packages/mcp-server/src/instructions.ts | 83 + packages/mcp-server/src/local-docs-search.ts | 52869 ++++++++++++++++ packages/mcp-server/src/logger.ts | 28 + packages/mcp-server/src/methods.ts | 5982 ++ packages/mcp-server/src/options.ts | 185 + packages/mcp-server/src/server.ts | 213 + packages/mcp-server/src/stdio.ts | 17 + packages/mcp-server/src/types.ts | 126 + packages/mcp-server/src/util.ts | 25 + packages/mcp-server/tests/options.test.ts | 32 + packages/mcp-server/tsc-multi.json | 7 + packages/mcp-server/tsconfig.build.json | 18 + packages/mcp-server/tsconfig.dist-src.json | 11 + packages/mcp-server/tsconfig.json | 36 + packages/mcp-server/yarn.lock | 4169 ++ release-please-config.json | 16 +- scripts/build | 6 + scripts/build-all | 5 + scripts/publish-packages.ts | 102 + scripts/utils/make-dist-package-json.cjs | 8 + 44 files changed, 66639 insertions(+), 10 deletions(-) create mode 100644 .dockerignore create mode 100644 packages/mcp-server/Dockerfile create mode 100644 packages/mcp-server/README.md create mode 100644 packages/mcp-server/build create mode 100644 packages/mcp-server/jest.config.ts create mode 100644 packages/mcp-server/manifest.json create mode 100644 packages/mcp-server/package.json create mode 100644 packages/mcp-server/scripts/copy-bundle-files.cjs create mode 100644 packages/mcp-server/scripts/postprocess-dist-package-json.cjs create mode 100644 packages/mcp-server/src/auth.ts create mode 100644 packages/mcp-server/src/code-tool-paths.cts create mode 100644 packages/mcp-server/src/code-tool-types.ts create mode 100644 packages/mcp-server/src/code-tool-worker.ts create mode 100644 packages/mcp-server/src/code-tool.ts create mode 100644 packages/mcp-server/src/docs-search-tool.ts create mode 100644 packages/mcp-server/src/http.ts create mode 100644 packages/mcp-server/src/index.ts create mode 100644 packages/mcp-server/src/instructions.ts create mode 100644 packages/mcp-server/src/local-docs-search.ts create mode 100644 packages/mcp-server/src/logger.ts create mode 100644 packages/mcp-server/src/methods.ts create mode 100644 packages/mcp-server/src/options.ts create mode 100644 packages/mcp-server/src/server.ts create mode 100644 packages/mcp-server/src/stdio.ts create mode 100644 packages/mcp-server/src/types.ts create mode 100644 packages/mcp-server/src/util.ts create mode 100644 packages/mcp-server/tests/options.test.ts create mode 100644 packages/mcp-server/tsc-multi.json create mode 100644 packages/mcp-server/tsconfig.build.json create mode 100644 packages/mcp-server/tsconfig.dist-src.json create mode 100644 packages/mcp-server/tsconfig.json create mode 100644 packages/mcp-server/yarn.lock create mode 100755 scripts/build-all create mode 100644 scripts/publish-packages.ts diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..12ff1e64 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,59 @@ +# Dependencies +node_modules/ +**/node_modules/ + +# Build outputs +dist/ +**/dist/ + +# Git +.git/ +.gitignore + +# CI/CD +.github/ +.gitlab-ci.yml +.travis.yml + +# IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# OS +.DS_Store +Thumbs.db + +# Testing +test/ +tests/ +__tests__/ +*.test.js +*.spec.js +coverage/ +.nyc_output/ + +# Logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Environment +.env +.env.* + +# Temporary files +*.tmp +*.temp +.cache/ + +# Examples and scripts +examples/ +bin/ + +# Other packages (we only need mcp-server) +packages/*/ +!packages/mcp-server/ diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5513e37f..c0ca8f2e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '20' + node-version: '22' - name: Bootstrap run: ./scripts/bootstrap @@ -48,7 +48,7 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '20' + node-version: '22' - name: Bootstrap run: ./scripts/bootstrap @@ -74,6 +74,17 @@ jobs: AUTH: ${{ steps.github-oidc.outputs.github_token }} SHA: ${{ github.sha }} run: ./scripts/utils/upload-artifact.sh + + - name: Upload MCP Server tarball + if: |- + github.repository == 'stainless-sdks/hubspot-sdk-typescript' && + !startsWith(github.ref, 'refs/heads/stl/') + env: + URL: https://pkg.stainless.com/s?subpackage=mcp-server + AUTH: ${{ steps.github-oidc.outputs.github_token }} + SHA: ${{ github.sha }} + BASE_PATH: packages/mcp-server + run: ./scripts/utils/upload-artifact.sh test: timeout-minutes: 10 name: test @@ -85,10 +96,13 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '20' + node-version: '22' - name: Bootstrap run: ./scripts/bootstrap + - name: Build + run: ./scripts/build + - name: Run tests run: ./scripts/test diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml index a6ea0887..cff607c0 100644 --- a/.github/workflows/publish-npm.yml +++ b/.github/workflows/publish-npm.yml @@ -4,6 +4,10 @@ name: Publish NPM on: workflow_dispatch: + inputs: + path: + description: The path to run the release in, e.g. '.' or 'packages/mcp-server' + required: true release: types: [published] @@ -13,7 +17,7 @@ jobs: name: publish runs-on: ubuntu-latest permissions: - contents: read + contents: write id-token: write steps: @@ -30,4 +34,18 @@ jobs: - name: Publish to NPM run: | - bash ./bin/publish-npm + if [ -n "$INPUT_PATH" ]; then + PATHS_RELEASED="[\"$INPUT_PATH\"]" + else + PATHS_RELEASED='[\".\", \"packages/mcp-server\"]' + fi + yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }" + env: + INPUT_PATH: ${{ github.event.inputs.path }} + + - name: Upload MCP Server DXT GitHub release asset + run: | + gh release upload ${{ github.event.release.tag_name }} \ + packages/mcp-server/hubspot_sdk_api.mcpb + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index 9487e48a..ae4aa20e 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,6 @@ dist-deno /*.tgz .idea/ .eslintcache +dist-bundle +*.mcpb oidc diff --git a/.prettierignore b/.prettierignore index 3548c5af..36afd3b3 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,6 +2,7 @@ CHANGELOG.md /ecosystem-tests/*/** /node_modules /deno +/packages/mcp-server/manifest.json # don't format tsc output, will break source maps -/dist +dist diff --git a/.stats.yml b/.stats.yml index 9441a68d..e2813b39 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 955 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-8aa2c4935982d3998769d656b2caae13c71151b5f00caaa875357ceb83f6e0a6.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-d306a9f90ec487d227a47c390018997eebc86a5983ac7fe21f945b82a74868db.yml openapi_spec_hash: 47d20b6496315d47f4f64441d4682f47 -config_hash: 9c2a17b9755f3edac92a3ec4b93ac51c +config_hash: f0caff211e137f418213baf5da549f3b diff --git a/README.md b/README.md index 6309e5a4..90038c4b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,15 @@ The REST API documentation can be found on [developers.hubspot.com](https://deve It is generated with [Stainless](https://www.stainless.com/). +## MCP Server + +Use the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. + +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19) +[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D) + +> Note: You may need to set environment variables in your MCP client. + ## Installation ```sh diff --git a/eslint.config.mjs b/eslint.config.mjs index 9ff827e0..0866279a 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -31,7 +31,7 @@ export default tseslint.config( }, }, { - files: ['tests/**', 'examples/**'], + files: ['tests/**', 'examples/**', 'packages/**'], rules: { 'no-restricted-imports': 'off', }, diff --git a/packages/mcp-server/Dockerfile b/packages/mcp-server/Dockerfile new file mode 100644 index 00000000..d2743fec --- /dev/null +++ b/packages/mcp-server/Dockerfile @@ -0,0 +1,78 @@ +# Dockerfile for HubSpot MCP Server +# +# This Dockerfile builds a Docker image for the MCP Server. +# +# To build the image locally: +# docker build -f packages/mcp-server/Dockerfile -t @hubspot/sdk-mcp:local . +# +# To run the image: +# docker run -i @hubspot/sdk-mcp:local [OPTIONS] +# +# Common options: +# --tool= Include specific tools +# --resource= Include tools for specific resources +# --operation=read|write Filter by operation type +# --client= Set client compatibility (e.g., claude, cursor) +# --transport= Set transport type (stdio or http) +# +# For a full list of options: +# docker run -i @hubspot/sdk-mcp:local --help +# +# Note: The MCP server uses stdio transport by default. Docker's -i flag +# enables interactive mode, allowing the container to communicate over stdin/stdout. + +# Build stage +FROM node:24-alpine AS builder + +# Install bash for build script +RUN apk add --no-cache bash openssl + +# Set working directory +WORKDIR /build + +# Copy entire repository +COPY . . + +# Install all dependencies and build everything +RUN yarn install --frozen-lockfile && \ + yarn build && \ + # Remove the symlink to the SDK so it doesn't interfere with the explicit COPY below + rm -Rf packages/mcp-server/node_modules/@hubspot/sdk + +FROM denoland/deno:alpine-2.7.1 + +# Install node and npm +RUN apk add --no-cache nodejs npm + +ENV LD_LIBRARY_PATH=/usr/lib:/usr/local/lib + +# Add non-root user +RUN addgroup -g 1001 -S nodejs && adduser -S nodejs -u 1001 + +# Set working directory +WORKDIR /app + +# Copy the built mcp-server dist directory +COPY --from=builder /build/packages/mcp-server/dist ./ + +# Copy node_modules from mcp-server (includes all production deps) +COPY --from=builder /build/packages/mcp-server/node_modules ./node_modules + +# Copy the built @hubspot/sdk into node_modules +COPY --from=builder /build/dist ./node_modules/@hubspot/sdk + +# Change ownership to nodejs user +RUN chown -R nodejs:nodejs /app +RUN chown -R nodejs:nodejs /deno-dir + +# Switch to non-root user +USER nodejs + +# The MCP server uses stdio transport by default +# No exposed ports needed for stdio communication + +# Set the entrypoint to the MCP server +ENTRYPOINT ["node", "index.js"] + +# Allow passing arguments to the MCP server +CMD [] diff --git a/packages/mcp-server/README.md b/packages/mcp-server/README.md new file mode 100644 index 00000000..c490640e --- /dev/null +++ b/packages/mcp-server/README.md @@ -0,0 +1,98 @@ +# HubSpot TypeScript MCP Server + +It is generated with [Stainless](https://www.stainless.com/). + +## Installation + +### Direct invocation + +You can run the MCP Server directly via `npx`: + +```sh +export HUBSPOT_ACCESS_TOKEN="My Access Token" +export HUBSPOT_DEVELOPER_API_KEY="My Developer API Key" +npx -y @hubspot/sdk-mcp@latest +``` + +### Via MCP Client + +There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already +have a client, consult their documentation to install the MCP server. + +For clients with a configuration JSON, it might look something like this: + +```json +{ + "mcpServers": { + "hubspot_sdk_api": { + "command": "npx", + "args": ["-y", "@hubspot/sdk-mcp"], + "env": { + "HUBSPOT_ACCESS_TOKEN": "My Access Token", + "HUBSPOT_DEVELOPER_API_KEY": "My Developer API Key" + } + } + } +} +``` + +### Cursor + +If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables +in Cursor's `mcp.json`, which can be found in Cursor Settings > Tools & MCP > New MCP Server. + +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19) + +### VS Code + +If you use MCP, you can install the MCP server by clicking the link below. You will need to set your environment variables +in VS Code's `mcp.json`, which can be found via Command Palette > MCP: Open User Configuration. + +[Open VS Code](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D) + +### Claude Code + +If you use Claude Code, you can install the MCP server by running the command below in your terminal. You will need to set your +environment variables in Claude Code's `.claude.json`, which can be found in your home directory. + +``` +claude mcp add hubspot_sdk_mcp_api --env HUBSPOT_ACCESS_TOKEN="My Access Token" HUBSPOT_DEVELOPER_API_KEY="My Developer API Key" -- npx -y @hubspot/sdk-mcp +``` + +## Code Mode + +This MCP server is built on the "Code Mode" tool scheme. In this MCP Server, +your agent will write code against the TypeScript SDK, which will then be executed in an +isolated sandbox. To accomplish this, the server will expose two tools to your agent: + +- The first tool is a docs search tool, which can be used to generically query for + documentation about your API/SDK. + +- The second tool is a code tool, where the agent can write code against the TypeScript SDK. + The code will be executed in a sandbox environment without web or filesystem access. Then, + anything the code returns or prints will be returned to the agent as the result of the + tool call. + +Using this scheme, agents are capable of performing very complex tasks deterministically +and repeatably. + +## Running remotely + +Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket. + +Authorization can be provided via the `Authorization` header using the Bearer scheme. + +A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`: + +```json +{ + "mcpServers": { + "hubspot_sdk_api": { + "url": "http://localhost:3000", + "headers": { + "Authorization": "Bearer " + } + } + } +} +``` diff --git a/packages/mcp-server/build b/packages/mcp-server/build new file mode 100644 index 00000000..01944266 --- /dev/null +++ b/packages/mcp-server/build @@ -0,0 +1,56 @@ +#!/usr/bin/env bash +set -exuo pipefail + +rm -rf dist; mkdir dist + +# Copy src to dist/src and build from dist/src into dist, so that +# the source map for index.js.map will refer to ./src/index.ts etc +cp -rp src README.md dist + +for file in LICENSE; do + if [ -e "../../${file}" ]; then cp "../../${file}" dist; fi +done + +for file in CHANGELOG.md; do + if [ -e "${file}" ]; then cp "${file}" dist; fi +done + +# this converts the export map paths for the dist directory +# and does a few other minor things +PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist/package.json + +# updates the `@hubspot/sdk` dependency to point to NPM +node scripts/postprocess-dist-package-json.cjs + +# build to .js/.mjs/.d.ts files +./node_modules/.bin/tsc-multi + +cp tsconfig.dist-src.json dist/src/tsconfig.json + +chmod +x dist/index.js + +DIST_PATH=./dist PKG_IMPORT_PATH=@hubspot/sdk-mcp/ node ../../scripts/utils/postprocess-files.cjs + +# mcp bundle +rm -rf dist-bundle hubspot_sdk_api.mcpb; mkdir dist-bundle + +# copy package.json +PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist-bundle/package.json + +# copy files +node scripts/copy-bundle-files.cjs + +# install runtime deps +cd dist-bundle +npm install +cd .. + +# pack bundle +cp manifest.json dist-bundle + +npx mcpb pack dist-bundle hubspot_sdk_api.mcpb + +npx mcpb sign hubspot_sdk_api.mcpb --self-signed + +# clean up +rm -rf dist-bundle diff --git a/packages/mcp-server/jest.config.ts b/packages/mcp-server/jest.config.ts new file mode 100644 index 00000000..8bbfd427 --- /dev/null +++ b/packages/mcp-server/jest.config.ts @@ -0,0 +1,17 @@ +import type { JestConfigWithTsJest } from 'ts-jest'; + +const config: JestConfigWithTsJest = { + preset: 'ts-jest/presets/default-esm', + testEnvironment: 'node', + transform: { + '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }], + }, + moduleNameMapper: { + '^@hubspot/sdk-mcp$': '/src/index.ts', + '^@hubspot/sdk-mcp/(.*)$': '/src/$1', + }, + modulePathIgnorePatterns: ['/dist/'], + testPathIgnorePatterns: ['scripts'], +}; + +export default config; diff --git a/packages/mcp-server/manifest.json b/packages/mcp-server/manifest.json new file mode 100644 index 00000000..037a8358 --- /dev/null +++ b/packages/mcp-server/manifest.json @@ -0,0 +1,53 @@ +{ + "dxt_version": "0.2", + "name": "@hubspot/sdk-mcp", + "version": "0.1.0-alpha.9", + "description": "The official MCP Server for the HubSpot API", + "author": { + "name": "HubSpot" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/HubSpot/hubspot-sdk-typescript.git" + }, + "homepage": "https://github.com/HubSpot/hubspot-sdk-typescript/tree/main/packages/mcp-server#readme", + "documentation": "https://developers.hubspot.com/docs/api-reference/overview", + "server": { + "type": "node", + "entry_point": "index.js", + "mcp_config": { + "command": "node", + "args": [ + "${__dirname}/index.js" + ], + "env": { + "HUBSPOT_ACCESS_TOKEN": "${user_config.HUBSPOT_ACCESS_TOKEN}", + "HUBSPOT_DEVELOPER_API_KEY": "${user_config.HUBSPOT_DEVELOPER_API_KEY}" + } + } + }, + "user_config": { + "HUBSPOT_ACCESS_TOKEN": { + "title": "access_token", + "description": "", + "required": false, + "type": "string" + }, + "HUBSPOT_DEVELOPER_API_KEY": { + "title": "developer_api_key", + "description": "", + "required": false, + "type": "string" + } + }, + "tools": [], + "tools_generated": true, + "compatibility": { + "runtimes": { + "node": ">=18.0.0" + } + }, + "keywords": [ + "api" + ] +} diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json new file mode 100644 index 00000000..b60d2e04 --- /dev/null +++ b/packages/mcp-server/package.json @@ -0,0 +1,96 @@ +{ + "name": "@hubspot/sdk-mcp", + "version": "0.1.0-alpha.9", + "description": "The official MCP Server for the HubSpot API", + "author": "HubSpot <>", + "types": "dist/index.d.ts", + "main": "dist/index.js", + "type": "commonjs", + "repository": { + "type": "git", + "url": "git+https://github.com/HubSpot/hubspot-sdk-typescript.git", + "directory": "packages/mcp-server" + }, + "homepage": "https://github.com/HubSpot/hubspot-sdk-typescript/tree/main/packages/mcp-server#readme", + "license": "Apache-2.0", + "packageManager": "yarn@1.22.22", + "private": false, + "publishConfig": { + "access": "public" + }, + "scripts": { + "test": "jest", + "build": "bash ./build", + "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1", + "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1", + "format": "prettier --write --cache --cache-strategy metadata . !dist", + "prepare": "npm run build", + "tsn": "ts-node -r tsconfig-paths/register", + "lint": "eslint .", + "fix": "eslint --fix ." + }, + "dependencies": { + "@hubspot/sdk": "link:../../dist/", + "ajv": "^8.18.0", + "@cloudflare/cabidela": "^0.2.4", + "@hono/node-server": "^1.19.10", + "@modelcontextprotocol/sdk": "^1.27.1", + "hono": "^4.12.4", + "@valtown/deno-http-worker": "^0.0.21", + "cookie-parser": "^1.4.6", + "cors": "^2.8.5", + "express": "^5.1.0", + "fuse.js": "^7.1.0", + "minisearch": "^7.2.0", + "jq-web": "https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz", + "pino": "^10.3.1", + "pino-http": "^11.0.0", + "pino-pretty": "^13.1.3", + "qs": "^6.14.1", + "typescript": "5.8.3", + "yargs": "^17.7.2", + "zod": "^3.25.20", + "zod-to-json-schema": "^3.24.5", + "zod-validation-error": "^4.0.1" + }, + "bin": { + "mcp-server": "dist/index.js" + }, + "devDependencies": { + "@anthropic-ai/mcpb": "^2.1.2", + "@types/cookie-parser": "^1.4.10", + "@types/cors": "^2.8.19", + "@types/express": "^5.0.3", + "@types/jest": "^29.4.0", + "@types/qs": "^6.14.0", + "@types/yargs": "^17.0.8", + "@typescript-eslint/eslint-plugin": "8.31.1", + "@typescript-eslint/parser": "8.31.1", + "eslint": "^9.39.1", + "eslint-plugin-prettier": "^5.4.1", + "eslint-plugin-unused-imports": "^4.1.4", + "jest": "^29.4.0", + "prettier": "^3.0.0", + "ts-jest": "^29.1.0", + "ts-morph": "^19.0.0", + "ts-node": "^10.5.0", + "tsc-multi": "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz", + "tsconfig-paths": "^4.0.0" + }, + "imports": { + "@hubspot/sdk-mcp": ".", + "@hubspot/sdk-mcp/*": "./src/*" + }, + "exports": { + ".": { + "require": "./dist/index.js", + "default": "./dist/index.mjs" + }, + "./*.mjs": "./dist/*.mjs", + "./*.js": "./dist/*.js", + "./*": { + "require": "./dist/*.js", + "default": "./dist/*.mjs" + } + } +} diff --git a/packages/mcp-server/scripts/copy-bundle-files.cjs b/packages/mcp-server/scripts/copy-bundle-files.cjs new file mode 100644 index 00000000..59570277 --- /dev/null +++ b/packages/mcp-server/scripts/copy-bundle-files.cjs @@ -0,0 +1,36 @@ +const fs = require('fs'); +const path = require('path'); +const pkgJson = require('../dist-bundle/package.json'); + +const distDir = path.resolve(__dirname, '..', 'dist'); +const distBundleDir = path.resolve(__dirname, '..', 'dist-bundle'); +const distBundlePkgJson = path.join(distBundleDir, 'package.json'); + +async function* walk(dir) { + for await (const d of await fs.promises.opendir(dir)) { + const entry = path.join(dir, d.name); + if (d.isDirectory()) yield* walk(entry); + else if (d.isFile()) yield entry; + } +} + +async function copyFiles() { + // copy runtime files + for await (const file of walk(distDir)) { + if (!/[cm]?js$/.test(file)) continue; + const dest = path.join(distBundleDir, path.relative(distDir, file)); + await fs.promises.mkdir(path.dirname(dest), { recursive: true }); + await fs.promises.copyFile(file, dest); + } + + // replace package.json reference with local reference + for (const dep in pkgJson.dependencies) { + if (dep === '@hubspot/sdk') { + pkgJson.dependencies[dep] = 'file:../../../dist/'; + } + } + + await fs.promises.writeFile(distBundlePkgJson, JSON.stringify(pkgJson, null, 2)); +} + +copyFiles(); diff --git a/packages/mcp-server/scripts/postprocess-dist-package-json.cjs b/packages/mcp-server/scripts/postprocess-dist-package-json.cjs new file mode 100644 index 00000000..ad835747 --- /dev/null +++ b/packages/mcp-server/scripts/postprocess-dist-package-json.cjs @@ -0,0 +1,12 @@ +const fs = require('fs'); +const pkgJson = require('../dist/package.json'); +const parentPkgJson = require('../../../package.json'); + +for (const dep in pkgJson.dependencies) { + // ensure we point to NPM instead of a local directory + if (dep === '@hubspot/sdk') { + pkgJson.dependencies[dep] = '^' + parentPkgJson.version; + } +} + +fs.writeFileSync('dist/package.json', JSON.stringify(pkgJson, null, 2)); diff --git a/packages/mcp-server/src/auth.ts b/packages/mcp-server/src/auth.ts new file mode 100644 index 00000000..0b286326 --- /dev/null +++ b/packages/mcp-server/src/auth.ts @@ -0,0 +1,38 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { IncomingMessage } from 'node:http'; +import { ClientOptions } from '@hubspot/sdk'; +import { McpOptions } from './options'; + +export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { + if (req.headers.authorization) { + const scheme = req.headers.authorization.split(' ')[0]!; + const value = req.headers.authorization.slice(scheme.length + 1); + switch (scheme) { + case 'Bearer': + return { accessToken: req.headers.authorization.slice('Bearer '.length) }; + default: + throw new Error( + 'Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer).', + ); + } + } else if (required) { + throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); + } + + return {}; +}; + +export const getStainlessApiKey = (req: IncomingMessage, mcpOptions: McpOptions): string | undefined => { + // Try to get the key from the x-stainless-api-key header + const headerKey = + Array.isArray(req.headers['x-stainless-api-key']) ? + req.headers['x-stainless-api-key'][0] + : req.headers['x-stainless-api-key']; + if (headerKey && typeof headerKey === 'string') { + return headerKey; + } + + // Fall back to value set in the mcpOptions (e.g. from environment variable), if provided + return mcpOptions.stainlessApiKey; +}; diff --git a/packages/mcp-server/src/code-tool-paths.cts b/packages/mcp-server/src/code-tool-paths.cts new file mode 100644 index 00000000..78263e45 --- /dev/null +++ b/packages/mcp-server/src/code-tool-paths.cts @@ -0,0 +1,5 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export function getWorkerPath(): string { + return require.resolve('./code-tool-worker.mjs'); +} diff --git a/packages/mcp-server/src/code-tool-types.ts b/packages/mcp-server/src/code-tool-types.ts new file mode 100644 index 00000000..45f914ff --- /dev/null +++ b/packages/mcp-server/src/code-tool-types.ts @@ -0,0 +1,17 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { ClientOptions } from '@hubspot/sdk'; + +export type WorkerInput = { + project_name: string; + code: string; + client_opts: ClientOptions; + intent?: string | undefined; +}; + +export type WorkerOutput = { + is_error: boolean; + result: unknown | null; + log_lines: string[]; + err_lines: string[]; +}; diff --git a/packages/mcp-server/src/code-tool-worker.ts b/packages/mcp-server/src/code-tool-worker.ts new file mode 100644 index 00000000..34779168 --- /dev/null +++ b/packages/mcp-server/src/code-tool-worker.ts @@ -0,0 +1,1260 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import path from 'node:path'; +import util from 'node:util'; +import Fuse from 'fuse.js'; +import ts from 'typescript'; +import { WorkerOutput } from './code-tool-types'; +import { HubSpot, ClientOptions } from '@hubspot/sdk'; + +async function tseval(code: string) { + return import('data:application/typescript;charset=utf-8;base64,' + Buffer.from(code).toString('base64')); +} + +function getRunFunctionSource(code: string): { + type: 'declaration' | 'expression'; + client: string | undefined; + code: string; +} | null { + const sourceFile = ts.createSourceFile('code.ts', code, ts.ScriptTarget.Latest, true); + const printer = ts.createPrinter(); + + for (const statement of sourceFile.statements) { + // Check for top-level function declarations + if (ts.isFunctionDeclaration(statement)) { + if (statement.name?.text === 'run') { + return { + type: 'declaration', + client: statement.parameters[0]?.name.getText(), + code: printer.printNode(ts.EmitHint.Unspecified, statement.body!, sourceFile), + }; + } + } + + // Check for variable declarations: const run = () => {} or const run = function() {} + if (ts.isVariableStatement(statement)) { + for (const declaration of statement.declarationList.declarations) { + if ( + ts.isIdentifier(declaration.name) && + declaration.name.text === 'run' && + // Check if it's initialized with a function + declaration.initializer && + (ts.isFunctionExpression(declaration.initializer) || ts.isArrowFunction(declaration.initializer)) + ) { + return { + type: 'expression', + client: declaration.initializer.parameters[0]?.name.getText(), + code: printer.printNode(ts.EmitHint.Unspecified, declaration.initializer, sourceFile), + }; + } + } + } + } + + return null; +} + +function getTSDiagnostics(code: string): string[] { + const functionSource = getRunFunctionSource(code)!; + const codeWithImport = [ + 'import { HubSpot } from "@hubspot/sdk";', + functionSource.type === 'declaration' ? + `async function run(${functionSource.client}: HubSpot)` + : `const run: (${functionSource.client}: HubSpot) => Promise =`, + functionSource.code, + ].join('\n'); + const sourcePath = path.resolve('code.ts'); + const ast = ts.createSourceFile(sourcePath, codeWithImport, ts.ScriptTarget.Latest, true); + const options = ts.getDefaultCompilerOptions(); + options.target = ts.ScriptTarget.Latest; + options.module = ts.ModuleKind.NodeNext; + options.moduleResolution = ts.ModuleResolutionKind.NodeNext; + const host = ts.createCompilerHost(options, true); + const newHost: typeof host = { + ...host, + getSourceFile: (...args) => { + if (path.resolve(args[0]) === sourcePath) { + return ast; + } + return host.getSourceFile(...args); + }, + readFile: (...args) => { + if (path.resolve(args[0]) === sourcePath) { + return codeWithImport; + } + return host.readFile(...args); + }, + fileExists: (...args) => { + if (path.resolve(args[0]) === sourcePath) { + return true; + } + return host.fileExists(...args); + }, + }; + const program = ts.createProgram({ + options, + rootNames: [sourcePath], + host: newHost, + }); + const diagnostics = ts.getPreEmitDiagnostics(program, ast); + return diagnostics.map((d) => { + const message = ts.flattenDiagnosticMessageText(d.messageText, '\n'); + if (!d.file || !d.start) return `- ${message}`; + const { line: lineNumber } = ts.getLineAndCharacterOfPosition(d.file, d.start); + const line = codeWithImport.split('\n').at(lineNumber)?.trim(); + return line ? `- ${message}\n ${line}` : `- ${message}`; + }); +} + +const fuse = new Fuse( + [ + 'client.account.get', + 'client.account.getDailyPrivateAppsUsage', + 'client.account.activity.listAuditLogs', + 'client.account.activity.listLoginActivities', + 'client.account.activity.listSecurityActivities', + 'client.auth.oauth.createToken', + 'client.auth.oauth.introspectToken', + 'client.auth.oauth.revokeToken', + 'client.automation.actions.callbacks.complete', + 'client.automation.actions.callbacks.completeBatch', + 'client.automation.actions.definitions.create', + 'client.automation.actions.definitions.createRequiresObject', + 'client.automation.actions.definitions.delete', + 'client.automation.actions.definitions.get', + 'client.automation.actions.definitions.getRequiresObject', + 'client.automation.actions.definitions.list', + 'client.automation.actions.definitions.update', + 'client.automation.actions.functions.createOrReplace', + 'client.automation.actions.functions.createOrReplaceByFunctionType', + 'client.automation.actions.functions.delete', + 'client.automation.actions.functions.deleteByFunctionType', + 'client.automation.actions.functions.get', + 'client.automation.actions.functions.getByFunctionType', + 'client.automation.actions.functions.list', + 'client.automation.actions.revisions.get', + 'client.automation.actions.revisions.list', + 'client.automation.sequences.createEnrollment', + 'client.automation.sequences.get', + 'client.automation.sequences.getEnrollmentByContactID', + 'client.automation.sequences.list', + 'client.businessUnits.businessUnitEntries.getByUserID', + 'client.cms.auditLogs.export', + 'client.cms.auditLogs.list', + 'client.cms.blogs.authors.attachToLangGroup', + 'client.cms.blogs.authors.create', + 'client.cms.blogs.authors.createLanguageVariation', + 'client.cms.blogs.authors.delete', + 'client.cms.blogs.authors.detachFromLangGroup', + 'client.cms.blogs.authors.get', + 'client.cms.blogs.authors.getCursor', + 'client.cms.blogs.authors.getCursorByQuery', + 'client.cms.blogs.authors.getPostsCursor', + 'client.cms.blogs.authors.getPostsCursorByQuery', + 'client.cms.blogs.authors.getTagsCursor', + 'client.cms.blogs.authors.getTagsCursorByQuery', + 'client.cms.blogs.authors.list', + 'client.cms.blogs.authors.setNewLangPrimary', + 'client.cms.blogs.authors.update', + 'client.cms.blogs.authors.updateLanguages', + 'client.cms.blogs.authors.batch.create', + 'client.cms.blogs.authors.batch.delete', + 'client.cms.blogs.authors.batch.get', + 'client.cms.blogs.authors.batch.update', + 'client.cms.blogs.posts.clone', + 'client.cms.blogs.posts.create', + 'client.cms.blogs.posts.delete', + 'client.cms.blogs.posts.get', + 'client.cms.blogs.posts.getDraftByID', + 'client.cms.blogs.posts.list', + 'client.cms.blogs.posts.listAuthors', + 'client.cms.blogs.posts.listTags', + 'client.cms.blogs.posts.pushLive', + 'client.cms.blogs.posts.query', + 'client.cms.blogs.posts.queryAuthors', + 'client.cms.blogs.posts.queryTags', + 'client.cms.blogs.posts.resetDraft', + 'client.cms.blogs.posts.schedule', + 'client.cms.blogs.posts.update', + 'client.cms.blogs.posts.updateDraft', + 'client.cms.blogs.posts.batch.create', + 'client.cms.blogs.posts.batch.delete', + 'client.cms.blogs.posts.batch.get', + 'client.cms.blogs.posts.batch.update', + 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', + 'client.cms.blogs.posts.multiLanguage.createLangVariation', + 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', + 'client.cms.blogs.posts.multiLanguage.setLangPrimary', + 'client.cms.blogs.posts.multiLanguage.updateLangs', + 'client.cms.blogs.posts.revisions.getPreviousVersion', + 'client.cms.blogs.posts.revisions.getPreviousVersions', + 'client.cms.blogs.posts.revisions.restorePreviousVersion', + 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', + 'client.cms.blogs.settings.get', + 'client.cms.blogs.settings.getRevision', + 'client.cms.blogs.settings.list', + 'client.cms.blogs.settings.listRevisions', + 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', + 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', + 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', + 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', + 'client.cms.blogs.settings.multiLanguage.updateLanguages', + 'client.cms.blogs.tags.attachToLangGroup', + 'client.cms.blogs.tags.create', + 'client.cms.blogs.tags.createLangVariation', + 'client.cms.blogs.tags.delete', + 'client.cms.blogs.tags.detachFromLangGroup', + 'client.cms.blogs.tags.get', + 'client.cms.blogs.tags.list', + 'client.cms.blogs.tags.listAuthorsCursor', + 'client.cms.blogs.tags.listAuthorsCursorByQuery', + 'client.cms.blogs.tags.listCursor', + 'client.cms.blogs.tags.listCursorByQuery', + 'client.cms.blogs.tags.listPostsCursor', + 'client.cms.blogs.tags.listPostsCursorByQuery', + 'client.cms.blogs.tags.setLangPrimary', + 'client.cms.blogs.tags.update', + 'client.cms.blogs.tags.updateLangs', + 'client.cms.blogs.tags.batch.createBatch', + 'client.cms.blogs.tags.batch.delete', + 'client.cms.blogs.tags.batch.getBatch', + 'client.cms.blogs.tags.batch.updateBatch', + 'client.cms.domains.get', + 'client.cms.domains.list', + 'client.cms.hubdb.rows.cloneBatch', + 'client.cms.hubdb.rows.cloneDraft', + 'client.cms.hubdb.rows.create', + 'client.cms.hubdb.rows.createBatch', + 'client.cms.hubdb.rows.deleteDraft', + 'client.cms.hubdb.rows.get', + 'client.cms.hubdb.rows.getBatch', + 'client.cms.hubdb.rows.getDraft', + 'client.cms.hubdb.rows.getDraftBatch', + 'client.cms.hubdb.rows.list', + 'client.cms.hubdb.rows.purgeBatch', + 'client.cms.hubdb.rows.replaceBatch', + 'client.cms.hubdb.rows.replaceDraft', + 'client.cms.hubdb.rows.updateBatch', + 'client.cms.hubdb.rows.updateDraft', + 'client.cms.hubdb.tables.cloneDraft', + 'client.cms.hubdb.tables.create', + 'client.cms.hubdb.tables.delete', + 'client.cms.hubdb.tables.deleteVersion', + 'client.cms.hubdb.tables.export', + 'client.cms.hubdb.tables.exportDraft', + 'client.cms.hubdb.tables.get', + 'client.cms.hubdb.tables.getDraft', + 'client.cms.hubdb.tables.importDraft', + 'client.cms.hubdb.tables.list', + 'client.cms.hubdb.tables.listDraft', + 'client.cms.hubdb.tables.publishDraft', + 'client.cms.hubdb.tables.resetDraft', + 'client.cms.hubdb.tables.unpublish', + 'client.cms.hubdb.tables.updateDraft', + 'client.cms.mediaBridge.createAssociation', + 'client.cms.mediaBridge.createAttentionSpanEvent', + 'client.cms.mediaBridge.createMediaPlayedEvent', + 'client.cms.mediaBridge.createMediaPlayedPercentEvent', + 'client.cms.mediaBridge.createObjectType', + 'client.cms.mediaBridge.createOembedDomain', + 'client.cms.mediaBridge.createProperty', + 'client.cms.mediaBridge.createPropertyGroup', + 'client.cms.mediaBridge.createVideoAssociationDefinition', + 'client.cms.mediaBridge.deleteAssociation', + 'client.cms.mediaBridge.deleteOembedDomain', + 'client.cms.mediaBridge.deleteProperty', + 'client.cms.mediaBridge.deletePropertyGroup', + 'client.cms.mediaBridge.getEventVisibilitySettings', + 'client.cms.mediaBridge.getOembedDomain', + 'client.cms.mediaBridge.getProperty', + 'client.cms.mediaBridge.getPropertyGroup', + 'client.cms.mediaBridge.getSchema', + 'client.cms.mediaBridge.listObjectTypesByMediaType', + 'client.cms.mediaBridge.listOembedDomains', + 'client.cms.mediaBridge.listProperties', + 'client.cms.mediaBridge.listPropertyGroups', + 'client.cms.mediaBridge.listSchemas', + 'client.cms.mediaBridge.registerAppName', + 'client.cms.mediaBridge.updateEventVisibilitySettings', + 'client.cms.mediaBridge.updateOembedDomain', + 'client.cms.mediaBridge.updateProperty', + 'client.cms.mediaBridge.updatePropertyGroup', + 'client.cms.mediaBridge.updateSchema', + 'client.cms.mediaBridge.updateSettings', + 'client.cms.mediaBridge.batch.create', + 'client.cms.mediaBridge.batch.delete', + 'client.cms.mediaBridge.batch.get', + 'client.cms.pages.landingPages.clone', + 'client.cms.pages.landingPages.create', + 'client.cms.pages.landingPages.delete', + 'client.cms.pages.landingPages.get', + 'client.cms.pages.landingPages.list', + 'client.cms.pages.landingPages.schedule', + 'client.cms.pages.landingPages.update', + 'client.cms.pages.landingPages.abTest.createLandingPageVariation', + 'client.cms.pages.landingPages.abTest.endLandingPageTest', + 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', + 'client.cms.pages.landingPages.batch.createLandingPages', + 'client.cms.pages.landingPages.batch.deleteLandingPages', + 'client.cms.pages.landingPages.batch.getLandingPages', + 'client.cms.pages.landingPages.batch.updateLandingPages', + 'client.cms.pages.landingPages.draft.get', + 'client.cms.pages.landingPages.draft.pushLive', + 'client.cms.pages.landingPages.draft.reset', + 'client.cms.pages.landingPages.draft.update', + 'client.cms.pages.landingPages.folders.batchGet', + 'client.cms.pages.landingPages.folders.create', + 'client.cms.pages.landingPages.folders.createFolders', + 'client.cms.pages.landingPages.folders.delete', + 'client.cms.pages.landingPages.folders.deleteFolders', + 'client.cms.pages.landingPages.folders.get', + 'client.cms.pages.landingPages.folders.getRevision', + 'client.cms.pages.landingPages.folders.list', + 'client.cms.pages.landingPages.folders.listRevisions', + 'client.cms.pages.landingPages.folders.restoreRevision', + 'client.cms.pages.landingPages.folders.update', + 'client.cms.pages.landingPages.folders.updateFolders', + 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', + 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', + 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', + 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', + 'client.cms.pages.landingPages.multiLanguage.updateLanguages', + 'client.cms.pages.landingPages.revisions.getLandingPageRevision', + 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', + 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', + 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', + 'client.cms.pages.sitePages.clone', + 'client.cms.pages.sitePages.create', + 'client.cms.pages.sitePages.delete', + 'client.cms.pages.sitePages.get', + 'client.cms.pages.sitePages.list', + 'client.cms.pages.sitePages.schedule', + 'client.cms.pages.sitePages.update', + 'client.cms.pages.sitePages.abTest.createSitePageVariation', + 'client.cms.pages.sitePages.abTest.endSitePageTest', + 'client.cms.pages.sitePages.abTest.rerunSitePageTest', + 'client.cms.pages.sitePages.batch.createSitePages', + 'client.cms.pages.sitePages.batch.deleteSitePages', + 'client.cms.pages.sitePages.batch.getSitePages', + 'client.cms.pages.sitePages.batch.updateSitePages', + 'client.cms.pages.sitePages.draft.getDraft', + 'client.cms.pages.sitePages.draft.publishDraft', + 'client.cms.pages.sitePages.draft.resetSitePageDraft', + 'client.cms.pages.sitePages.draft.updateDraft', + 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', + 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', + 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', + 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', + 'client.cms.pages.sitePages.multiLanguage.updateLanguages', + 'client.cms.pages.sitePages.revisions.getSitePageRevision', + 'client.cms.pages.sitePages.revisions.listSitePageRevisions', + 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', + 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', + 'client.cms.siteSearch.getIndexedData', + 'client.cms.sourceCode.extractAsync', + 'client.cms.sourceCode.getExtractionStatus', + 'client.cms.urlMappings.create', + 'client.cms.urlMappings.delete', + 'client.cms.urlMappings.get', + 'client.cms.urlMappings.list', + 'client.cms.urlRedirects.create', + 'client.cms.urlRedirects.delete', + 'client.cms.urlRedirects.get', + 'client.cms.urlRedirects.list', + 'client.cms.urlRedirects.update', + 'client.communicationPreferences.generateLinks', + 'client.communicationPreferences.getStatuses', + 'client.communicationPreferences.getUnsubscribeAllStatus', + 'client.communicationPreferences.unsubscribeAll', + 'client.communicationPreferences.updateStatus', + 'client.communicationPreferences.definitions.list', + 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', + 'client.communicationPreferences.statuses.batch.read', + 'client.communicationPreferences.statuses.batch.unsubscribeAll', + 'client.communicationPreferences.statuses.batch.updateStatuses', + 'client.conversations.customChannels.create', + 'client.conversations.customChannels.delete', + 'client.conversations.customChannels.get', + 'client.conversations.customChannels.list', + 'client.conversations.customChannels.update', + 'client.conversations.customChannels.channelAccounts.create', + 'client.conversations.customChannels.channelAccounts.list', + 'client.conversations.customChannels.channelAccounts.update', + 'client.conversations.customChannels.channelAccounts.updateStagingToken', + 'client.conversations.customChannels.messages.create', + 'client.conversations.customChannels.messages.get', + 'client.conversations.customChannels.messages.update', + 'client.conversations.visitorIdentification.generateToken', + 'client.crm.appUninstalls.uninstall', + 'client.crm.associations.create', + 'client.crm.associations.delete', + 'client.crm.associations.list', + 'client.crm.associations.requestHighUsageReport', + 'client.crm.associations.search', + 'client.crm.associations.updateLabels', + 'client.crm.associations.batch.create', + 'client.crm.associations.batch.createDefault', + 'client.crm.associations.batch.delete', + 'client.crm.associations.batch.deleteLabels', + 'client.crm.associations.batch.get', + 'client.crm.associationsSchema.labels.batchCreate', + 'client.crm.associationsSchema.labels.createLabel', + 'client.crm.associationsSchema.labels.deleteLabel', + 'client.crm.associationsSchema.labels.listLabels', + 'client.crm.associationsSchema.labels.updateLabel', + 'client.crm.associationsSchema.limits.batchDelete', + 'client.crm.associationsSchema.limits.batchUpdate', + 'client.crm.associationsSchema.limits.getByObjectTypes', + 'client.crm.associationsSchema.limits.list', + 'client.crm.dealSplits.batch.read', + 'client.crm.dealSplits.batch.upsert', + 'client.crm.exports.createAsync', + 'client.crm.exports.get', + 'client.crm.exports.getStatus', + 'client.crm.extensions.calling.createChannelConnectionSettings', + 'client.crm.extensions.calling.createInboundCall', + 'client.crm.extensions.calling.createRecordingReady', + 'client.crm.extensions.calling.createRecordingSettings', + 'client.crm.extensions.calling.createSettings', + 'client.crm.extensions.calling.deleteChannelConnectionSettings', + 'client.crm.extensions.calling.deleteSettings', + 'client.crm.extensions.calling.getChannelConnectionSettings', + 'client.crm.extensions.calling.getRecordingSettings', + 'client.crm.extensions.calling.getSettings', + 'client.crm.extensions.calling.updateChannelConnectionSettings', + 'client.crm.extensions.calling.updateRecordingSettings', + 'client.crm.extensions.calling.updateSettings', + 'client.crm.extensions.calling.transcripts.create', + 'client.crm.extensions.calling.transcripts.createInboundCall', + 'client.crm.extensions.calling.transcripts.delete', + 'client.crm.extensions.calling.transcripts.get', + 'client.crm.extensions.cardsDev.create', + 'client.crm.extensions.cardsDev.delete', + 'client.crm.extensions.cardsDev.get', + 'client.crm.extensions.cardsDev.getByID', + 'client.crm.extensions.cardsDev.getSampleResponse', + 'client.crm.extensions.cardsDev.migrateViews', + 'client.crm.extensions.cardsDev.update', + 'client.crm.extensions.videoConferencing.delete', + 'client.crm.extensions.videoConferencing.get', + 'client.crm.extensions.videoConferencing.update', + 'client.crm.featureFlags.delete', + 'client.crm.featureFlags.deletePortalState', + 'client.crm.featureFlags.get', + 'client.crm.featureFlags.getPortalState', + 'client.crm.featureFlags.listAll', + 'client.crm.featureFlags.listPortals', + 'client.crm.featureFlags.update', + 'client.crm.featureFlags.updatePortalState', + 'client.crm.featureFlags.batch.delete', + 'client.crm.featureFlags.batch.upsert', + 'client.crm.imports.cancel', + 'client.crm.imports.create', + 'client.crm.imports.get', + 'client.crm.imports.list', + 'client.crm.imports.listErrors', + 'client.crm.limits.getAssociationLabelLimits', + 'client.crm.limits.getAssociationRecordsLimitsByObjectType', + 'client.crm.limits.getAssociationRecordsLimitsFromObjects', + 'client.crm.limits.getAssociationRecordsLimitsToObjects', + 'client.crm.limits.getCalculatedPropertyLimits', + 'client.crm.limits.getCustomObjectTypeLimits', + 'client.crm.limits.getCustomPropertyLimits', + 'client.crm.limits.getPipelineLimits', + 'client.crm.limits.getRecordLimits', + 'client.crm.lists.addAndRemoveMemberships', + 'client.crm.lists.addMemberships', + 'client.crm.lists.addMembershipsFrom', + 'client.crm.lists.batchReadMemberships', + 'client.crm.lists.create', + 'client.crm.lists.createFolder', + 'client.crm.lists.createIDMapping', + 'client.crm.lists.delete', + 'client.crm.lists.deleteFolder', + 'client.crm.lists.deleteMemberships', + 'client.crm.lists.get', + 'client.crm.lists.getByObjectTypeAndName', + 'client.crm.lists.getIDMapping', + 'client.crm.lists.getMembershipsJoinOrder', + 'client.crm.lists.getRecordMemberships', + 'client.crm.lists.getScheduleConversion', + 'client.crm.lists.getSizeAndEditsHistoryBetween', + 'client.crm.lists.list', + 'client.crm.lists.listBySearch', + 'client.crm.lists.listFolders', + 'client.crm.lists.listMemberships', + 'client.crm.lists.moveFolder', + 'client.crm.lists.moveList', + 'client.crm.lists.removeMemberships', + 'client.crm.lists.renameFolder', + 'client.crm.lists.restore', + 'client.crm.lists.scheduleConversion', + 'client.crm.lists.updateListFilters', + 'client.crm.lists.updateListName', + 'client.crm.lists.updateScheduleConversion', + 'client.crm.objectLibrary.enablement.getAll', + 'client.crm.objectLibrary.enablement.getByObjectTypeID', + 'client.crm.objectSchemas.create', + 'client.crm.objectSchemas.createAssociation', + 'client.crm.objectSchemas.delete', + 'client.crm.objectSchemas.deleteAssociation', + 'client.crm.objectSchemas.get', + 'client.crm.objectSchemas.list', + 'client.crm.objectSchemas.update', + 'client.crm.objectSchemas.batch.get', + 'client.crm.objects.calls.create', + 'client.crm.objects.calls.delete', + 'client.crm.objects.calls.get', + 'client.crm.objects.calls.list', + 'client.crm.objects.calls.search', + 'client.crm.objects.calls.update', + 'client.crm.objects.calls.batch.create', + 'client.crm.objects.calls.batch.delete', + 'client.crm.objects.calls.batch.get', + 'client.crm.objects.calls.batch.update', + 'client.crm.objects.calls.batch.upsert', + 'client.crm.objects.carts.create', + 'client.crm.objects.carts.delete', + 'client.crm.objects.carts.get', + 'client.crm.objects.carts.list', + 'client.crm.objects.carts.search', + 'client.crm.objects.carts.update', + 'client.crm.objects.carts.batch.create', + 'client.crm.objects.carts.batch.delete', + 'client.crm.objects.carts.batch.get', + 'client.crm.objects.carts.batch.update', + 'client.crm.objects.carts.batch.upsert', + 'client.crm.objects.commercePayments.create', + 'client.crm.objects.commercePayments.delete', + 'client.crm.objects.commercePayments.get', + 'client.crm.objects.commercePayments.list', + 'client.crm.objects.commercePayments.search', + 'client.crm.objects.commercePayments.update', + 'client.crm.objects.commercePayments.batch.create', + 'client.crm.objects.commercePayments.batch.delete', + 'client.crm.objects.commercePayments.batch.get', + 'client.crm.objects.commercePayments.batch.update', + 'client.crm.objects.commercePayments.batch.upsert', + 'client.crm.objects.communications.create', + 'client.crm.objects.communications.delete', + 'client.crm.objects.communications.get', + 'client.crm.objects.communications.list', + 'client.crm.objects.communications.search', + 'client.crm.objects.communications.update', + 'client.crm.objects.communications.batch.create', + 'client.crm.objects.communications.batch.delete', + 'client.crm.objects.communications.batch.get', + 'client.crm.objects.communications.batch.update', + 'client.crm.objects.communications.batch.upsert', + 'client.crm.objects.companies.create', + 'client.crm.objects.companies.delete', + 'client.crm.objects.companies.get', + 'client.crm.objects.companies.list', + 'client.crm.objects.companies.merge', + 'client.crm.objects.companies.search', + 'client.crm.objects.companies.update', + 'client.crm.objects.companies.batch.create', + 'client.crm.objects.companies.batch.delete', + 'client.crm.objects.companies.batch.get', + 'client.crm.objects.companies.batch.update', + 'client.crm.objects.companies.batch.upsert', + 'client.crm.objects.contacts.create', + 'client.crm.objects.contacts.delete', + 'client.crm.objects.contacts.gdprDelete', + 'client.crm.objects.contacts.get', + 'client.crm.objects.contacts.list', + 'client.crm.objects.contacts.merge', + 'client.crm.objects.contacts.search', + 'client.crm.objects.contacts.update', + 'client.crm.objects.contacts.batch.create', + 'client.crm.objects.contacts.batch.delete', + 'client.crm.objects.contacts.batch.get', + 'client.crm.objects.contacts.batch.update', + 'client.crm.objects.contacts.batch.upsert', + 'client.crm.objects.contracts.get', + 'client.crm.objects.contracts.list', + 'client.crm.objects.contracts.batch.get', + 'client.crm.objects.courses.create', + 'client.crm.objects.courses.delete', + 'client.crm.objects.courses.get', + 'client.crm.objects.courses.list', + 'client.crm.objects.courses.search', + 'client.crm.objects.courses.update', + 'client.crm.objects.courses.batch.create', + 'client.crm.objects.courses.batch.delete', + 'client.crm.objects.courses.batch.get', + 'client.crm.objects.courses.batch.update', + 'client.crm.objects.courses.batch.upsert', + 'client.crm.objects.custom.create', + 'client.crm.objects.custom.delete', + 'client.crm.objects.custom.get', + 'client.crm.objects.custom.list', + 'client.crm.objects.custom.merge', + 'client.crm.objects.custom.search', + 'client.crm.objects.custom.update', + 'client.crm.objects.custom.batch.create', + 'client.crm.objects.custom.batch.delete', + 'client.crm.objects.custom.batch.get', + 'client.crm.objects.custom.batch.update', + 'client.crm.objects.custom.batch.upsert', + 'client.crm.objects.deals.create', + 'client.crm.objects.deals.delete', + 'client.crm.objects.deals.get', + 'client.crm.objects.deals.list', + 'client.crm.objects.deals.merge', + 'client.crm.objects.deals.search', + 'client.crm.objects.deals.update', + 'client.crm.objects.deals.batch.create', + 'client.crm.objects.deals.batch.delete', + 'client.crm.objects.deals.batch.get', + 'client.crm.objects.deals.batch.update', + 'client.crm.objects.deals.batch.upsert', + 'client.crm.objects.discounts.create', + 'client.crm.objects.discounts.delete', + 'client.crm.objects.discounts.get', + 'client.crm.objects.discounts.list', + 'client.crm.objects.discounts.search', + 'client.crm.objects.discounts.update', + 'client.crm.objects.discounts.batch.create', + 'client.crm.objects.discounts.batch.delete', + 'client.crm.objects.discounts.batch.get', + 'client.crm.objects.discounts.batch.update', + 'client.crm.objects.discounts.batch.upsert', + 'client.crm.objects.emails.create', + 'client.crm.objects.emails.delete', + 'client.crm.objects.emails.get', + 'client.crm.objects.emails.list', + 'client.crm.objects.emails.search', + 'client.crm.objects.emails.update', + 'client.crm.objects.emails.batch.create', + 'client.crm.objects.emails.batch.delete', + 'client.crm.objects.emails.batch.get', + 'client.crm.objects.emails.batch.update', + 'client.crm.objects.emails.batch.upsert', + 'client.crm.objects.feedbackSubmissions.get', + 'client.crm.objects.feedbackSubmissions.list', + 'client.crm.objects.feedbackSubmissions.search', + 'client.crm.objects.feedbackSubmissions.batch.get', + 'client.crm.objects.fees.create', + 'client.crm.objects.fees.delete', + 'client.crm.objects.fees.get', + 'client.crm.objects.fees.list', + 'client.crm.objects.fees.search', + 'client.crm.objects.fees.update', + 'client.crm.objects.fees.batch.create', + 'client.crm.objects.fees.batch.delete', + 'client.crm.objects.fees.batch.get', + 'client.crm.objects.fees.batch.update', + 'client.crm.objects.fees.batch.upsert', + 'client.crm.objects.genericObjects.create', + 'client.crm.objects.genericObjects.delete', + 'client.crm.objects.genericObjects.get', + 'client.crm.objects.genericObjects.list', + 'client.crm.objects.genericObjects.search', + 'client.crm.objects.genericObjects.update', + 'client.crm.objects.genericObjects.batch.create', + 'client.crm.objects.genericObjects.batch.delete', + 'client.crm.objects.genericObjects.batch.get', + 'client.crm.objects.genericObjects.batch.update', + 'client.crm.objects.genericObjects.batch.upsert', + 'client.crm.objects.goalTargets.create', + 'client.crm.objects.goalTargets.delete', + 'client.crm.objects.goalTargets.get', + 'client.crm.objects.goalTargets.list', + 'client.crm.objects.goalTargets.search', + 'client.crm.objects.goalTargets.update', + 'client.crm.objects.goalTargets.batch.create', + 'client.crm.objects.goalTargets.batch.delete', + 'client.crm.objects.goalTargets.batch.get', + 'client.crm.objects.goalTargets.batch.update', + 'client.crm.objects.goalTargets.batch.upsert', + 'client.crm.objects.invoices.create', + 'client.crm.objects.invoices.delete', + 'client.crm.objects.invoices.get', + 'client.crm.objects.invoices.list', + 'client.crm.objects.invoices.search', + 'client.crm.objects.invoices.update', + 'client.crm.objects.invoices.batch.create', + 'client.crm.objects.invoices.batch.delete', + 'client.crm.objects.invoices.batch.get', + 'client.crm.objects.invoices.batch.update', + 'client.crm.objects.invoices.batch.upsert', + 'client.crm.objects.leads.create', + 'client.crm.objects.leads.delete', + 'client.crm.objects.leads.get', + 'client.crm.objects.leads.list', + 'client.crm.objects.leads.search', + 'client.crm.objects.leads.update', + 'client.crm.objects.leads.batch.create', + 'client.crm.objects.leads.batch.delete', + 'client.crm.objects.leads.batch.get', + 'client.crm.objects.leads.batch.update', + 'client.crm.objects.leads.batch.upsert', + 'client.crm.objects.lineItems.create', + 'client.crm.objects.lineItems.delete', + 'client.crm.objects.lineItems.get', + 'client.crm.objects.lineItems.list', + 'client.crm.objects.lineItems.search', + 'client.crm.objects.lineItems.update', + 'client.crm.objects.lineItems.batch.create', + 'client.crm.objects.lineItems.batch.delete', + 'client.crm.objects.lineItems.batch.get', + 'client.crm.objects.lineItems.batch.update', + 'client.crm.objects.lineItems.batch.upsert', + 'client.crm.objects.listings.create', + 'client.crm.objects.listings.delete', + 'client.crm.objects.listings.get', + 'client.crm.objects.listings.list', + 'client.crm.objects.listings.search', + 'client.crm.objects.listings.update', + 'client.crm.objects.listings.batch.create', + 'client.crm.objects.listings.batch.delete', + 'client.crm.objects.listings.batch.get', + 'client.crm.objects.listings.batch.update', + 'client.crm.objects.listings.batch.upsert', + 'client.crm.objects.meetings.create', + 'client.crm.objects.meetings.delete', + 'client.crm.objects.meetings.get', + 'client.crm.objects.meetings.list', + 'client.crm.objects.meetings.search', + 'client.crm.objects.meetings.update', + 'client.crm.objects.meetings.batch.create', + 'client.crm.objects.meetings.batch.delete', + 'client.crm.objects.meetings.batch.get', + 'client.crm.objects.meetings.batch.update', + 'client.crm.objects.meetings.batch.upsert', + 'client.crm.objects.notes.create', + 'client.crm.objects.notes.delete', + 'client.crm.objects.notes.get', + 'client.crm.objects.notes.list', + 'client.crm.objects.notes.search', + 'client.crm.objects.notes.update', + 'client.crm.objects.notes.batch.create', + 'client.crm.objects.notes.batch.delete', + 'client.crm.objects.notes.batch.get', + 'client.crm.objects.notes.batch.update', + 'client.crm.objects.notes.batch.upsert', + 'client.crm.objects.orders.create', + 'client.crm.objects.orders.delete', + 'client.crm.objects.orders.get', + 'client.crm.objects.orders.list', + 'client.crm.objects.orders.search', + 'client.crm.objects.orders.update', + 'client.crm.objects.orders.batch.create', + 'client.crm.objects.orders.batch.delete', + 'client.crm.objects.orders.batch.get', + 'client.crm.objects.orders.batch.update', + 'client.crm.objects.orders.batch.upsert', + 'client.crm.objects.partnerClients.get', + 'client.crm.objects.partnerClients.list', + 'client.crm.objects.partnerClients.listAssociations', + 'client.crm.objects.partnerClients.search', + 'client.crm.objects.partnerClients.update', + 'client.crm.objects.partnerClients.batch.get', + 'client.crm.objects.partnerClients.batch.update', + 'client.crm.objects.partnerServices.get', + 'client.crm.objects.partnerServices.list', + 'client.crm.objects.partnerServices.search', + 'client.crm.objects.partnerServices.update', + 'client.crm.objects.partnerServices.batch.get', + 'client.crm.objects.partnerServices.batch.update', + 'client.crm.objects.postalMail.create', + 'client.crm.objects.postalMail.delete', + 'client.crm.objects.postalMail.get', + 'client.crm.objects.postalMail.list', + 'client.crm.objects.postalMail.search', + 'client.crm.objects.postalMail.update', + 'client.crm.objects.postalMail.batch.create', + 'client.crm.objects.postalMail.batch.delete', + 'client.crm.objects.postalMail.batch.get', + 'client.crm.objects.postalMail.batch.update', + 'client.crm.objects.postalMail.batch.upsert', + 'client.crm.objects.products.create', + 'client.crm.objects.products.delete', + 'client.crm.objects.products.get', + 'client.crm.objects.products.list', + 'client.crm.objects.products.search', + 'client.crm.objects.products.update', + 'client.crm.objects.products.batch.create', + 'client.crm.objects.products.batch.delete', + 'client.crm.objects.products.batch.get', + 'client.crm.objects.products.batch.update', + 'client.crm.objects.products.batch.upsert', + 'client.crm.objects.projects.create', + 'client.crm.objects.projects.delete', + 'client.crm.objects.projects.get', + 'client.crm.objects.projects.list', + 'client.crm.objects.projects.merge', + 'client.crm.objects.projects.search', + 'client.crm.objects.projects.update', + 'client.crm.objects.projects.batch.create', + 'client.crm.objects.projects.batch.delete', + 'client.crm.objects.projects.batch.get', + 'client.crm.objects.projects.batch.update', + 'client.crm.objects.projects.batch.upsert', + 'client.crm.objects.quotes.create', + 'client.crm.objects.quotes.delete', + 'client.crm.objects.quotes.get', + 'client.crm.objects.quotes.list', + 'client.crm.objects.quotes.search', + 'client.crm.objects.quotes.update', + 'client.crm.objects.quotes.batch.create', + 'client.crm.objects.quotes.batch.delete', + 'client.crm.objects.quotes.batch.get', + 'client.crm.objects.quotes.batch.update', + 'client.crm.objects.quotes.batch.upsert', + 'client.crm.objects.services.create', + 'client.crm.objects.services.delete', + 'client.crm.objects.services.get', + 'client.crm.objects.services.list', + 'client.crm.objects.services.search', + 'client.crm.objects.services.update', + 'client.crm.objects.services.batch.create', + 'client.crm.objects.services.batch.delete', + 'client.crm.objects.services.batch.get', + 'client.crm.objects.services.batch.update', + 'client.crm.objects.services.batch.upsert', + 'client.crm.objects.subscriptions.create', + 'client.crm.objects.subscriptions.delete', + 'client.crm.objects.subscriptions.get', + 'client.crm.objects.subscriptions.list', + 'client.crm.objects.subscriptions.search', + 'client.crm.objects.subscriptions.update', + 'client.crm.objects.subscriptions.batch.create', + 'client.crm.objects.subscriptions.batch.delete', + 'client.crm.objects.subscriptions.batch.get', + 'client.crm.objects.subscriptions.batch.update', + 'client.crm.objects.subscriptions.batch.upsert', + 'client.crm.objects.tasks.create', + 'client.crm.objects.tasks.delete', + 'client.crm.objects.tasks.get', + 'client.crm.objects.tasks.list', + 'client.crm.objects.tasks.search', + 'client.crm.objects.tasks.update', + 'client.crm.objects.tasks.batch.create', + 'client.crm.objects.tasks.batch.delete', + 'client.crm.objects.tasks.batch.get', + 'client.crm.objects.tasks.batch.update', + 'client.crm.objects.tasks.batch.upsert', + 'client.crm.objects.taxes.create', + 'client.crm.objects.taxes.delete', + 'client.crm.objects.taxes.get', + 'client.crm.objects.taxes.list', + 'client.crm.objects.taxes.search', + 'client.crm.objects.taxes.update', + 'client.crm.objects.taxes.batch.create', + 'client.crm.objects.taxes.batch.delete', + 'client.crm.objects.taxes.batch.get', + 'client.crm.objects.taxes.batch.update', + 'client.crm.objects.taxes.batch.upsert', + 'client.crm.objects.tickets.create', + 'client.crm.objects.tickets.delete', + 'client.crm.objects.tickets.get', + 'client.crm.objects.tickets.list', + 'client.crm.objects.tickets.merge', + 'client.crm.objects.tickets.search', + 'client.crm.objects.tickets.update', + 'client.crm.objects.tickets.batch.create', + 'client.crm.objects.tickets.batch.delete', + 'client.crm.objects.tickets.batch.get', + 'client.crm.objects.tickets.batch.update', + 'client.crm.objects.tickets.batch.upsert', + 'client.crm.objects.users.create', + 'client.crm.objects.users.delete', + 'client.crm.objects.users.get', + 'client.crm.objects.users.list', + 'client.crm.objects.users.search', + 'client.crm.objects.users.update', + 'client.crm.objects.users.batch.create', + 'client.crm.objects.users.batch.delete', + 'client.crm.objects.users.batch.get', + 'client.crm.objects.users.batch.update', + 'client.crm.objects.users.batch.upsert', + 'client.crm.owners.get', + 'client.crm.owners.list', + 'client.crm.pipelines.create', + 'client.crm.pipelines.createStage', + 'client.crm.pipelines.delete', + 'client.crm.pipelines.deleteStage', + 'client.crm.pipelines.get', + 'client.crm.pipelines.getStage', + 'client.crm.pipelines.list', + 'client.crm.pipelines.listAudit', + 'client.crm.pipelines.listStageAudit', + 'client.crm.pipelines.listStages', + 'client.crm.pipelines.update', + 'client.crm.pipelines.updateAllProperties', + 'client.crm.pipelines.updateStage', + 'client.crm.pipelines.updateStageAllProperties', + 'client.crm.properties.create', + 'client.crm.properties.delete', + 'client.crm.properties.get', + 'client.crm.properties.list', + 'client.crm.properties.update', + 'client.crm.properties.batch.create', + 'client.crm.properties.batch.delete', + 'client.crm.properties.batch.get', + 'client.crm.properties.groups.create', + 'client.crm.properties.groups.delete', + 'client.crm.properties.groups.get', + 'client.crm.properties.groups.list', + 'client.crm.properties.groups.update', + 'client.crm.propertiesValidations.getByObjectTypeID', + 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', + 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', + 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', + 'client.crm.timeline.createEvent', + 'client.crm.timeline.createProjectType', + 'client.crm.timeline.batch.create', + 'client.events.definitions.create', + 'client.events.definitions.createProperty', + 'client.events.definitions.delete', + 'client.events.definitions.deleteProperty', + 'client.events.definitions.get', + 'client.events.definitions.list', + 'client.events.definitions.sendBatch', + 'client.events.definitions.update', + 'client.events.definitions.updateProperty', + 'client.events.occurrences.list', + 'client.events.occurrences.listEventTypes', + 'client.events.send.batchSend', + 'client.events.send.send', + 'client.files.fileAssets.create', + 'client.files.fileAssets.delete', + 'client.files.fileAssets.gdprDelete', + 'client.files.fileAssets.get', + 'client.files.fileAssets.getImportTaskStatus', + 'client.files.fileAssets.getSignedURL', + 'client.files.fileAssets.importFromURLAsync', + 'client.files.fileAssets.replace', + 'client.files.fileAssets.search', + 'client.files.fileAssets.update', + 'client.files.fileAssets.upload', + 'client.files.folders.deleteByID', + 'client.files.folders.deleteByPath', + 'client.files.folders.getByID', + 'client.files.folders.getByPath', + 'client.files.folders.getUpdateAsyncStatus', + 'client.files.folders.search', + 'client.files.folders.updateAsyncByID', + 'client.files.folders.updateByID', + 'client.marketing.campaigns.create', + 'client.marketing.campaigns.delete', + 'client.marketing.campaigns.get', + 'client.marketing.campaigns.list', + 'client.marketing.campaigns.update', + 'client.marketing.campaigns.assets.delete', + 'client.marketing.campaigns.assets.list', + 'client.marketing.campaigns.assets.update', + 'client.marketing.campaigns.batch.create', + 'client.marketing.campaigns.batch.delete', + 'client.marketing.campaigns.batch.get', + 'client.marketing.campaigns.batch.update', + 'client.marketing.campaigns.budget.create', + 'client.marketing.campaigns.budget.delete', + 'client.marketing.campaigns.budget.get', + 'client.marketing.campaigns.budget.getTotals', + 'client.marketing.campaigns.budget.update', + 'client.marketing.campaigns.metrics.getAttributionMetrics', + 'client.marketing.campaigns.metrics.getRevenueAttribution', + 'client.marketing.campaigns.metrics.listContactIDsByType', + 'client.marketing.campaigns.spend.create', + 'client.marketing.campaigns.spend.delete', + 'client.marketing.campaigns.spend.get', + 'client.marketing.campaigns.spend.update', + 'client.marketing.emails.clone', + 'client.marketing.emails.create', + 'client.marketing.emails.createAbTestVariation', + 'client.marketing.emails.delete', + 'client.marketing.emails.get', + 'client.marketing.emails.getAbTestVariation', + 'client.marketing.emails.getDraft', + 'client.marketing.emails.getHistogram', + 'client.marketing.emails.getRevision', + 'client.marketing.emails.list', + 'client.marketing.emails.listRevisions', + 'client.marketing.emails.publish', + 'client.marketing.emails.resetDraft', + 'client.marketing.emails.restoreRevision', + 'client.marketing.emails.restoreRevisionToDraft', + 'client.marketing.emails.unpublish', + 'client.marketing.emails.update', + 'client.marketing.emails.updateDraft', + 'client.marketing.marketingEvents.create', + 'client.marketing.marketingEvents.delete', + 'client.marketing.marketingEvents.deleteBatch', + 'client.marketing.marketingEvents.deleteBatchByExternalEventID', + 'client.marketing.marketingEvents.deleteByExternalEventID', + 'client.marketing.marketingEvents.get', + 'client.marketing.marketingEvents.getByExternalEventID', + 'client.marketing.marketingEvents.list', + 'client.marketing.marketingEvents.searchByExternalEventID', + 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', + 'client.marketing.marketingEvents.update', + 'client.marketing.marketingEvents.updateBatch', + 'client.marketing.marketingEvents.updateByExternalEventID', + 'client.marketing.marketingEvents.upsertBatch', + 'client.marketing.marketingEvents.upsertByExternalEventID', + 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', + 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', + 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', + 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', + 'client.marketing.marketingEvents.events.cancelByExternalEventID', + 'client.marketing.marketingEvents.events.completeByExternalEventID', + 'client.marketing.marketingEvents.listAssociations.associate', + 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', + 'client.marketing.marketingEvents.listAssociations.delete', + 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', + 'client.marketing.marketingEvents.listAssociations.list', + 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', + 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', + 'client.marketing.marketingEvents.participations.getByID', + 'client.marketing.marketingEvents.participations.listBreakdownByContact', + 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', + 'client.marketing.marketingEvents.participations.listBreakdownByID', + 'client.marketing.marketingEvents.settings.createOrUpdate', + 'client.marketing.marketingEvents.settings.get', + 'client.marketing.marketingEvents.subscriberState.recordByEmail', + 'client.marketing.marketingEvents.subscriberState.recordByID', + 'client.marketing.singleSend.create', + 'client.marketing.transactional.singleEmail.send', + 'client.marketing.transactional.smtpTokens.create', + 'client.marketing.transactional.smtpTokens.delete', + 'client.marketing.transactional.smtpTokens.get', + 'client.marketing.transactional.smtpTokens.list', + 'client.marketing.transactional.smtpTokens.resetPassword', + 'client.meta.origins.ipRanges.list', + 'client.meta.origins.ipRanges.listSimple', + 'client.scheduler.meetings.advanced.book', + 'client.scheduler.meetings.advanced.create', + 'client.scheduler.meetings.basic.getAvailabilityBySlug', + 'client.scheduler.meetings.basic.getBookingInfoBySlug', + 'client.scheduler.meetings.basic.list', + 'client.settings.currencies.getCompanyCurrency', + 'client.settings.currencies.listCodes', + 'client.settings.currencies.updateCompanyCurrency', + 'client.settings.currencies.centralFxRates.createCurrency', + 'client.settings.currencies.centralFxRates.getInformation', + 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', + 'client.settings.currencies.exchangeRates.createExchangeRate', + 'client.settings.currencies.exchangeRates.getExchangeRateByID', + 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', + 'client.settings.currencies.exchangeRates.listExchangeRates', + 'client.settings.currencies.exchangeRates.updateExchangeRate', + 'client.settings.currencies.exchangeRates.updateVisibility', + 'client.settings.currencies.exchangeRates.batch.create', + 'client.settings.currencies.exchangeRates.batch.get', + 'client.settings.currencies.exchangeRates.batch.update', + 'client.settings.taxRates.get', + 'client.settings.taxRates.list', + 'client.settings.users.create', + 'client.settings.users.delete', + 'client.settings.users.get', + 'client.settings.users.list', + 'client.settings.users.listRoles', + 'client.settings.users.listTeams', + 'client.settings.users.update', + 'client.webhooks.createBatchEventSubscriptions', + 'client.webhooks.createCrmSnapshots', + 'client.webhooks.createEventSubscription', + 'client.webhooks.createJournalSubscription', + 'client.webhooks.createSubscriptionFilter', + 'client.webhooks.deleteEventSubscription', + 'client.webhooks.deleteJournalSubscription', + 'client.webhooks.deleteJournalSubscriptionForPortal', + 'client.webhooks.deleteSettings', + 'client.webhooks.deleteSubscriptionFilter', + 'client.webhooks.getEarliestJournalBatch', + 'client.webhooks.getEarliestJournalEntry', + 'client.webhooks.getEarliestLocalJournalBatch', + 'client.webhooks.getEarliestLocalJournalEntry', + 'client.webhooks.getEventSubscription', + 'client.webhooks.getJournalBatchByRequest', + 'client.webhooks.getJournalBatchFromOffset', + 'client.webhooks.getJournalStatus', + 'client.webhooks.getJournalSubscription', + 'client.webhooks.getLatestJournalBatch', + 'client.webhooks.getLatestJournalEntry', + 'client.webhooks.getLatestLocalJournalBatch', + 'client.webhooks.getLatestLocalJournalEntry', + 'client.webhooks.getLocalJournalBatchByRequest', + 'client.webhooks.getLocalJournalBatchFromOffset', + 'client.webhooks.getLocalJournalStatus', + 'client.webhooks.getNextJournalEntries', + 'client.webhooks.getNextLocalJournalEntries', + 'client.webhooks.getSettings', + 'client.webhooks.getSubscriptionFilter', + 'client.webhooks.listEventSubscriptions', + 'client.webhooks.listJournalSubscriptions', + 'client.webhooks.listSubscriptionFilters', + 'client.webhooks.updateEventSubscription', + 'client.webhooks.updateSettings', + ], + { threshold: 1, shouldSort: true }, +); + +function getMethodSuggestions(fullyQualifiedMethodName: string): string[] { + return fuse + .search(fullyQualifiedMethodName) + .map(({ item }) => item) + .slice(0, 5); +} + +const proxyToObj = new WeakMap(); +const objToProxy = new WeakMap(); + +type ClientProxyConfig = { + path: string[]; + isBelievedBad?: boolean; +}; + +function makeSdkProxy(obj: T, { path, isBelievedBad = false }: ClientProxyConfig): T { + let proxy: T = objToProxy.get(obj); + + if (!proxy) { + proxy = new Proxy(obj, { + get(target, prop, receiver) { + const propPath = [...path, String(prop)]; + const value = Reflect.get(target, prop, receiver); + + if (isBelievedBad || (!(prop in target) && value === undefined)) { + // If we're accessing a path that doesn't exist, it will probably eventually error. + // Let's proxy it and mark it bad so that we can control the error message. + // We proxy an empty class so that an invocation or construction attempt is possible. + return makeSdkProxy(class {}, { path: propPath, isBelievedBad: true }); + } + + if (value !== null && (typeof value === 'object' || typeof value === 'function')) { + return makeSdkProxy(value, { path: propPath, isBelievedBad }); + } + + return value; + }, + + apply(target, thisArg, args) { + if (isBelievedBad || typeof target !== 'function') { + const fullyQualifiedMethodName = path.join('.'); + const suggestions = getMethodSuggestions(fullyQualifiedMethodName); + throw new Error( + `${fullyQualifiedMethodName} is not a function. Did you mean: ${suggestions.join(', ')}`, + ); + } + + return Reflect.apply(target, proxyToObj.get(thisArg) ?? thisArg, args); + }, + + construct(target, args, newTarget) { + if (isBelievedBad || typeof target !== 'function') { + const fullyQualifiedMethodName = path.join('.'); + const suggestions = getMethodSuggestions(fullyQualifiedMethodName); + throw new Error( + `${fullyQualifiedMethodName} is not a constructor. Did you mean: ${suggestions.join(', ')}`, + ); + } + + return Reflect.construct(target, args, newTarget); + }, + }); + + objToProxy.set(obj, proxy); + proxyToObj.set(proxy, obj); + } + + return proxy; +} + +function parseError(code: string, error: unknown): string | undefined { + if (!(error instanceof Error)) return; + const cause = error.cause instanceof Error ? `: ${error.cause.message}` : ''; + const message = error.name ? `${error.name}: ${error.message}${cause}` : `${error.message}${cause}`; + try { + // Deno uses V8; the first ":LINE:COLUMN" is the top of stack. + const lineNumber = error.stack?.match(/:([0-9]+):[0-9]+/)?.[1]; + // -1 for the zero-based indexing + const line = + lineNumber && + code + .split('\n') + .at(parseInt(lineNumber, 10) - 1) + ?.trim(); + return line ? `${message}\n at line ${lineNumber}\n ${line}` : message; + } catch { + return message; + } +} + +const fetch = async (req: Request): Promise => { + const { opts, code } = (await req.json()) as { opts: ClientOptions; code: string }; + + const runFunctionSource = code ? getRunFunctionSource(code) : null; + if (!runFunctionSource) { + const message = + code ? + 'The code is missing a top-level `run` function.' + : 'The code argument is missing. Provide one containing a top-level `run` function.'; + return Response.json( + { + is_error: true, + result: `${message} Write code within this template:\n\n\`\`\`\nasync function run(client) {\n // Fill this out\n}\n\`\`\``, + log_lines: [], + err_lines: [], + } satisfies WorkerOutput, + { status: 400, statusText: 'Code execution error' }, + ); + } + + const diagnostics = getTSDiagnostics(code); + if (diagnostics.length > 0) { + return Response.json( + { + is_error: true, + result: `The code contains TypeScript diagnostics:\n${diagnostics.join('\n')}`, + log_lines: [], + err_lines: [], + } satisfies WorkerOutput, + { status: 400, statusText: 'Code execution error' }, + ); + } + + const client = new HubSpot({ + ...opts, + }); + + const log_lines: string[] = []; + const err_lines: string[] = []; + const originalConsole = globalThis.console; + globalThis.console = { + ...originalConsole, + log: (...args: unknown[]) => { + log_lines.push(util.format(...args)); + }, + error: (...args: unknown[]) => { + err_lines.push(util.format(...args)); + }, + }; + try { + let run_ = async (client: any) => {}; + run_ = (await tseval(`${code}\nexport default run;`)).default; + const result = await run_(makeSdkProxy(client, { path: ['client'] })); + return Response.json({ + is_error: false, + result, + log_lines, + err_lines, + } satisfies WorkerOutput); + } catch (e) { + return Response.json( + { + is_error: true, + result: parseError(code, e), + log_lines, + err_lines, + } satisfies WorkerOutput, + { status: 400, statusText: 'Code execution error' }, + ); + } finally { + globalThis.console = originalConsole; + } +}; + +export default { fetch }; diff --git a/packages/mcp-server/src/code-tool.ts b/packages/mcp-server/src/code-tool.ts new file mode 100644 index 00000000..94d68968 --- /dev/null +++ b/packages/mcp-server/src/code-tool.ts @@ -0,0 +1,392 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { + ContentBlock, + McpRequestContext, + McpTool, + Metadata, + ToolCallResult, + asErrorResult, + asTextContentResult, +} from './types'; +import { Tool } from '@modelcontextprotocol/sdk/types.js'; +import { readEnv } from './util'; +import { WorkerInput, WorkerOutput } from './code-tool-types'; +import { getLogger } from './logger'; +import { SdkMethod } from './methods'; +import { McpCodeExecutionMode } from './options'; +import { ClientOptions } from '@hubspot/sdk'; + +const prompt = `Runs JavaScript code to interact with the HubSpot API. + +You are a skilled TypeScript programmer writing code to interface with the service. +Define an async function named "run" that takes a single parameter of an initialized SDK client and it will be run. +For example: + +\`\`\` +async function run(client) { + const result = await client.crm.objects.contacts.get('contactId'); + + console.log(result.id); +} +\`\`\` + +You will be returned anything that your function returns, plus the results of any console.log statements. +Do not add try-catch blocks for single API calls. The tool will handle errors for you. +Do not add comments unless necessary for generating better code. +Code will run in a container, and cannot interact with the network outside of the given SDK client. +Variables will not persist between calls, so make sure to return or log any data you might need later. +Remember that you are writing TypeScript code, so you need to be careful with your types. +Always type dynamic key-value stores explicitly as Record instead of {}.`; + +/** + * A tool that runs code against a copy of the SDK. + * + * Instead of exposing every endpoint as its own tool, which uses up too many tokens for LLMs to use at once, + * we expose a single tool that can be used to search for endpoints by name, resource, operation, or tag, and then + * a generic endpoint that can be used to invoke any endpoint with the provided arguments. + * + * @param blockedMethods - The methods to block for code execution. Blocking is done by simple string + * matching, so it is not secure against obfuscation. For stronger security, block in the downstream API + * with limited API keys. + * @param codeExecutionMode - Whether to execute code in a local Deno environment or in a remote + * sandbox environment hosted by Stainless. + */ +export function codeTool({ + blockedMethods, + codeExecutionMode, +}: { + blockedMethods: SdkMethod[] | undefined; + codeExecutionMode: McpCodeExecutionMode; +}): McpTool { + const metadata: Metadata = { resource: 'all', operation: 'write', tags: [] }; + const tool: Tool = { + name: 'execute', + description: prompt, + inputSchema: { + type: 'object', + properties: { + code: { + type: 'string', + description: 'Code to execute.', + }, + intent: { + type: 'string', + description: 'Task you are trying to perform. Used for improving the service.', + }, + }, + required: ['code'], + }, + }; + + const logger = getLogger(); + + const handler = async ({ + reqContext, + args, + }: { + reqContext: McpRequestContext; + args: any; + }): Promise => { + const code = args.code as string; + // Do very basic blocking of code that includes forbidden method names. + // + // WARNING: This is not secure against obfuscation and other evasion methods. If + // stronger security blocks are required, then these should be enforced in the downstream + // API (e.g., by having users call the MCP server with API keys with limited permissions). + if (blockedMethods) { + const blockedMatches = blockedMethods.filter((method) => code.includes(method.fullyQualifiedName)); + if (blockedMatches.length > 0) { + return asErrorResult( + `The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches + .map((m) => m.fullyQualifiedName) + .join(', ')}`, + ); + } + } + + let result: ToolCallResult; + const startTime = Date.now(); + + if (codeExecutionMode === 'local') { + logger.debug('Executing code in local Deno environment'); + result = await localDenoHandler({ reqContext, args }); + } else { + logger.debug('Executing code in remote Stainless environment'); + result = await remoteStainlessHandler({ reqContext, args }); + } + + logger.info( + { + codeExecutionMode, + durationMs: Date.now() - startTime, + isError: result.isError, + contentRows: result.content?.length ?? 0, + }, + 'Got code tool execution result', + ); + return result; + }; + + return { metadata, tool, handler }; +} + +const remoteStainlessHandler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: any; +}): Promise => { + const code = args.code as string; + const intent = args.intent as string | undefined; + const client = reqContext.client; + + const codeModeEndpoint = readEnv('CODE_MODE_ENDPOINT_URL') ?? 'https://api.stainless.com/api/ai/code-tool'; + + const localClientEnvs = { HUBSPOT_BASE_URL: readEnv('HUBSPOT_BASE_URL') ?? client.baseURL ?? undefined }; + // Merge any upstream client envs from the request header, with upstream values taking precedence. + const mergedClientEnvs = { ...localClientEnvs, ...reqContext.upstreamClientEnvs }; + + // Setting a Stainless API key authenticates requests to the code tool endpoint. + const res = await fetch(codeModeEndpoint, { + method: 'POST', + headers: { + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), + 'Content-Type': 'application/json', + 'x-stainless-mcp-client-envs': JSON.stringify(mergedClientEnvs), + }, + body: JSON.stringify({ + project_name: 'hubspot-sdk', + code, + intent, + client_opts: { + accessToken: readEnv('HUBSPOT_ACCESS_TOKEN'), + developerAPIKey: readEnv('HUBSPOT_DEVELOPER_API_KEY'), + }, + } satisfies WorkerInput), + }); + + if (!res.ok) { + if (res.status === 404 && !reqContext.stainlessApiKey) { + throw new Error( + 'Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', + ); + } + throw new Error( + `${res.status}: ${ + res.statusText + } error when trying to contact Code Tool server. Details: ${await res.text()}`, + ); + } + + const { is_error, result, log_lines, err_lines } = (await res.json()) as WorkerOutput; + const hasLogs = log_lines.length > 0 || err_lines.length > 0; + const output = { + result, + ...(log_lines.length > 0 && { log_lines }), + ...(err_lines.length > 0 && { err_lines }), + }; + if (is_error) { + return asErrorResult(typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2)); + } + return asTextContentResult(output); +}; + +const localDenoHandler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: unknown; +}): Promise => { + const fs = await import('node:fs'); + const path = await import('node:path'); + const url = await import('node:url'); + const { newDenoHTTPWorker } = await import('@valtown/deno-http-worker'); + const { getWorkerPath } = await import('./code-tool-paths.cjs'); + const workerPath = getWorkerPath(); + + const client = reqContext.client; + const baseURLHostname = new URL(client.baseURL).hostname; + const { code } = args as { code: string }; + + let denoPath: string; + + const packageRoot = path.resolve(path.dirname(workerPath), '..'); + const packageNodeModulesPath = path.resolve(packageRoot, 'node_modules'); + + // Check if deno is in PATH + const { execSync } = await import('node:child_process'); + try { + execSync('command -v deno', { stdio: 'ignore' }); + denoPath = 'deno'; + } catch { + try { + // Use deno binary in node_modules if it's found + const denoNodeModulesPath = path.resolve(packageNodeModulesPath, 'deno', 'bin.cjs'); + await fs.promises.access(denoNodeModulesPath, fs.constants.X_OK); + denoPath = denoNodeModulesPath; + } catch { + return asErrorResult( + 'Deno is required for code execution but was not found. ' + + 'Install it from https://deno.land or run: npm install deno', + ); + } + } + + const allowReadPaths = [ + 'code-tool-worker.mjs', + `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, '$1')}/`, + packageRoot, + ]; + + // Follow symlinks in node_modules to allow read access to workspace-linked packages + try { + const sdkPkgName = '@hubspot/sdk'; + const sdkDir = path.resolve(packageNodeModulesPath, sdkPkgName); + const realSdkDir = fs.realpathSync(sdkDir); + if (realSdkDir !== sdkDir) { + allowReadPaths.push(realSdkDir); + } + } catch { + // Ignore if symlink resolution fails + } + + const allowRead = allowReadPaths.join(','); + + const worker = await newDenoHTTPWorker(url.pathToFileURL(workerPath), { + denoExecutable: denoPath, + runFlags: [ + `--node-modules-dir=manual`, + `--allow-read=${allowRead}`, + `--allow-net=${baseURLHostname}`, + // Allow environment variables because instantiating the client will try to read from them, + // even though they are not set. + '--allow-env', + ], + printOutput: true, + spawnOptions: { + cwd: path.dirname(workerPath), + // Merge any upstream client envs into the Deno subprocess environment, + // with the upstream env vars taking precedence. + env: { ...process.env, ...reqContext.upstreamClientEnvs }, + }, + }); + + try { + const resp = await new Promise((resolve, reject) => { + worker.addEventListener('exit', (exitCode) => { + reject(new Error(`Worker exited with code ${exitCode}`)); + }); + + // Strip null/undefined values so that the worker SDK client can fall back to + // reading from environment variables (including any upstreamClientEnvs). + const opts = { + ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), + ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), + ...(client.developerAPIKey != null ? { developerAPIKey: client.developerAPIKey } : undefined), + defaultHeaders: { + 'X-Stainless-MCP': 'true', + }, + } satisfies Partial as ClientOptions; + + const req = worker.request( + 'http://localhost', + { + headers: { + 'content-type': 'application/json', + }, + method: 'POST', + }, + (resp) => { + const body: Uint8Array[] = []; + resp.on('error', (err) => { + reject(err); + }); + resp.on('data', (chunk) => { + body.push(chunk); + }); + resp.on('end', () => { + resolve( + new Response(Buffer.concat(body).toString(), { + status: resp.statusCode ?? 200, + headers: resp.headers as any, + }), + ); + }); + }, + ); + + const body = JSON.stringify({ + opts, + code, + }); + + req.write(body, (err) => { + if (err != null) { + reject(err); + } + }); + + req.end(); + }); + + if (resp.status === 200) { + const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; + const returnOutput: ContentBlock | null = + result == null ? null : ( + { + type: 'text', + text: typeof result === 'string' ? result : JSON.stringify(result), + } + ); + const logOutput: ContentBlock | null = + log_lines.length === 0 ? + null + : { + type: 'text', + text: log_lines.join('\n'), + }; + const errOutput: ContentBlock | null = + err_lines.length === 0 ? + null + : { + type: 'text', + text: 'Error output:\n' + err_lines.join('\n'), + }; + return { + content: [returnOutput, logOutput, errOutput].filter((block) => block !== null), + }; + } else { + const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; + const messageOutput: ContentBlock | null = + result == null ? null : ( + { + type: 'text', + text: typeof result === 'string' ? result : JSON.stringify(result), + } + ); + const logOutput: ContentBlock | null = + log_lines.length === 0 ? + null + : { + type: 'text', + text: log_lines.join('\n'), + }; + const errOutput: ContentBlock | null = + err_lines.length === 0 ? + null + : { + type: 'text', + text: 'Error output:\n' + err_lines.join('\n'), + }; + return { + content: [messageOutput, logOutput, errOutput].filter((block) => block !== null), + isError: true, + }; + } + } finally { + worker.terminate(); + } +}; diff --git a/packages/mcp-server/src/docs-search-tool.ts b/packages/mcp-server/src/docs-search-tool.ts new file mode 100644 index 00000000..fbdd6332 --- /dev/null +++ b/packages/mcp-server/src/docs-search-tool.ts @@ -0,0 +1,138 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { Tool } from '@modelcontextprotocol/sdk/types.js'; +import { Metadata, McpRequestContext, asTextContentResult } from './types'; +import { getLogger } from './logger'; +import type { LocalDocsSearch } from './local-docs-search'; + +export const metadata: Metadata = { + resource: 'all', + operation: 'read', + tags: [], + httpMethod: 'get', +}; + +export const tool: Tool = { + name: 'search_docs', + description: + 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', + inputSchema: { + type: 'object', + properties: { + query: { + type: 'string', + description: 'The query to search for.', + }, + language: { + type: 'string', + description: 'The language for the SDK to search for.', + enum: ['http', 'python', 'go', 'typescript', 'javascript', 'terraform', 'ruby', 'java', 'kotlin'], + }, + detail: { + type: 'string', + description: 'The amount of detail to return.', + enum: ['default', 'verbose'], + }, + }, + required: ['query', 'language'], + }, + annotations: { + readOnlyHint: true, + }, +}; + +const docsSearchURL = + process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/hubspot-sdk/docs/search'; + +let _localSearch: LocalDocsSearch | undefined; + +export function setLocalSearch(search: LocalDocsSearch): void { + _localSearch = search; +} + +async function searchLocal(args: Record): Promise { + if (!_localSearch) { + throw new Error('Local search not initialized'); + } + + const query = (args['query'] as string) ?? ''; + const language = (args['language'] as string) ?? 'typescript'; + const detail = (args['detail'] as string) ?? 'default'; + + return _localSearch.search({ + query, + language, + detail, + maxResults: 10, + }).results; +} + +async function searchRemote(args: Record, reqContext: McpRequestContext): Promise { + const body = args as any; + const query = new URLSearchParams(body).toString(); + + const startTime = Date.now(); + const result = await fetch(`${docsSearchURL}?${query}`, { + headers: { + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), + ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), + ...(reqContext.mcpClientInfo && { + 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo), + }), + }, + }); + + const logger = getLogger(); + + if (!result.ok) { + const errorText = await result.text(); + logger.warn( + { + durationMs: Date.now() - startTime, + query: body.query, + status: result.status, + statusText: result.statusText, + errorText, + }, + 'Got error response from docs search tool', + ); + + if (result.status === 404 && !reqContext.stainlessApiKey) { + throw new Error( + 'Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', + ); + } + + throw new Error( + `${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`, + ); + } + + const resultBody = await result.json(); + logger.info( + { + durationMs: Date.now() - startTime, + query: body.query, + }, + 'Got docs search result', + ); + return resultBody; +} + +export const handler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: Record | undefined; +}) => { + const body = args ?? {}; + + if (_localSearch) { + return asTextContentResult(await searchLocal(body)); + } + + return asTextContentResult(await searchRemote(body, reqContext)); +}; + +export default { metadata, tool, handler }; diff --git a/packages/mcp-server/src/http.ts b/packages/mcp-server/src/http.ts new file mode 100644 index 00000000..524a4800 --- /dev/null +++ b/packages/mcp-server/src/http.ts @@ -0,0 +1,227 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { McpServer } from '@modelcontextprotocol/sdk/server/mcp'; +import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'; +import { ClientOptions } from '@hubspot/sdk'; +import express from 'express'; +import pino from 'pino'; +import pinoHttp from 'pino-http'; +import { getStainlessApiKey, parseClientAuthHeaders } from './auth'; +import { getLogger } from './logger'; +import { McpOptions } from './options'; +import { initMcpServer, newMcpServer } from './server'; + +const newServer = async ({ + clientOptions, + mcpOptions, + req, + res, +}: { + clientOptions: ClientOptions; + mcpOptions: McpOptions; + req: express.Request; + res: express.Response; +}): Promise => { + const stainlessApiKey = getStainlessApiKey(req, mcpOptions); + const customInstructionsPath = mcpOptions.customInstructionsPath; + const server = await newMcpServer({ stainlessApiKey, customInstructionsPath }); + + const authOptions = parseClientAuthHeaders(req, false); + + let upstreamClientEnvs: Record | undefined; + const clientEnvsHeader = req.headers['x-stainless-mcp-client-envs']; + if (typeof clientEnvsHeader === 'string') { + try { + const parsed = JSON.parse(clientEnvsHeader); + if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) { + upstreamClientEnvs = parsed; + } + } catch { + // Ignore malformed header + } + } + + // Parse x-stainless-mcp-client-permissions header to override permission options + // + // Note: Permissions are best-effort and intended to prevent clients from doing unexpected things; + // they're not a hard security boundary, so we allow arbitrary, client-driven overrides. + // + // See the Stainless MCP documentation for more details. + let effectiveMcpOptions = mcpOptions; + const clientPermissionsHeader = req.headers['x-stainless-mcp-client-permissions']; + if (typeof clientPermissionsHeader === 'string') { + try { + const parsed = JSON.parse(clientPermissionsHeader); + if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) { + effectiveMcpOptions = { + ...mcpOptions, + ...(typeof parsed.allow_http_gets === 'boolean' && { codeAllowHttpGets: parsed.allow_http_gets }), + ...(Array.isArray(parsed.allowed_methods) && { codeAllowedMethods: parsed.allowed_methods }), + ...(Array.isArray(parsed.blocked_methods) && { codeBlockedMethods: parsed.blocked_methods }), + }; + getLogger().info( + { clientPermissions: parsed }, + 'Overriding code execution permissions from x-stainless-mcp-client-permissions header', + ); + } + } catch (error) { + getLogger().warn({ error }, 'Failed to parse x-stainless-mcp-client-permissions header'); + } + } + + const mcpClientInfo = + typeof req.body?.params?.clientInfo?.name === 'string' ? + { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } + : undefined; + + await initMcpServer({ + server: server, + mcpOptions: effectiveMcpOptions, + clientOptions: { + ...clientOptions, + ...authOptions, + }, + stainlessApiKey: stainlessApiKey, + upstreamClientEnvs, + mcpSessionId: (req as any).mcpSessionId, + mcpClientInfo, + }); + + if (mcpClientInfo) { + getLogger().info({ mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, 'MCP client connected'); + } + + return server; +}; + +const post = + (options: { clientOptions: ClientOptions; mcpOptions: McpOptions }) => + async (req: express.Request, res: express.Response) => { + const server = await newServer({ ...options, req, res }); + // If we return null, we already set the authorization error. + if (server === null) return; + const transport = new StreamableHTTPServerTransport(); + await server.connect(transport as any); + await transport.handleRequest(req, res, req.body); + }; + +const get = async (req: express.Request, res: express.Response) => { + res.status(405).json({ + jsonrpc: '2.0', + error: { + code: -32000, + message: 'Method not supported', + }, + }); +}; + +const del = async (req: express.Request, res: express.Response) => { + res.status(405).json({ + jsonrpc: '2.0', + error: { + code: -32000, + message: 'Method not supported', + }, + }); +}; + +const redactHeaders = (headers: Record) => { + const hiddenHeaders = /auth|cookie|key|token|x-stainless-mcp-client-envs/i; + const filtered = { ...headers }; + Object.keys(filtered).forEach((key) => { + if (hiddenHeaders.test(key)) { + filtered[key] = '[REDACTED]'; + } + }); + return filtered; +}; + +export const streamableHTTPApp = ({ + clientOptions = {}, + mcpOptions, +}: { + clientOptions?: ClientOptions; + mcpOptions: McpOptions; +}): express.Express => { + const app = express(); + app.set('query parser', 'extended'); + app.use(express.json()); + app.use((req: express.Request, res: express.Response, next: express.NextFunction) => { + const existing = req.headers['mcp-session-id']; + const sessionId = (Array.isArray(existing) ? existing[0] : existing) || crypto.randomUUID(); + (req as any).mcpSessionId = sessionId; + const origWriteHead = res.writeHead.bind(res); + res.writeHead = function (statusCode: number, ...rest: any[]) { + res.setHeader('mcp-session-id', sessionId); + return origWriteHead(statusCode, ...rest); + } as typeof res.writeHead; + next(); + }); + app.use( + pinoHttp({ + logger: getLogger(), + customProps: (req) => ({ + mcpSessionId: (req as any).mcpSessionId, + }), + customLogLevel: (req, res) => { + if (res.statusCode >= 500) { + return 'error'; + } else if (res.statusCode >= 400) { + return 'warn'; + } + return 'info'; + }, + customSuccessMessage: function (req, res) { + return `Request ${req.method} to ${req.url} completed with status ${res.statusCode}`; + }, + customErrorMessage: function (req, res, err) { + return `Request ${req.method} to ${req.url} errored with status ${res.statusCode}`; + }, + serializers: { + req: pino.stdSerializers.wrapRequestSerializer((req) => { + return { + ...req, + headers: redactHeaders(req.raw.headers), + }; + }), + res: pino.stdSerializers.wrapResponseSerializer((res) => { + return { + ...res, + headers: redactHeaders(res.headers), + }; + }), + }, + }), + ); + + app.get('/health', async (req: express.Request, res: express.Response) => { + res.status(200).send('OK'); + }); + app.get('/', get); + app.post('/', post({ clientOptions, mcpOptions })); + app.delete('/', del); + + return app; +}; + +export const launchStreamableHTTPServer = async ({ + mcpOptions, + port, +}: { + mcpOptions: McpOptions; + port: number | string | undefined; +}) => { + const app = streamableHTTPApp({ mcpOptions }); + const server = app.listen(port); + const address = server.address(); + + const logger = getLogger(); + + if (typeof address === 'string') { + logger.info(`MCP Server running on streamable HTTP at ${address}`); + } else if (address !== null) { + logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); + } else { + logger.info(`MCP Server running on streamable HTTP on port ${port}`); + } +}; diff --git a/packages/mcp-server/src/index.ts b/packages/mcp-server/src/index.ts new file mode 100644 index 00000000..5bca4a60 --- /dev/null +++ b/packages/mcp-server/src/index.ts @@ -0,0 +1,67 @@ +#!/usr/bin/env node + +import { selectTools } from './server'; +import { McpOptions, parseCLIOptions } from './options'; +import { launchStdioServer } from './stdio'; +import { launchStreamableHTTPServer } from './http'; +import type { McpTool } from './types'; +import { configureLogger, getLogger } from './logger'; + +async function main() { + const options = parseOptionsOrError(); + configureLogger({ + level: options.debug ? 'debug' : 'info', + pretty: options.logFormat === 'pretty', + }); + + const selectedTools = await selectToolsOrError(options); + + getLogger().info( + { tools: selectedTools.map((e) => e.tool.name) }, + `MCP Server starting with ${selectedTools.length} tools`, + ); + + switch (options.transport) { + case 'stdio': + await launchStdioServer(options); + break; + case 'http': + await launchStreamableHTTPServer({ + mcpOptions: options, + port: options.socket ?? options.port, + }); + break; + } +} + +if (require.main === module) { + main().catch((error) => { + // Logger might not be initialized yet + console.error('Fatal error in main()', error); + process.exit(1); + }); +} + +function parseOptionsOrError() { + try { + return parseCLIOptions(); + } catch (error) { + // Logger is initialized after options, so use console.error here + console.error('Error parsing options', error); + process.exit(1); + } +} + +async function selectToolsOrError(options: McpOptions): Promise { + try { + const includedTools = selectTools(options); + if (includedTools.length === 0) { + getLogger().error('No tools match the provided filters'); + process.exit(1); + } + return includedTools; + } catch (error) { + getLogger().error({ error }, 'Error filtering tools'); + process.exit(1); + } +} diff --git a/packages/mcp-server/src/instructions.ts b/packages/mcp-server/src/instructions.ts new file mode 100644 index 00000000..d9b5c0f7 --- /dev/null +++ b/packages/mcp-server/src/instructions.ts @@ -0,0 +1,83 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import fs from 'fs/promises'; +import { getLogger } from './logger'; +import { readEnv } from './util'; + +const INSTRUCTIONS_CACHE_TTL_MS = 15 * 60 * 1000; // 15 minutes + +interface InstructionsCacheEntry { + fetchedInstructions: string; + fetchedAt: number; +} + +const instructionsCache = new Map(); + +export async function getInstructions({ + stainlessApiKey, + customInstructionsPath, +}: { + stainlessApiKey?: string | undefined; + customInstructionsPath?: string | undefined; +}): Promise { + const now = Date.now(); + const cacheKey = customInstructionsPath ?? stainlessApiKey ?? ''; + const cached = instructionsCache.get(cacheKey); + + if (cached && now - cached.fetchedAt <= INSTRUCTIONS_CACHE_TTL_MS) { + return cached.fetchedInstructions; + } + + // Evict stale entries so the cache doesn't grow unboundedly. + for (const [key, entry] of instructionsCache) { + if (now - entry.fetchedAt > INSTRUCTIONS_CACHE_TTL_MS) { + instructionsCache.delete(key); + } + } + + let fetchedInstructions: string; + + if (customInstructionsPath) { + fetchedInstructions = await fetchLatestInstructionsFromFile(customInstructionsPath); + } else { + fetchedInstructions = await fetchLatestInstructionsFromApi(stainlessApiKey); + } + + instructionsCache.set(cacheKey, { fetchedInstructions, fetchedAt: now }); + return fetchedInstructions; +} + +async function fetchLatestInstructionsFromFile(path: string): Promise { + try { + return await fs.readFile(path, 'utf-8'); + } catch (error) { + getLogger().error({ error, path }, 'Error fetching instructions from file'); + throw error; + } +} + +async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefined): Promise { + // Setting the stainless API key is optional, but may be required + // to authenticate requests to the Stainless API. + const response = await fetch( + readEnv('CODE_MODE_INSTRUCTIONS_URL') ?? 'https://api.stainless.com/api/ai/instructions/hubspot-sdk', + { + method: 'GET', + headers: { ...(stainlessApiKey && { Authorization: stainlessApiKey }) }, + }, + ); + + let instructions: string | undefined; + if (!response.ok) { + getLogger().warn( + 'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...', + ); + + instructions = + '\n This is the hubspot-sdk MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n '; + } + + instructions ??= ((await response.json()) as { instructions: string }).instructions; + + return instructions; +} diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts new file mode 100644 index 00000000..be9fa23e --- /dev/null +++ b/packages/mcp-server/src/local-docs-search.ts @@ -0,0 +1,52869 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import MiniSearch from 'minisearch'; +import * as fs from 'node:fs/promises'; +import * as path from 'node:path'; +import { getLogger } from './logger'; + +type PerLanguageData = { + method?: string; + example?: string; +}; + +type MethodEntry = { + name: string; + endpoint: string; + httpMethod: string; + summary: string; + description: string; + stainlessPath: string; + qualified: string; + params?: string[]; + response?: string; + markdown?: string; + perLanguage?: Record; +}; + +type ProseChunk = { + content: string; + tag: string; + sectionContext?: string; + source?: string; +}; + +type MiniSearchDocument = { + id: string; + kind: 'http_method' | 'prose'; + name?: string; + endpoint?: string; + summary?: string; + description?: string; + qualified?: string; + stainlessPath?: string; + content?: string; + sectionContext?: string; + _original: Record; +}; + +type SearchResult = { + results: (string | Record)[]; +}; + +const EMBEDDED_METHODS: MethodEntry[] = [ + { + name: 'get', + endpoint: '/account-info/2026-03/details', + httpMethod: 'get', + summary: 'Retrieve account details', + description: + 'Retrieve account details such as the account type, time zone, currencies, and data hosting location. ', + stainlessPath: '(resource) account > (method) get', + qualified: 'client.account.get', + response: + "{ accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }", + markdown: + "## get\n\n`client.account.get(): { accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }`\n\n**get** `/account-info/2026-03/details`\n\nRetrieve account details such as the account type, time zone, currencies, and data hosting location. \n\n### Returns\n\n- `{ accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }`\n\n - `accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'`\n - `additionalCurrencies: string[]`\n - `companyCurrency: string`\n - `dataHostingLocation: string`\n - `portalId: number`\n - `timeZone: string`\n - `uiDomain: string`\n - `utcOffset: string`\n - `utcOffsetMilliseconds: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalInformationResponse = await client.account.get();\n\nconsole.log(portalInformationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.account.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalInformationResponse = await client.account.get();\n\nconsole.log(portalInformationResponse.accountType);", + }, + python: { + method: 'account.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_information_response = client.account.get()\nprint(portal_information_response.account_type)', + }, + java: { + method: 'account().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.AccountGetParams;\nimport com.hubspot.sdk.models.account.PortalInformationResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PortalInformationResponse portalInformationResponse = client.account().get();\n }\n}', + }, + go: { + method: 'client.Account.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalInformationResponse, err := client.Account.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalInformationResponse.AccountType)\n}\n', + }, + ruby: { + method: 'account.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_information_response = hubspot.account.get\n\nputs(portal_information_response)', + }, + php: { + method: 'account->get', + example: + "account->get();\n\nvar_dump($portalInformationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/account-info/2026-03/details \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_daily_private_apps_usage', + endpoint: '/account-info/2026-03/api-usage/daily/private-apps', + httpMethod: 'get', + summary: 'Retrieve private app daily API usage', + description: + 'Retrieve the daily API usage for private apps in the account, along with information about usage limits.', + stainlessPath: '(resource) account > (method) get_daily_private_apps_usage', + qualified: 'client.account.getDailyPrivateAppsUsage', + response: + "{ results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]; }", + markdown: + "## get_daily_private_apps_usage\n\n`client.account.getDailyPrivateAppsUsage(): { results: api_usage[]; }`\n\n**get** `/account-info/2026-03/api-usage/daily/private-apps`\n\nRetrieve the daily API usage for private apps in the account, along with information about usage limits.\n\n### Returns\n\n- `{ results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]; }`\n\n - `results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAPIUsageNoPaging = await client.account.getDailyPrivateAppsUsage();\n\nconsole.log(collectionResponseAPIUsageNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.account.getDailyPrivateAppsUsage', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAPIUsageNoPaging = await client.account.getDailyPrivateAppsUsage();\n\nconsole.log(collectionResponseAPIUsageNoPaging.results);", + }, + python: { + method: 'account.get_daily_private_apps_usage', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_api_usage_no_paging = client.account.get_daily_private_apps_usage()\nprint(collection_response_api_usage_no_paging.results)', + }, + java: { + method: 'account().getDailyPrivateAppsUsage', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.AccountGetDailyPrivateAppsUsageParams;\nimport com.hubspot.sdk.models.account.CollectionResponseApiUsageNoPaging;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseApiUsageNoPaging collectionResponseApiUsageNoPaging = client.account().getDailyPrivateAppsUsage();\n }\n}', + }, + go: { + method: 'client.Account.GetDailyPrivateAppsUsage', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAPIUsageNoPaging, err := client.Account.GetDailyPrivateAppsUsage(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAPIUsageNoPaging.Results)\n}\n', + }, + ruby: { + method: 'account.get_daily_private_apps_usage', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_api_usage_no_paging = hubspot.account.get_daily_private_apps_usage\n\nputs(collection_response_api_usage_no_paging)', + }, + php: { + method: 'account->getDailyPrivateAppsUsage', + example: + "account\n ->getDailyPrivateAppsUsage();\n\nvar_dump($collectionResponseAPIUsageNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/account-info/2026-03/api-usage/daily/private-apps \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_audit_logs', + endpoint: '/account-info/2026-03/activity/audit-logs', + httpMethod: 'get', + summary: 'Retrieve audit logs', + description: + 'Retrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log).', + stainlessPath: '(resource) account.activity > (method) list_audit_logs', + qualified: 'client.account.activity.listAuditLogs', + params: [ + 'actingUserId?: number[];', + 'after?: string;', + 'fillFinalTimestamp?: boolean;', + 'limit?: number;', + 'occurredAfter?: string;', + 'occurredBefore?: string;', + 'sort?: string[];', + ], + response: + '{ id: string; actingUser: { userId: number; userEmail?: string; }; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }', + markdown: + "## list_audit_logs\n\n`client.account.activity.listAuditLogs(actingUserId?: number[], after?: string, fillFinalTimestamp?: boolean, limit?: number, occurredAfter?: string, occurredBefore?: string, sort?: string[]): { id: string; actingUser: acting_user; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }`\n\n**get** `/account-info/2026-03/activity/audit-logs`\n\nRetrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log).\n\n### Parameters\n\n- `actingUserId?: number[]`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fillFinalTimestamp?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `occurredAfter?: string`\n\n- `occurredBefore?: string`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; actingUser: { userId: number; userEmail?: string; }; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }`\n\n - `id: string`\n - `actingUser: { userId: number; userEmail?: string; }`\n - `action: string`\n - `category: string`\n - `occurredAt: string`\n - `subCategory?: string`\n - `targetObjectId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicAPIUserActionEvent of client.account.activity.listAuditLogs()) {\n console.log(publicAPIUserActionEvent);\n}\n```", + perLanguage: { + typescript: { + method: 'client.account.activity.listAuditLogs', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicAPIUserActionEvent of client.account.activity.listAuditLogs()) {\n console.log(publicAPIUserActionEvent.id);\n}", + }, + python: { + method: 'account.activity.list_audit_logs', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_audit_logs()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'account().activity().listAuditLogs', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListAuditLogsPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListAuditLogsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListAuditLogsPage page = client.account().activity().listAuditLogs();\n }\n}', + }, + go: { + method: 'client.Account.Activity.ListAuditLogs', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListAuditLogs(context.TODO(), account.ActivityListAuditLogsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'account.activity.list_audit_logs', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_audit_logs\n\nputs(page)', + }, + php: { + method: 'account->activity->listAuditLogs', + example: + "account->activity->listAuditLogs(\n actingUserID: [0],\n after: 'after',\n fillFinalTimestamp: true,\n limit: 0,\n occurredAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n occurredBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n sort: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/account-info/2026-03/activity/audit-logs \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_login_activities', + endpoint: '/account-info/2026-03/activity/login', + httpMethod: 'get', + summary: 'Retrieve login activity', + description: + 'Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).', + stainlessPath: '(resource) account.activity > (method) list_login_activities', + qualified: 'client.account.activity.listLoginActivities', + params: ['after?: string;', 'limit?: number;', 'userId?: number;'], + response: + '{ id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }', + markdown: + "## list_login_activities\n\n`client.account.activity.listLoginActivities(after?: string, limit?: number, userId?: number): { id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }`\n\n**get** `/account-info/2026-03/activity/login`\n\nRetrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `userId?: number`\n\n### Returns\n\n- `{ id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }`\n\n - `id: string`\n - `loginAt: string`\n - `loginSucceeded: boolean`\n - `countryCode?: string`\n - `email?: string`\n - `ipAddress?: string`\n - `location?: string`\n - `regionCode?: string`\n - `userAgent?: string`\n - `userId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicLoginAudit of client.account.activity.listLoginActivities()) {\n console.log(publicLoginAudit);\n}\n```", + perLanguage: { + typescript: { + method: 'client.account.activity.listLoginActivities', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicLoginAudit of client.account.activity.listLoginActivities()) {\n console.log(publicLoginAudit.id);\n}", + }, + python: { + method: 'account.activity.list_login_activities', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_login_activities()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'account().activity().listLoginActivities', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListLoginActivitiesPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListLoginActivitiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListLoginActivitiesPage page = client.account().activity().listLoginActivities();\n }\n}', + }, + go: { + method: 'client.Account.Activity.ListLoginActivities', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListLoginActivities(context.TODO(), account.ActivityListLoginActivitiesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'account.activity.list_login_activities', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_login_activities\n\nputs(page)', + }, + php: { + method: 'account->activity->listLoginActivities', + example: + "account->activity->listLoginActivities(\n after: 'after', limit: 0, userID: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/account-info/2026-03/activity/login \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_security_activities', + endpoint: '/account-info/2026-03/activity/security', + httpMethod: 'get', + summary: 'Retrieve security history', + description: + 'Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).', + stainlessPath: '(resource) account.activity > (method) list_security_activities', + qualified: 'client.account.activity.listSecurityActivities', + params: [ + 'after?: string;', + 'fromTimestamp?: number;', + 'limit?: number;', + 'toTimestamp?: number;', + 'userId?: number;', + ], + response: + '{ id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }', + markdown: + "## list_security_activities\n\n`client.account.activity.listSecurityActivities(after?: string, fromTimestamp?: number, limit?: number, toTimestamp?: number, userId?: number): { id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }`\n\n**get** `/account-info/2026-03/activity/security`\n\nRetrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fromTimestamp?: number`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `toTimestamp?: number`\n\n- `userId?: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `type: string`\n - `userId: number`\n - `actingUser?: string`\n - `countryCode?: string`\n - `infoUrl?: string`\n - `ipAddress?: string`\n - `location?: string`\n - `objectId?: string`\n - `regionCode?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hydratedCriticalAction of client.account.activity.listSecurityActivities()) {\n console.log(hydratedCriticalAction);\n}\n```", + perLanguage: { + typescript: { + method: 'client.account.activity.listSecurityActivities', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hydratedCriticalAction of client.account.activity.listSecurityActivities()) {\n console.log(hydratedCriticalAction.id);\n}", + }, + python: { + method: 'account.activity.list_security_activities', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_security_activities()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'account().activity().listSecurityActivities', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListSecurityActivitiesPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListSecurityActivitiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListSecurityActivitiesPage page = client.account().activity().listSecurityActivities();\n }\n}', + }, + go: { + method: 'client.Account.Activity.ListSecurityActivities', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListSecurityActivities(context.TODO(), account.ActivityListSecurityActivitiesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'account.activity.list_security_activities', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_security_activities\n\nputs(page)', + }, + php: { + method: 'account->activity->listSecurityActivities', + example: + "account->activity->listSecurityActivities(\n after: 'after', fromTimestamp: 0, limit: 0, toTimestamp: 0, userID: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/account-info/2026-03/activity/security \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create_token', + endpoint: '/oauth/2026-03/token', + httpMethod: 'post', + summary: 'OAuth token endpoint', + description: 'Authenticates a client and returns access and refresh tokens.', + stainlessPath: '(resource) auth.oauth > (method) create_token', + qualified: 'client.auth.oauth.createToken', + params: [ + 'client_id?: string;', + 'client_secret?: string;', + 'code?: string;', + 'code_verifier?: string;', + "grant_type?: 'authorization_code' | 'refresh_token';", + 'redirect_uri?: string;', + 'refresh_token?: string;', + 'scope?: string;', + ], + response: 'string', + markdown: + "## create_token\n\n`client.auth.oauth.createToken(client_id?: string, client_secret?: string, code?: string, code_verifier?: string, grant_type?: 'authorization_code' | 'refresh_token', redirect_uri?: string, refresh_token?: string, scope?: string): string`\n\n**post** `/oauth/2026-03/token`\n\nAuthenticates a client and returns access and refresh tokens.\n\n### Parameters\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `code?: string`\n\n- `code_verifier?: string`\n\n- `grant_type?: 'authorization_code' | 'refresh_token'`\n\n- `redirect_uri?: string`\n\n- `refresh_token?: string`\n\n- `scope?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.auth.oauth.createToken();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.auth.oauth.createToken', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.auth.oauth.createToken();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'auth.oauth.create_token', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.auth.oauth.create_token()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'auth().oauth().createToken', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthCreateTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.auth().oauth().createToken();\n }\n}', + }, + go: { + method: 'client.Auth.OAuth.NewToken', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Auth.OAuth.NewToken(context.TODO(), auth.OAuthNewTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'auth.oauth.create_token', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.auth.oauth.create_token\n\nputs(response)', + }, + php: { + method: 'auth->oauth->createToken', + example: + "auth->oauth->createToken(\n clientID: 'client_id',\n clientSecret: 'client_secret',\n code: 'code',\n codeVerifier: 'code_verifier',\n grantType: 'authorization_code',\n redirectUri: 'redirect_uri',\n refreshToken: 'refresh_token',\n scope: 'scope',\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/oauth/2026-03/token \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'introspect_token', + endpoint: '/oauth/2026-03/token/introspect', + httpMethod: 'post', + summary: 'Token introspection endpoint', + description: 'Returns validity and metadata for access and refresh tokens.', + stainlessPath: '(resource) auth.oauth > (method) introspect_token', + qualified: 'client.auth.oauth.introspectToken', + params: [ + 'token?: string;', + 'client_id?: string;', + 'client_secret?: string;', + 'token_type_hint?: string;', + ], + response: + "{ token: string; active: boolean; app_id: number; client_id: string; expires_in: number; hub_id: number; is_private_distribution: boolean; scopes: string[]; signed_access_token: object; token_type: string; token_use: 'access_token'; user_id: number; hub_domain?: string; user?: string; } | { token: string; active: boolean; app_id: number; client_id: string; hub_id: number; scopes: string[]; token_type: string; token_use: 'refresh_token'; user_id: number; hub_domain?: string; user?: string; }", + markdown: + "## introspect_token\n\n`client.auth.oauth.introspectToken(token?: string, client_id?: string, client_secret?: string, token_type_hint?: string): object | object`\n\n**post** `/oauth/2026-03/token/introspect`\n\nReturns validity and metadata for access and refresh tokens.\n\n### Parameters\n\n- `token?: string`\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `token_type_hint?: string`\n\n### Returns\n\n- `{ token: string; active: boolean; app_id: number; client_id: string; expires_in: number; hub_id: number; is_private_distribution: boolean; scopes: string[]; signed_access_token: object; token_type: string; token_use: 'access_token'; user_id: number; hub_domain?: string; user?: string; } | { token: string; active: boolean; app_id: number; client_id: string; hub_id: number; scopes: string[]; token_type: string; token_use: 'refresh_token'; user_id: number; hub_domain?: string; user?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tokenInfoResponseBaseIf = await client.auth.oauth.introspectToken();\n\nconsole.log(tokenInfoResponseBaseIf);\n```", + perLanguage: { + typescript: { + method: 'client.auth.oauth.introspectToken', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tokenInfoResponseBaseIf = await client.auth.oauth.introspectToken();\n\nconsole.log(tokenInfoResponseBaseIf);", + }, + python: { + method: 'auth.oauth.introspect_token', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntoken_info_response_base_if = client.auth.oauth.introspect_token()\nprint(token_info_response_base_if)', + }, + java: { + method: 'auth().oauth().introspectToken', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.auth.oauth.OAuthIntrospectTokenParams;\nimport com.hubspot.sdk.models.auth.oauth.TokenInfoResponseBaseIf;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TokenInfoResponseBaseIf tokenInfoResponseBaseIf = client.auth().oauth().introspectToken();\n }\n}', + }, + go: { + method: 'client.Auth.OAuth.IntrospectToken', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttokenInfoResponseBaseIf, err := client.Auth.OAuth.IntrospectToken(context.TODO(), auth.OAuthIntrospectTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tokenInfoResponseBaseIf)\n}\n', + }, + ruby: { + method: 'auth.oauth.introspect_token', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntoken_info_response_base_if = hubspot.auth.oauth.introspect_token\n\nputs(token_info_response_base_if)', + }, + php: { + method: 'auth->oauth->introspectToken', + example: + "auth->oauth->introspectToken(\n token: 'token',\n clientID: 'client_id',\n clientSecret: 'client_secret',\n tokenTypeHint: 'token_type_hint',\n);\n\nvar_dump($tokenInfoResponseBaseIf);", + }, + http: { + example: + 'curl https://api.hubapi.com/oauth/2026-03/token/introspect \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'revoke_token', + endpoint: '/oauth/2026-03/token/revoke', + httpMethod: 'post', + summary: 'Token Revocation endpoint', + description: 'Deletes/Revokes provided Refresh Token', + stainlessPath: '(resource) auth.oauth > (method) revoke_token', + qualified: 'client.auth.oauth.revokeToken', + params: [ + 'token?: string;', + 'client_id?: string;', + 'client_secret?: string;', + 'token_type_hint?: string;', + ], + response: 'string', + markdown: + "## revoke_token\n\n`client.auth.oauth.revokeToken(token?: string, client_id?: string, client_secret?: string, token_type_hint?: string): string`\n\n**post** `/oauth/2026-03/token/revoke`\n\nDeletes/Revokes provided Refresh Token\n\n### Parameters\n\n- `token?: string`\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `token_type_hint?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.auth.oauth.revokeToken();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.auth.oauth.revokeToken', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.auth.oauth.revokeToken();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'auth.oauth.revoke_token', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.auth.oauth.revoke_token()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'auth().oauth().revokeToken', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthRevokeTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.auth().oauth().revokeToken();\n }\n}', + }, + go: { + method: 'client.Auth.OAuth.RevokeToken', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Auth.OAuth.RevokeToken(context.TODO(), auth.OAuthRevokeTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'auth.oauth.revoke_token', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.auth.oauth.revoke_token\n\nputs(response)', + }, + php: { + method: 'auth->oauth->revokeToken', + example: + "auth->oauth->revokeToken(\n token: 'token',\n clientID: 'client_id',\n clientSecret: 'client_secret',\n tokenTypeHint: 'token_type_hint',\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/oauth/2026-03/token/revoke \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'complete', + endpoint: '/automation/actions/callbacks/2026-03/{callbackId}/complete', + httpMethod: 'post', + summary: 'Completes a callback', + description: 'Complete a specific blocked action execution by ID.', + stainlessPath: '(resource) automation.actions.callbacks > (method) complete', + qualified: 'client.automation.actions.callbacks.complete', + params: [ + 'callbackId: string;', + 'outputFields: object;', + 'typedOutputs: object;', + 'failureReasonType?: string;', + "requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: { actionExecutionIndex: number; enrollmentId: number; }; actionId?: number; } | { agentId: number; chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; };", + ], + markdown: + "## complete\n\n`client.automation.actions.callbacks.complete(callbackId: string, outputFields: object, typedOutputs: object, failureReasonType?: string, requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }): void`\n\n**post** `/automation/actions/callbacks/2026-03/{callbackId}/complete`\n\nComplete a specific blocked action execution by ID.\n\n### Parameters\n\n- `callbackId: string`\n\n- `outputFields: object`\n Contains the output fields associated with the callback, with each field represented as a key-value pair.\n\n- `typedOutputs: object`\n Holds the typed outputs related to the callback, structured as an object.\n\n- `failureReasonType?: string`\n Indicates the reason for the failure of a callback completion.\n\n- `requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: { actionExecutionIndex: number; enrollmentId: number; }; actionId?: number; } | { agentId: number; chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }`\n Specifies the context in which the request is made, which can be one of several predefined contexts.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.callbacks.complete('callbackId', {\n outputFields: { foo: 'string' },\n typedOutputs: {},\n})\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.callbacks.complete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.callbacks.complete('callbackId', {\n outputFields: { foo: 'string' },\n typedOutputs: {},\n});", + }, + python: { + method: 'automation.actions.callbacks.complete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.callbacks.complete(\n callback_id="callbackId",\n output_fields={\n "foo": "string"\n },\n typed_outputs={},\n)', + }, + java: { + method: 'automation().actions().callbacks().complete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.CallbackCompletionRequest;\nimport com.hubspot.sdk.models.automation.actions.callbacks.CallbackCompleteParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallbackCompleteParams params = CallbackCompleteParams.builder()\n .callbackId("callbackId")\n .callbackCompletionRequest(CallbackCompletionRequest.builder()\n .outputFields(CallbackCompletionRequest.OutputFields.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .typedOutputs(JsonValue.from(Map.of()))\n .build())\n .build();\n client.automation().actions().callbacks().complete(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Callbacks.Complete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Callbacks.Complete(\n\t\tcontext.TODO(),\n\t\t"callbackId",\n\t\tautomation.ActionCallbackCompleteParams{\n\t\t\tCallbackCompletionRequest: automation.CallbackCompletionRequestParam{\n\t\t\t\tOutputFields: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t\tTypedOutputs: map[string]any{},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.callbacks.complete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.callbacks.complete(\n "callbackId",\n output_fields: {foo: "string"},\n typed_outputs: {}\n)\n\nputs(result)', + }, + php: { + method: 'automation->actions->callbacks->complete', + example: + "automation->actions->callbacks->complete(\n 'callbackId',\n outputFields: ['foo' => 'string'],\n typedOutputs: (object) [],\n failureReasonType: 'failureReasonType',\n requestContext: [\n 'source' => 'WORKFLOWS',\n 'workflowID' => 0,\n 'actionExecutionIndexIdentifier' => [\n 'actionExecutionIndex' => 0, 'enrollmentID' => 0\n ],\n 'actionID' => 0,\n ],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/callbacks/2026-03/$CALLBACK_ID/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "outputFields": {\n "foo": "string"\n },\n "typedOutputs": {}\n }\'', + }, + }, + }, + { + name: 'complete_batch', + endpoint: '/automation/actions/callbacks/2026-03/complete', + httpMethod: 'post', + summary: 'Complete a batch of callbacks', + description: 'Complete a batch of blocked action executions.', + stainlessPath: '(resource) automation.actions.callbacks > (method) complete_batch', + qualified: 'client.automation.actions.callbacks.completeBatch', + params: [ + "inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }; }[];", + ], + markdown: + "## complete_batch\n\n`client.automation.actions.callbacks.completeBatch(inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: workflows_request_context | agent_request_context | copilot_request_context | standalone_request_context | test_request_context; }[]): void`\n\n**post** `/automation/actions/callbacks/2026-03/complete`\n\nComplete a batch of blocked action executions.\n\n### Parameters\n\n- `inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.callbacks.completeBatch({ inputs: [{\n callbackId: 'callbackId',\n outputFields: { foo: 'string' },\n typedOutputs: {},\n}] })\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.callbacks.completeBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.callbacks.completeBatch({\n inputs: [\n {\n callbackId: 'callbackId',\n outputFields: { foo: 'string' },\n typedOutputs: {},\n },\n ],\n});", + }, + python: { + method: 'automation.actions.callbacks.complete_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.callbacks.complete_batch(\n inputs=[{\n "callback_id": "callbackId",\n "output_fields": {\n "foo": "string"\n },\n "typed_outputs": {},\n }],\n)', + }, + java: { + method: 'automation().actions().callbacks().completeBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.BatchInputCallbackCompletionBatchRequest;\nimport com.hubspot.sdk.models.automation.actions.CallbackCompletionBatchRequest;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputCallbackCompletionBatchRequest params = BatchInputCallbackCompletionBatchRequest.builder()\n .addInput(CallbackCompletionBatchRequest.builder()\n .callbackId("callbackId")\n .outputFields(CallbackCompletionBatchRequest.OutputFields.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .typedOutputs(JsonValue.from(Map.of()))\n .build())\n .build();\n client.automation().actions().callbacks().completeBatch(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Callbacks.CompleteBatch', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Callbacks.CompleteBatch(context.TODO(), automation.ActionCallbackCompleteBatchParams{\n\t\tBatchInputCallbackCompletionBatchRequest: automation.BatchInputCallbackCompletionBatchRequestParam{\n\t\t\tInputs: []automation.CallbackCompletionBatchRequestParam{{\n\t\t\t\tCallbackID: "callbackId",\n\t\t\t\tOutputFields: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t\tTypedOutputs: map[string]any{},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.callbacks.complete_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.callbacks.complete_batch(\n inputs: [{callbackId: "callbackId", outputFields: {foo: "string"}, typedOutputs: {}}]\n)\n\nputs(result)', + }, + php: { + method: 'automation->actions->callbacks->completeBatch', + example: + "automation->actions->callbacks->completeBatch(\n inputs: [\n [\n 'callbackID' => 'callbackId',\n 'outputFields' => ['foo' => 'string'],\n 'typedOutputs' => (object) [],\n 'failureReasonType' => 'failureReasonType',\n 'requestContext' => [\n 'source' => 'WORKFLOWS',\n 'workflowID' => 0,\n 'actionExecutionIndexIdentifier' => [\n 'actionExecutionIndex' => 0, 'enrollmentID' => 0\n ],\n 'actionID' => 0,\n ],\n ],\n ],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/callbacks/2026-03/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "callbackId": "callbackId",\n "outputFields": {\n "foo": "string"\n },\n "typedOutputs": {}\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/automation/actions/2026-03/{appId}', + httpMethod: 'post', + summary: 'Create a new custom action definition', + description: 'Create a new custom workflow action.', + stainlessPath: '(resource) automation.actions.definitions > (method) create', + qualified: 'client.automation.actions.definitions.create', + params: [ + 'appId: number;', + 'actionUrl: string;', + "functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[];", + "inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[];", + 'labels: object;', + 'objectTypes: string[];', + 'published: boolean;', + 'archivedAt?: number;', + 'executionRules?: { conditions: object; labelName: string; }[];', + "inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[];", + 'objectRequestOptions?: { properties: string[]; };', + 'outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[];', + ], + response: + "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", + markdown: + "## create\n\n`client.automation.actions.definitions.create(appId: number, actionUrl: string, functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[], inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[], labels: object, objectTypes: string[], published: boolean, archivedAt?: number, executionRules?: { conditions: object; labelName: string; }[], inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[], objectRequestOptions?: { properties: string[]; }, outputFields?: { typeDefinition: field_type_definition; }[]): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**post** `/automation/actions/2026-03/{appId}`\n\nCreate a new custom workflow action.\n\n### Parameters\n\n- `appId: number`\n\n- `actionUrl: string`\n The URL endpoint where the action is executed.\n\n- `functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n\n- `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n\n- `labels: object`\n Holds various labels associated with the action, including names and descriptions.\n\n- `objectTypes: string[]`\n\n- `published: boolean`\n Indicates whether the action is published and available for use.\n\n- `archivedAt?: number`\n The timestamp indicating when the action was archived.\n\n- `executionRules?: { conditions: object; labelName: string; }[]`\n\n- `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n\n- `objectRequestOptions?: { properties: string[]; }`\n - `properties: string[]`\n\n- `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.create(0, {\n actionUrl: 'actionUrl',\n functions: [{ functionSource: 'functionSource', functionType: 'POST_ACTION_EXECUTION' }],\n inputFields: [{\n isRequired: true,\n typeDefinition: {\n name: 'name',\n options: [{ label: 'label', value: 'value' }],\n type: 'bool',\n},\n}],\n labels: { foo: { actionName: 'actionName' } },\n objectTypes: ['string'],\n published: true,\n});\n\nconsole.log(publicActionDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.create(0, {\n actionUrl: 'actionUrl',\n functions: [{ functionSource: 'functionSource', functionType: 'POST_ACTION_EXECUTION' }],\n inputFields: [\n {\n isRequired: true,\n typeDefinition: {\n name: 'name',\n options: [{ label: 'label', value: 'value' }],\n type: 'bool',\n },\n },\n ],\n labels: { foo: { actionName: 'actionName' } },\n objectTypes: ['string'],\n published: true,\n});\n\nconsole.log(publicActionDefinition.id);", + }, + python: { + method: 'automation.actions.definitions.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.create(\n app_id=0,\n action_url="actionUrl",\n functions=[{\n "function_source": "functionSource",\n "function_type": "POST_ACTION_EXECUTION",\n }],\n input_fields=[{\n "is_required": True,\n "type_definition": {\n "name": "name",\n "options": [{\n "label": "label",\n "value": "value",\n }],\n "type": "bool",\n },\n }],\n labels={\n "foo": {\n "action_name": "actionName"\n }\n },\n object_types=["string"],\n published=True,\n)\nprint(public_action_definition.id)', + }, + java: { + method: 'automation().actions().definitions().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionEgg;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.PublicFieldTypeDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicInputFieldDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicOption;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionCreateParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreateParams params = DefinitionCreateParams.builder()\n .appId(0)\n .publicActionDefinitionEgg(PublicActionDefinitionEgg.builder()\n .actionUrl("actionUrl")\n .addFunction(PublicActionFunction.builder()\n .functionSource("functionSource")\n .functionType(PublicActionFunction.FunctionType.POST_ACTION_EXECUTION)\n .build())\n .addInputField(PublicInputFieldDefinition.builder()\n .isRequired(true)\n .typeDefinition(PublicFieldTypeDefinition.builder()\n .name("name")\n .addOption(PublicOption.builder()\n .label("label")\n .value("value")\n .build())\n .type(PublicFieldTypeDefinition.Type.BOOL)\n .build())\n .build())\n .labels(PublicActionDefinitionEgg.Labels.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "actionName", "actionName"\n )))\n .build())\n .addObjectType("string")\n .published(true)\n .build())\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().create(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tautomation.ActionDefinitionNewParams{\n\t\t\tPublicActionDefinitionEgg: automation.PublicActionDefinitionEggParam{\n\t\t\t\tActionURL: "actionUrl",\n\t\t\t\tFunctions: []automation.PublicActionFunctionParam{{\n\t\t\t\t\tFunctionSource: "functionSource",\n\t\t\t\t\tFunctionType: automation.PublicActionFunctionFunctionTypePostActionExecution,\n\t\t\t\t}},\n\t\t\t\tInputFields: []automation.PublicInputFieldDefinitionParam{{\n\t\t\t\t\tIsRequired: true,\n\t\t\t\t\tTypeDefinition: automation.PublicFieldTypeDefinitionParam{\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOptions: []automation.PublicOptionParam{{\n\t\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tType: automation.PublicFieldTypeDefinitionTypeBool,\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tLabels: map[string]automation.PublicActionLabelsParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tActionName: "actionName",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tObjectTypes: []string{"string"},\n\t\t\t\tPublished: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.create(\n 0,\n action_url: "actionUrl",\n functions: [{functionSource: "functionSource", functionType: :POST_ACTION_EXECUTION}],\n input_fields: [\n {isRequired: true, typeDefinition: {name: "name", options: [{label: "label", value: "value"}], type: :bool}}\n ],\n labels: {foo: {actionName: "actionName"}},\n object_types: ["string"],\n published: true\n)\n\nputs(public_action_definition)', + }, + php: { + method: 'automation->actions->definitions->create', + example: + "automation->actions->definitions->create(\n 0,\n actionURL: 'actionUrl',\n functions: [\n [\n 'functionSource' => 'functionSource',\n 'functionType' => 'POST_ACTION_EXECUTION',\n 'id' => 'id',\n ],\n ],\n inputFields: [\n [\n 'isRequired' => true,\n 'typeDefinition' => [\n 'name' => 'name',\n 'options' => [\n [\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n 'displayOrder' => 0,\n ],\n ],\n 'type' => 'bool',\n 'description' => 'description',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'OWNER',\n ],\n 'supportedValueTypes' => ['STATIC_VALUE'],\n ],\n ],\n labels: [\n 'foo' => [\n 'actionName' => 'actionName',\n 'actionCardContent' => 'actionCardContent',\n 'actionDescription' => 'actionDescription',\n 'appDisplayName' => 'appDisplayName',\n 'executionRules' => ['foo' => 'string'],\n 'inputFieldDescriptions' => ['foo' => 'string'],\n 'inputFieldLabels' => ['foo' => 'string'],\n 'inputFieldOptionLabels' => ['foo' => ['foo' => 'string']],\n 'outputFieldLabels' => ['foo' => 'string'],\n ],\n ],\n objectTypes: ['string'],\n published: true,\n archivedAt: 0,\n executionRules: [\n ['conditions' => ['foo' => (object) []], 'labelName' => 'labelName']\n ],\n inputFieldDependencies: [\n [\n 'controllingFieldName' => 'controllingFieldName',\n 'dependencyType' => 'SINGLE_FIELD',\n 'dependentFieldNames' => ['string'],\n ],\n ],\n objectRequestOptions: ['properties' => ['string']],\n outputFields: [\n [\n 'typeDefinition' => [\n 'externalOptions' => true,\n 'name' => 'name',\n 'options' => [\n [\n 'description' => 'description',\n 'displayOrder' => 0,\n 'doubleData' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'readOnly' => true,\n 'value' => 'value',\n ],\n ],\n 'schema' => ['type' => 'ARRAY', 'maximum' => 0, 'minimum' => 0],\n 'type' => 'bool',\n 'useChirp' => true,\n 'description' => 'description',\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'ABANDONED_CART',\n ],\n ],\n ],\n);\n\nvar_dump($publicActionDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "actionUrl": "actionUrl",\n "functions": [\n {\n "functionSource": "functionSource",\n "functionType": "POST_ACTION_EXECUTION"\n }\n ],\n "inputFields": [\n {\n "isRequired": true,\n "typeDefinition": {\n "name": "name",\n "options": [\n {\n "label": "label",\n "value": "value"\n }\n ],\n "type": "bool"\n }\n }\n ],\n "labels": {\n "foo": {\n "actionName": "actionName"\n }\n },\n "objectTypes": [\n "string"\n ],\n "published": true\n }\'', + }, + }, + }, + { + name: 'create_requires_object', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', + httpMethod: 'post', + summary: 'Set the object requirement for a custom action definition.', + description: 'Set whether a custom action definition requires an object.', + stainlessPath: '(resource) automation.actions.definitions > (method) create_requires_object', + qualified: 'client.automation.actions.definitions.createRequiresObject', + params: ['appId: number;', 'definitionId: string;', 'requiresObject: boolean;'], + markdown: + "## create_requires_object\n\n`client.automation.actions.definitions.createRequiresObject(appId: number, definitionId: string, requiresObject: boolean): void`\n\n**post** `/automation/actions/2026-03/{appId}/{definitionId}/requires-object`\n\nSet whether a custom action definition requires an object.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `requiresObject: boolean`\n Indicates whether a custom action definition requires an associated object.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.definitions.createRequiresObject('definitionId', { appId: 0, requiresObject: true })\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.createRequiresObject', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.definitions.createRequiresObject('definitionId', {\n appId: 0,\n requiresObject: true,\n});", + }, + python: { + method: 'automation.actions.definitions.create_requires_object', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.definitions.create_requires_object(\n definition_id="definitionId",\n app_id=0,\n requires_object=True,\n)', + }, + java: { + method: 'automation().actions().definitions().createRequiresObject', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionRequiresObjectRequest;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionCreateRequiresObjectParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreateRequiresObjectParams params = DefinitionCreateRequiresObjectParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .publicActionDefinitionRequiresObjectRequest(PublicActionDefinitionRequiresObjectRequest.builder()\n .requiresObject(true)\n .build())\n .build();\n client.automation().actions().definitions().createRequiresObject(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.NewRequiresObject', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Definitions.NewRequiresObject(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionNewRequiresObjectParams{\n\t\t\tAppID: 0,\n\t\t\tPublicActionDefinitionRequiresObjectRequest: automation.PublicActionDefinitionRequiresObjectRequestParam{\n\t\t\t\tRequiresObject: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.create_requires_object', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.definitions.create_requires_object(\n "definitionId",\n app_id: 0,\n requires_object: true\n)\n\nputs(result)', + }, + php: { + method: 'automation->actions->definitions->createRequiresObject', + example: + "automation->actions->definitions->createRequiresObject(\n 'definitionId', appID: 0, requiresObject: true\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/requires-object \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requiresObject": true\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', + httpMethod: 'delete', + summary: 'Delete an action definition', + description: 'Delete an action definition by ID.', + stainlessPath: '(resource) automation.actions.definitions > (method) delete', + qualified: 'client.automation.actions.definitions.delete', + params: ['appId: number;', 'definitionId: string;'], + markdown: + "## delete\n\n`client.automation.actions.definitions.delete(appId: number, definitionId: string): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nDelete an action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.definitions.delete('definitionId', { appId: 0 })\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.definitions.delete('definitionId', { appId: 0 });", + }, + python: { + method: 'automation.actions.definitions.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.definitions.delete(\n definition_id="definitionId",\n app_id=0,\n)', + }, + java: { + method: 'automation().actions().definitions().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionDeleteParams params = DefinitionDeleteParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n client.automation().actions().definitions().delete(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Definitions.Delete(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.definitions.delete("definitionId", app_id: 0)\n\nputs(result)', + }, + php: { + method: 'automation->actions->definitions->delete', + example: + "automation->actions->definitions->delete(\n 'definitionId', appID: 0\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', + httpMethod: 'get', + summary: 'Retrieve a custom action definition', + description: 'Retrieve a custom workflow action definition by ID.', + stainlessPath: '(resource) automation.actions.definitions > (method) get', + qualified: 'client.automation.actions.definitions.get', + params: ['appId: number;', 'definitionId: string;', 'archived?: boolean;'], + response: + "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", + markdown: + "## get\n\n`client.automation.actions.definitions.get(appId: number, definitionId: string, archived?: boolean): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nRetrieve a custom workflow action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.get('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.get('definitionId', {\n appId: 0,\n});\n\nconsole.log(publicActionDefinition.id);", + }, + python: { + method: 'automation.actions.definitions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.get(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition.id)', + }, + java: { + method: 'automation().actions().definitions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionGetParams params = DefinitionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().get(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.Get(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionGetParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.get("definitionId", app_id: 0)\n\nputs(public_action_definition)', + }, + php: { + method: 'automation->actions->definitions->get', + example: + "automation->actions->definitions->get(\n 'definitionId', appID: 0, archived: true\n);\n\nvar_dump($publicActionDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_requires_object', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', + httpMethod: 'get', + summary: 'Retrieve the object requirement status for a custom action definition.', + description: 'Retrieve whether a custom action definition requires an object.', + stainlessPath: '(resource) automation.actions.definitions > (method) get_requires_object', + qualified: 'client.automation.actions.definitions.getRequiresObject', + params: ['appId: number;', 'definitionId: string;'], + response: '{ requiresObject: boolean; }', + markdown: + "## get_requires_object\n\n`client.automation.actions.definitions.getRequiresObject(appId: number, definitionId: string): { requiresObject: boolean; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/requires-object`\n\nRetrieve whether a custom action definition requires an object.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Returns\n\n- `{ requiresObject: boolean; }`\n\n - `requiresObject: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinitionRequiresObjectResponse = await client.automation.actions.definitions.getRequiresObject('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinitionRequiresObjectResponse);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.getRequiresObject', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinitionRequiresObjectResponse =\n await client.automation.actions.definitions.getRequiresObject('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinitionRequiresObjectResponse.requiresObject);", + }, + python: { + method: 'automation.actions.definitions.get_requires_object', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition_requires_object_response = client.automation.actions.definitions.get_requires_object(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition_requires_object_response.requires_object)', + }, + java: { + method: 'automation().actions().definitions().getRequiresObject', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionRequiresObjectResponse;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionGetRequiresObjectParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionGetRequiresObjectParams params = DefinitionGetRequiresObjectParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n PublicActionDefinitionRequiresObjectResponse publicActionDefinitionRequiresObjectResponse = client.automation().actions().definitions().getRequiresObject(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.GetRequiresObject', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinitionRequiresObjectResponse, err := client.Automation.Actions.Definitions.GetRequiresObject(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionGetRequiresObjectParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinitionRequiresObjectResponse.RequiresObject)\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.get_requires_object', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition_requires_object_response = hubspot.automation.actions.definitions.get_requires_object("definitionId", app_id: 0)\n\nputs(public_action_definition_requires_object_response)', + }, + php: { + method: 'automation->actions->definitions->getRequiresObject', + example: + "automation\n ->actions\n ->definitions\n ->getRequiresObject('definitionId', appID: 0);\n\nvar_dump($publicActionDefinitionRequiresObjectResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/requires-object \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/automation/actions/2026-03/{appId}', + httpMethod: 'get', + summary: 'Retrieve custom action definitions', + description: 'Retrieve custom workflow action definitions by app ID.', + stainlessPath: '(resource) automation.actions.definitions > (method) list', + qualified: 'client.automation.actions.definitions.list', + params: ['appId: number;', 'after?: string;', 'archived?: boolean;', 'limit?: number;'], + response: + "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", + markdown: + "## list\n\n`client.automation.actions.definitions.list(appId: number, after?: string, archived?: boolean, limit?: number): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**get** `/automation/actions/2026-03/{appId}`\n\nRetrieve custom workflow action definitions by app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionDefinition of client.automation.actions.definitions.list(0)) {\n console.log(publicActionDefinition);\n}\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionDefinition of client.automation.actions.definitions.list(0)) {\n console.log(publicActionDefinition.id);\n}", + }, + python: { + method: 'automation.actions.definitions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.actions.definitions.list(\n app_id=0,\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'automation().actions().definitions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionListPage;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionListPage page = client.automation().actions().definitions().list(0);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Actions.Definitions.List(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tautomation.ActionDefinitionListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.actions.definitions.list(0)\n\nputs(page)', + }, + php: { + method: 'automation->actions->definitions->list', + example: + "automation->actions->definitions->list(\n 0, after: 'after', archived: true, limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', + httpMethod: 'patch', + summary: 'Update an existing action definition', + description: 'Update an existing action definition by ID.', + stainlessPath: '(resource) automation.actions.definitions > (method) update', + qualified: 'client.automation.actions.definitions.update', + params: [ + 'appId: number;', + 'definitionId: string;', + 'actionUrl?: string;', + 'executionRules?: { conditions: object; labelName: string; }[];', + "inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[];", + "inputFields?: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[];", + 'labels?: object;', + 'objectRequestOptions?: { properties: string[]; };', + 'objectTypes?: string[];', + 'outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[];', + 'published?: boolean;', + ], + response: + "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", + markdown: + "## update\n\n`client.automation.actions.definitions.update(appId: number, definitionId: string, actionUrl?: string, executionRules?: { conditions: object; labelName: string; }[], inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[], inputFields?: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[], labels?: object, objectRequestOptions?: { properties: string[]; }, objectTypes?: string[], outputFields?: { typeDefinition: field_type_definition; }[], published?: boolean): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**patch** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nUpdate an existing action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `actionUrl?: string`\n The URL endpoint where the action is executed.\n\n- `executionRules?: { conditions: object; labelName: string; }[]`\n\n- `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n\n- `inputFields?: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n\n- `labels?: object`\n Contains labels for the action, including names and descriptions.\n\n- `objectRequestOptions?: { properties: string[]; }`\n - `properties: string[]`\n\n- `objectTypes?: string[]`\n\n- `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n- `published?: boolean`\n Indicates whether the action is published and available for use.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.update('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.definitions.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.update('definitionId', {\n appId: 0,\n});\n\nconsole.log(publicActionDefinition.id);", + }, + python: { + method: 'automation.actions.definitions.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.update(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition.id)', + }, + java: { + method: 'automation().actions().definitions().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionPatch;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdateParams params = DefinitionUpdateParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .publicActionDefinitionPatch(PublicActionDefinitionPatch.builder().build())\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().update(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Definitions.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.Update(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tPublicActionDefinitionPatch: automation.PublicActionDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.definitions.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.update("definitionId", app_id: 0)\n\nputs(public_action_definition)', + }, + php: { + method: 'automation->actions->definitions->update', + example: + "automation->actions->definitions->update(\n 'definitionId',\n appID: 0,\n actionURL: 'actionUrl',\n executionRules: [\n ['conditions' => ['foo' => (object) []], 'labelName' => 'labelName']\n ],\n inputFieldDependencies: [\n [\n 'controllingFieldName' => 'controllingFieldName',\n 'dependencyType' => 'SINGLE_FIELD',\n 'dependentFieldNames' => ['string'],\n ],\n ],\n inputFields: [\n [\n 'isRequired' => true,\n 'typeDefinition' => [\n 'name' => 'name',\n 'options' => [\n [\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n 'displayOrder' => 0,\n ],\n ],\n 'type' => 'bool',\n 'description' => 'description',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'OWNER',\n ],\n 'supportedValueTypes' => ['STATIC_VALUE'],\n ],\n ],\n labels: [\n 'foo' => [\n 'actionName' => 'actionName',\n 'actionCardContent' => 'actionCardContent',\n 'actionDescription' => 'actionDescription',\n 'appDisplayName' => 'appDisplayName',\n 'executionRules' => ['foo' => 'string'],\n 'inputFieldDescriptions' => ['foo' => 'string'],\n 'inputFieldLabels' => ['foo' => 'string'],\n 'inputFieldOptionLabels' => ['foo' => ['foo' => 'string']],\n 'outputFieldLabels' => ['foo' => 'string'],\n ],\n ],\n objectRequestOptions: ['properties' => ['string']],\n objectTypes: ['string'],\n outputFields: [\n [\n 'typeDefinition' => [\n 'externalOptions' => true,\n 'name' => 'name',\n 'options' => [\n [\n 'description' => 'description',\n 'displayOrder' => 0,\n 'doubleData' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'readOnly' => true,\n 'value' => 'value',\n ],\n ],\n 'schema' => ['type' => 'ARRAY', 'maximum' => 0, 'minimum' => 0],\n 'type' => 'bool',\n 'useChirp' => true,\n 'description' => 'description',\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'ABANDONED_CART',\n ],\n ],\n ],\n published: true,\n);\n\nvar_dump($publicActionDefinition);", + }, + http: { + example: + "curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create_or_replace', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + httpMethod: 'put', + summary: 'Update a function for a definition', + description: 'Update a function for a given definition by ID.', + stainlessPath: '(resource) automation.actions.functions > (method) create_or_replace', + qualified: 'client.automation.actions.functions.createOrReplace', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + 'functionId: string;', + 'body: string;', + ], + response: + "{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", + markdown: + "## create_or_replace\n\n`client.automation.actions.functions.createOrReplace(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string, body: string): { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**put** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nUpdate a function for a given definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n- `body: string`\n\n### Returns\n\n- `{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplace('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n});\n\nconsole.log(publicActionFunctionIdentifier);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.createOrReplace', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplace(\n 'functionId',\n {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n },\n);\n\nconsole.log(publicActionFunctionIdentifier.id);", + }, + python: { + method: 'automation.actions.functions.create_or_replace', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function_identifier = client.automation.actions.functions.create_or_replace(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n body="body",\n)\nprint(public_action_function_identifier.id)', + }, + java: { + method: 'automation().actions().functions().createOrReplace', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunctionIdentifier;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionCreateOrReplaceParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionCreateOrReplaceParams params = FunctionCreateOrReplaceParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionCreateOrReplaceParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .body("body")\n .build();\n PublicActionFunctionIdentifier publicActionFunctionIdentifier = client.automation().actions().functions().createOrReplace(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.NewOrReplace', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunctionIdentifier, err := client.Automation.Actions.Functions.NewOrReplace(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionNewOrReplaceParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionNewOrReplaceParamsFunctionTypePostActionExecution,\n\t\t\tBody: "body",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunctionIdentifier.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.functions.create_or_replace', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function_identifier = hubspot.automation.actions.functions.create_or_replace(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION,\n body: "body"\n)\n\nputs(public_action_function_identifier)', + }, + php: { + method: 'automation->actions->functions->createOrReplace', + example: + "automation\n ->actions\n ->functions\n ->createOrReplace(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n);\n\nvar_dump($publicActionFunctionIdentifier);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -X PUT \\\n -H \'Content-Type: text/plain\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'"body"\'', + }, + }, + }, + { + name: 'create_or_replace_by_function_type', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + httpMethod: 'put', + summary: 'Insert a function for a definition', + description: 'Add a function for a given definition.', + stainlessPath: '(resource) automation.actions.functions > (method) create_or_replace_by_function_type', + qualified: 'client.automation.actions.functions.createOrReplaceByFunctionType', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + 'body: string;', + ], + response: + "{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", + markdown: + "## create_or_replace_by_function_type\n\n`client.automation.actions.functions.createOrReplaceByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', body: string): { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**put** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nAdd a function for a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `body: string`\n\n### Returns\n\n- `{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplaceByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n body: 'body',\n});\n\nconsole.log(publicActionFunctionIdentifier);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.createOrReplaceByFunctionType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunctionIdentifier =\n await client.automation.actions.functions.createOrReplaceByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n body: 'body',\n });\n\nconsole.log(publicActionFunctionIdentifier.id);", + }, + python: { + method: 'automation.actions.functions.create_or_replace_by_function_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function_identifier = client.automation.actions.functions.create_or_replace_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n body="body",\n)\nprint(public_action_function_identifier.id)', + }, + java: { + method: 'automation().actions().functions().createOrReplaceByFunctionType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunctionIdentifier;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionCreateOrReplaceByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionCreateOrReplaceByFunctionTypeParams params = FunctionCreateOrReplaceByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionCreateOrReplaceByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .body("body")\n .build();\n PublicActionFunctionIdentifier publicActionFunctionIdentifier = client.automation().actions().functions().createOrReplaceByFunctionType(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.NewOrReplaceByFunctionType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunctionIdentifier, err := client.Automation.Actions.Functions.NewOrReplaceByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionNewOrReplaceByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionNewOrReplaceByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tBody: "body",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunctionIdentifier.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.functions.create_or_replace_by_function_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function_identifier = hubspot.automation.actions.functions.create_or_replace_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId",\n body: "body"\n)\n\nputs(public_action_function_identifier)', + }, + php: { + method: 'automation->actions->functions->createOrReplaceByFunctionType', + example: + "automation\n ->actions\n ->functions\n ->createOrReplaceByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId', body: 'body'\n);\n\nvar_dump($publicActionFunctionIdentifier);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -X PUT \\\n -H \'Content-Type: text/plain\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'"body"\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + httpMethod: 'delete', + summary: 'Archive a function for a definition', + description: 'Archive a function for a specific definition.', + stainlessPath: '(resource) automation.actions.functions > (method) delete', + qualified: 'client.automation.actions.functions.delete', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + 'functionId: string;', + ], + markdown: + "## delete\n\n`client.automation.actions.functions.delete(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nArchive a function for a specific definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.functions.delete('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n})\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.functions.delete('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});", + }, + python: { + method: 'automation.actions.functions.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.functions.delete(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n)', + }, + java: { + method: 'automation().actions().functions().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionDeleteParams params = FunctionDeleteParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionDeleteParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .build();\n client.automation().actions().functions().delete(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Functions.Delete(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionDeleteParamsFunctionTypePostActionExecution,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.functions.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.functions.delete(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION\n)\n\nputs(result)', + }, + php: { + method: 'automation->actions->functions->delete', + example: + "automation->actions->functions->delete(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_by_function_type', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + httpMethod: 'delete', + summary: 'Delete a function for a definition', + description: 'Delete a function within a given definition.', + stainlessPath: '(resource) automation.actions.functions > (method) delete_by_function_type', + qualified: 'client.automation.actions.functions.deleteByFunctionType', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + ], + markdown: + "## delete_by_function_type\n\n`client.automation.actions.functions.deleteByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nDelete a function within a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.functions.deleteByFunctionType('POST_ACTION_EXECUTION', { appId: 0, definitionId: 'definitionId' })\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.deleteByFunctionType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.functions.deleteByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n});", + }, + python: { + method: 'automation.actions.functions.delete_by_function_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.functions.delete_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n)', + }, + java: { + method: 'automation().actions().functions().deleteByFunctionType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionDeleteByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionDeleteByFunctionTypeParams params = FunctionDeleteByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionDeleteByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .build();\n client.automation().actions().functions().deleteByFunctionType(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.DeleteByFunctionType', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Functions.DeleteByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionDeleteByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionDeleteByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'automation.actions.functions.delete_by_function_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.functions.delete_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId"\n)\n\nputs(result)', + }, + php: { + method: 'automation->actions->functions->deleteByFunctionType', + example: + "automation->actions->functions->deleteByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + httpMethod: 'get', + summary: 'Retrieve a function from a given definition', + description: 'Retrieve a specific function from a given definition.', + stainlessPath: '(resource) automation.actions.functions > (method) get', + qualified: 'client.automation.actions.functions.get', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + 'functionId: string;', + ], + response: + "{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", + markdown: + "## get\n\n`client.automation.actions.functions.get(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string): { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nRetrieve a specific function from a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n### Returns\n\n- `{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionSource: string`\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunction = await client.automation.actions.functions.get('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});\n\nconsole.log(publicActionFunction);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunction = await client.automation.actions.functions.get('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});\n\nconsole.log(publicActionFunction.id);", + }, + python: { + method: 'automation.actions.functions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function = client.automation.actions.functions.get(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n)\nprint(public_action_function.id)', + }, + java: { + method: 'automation().actions().functions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionGetParams params = FunctionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionGetParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .build();\n PublicActionFunction publicActionFunction = client.automation().actions().functions().get(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunction, err := client.Automation.Actions.Functions.Get(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionGetParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionGetParamsFunctionTypePostActionExecution,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunction.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.functions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function = hubspot.automation.actions.functions.get(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION\n)\n\nputs(public_action_function)', + }, + php: { + method: 'automation->actions->functions->get', + example: + "automation->actions->functions->get(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n);\n\nvar_dump($publicActionFunction);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_function_type', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + httpMethod: 'get', + summary: 'Retrieve functions by a type for a given definition', + description: 'Retrieve functions of a specific type for a given definition.', + stainlessPath: '(resource) automation.actions.functions > (method) get_by_function_type', + qualified: 'client.automation.actions.functions.getByFunctionType', + params: [ + 'appId: number;', + 'definitionId: string;', + "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", + ], + response: + "{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", + markdown: + "## get_by_function_type\n\n`client.automation.actions.functions.getByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'): { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nRetrieve functions of a specific type for a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n### Returns\n\n- `{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionSource: string`\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunction = await client.automation.actions.functions.getByFunctionType('POST_ACTION_EXECUTION', { appId: 0, definitionId: 'definitionId' });\n\nconsole.log(publicActionFunction);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.getByFunctionType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunction = await client.automation.actions.functions.getByFunctionType(\n 'POST_ACTION_EXECUTION',\n { appId: 0, definitionId: 'definitionId' },\n);\n\nconsole.log(publicActionFunction.id);", + }, + python: { + method: 'automation.actions.functions.get_by_function_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function = client.automation.actions.functions.get_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n)\nprint(public_action_function.id)', + }, + java: { + method: 'automation().actions().functions().getByFunctionType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionGetByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionGetByFunctionTypeParams params = FunctionGetByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionGetByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .build();\n PublicActionFunction publicActionFunction = client.automation().actions().functions().getByFunctionType(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.GetByFunctionType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunction, err := client.Automation.Actions.Functions.GetByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionGetByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionGetByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunction.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.functions.get_by_function_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function = hubspot.automation.actions.functions.get_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId"\n)\n\nputs(public_action_function)', + }, + php: { + method: 'automation->actions->functions->getByFunctionType', + example: + "automation\n ->actions\n ->functions\n ->getByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($publicActionFunction);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions', + httpMethod: 'get', + summary: 'Retrieve functions for a given definition', + description: 'Retrieve all functions included in a definition.', + stainlessPath: '(resource) automation.actions.functions > (method) list', + qualified: 'client.automation.actions.functions.list', + params: ['appId: number;', 'definitionId: string;'], + response: + "{ results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; }", + markdown: + "## list\n\n`client.automation.actions.functions.list(appId: number, definitionId: string): { results: public_action_function_identifier[]; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions`\n\nRetrieve all functions included in a definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Returns\n\n- `{ results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; }`\n\n - `results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicActionFunctionIdentifierNoPaging = await client.automation.actions.functions.list('definitionId', { appId: 0 });\n\nconsole.log(collectionResponsePublicActionFunctionIdentifierNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.functions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicActionFunctionIdentifierNoPaging =\n await client.automation.actions.functions.list('definitionId', { appId: 0 });\n\nconsole.log(collectionResponsePublicActionFunctionIdentifierNoPaging.results);", + }, + python: { + method: 'automation.actions.functions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_action_function_identifier_no_paging = client.automation.actions.functions.list(\n definition_id="definitionId",\n app_id=0,\n)\nprint(collection_response_public_action_function_identifier_no_paging.results)', + }, + java: { + method: 'automation().actions().functions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.CollectionResponsePublicActionFunctionIdentifierNoPaging;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionListParams params = FunctionListParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n CollectionResponsePublicActionFunctionIdentifierNoPaging collectionResponsePublicActionFunctionIdentifierNoPaging = client.automation().actions().functions().list(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Functions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicActionFunctionIdentifierNoPaging, err := client.Automation.Actions.Functions.List(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionFunctionListParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicActionFunctionIdentifierNoPaging.Results)\n}\n', + }, + ruby: { + method: 'automation.actions.functions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_action_function_identifier_no_paging = hubspot.automation.actions.functions.list("definitionId", app_id: 0)\n\nputs(collection_response_public_action_function_identifier_no_paging)', + }, + php: { + method: 'automation->actions->functions->list', + example: + "automation\n ->actions\n ->functions\n ->list('definitionId', appID: 0);\n\nvar_dump($collectionResponsePublicActionFunctionIdentifierNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Retrieve a specific revision of a definition', + description: 'Retrieve a specific revision of a definition by revision ID.', + stainlessPath: '(resource) automation.actions.revisions > (method) get', + qualified: 'client.automation.actions.revisions.get', + params: ['appId: number;', 'definitionId: string;', 'revisionId: string;'], + response: + '{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }', + markdown: + "## get\n\n`client.automation.actions.revisions.get(appId: number, definitionId: string, revisionId: string): { id: string; createdAt: string; definition: public_action_definition; revisionId: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}`\n\nRetrieve a specific revision of a definition by revision ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `definition: { id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n - `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionRevision = await client.automation.actions.revisions.get('revisionId', { appId: 0, definitionId: 'definitionId' });\n\nconsole.log(publicActionRevision);\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.revisions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionRevision = await client.automation.actions.revisions.get('revisionId', {\n appId: 0,\n definitionId: 'definitionId',\n});\n\nconsole.log(publicActionRevision.id);", + }, + python: { + method: 'automation.actions.revisions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_revision = client.automation.actions.revisions.get(\n revision_id="revisionId",\n app_id=0,\n definition_id="definitionId",\n)\nprint(public_action_revision.id)', + }, + java: { + method: 'automation().actions().revisions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionRevision;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetParams params = RevisionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .revisionId("revisionId")\n .build();\n PublicActionRevision publicActionRevision = client.automation().actions().revisions().get(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Revisions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionRevision, err := client.Automation.Actions.Revisions.Get(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tautomation.ActionRevisionGetParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionRevision.ID)\n}\n', + }, + ruby: { + method: 'automation.actions.revisions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_revision = hubspot.automation.actions.revisions.get("revisionId", app_id: 0, definition_id: "definitionId")\n\nputs(public_action_revision)', + }, + php: { + method: 'automation->actions->revisions->get', + example: + "automation->actions->revisions->get(\n 'revisionId', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($publicActionRevision);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/revisions', + httpMethod: 'get', + summary: 'Retrieve revisions for a given definition', + description: 'Retrieve the versions of a definition by ID.', + stainlessPath: '(resource) automation.actions.revisions > (method) list', + qualified: 'client.automation.actions.revisions.list', + params: ['appId: number;', 'definitionId: string;', 'after?: string;', 'limit?: number;'], + response: + '{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }', + markdown: + "## list\n\n`client.automation.actions.revisions.list(appId: number, definitionId: string, after?: string, limit?: number): { id: string; createdAt: string; definition: public_action_definition; revisionId: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/revisions`\n\nRetrieve the versions of a definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `definition: { id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n - `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionRevision of client.automation.actions.revisions.list('definitionId', { appId: 0 })) {\n console.log(publicActionRevision);\n}\n```", + perLanguage: { + typescript: { + method: 'client.automation.actions.revisions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionRevision of client.automation.actions.revisions.list('definitionId', {\n appId: 0,\n})) {\n console.log(publicActionRevision.id);\n}", + }, + python: { + method: 'automation.actions.revisions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.actions.revisions.list(\n definition_id="definitionId",\n app_id=0,\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'automation().actions().revisions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionListPage;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListParams params = RevisionListParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n RevisionListPage page = client.automation().actions().revisions().list(params);\n }\n}', + }, + go: { + method: 'client.Automation.Actions.Revisions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Actions.Revisions.List(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionRevisionListParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'automation.actions.revisions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.actions.revisions.list("definitionId", app_id: 0)\n\nputs(page)', + }, + php: { + method: 'automation->actions->revisions->list', + example: + "automation->actions->revisions->list(\n 'definitionId', appID: 0, after: 'after', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create_enrollment', + endpoint: '/automation/sequences/2026-03/enrollments', + httpMethod: 'post', + summary: 'Enroll a contact in a sequence', + description: 'Enroll a contact into a sequence using the specified user ID and sequence details.', + stainlessPath: '(resource) automation.sequences > (method) create_enrollment', + qualified: 'client.automation.sequences.createEnrollment', + params: [ + 'userId: string;', + 'contactId: string;', + 'senderEmail: string;', + 'sequenceId: string;', + 'senderAliasAddress?: string;', + ], + response: '{ id: string; enrolledAt: string; toEmail: string; updatedAt: string; }', + markdown: + "## create_enrollment\n\n`client.automation.sequences.createEnrollment(userId: string, contactId: string, senderEmail: string, sequenceId: string, senderAliasAddress?: string): { id: string; enrolledAt: string; toEmail: string; updatedAt: string; }`\n\n**post** `/automation/sequences/2026-03/enrollments`\n\nEnroll a contact into a sequence using the specified user ID and sequence details.\n\n### Parameters\n\n- `userId: string`\n\n- `contactId: string`\n The unique identifier of the contact to be enrolled in the sequence.\n\n- `senderEmail: string`\n The email address of the sender enrolling the contact in the sequence.\n\n- `sequenceId: string`\n The unique identifier of the sequence in which the contact will be enrolled.\n\n- `senderAliasAddress?: string`\n The alias email address used by the sender when enrolling the contact.\n\n### Returns\n\n- `{ id: string; enrolledAt: string; toEmail: string; updatedAt: string; }`\n\n - `id: string`\n - `enrolledAt: string`\n - `toEmail: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceEnrollmentLiteResponse = await client.automation.sequences.createEnrollment({\n userId: 'userId',\n contactId: 'contactId',\n senderEmail: 'senderEmail',\n sequenceId: 'sequenceId',\n});\n\nconsole.log(publicSequenceEnrollmentLiteResponse);\n```", + perLanguage: { + typescript: { + method: 'client.automation.sequences.createEnrollment', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceEnrollmentLiteResponse = await client.automation.sequences.createEnrollment({\n userId: 'userId',\n contactId: 'contactId',\n senderEmail: 'senderEmail',\n sequenceId: 'sequenceId',\n});\n\nconsole.log(publicSequenceEnrollmentLiteResponse.id);", + }, + python: { + method: 'automation.sequences.create_enrollment', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_enrollment_lite_response = client.automation.sequences.create_enrollment(\n user_id="userId",\n contact_id="contactId",\n sender_email="senderEmail",\n sequence_id="sequenceId",\n)\nprint(public_sequence_enrollment_lite_response.id)', + }, + java: { + method: 'automation().sequences().createEnrollment', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentLiteResponse;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentRequest;\nimport com.hubspot.sdk.models.automation.sequences.SequenceCreateEnrollmentParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceCreateEnrollmentParams params = SequenceCreateEnrollmentParams.builder()\n .userId("userId")\n .publicSequenceEnrollmentRequest(PublicSequenceEnrollmentRequest.builder()\n .contactId("contactId")\n .senderEmail("senderEmail")\n .sequenceId("sequenceId")\n .build())\n .build();\n PublicSequenceEnrollmentLiteResponse publicSequenceEnrollmentLiteResponse = client.automation().sequences().createEnrollment(params);\n }\n}', + }, + go: { + method: 'client.Automation.Sequences.NewEnrollment', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceEnrollmentLiteResponse, err := client.Automation.Sequences.NewEnrollment(context.TODO(), automation.SequenceNewEnrollmentParams{\n\t\tUserID: "userId",\n\t\tPublicSequenceEnrollmentRequest: automation.PublicSequenceEnrollmentRequestParam{\n\t\t\tContactID: "contactId",\n\t\t\tSenderEmail: "senderEmail",\n\t\t\tSequenceID: "sequenceId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceEnrollmentLiteResponse.ID)\n}\n', + }, + ruby: { + method: 'automation.sequences.create_enrollment', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_enrollment_lite_response = hubspot.automation.sequences.create_enrollment(\n user_id: "userId",\n contact_id: "contactId",\n sender_email: "senderEmail",\n sequence_id: "sequenceId"\n)\n\nputs(public_sequence_enrollment_lite_response)', + }, + php: { + method: 'automation->sequences->createEnrollment', + example: + "automation\n ->sequences\n ->createEnrollment(\n userID: 'userId',\n contactID: 'contactId',\n senderEmail: 'senderEmail',\n sequenceID: 'sequenceId',\n senderAliasAddress: 'senderAliasAddress',\n);\n\nvar_dump($publicSequenceEnrollmentLiteResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/sequences/2026-03/enrollments \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactId": "contactId",\n "senderEmail": "senderEmail",\n "sequenceId": "sequenceId"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/automation/sequences/2026-03/{sequenceId}', + httpMethod: 'get', + summary: 'Retrieve details for a sequence', + description: 'Retrieve details of a specific sequence by its ID.', + stainlessPath: '(resource) automation.sequences > (method) get', + qualified: 'client.automation.sequences.get', + params: ['sequenceId: string;', 'userId: string;'], + response: + "{ id: string; createdAt: string; dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]; name: string; steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: public_email_pattern_response; taskPattern?: public_task_pattern_response; }[]; updatedAt: string; userId: string; folderId?: string; settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }; }", + markdown: + "## get\n\n`client.automation.sequences.get(sequenceId: string, userId: string): { id: string; createdAt: string; dependencies: public_sequence_step_dependency_response[]; name: string; steps: public_sequence_step_response[]; updatedAt: string; userId: string; folderId?: string; settings?: public_sequence_settings_response; }`\n\n**get** `/automation/sequences/2026-03/{sequenceId}`\n\nRetrieve details of a specific sequence by its ID.\n\n### Parameters\n\n- `sequenceId: string`\n\n- `userId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]; name: string; steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: public_email_pattern_response; taskPattern?: public_task_pattern_response; }[]; updatedAt: string; userId: string; folderId?: string; settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]`\n - `name: string`\n - `steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: { id: string; createdAt: string; templateId: string; updatedAt: string; threadEmailToStepOrder?: number; }; taskPattern?: { id: string; createdAt: string; taskPriority: 'HIGH' | 'LOW' | 'MEDIUM' | 'NONE'; taskType: 'CALL' | 'EMAIL' | 'LINKED_IN_CONNECT' | 'LINKED_IN_MESSAGE' | 'MEETING' | 'TODO'; updatedAt: string; notes?: string; queueId?: number; subject?: string; templateId?: number; threadEmailToStepOrder?: number; }; }[]`\n - `updatedAt: string`\n - `userId: string`\n - `folderId?: string`\n - `settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceResponse = await client.automation.sequences.get('sequenceId', { userId: 'userId' });\n\nconsole.log(publicSequenceResponse);\n```", + perLanguage: { + typescript: { + method: 'client.automation.sequences.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceResponse = await client.automation.sequences.get('sequenceId', {\n userId: 'userId',\n});\n\nconsole.log(publicSequenceResponse.id);", + }, + python: { + method: 'automation.sequences.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_response = client.automation.sequences.get(\n sequence_id="sequenceId",\n user_id="userId",\n)\nprint(public_sequence_response.id)', + }, + java: { + method: 'automation().sequences().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceResponse;\nimport com.hubspot.sdk.models.automation.sequences.SequenceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceGetParams params = SequenceGetParams.builder()\n .sequenceId("sequenceId")\n .userId("userId")\n .build();\n PublicSequenceResponse publicSequenceResponse = client.automation().sequences().get(params);\n }\n}', + }, + go: { + method: 'client.Automation.Sequences.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceResponse, err := client.Automation.Sequences.Get(\n\t\tcontext.TODO(),\n\t\t"sequenceId",\n\t\tautomation.SequenceGetParams{\n\t\t\tUserID: "userId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceResponse.ID)\n}\n', + }, + ruby: { + method: 'automation.sequences.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_response = hubspot.automation.sequences.get("sequenceId", user_id: "userId")\n\nputs(public_sequence_response)', + }, + php: { + method: 'automation->sequences->get', + example: + "automation->sequences->get(\n 'sequenceId', userID: 'userId'\n);\n\nvar_dump($publicSequenceResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/sequences/2026-03/$SEQUENCE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_enrollment_by_contact_id', + endpoint: '/automation/sequences/2026-03/enrollments/contact/{contactId}', + httpMethod: 'get', + summary: 'Retrieve the enrollment status of a contact', + description: 'Get the enrollment status of a contact in sequences by their contact ID.', + stainlessPath: '(resource) automation.sequences > (method) get_enrollment_by_contact_id', + qualified: 'client.automation.sequences.getEnrollmentByContactID', + params: ['contactId: string;'], + response: + '{ id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }', + markdown: + "## get_enrollment_by_contact_id\n\n`client.automation.sequences.getEnrollmentByContactID(contactId: string): { id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }`\n\n**get** `/automation/sequences/2026-03/enrollments/contact/{contactId}`\n\nGet the enrollment status of a contact in sequences by their contact ID.\n\n### Parameters\n\n- `contactId: string`\n\n### Returns\n\n- `{ id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }`\n\n - `id: string`\n - `enrolledAt: string`\n - `enrolledBy: string`\n - `enrolledByEmail: string`\n - `sequenceId: string`\n - `sequenceName: string`\n - `toEmail: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceEnrollmentResponse = await client.automation.sequences.getEnrollmentByContactID('contactId');\n\nconsole.log(publicSequenceEnrollmentResponse);\n```", + perLanguage: { + typescript: { + method: 'client.automation.sequences.getEnrollmentByContactID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceEnrollmentResponse = await client.automation.sequences.getEnrollmentByContactID(\n 'contactId',\n);\n\nconsole.log(publicSequenceEnrollmentResponse.id);", + }, + python: { + method: 'automation.sequences.get_enrollment_by_contact_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_enrollment_response = client.automation.sequences.get_enrollment_by_contact_id(\n "contactId",\n)\nprint(public_sequence_enrollment_response.id)', + }, + java: { + method: 'automation().sequences().getEnrollmentByContactId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentResponse;\nimport com.hubspot.sdk.models.automation.sequences.SequenceGetEnrollmentByContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSequenceEnrollmentResponse publicSequenceEnrollmentResponse = client.automation().sequences().getEnrollmentByContactId("contactId");\n }\n}', + }, + go: { + method: 'client.Automation.Sequences.GetEnrollmentByContactID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceEnrollmentResponse, err := client.Automation.Sequences.GetEnrollmentByContactID(context.TODO(), "contactId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceEnrollmentResponse.ID)\n}\n', + }, + ruby: { + method: 'automation.sequences.get_enrollment_by_contact_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_enrollment_response = hubspot.automation.sequences.get_enrollment_by_contact_id("contactId")\n\nputs(public_sequence_enrollment_response)', + }, + php: { + method: 'automation->sequences->getEnrollmentByContactID', + example: + "automation\n ->sequences\n ->getEnrollmentByContactID('contactId');\n\nvar_dump($publicSequenceEnrollmentResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/sequences/2026-03/enrollments/contact/$CONTACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/automation/sequences/2026-03', + httpMethod: 'get', + summary: 'Retrieve sequences', + description: + 'Retrieve a list of sequences available in your HubSpot account. This endpoint allows you to filter sequences by user ID and name, and supports pagination for large result sets. Use this endpoint to manage and review your sequences effectively.', + stainlessPath: '(resource) automation.sequences > (method) list', + qualified: 'client.automation.sequences.list', + params: ['userId: string;', 'after?: string;', 'limit?: number;', 'name?: string;'], + response: + '{ id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }', + markdown: + "## list\n\n`client.automation.sequences.list(userId: string, after?: string, limit?: number, name?: string): { id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }`\n\n**get** `/automation/sequences/2026-03`\n\nRetrieve a list of sequences available in your HubSpot account. This endpoint allows you to filter sequences by user ID and name, and supports pagination for large result sets. Use this endpoint to manage and review your sequences effectively.\n\n### Parameters\n\n- `userId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `name: string`\n - `updatedAt: string`\n - `userId: string`\n - `folderId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicSequenceLiteResponse of client.automation.sequences.list({ userId: 'userId' })) {\n console.log(publicSequenceLiteResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.automation.sequences.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicSequenceLiteResponse of client.automation.sequences.list({\n userId: 'userId',\n})) {\n console.log(publicSequenceLiteResponse.id);\n}", + }, + python: { + method: 'automation.sequences.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.sequences.list(\n user_id="userId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'automation().sequences().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.SequenceListPage;\nimport com.hubspot.sdk.models.automation.sequences.SequenceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceListParams params = SequenceListParams.builder()\n .userId("userId")\n .build();\n SequenceListPage page = client.automation().sequences().list(params);\n }\n}', + }, + go: { + method: 'client.Automation.Sequences.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Sequences.List(context.TODO(), automation.SequenceListParams{\n\t\tUserID: "userId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'automation.sequences.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.sequences.list(user_id: "userId")\n\nputs(page)', + }, + php: { + method: 'automation->sequences->list', + example: + "automation->sequences->list(\n userID: 'userId', after: 'after', limit: 0, name: 'name'\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/automation/sequences/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_user_id', + endpoint: '/business-units/public/2026-03/business-units/user/{userId}', + httpMethod: 'get', + summary: 'Retrieve brands by associated user', + description: 'Retrieve the brands that a specific user can access.', + stainlessPath: '(resource) business_units.business_unit_entries > (method) get_by_user_id', + qualified: 'client.businessUnits.businessUnitEntries.getByUserID', + params: ['userId: string;', 'name?: string[];', 'properties?: string[];'], + response: + '{ results: { id: string; name: string; logoMetadata?: public_business_unit_logo_metadata; }[]; }', + markdown: + "## get_by_user_id\n\n`client.businessUnits.businessUnitEntries.getByUserID(userId: string, name?: string[], properties?: string[]): { results: public_business_unit[]; }`\n\n**get** `/business-units/public/2026-03/business-units/user/{userId}`\n\nRetrieve the brands that a specific user can access.\n\n### Parameters\n\n- `userId: string`\n\n- `name?: string[]`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ results: { id: string; name: string; logoMetadata?: public_business_unit_logo_metadata; }[]; }`\n\n - `results: { id: string; name: string; logoMetadata?: { logoAltText?: string; logoUrl?: string; resizedUrl?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicBusinessUnitNoPaging = await client.businessUnits.businessUnitEntries.getByUserID('userId');\n\nconsole.log(collectionResponsePublicBusinessUnitNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.businessUnits.businessUnitEntries.getByUserID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicBusinessUnitNoPaging =\n await client.businessUnits.businessUnitEntries.getByUserID('userId');\n\nconsole.log(collectionResponsePublicBusinessUnitNoPaging.results);", + }, + python: { + method: 'business_units.business_unit_entries.get_by_user_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_business_unit_no_paging = client.business_units.business_unit_entries.get_by_user_id(\n user_id="userId",\n)\nprint(collection_response_public_business_unit_no_paging.results)', + }, + java: { + method: 'businessUnits().businessUnitEntries().getByUserId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.businessunits.CollectionResponsePublicBusinessUnitNoPaging;\nimport com.hubspot.sdk.models.businessunits.businessunitentries.BusinessUnitEntryGetByUserIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicBusinessUnitNoPaging collectionResponsePublicBusinessUnitNoPaging = client.businessUnits().businessUnitEntries().getByUserId("userId");\n }\n}', + }, + go: { + method: 'client.BusinessUnits.BusinessUnitEntries.GetByUserID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/business_units"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicBusinessUnitNoPaging, err := client.BusinessUnits.BusinessUnitEntries.GetByUserID(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tbusiness_units.BusinessUnitEntryGetByUserIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicBusinessUnitNoPaging.Results)\n}\n', + }, + ruby: { + method: 'business_units.business_unit_entries.get_by_user_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_business_unit_no_paging = hubspot.business_units.business_unit_entries.get_by_user_id("userId")\n\nputs(collection_response_public_business_unit_no_paging)', + }, + php: { + method: 'businessUnits->businessUnitEntries->getByUserID', + example: + "businessUnits\n ->businessUnitEntries\n ->getByUserID('userId', name: ['string'], properties: ['string']);\n\nvar_dump($collectionResponsePublicBusinessUnitNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/business-units/public/2026-03/business-units/user/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'export', + endpoint: '/cms/audit-logs/2026-03/export', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) cms.audit_logs > (method) export', + qualified: 'client.cms.auditLogs.export', + params: [ + 'email: string;', + "format: 'CSV' | 'XLS' | 'XLSX';", + 'portalId: number;', + 'recipientUserIds: number[];', + 'shouldMarkExportFileAsSensitive: boolean;', + 'type: string;', + 'filters?: { objectType: string[]; };', + 'partition?: number;', + 'userId?: number;', + 'userTimeZone?: string;', + ], + markdown: + "## export\n\n`client.cms.auditLogs.export(email: string, format: 'CSV' | 'XLS' | 'XLSX', portalId: number, recipientUserIds: number[], shouldMarkExportFileAsSensitive: boolean, type: string, filters?: { objectType: string[]; }, partition?: number, userId?: number, userTimeZone?: string): void`\n\n**post** `/cms/audit-logs/2026-03/export`\n\n### Parameters\n\n- `email: string`\n\n- `format: 'CSV' | 'XLS' | 'XLSX'`\n\n- `portalId: number`\n\n- `recipientUserIds: number[]`\n\n- `shouldMarkExportFileAsSensitive: boolean`\n\n- `type: string`\n\n- `filters?: { objectType: string[]; }`\n - `objectType: string[]`\n\n- `partition?: number`\n\n- `userId?: number`\n\n- `userTimeZone?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.auditLogs.export({\n email: 'email',\n format: 'CSV',\n portalId: 0,\n recipientUserIds: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n})\n```", + perLanguage: { + typescript: { + method: 'client.cms.auditLogs.export', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.auditLogs.export({\n email: 'email',\n format: 'CSV',\n portalId: 0,\n recipientUserIds: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n});", + }, + python: { + method: 'cms.audit_logs.export', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.audit_logs.export(\n email="email",\n format="CSV",\n portal_id=0,\n recipient_user_ids=[0],\n should_mark_export_file_as_sensitive=True,\n type="type",\n)', + }, + java: { + method: 'cms().auditLogs().export', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.auditlogs.CmsAuditLoggingExportSettings;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CmsAuditLoggingExportSettings params = CmsAuditLoggingExportSettings.builder()\n .email("email")\n .format(CmsAuditLoggingExportSettings.Format.CSV)\n .portalId(0)\n .addRecipientUserId(0)\n .shouldMarkExportFileAsSensitive(true)\n .type("type")\n .build();\n client.cms().auditLogs().export(params);\n }\n}', + }, + go: { + method: 'client.Cms.AuditLogs.Export', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.AuditLogs.Export(context.TODO(), cms.AuditLogExportParams{\n\t\tCmsAuditLoggingExportSettings: cms.CmsAuditLoggingExportSettingsParam{\n\t\t\tEmail: "email",\n\t\t\tFormat: cms.CmsAuditLoggingExportSettingsFormatCsv,\n\t\t\tPortalID: 0,\n\t\t\tRecipientUserIDs: []int64{0},\n\t\t\tShouldMarkExportFileAsSensitive: true,\n\t\t\tType: "type",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.audit_logs.export', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.audit_logs.export(\n email: "email",\n format_: :CSV,\n portal_id: 0,\n recipient_user_ids: [0],\n should_mark_export_file_as_sensitive: true,\n type: "type"\n)\n\nputs(result)', + }, + php: { + method: 'cms->auditLogs->export', + example: + "cms->auditLogs->export(\n email: 'email',\n format: 'CSV',\n portalID: 0,\n recipientUserIDs: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n filters: ['objectType' => ['string']],\n partition: 0,\n userID: 0,\n userTimeZone: 'userTimeZone',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/audit-logs/2026-03/export \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email",\n "format": "CSV",\n "portalId": 0,\n "recipientUserIds": [\n 0\n ],\n "shouldMarkExportFileAsSensitive": true,\n "type": "type"\n }\'', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/audit-logs/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.audit_logs > (method) list', + qualified: 'client.cms.auditLogs.list', + params: [ + 'after?: string;', + 'before?: string;', + 'eventType?: string[];', + 'limit?: number;', + 'objectId?: string[];', + 'objectType?: string[];', + 'sort?: string[];', + 'userId?: string[];', + ], + response: + "{ event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }", + markdown: + "## list\n\n`client.cms.auditLogs.list(after?: string, before?: string, eventType?: string[], limit?: number, objectId?: string[], objectType?: string[], sort?: string[], userId?: string[]): { event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }`\n\n**get** `/cms/audit-logs/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `eventType?: string[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `objectId?: string[]`\n\n- `objectType?: string[]`\n\n- `sort?: string[]`\n\n- `userId?: string[]`\n\n### Returns\n\n- `{ event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }`\n\n - `event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'`\n - `fullName: string`\n - `meta: object`\n - `objectId: string`\n - `objectName: string`\n - `objectType: string`\n - `timestamp: string`\n - `userId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicAuditLog of client.cms.auditLogs.list()) {\n console.log(publicAuditLog);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.auditLogs.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicAuditLog of client.cms.auditLogs.list()) {\n console.log(publicAuditLog.event);\n}", + }, + python: { + method: 'cms.audit_logs.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.audit_logs.list()\npage = page.results[0]\nprint(page.event)', + }, + java: { + method: 'cms().auditLogs().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.auditlogs.AuditLogListPage;\nimport com.hubspot.sdk.models.cms.auditlogs.AuditLogListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AuditLogListPage page = client.cms().auditLogs().list();\n }\n}', + }, + go: { + method: 'client.Cms.AuditLogs.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.AuditLogs.List(context.TODO(), cms.AuditLogListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.audit_logs.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.audit_logs.list\n\nputs(page)', + }, + php: { + method: 'cms->auditLogs->list', + example: + "cms->auditLogs->list(\n after: 'after',\n before: 'before',\n eventType: ['string'],\n limit: 0,\n objectID: ['string'],\n objectType: ['string'],\n sort: ['string'],\n userID: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/audit-logs/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Attach a Blog Author to a multi-language group', + description: 'Attach a Blog Author to a multi-language group.', + stainlessPath: '(resource) cms.blogs.authors > (method) attach_to_lang_group', + qualified: 'client.cms.blogs.authors.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.blogs.authors.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group`\n\nAttach a Blog Author to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().authors().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.AttachToLangGroup(context.TODO(), cms.BlogAuthorAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.attach_to_lang_group(id: "id", language: :aa, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->attachToLangGroup', + example: + "cms->blogs->authors->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/blogs/2026-03/authors', + httpMethod: 'post', + summary: 'Create a new Blog Author', + description: 'Create a new Blog Author.', + stainlessPath: '(resource) cms.blogs.authors > (method) create', + qualified: 'client.cms.blogs.authors.create', + params: [ + 'id: string;', + 'avatar: string;', + 'bio: string;', + 'created: string;', + 'deletedAt: string;', + 'displayName: string;', + 'email: string;', + 'facebook: string;', + 'fullName: string;', + 'language: string;', + 'linkedin: string;', + 'name: string;', + 'slug: string;', + 'translatedFromId: number;', + 'twitter: string;', + 'updated: string;', + 'website: string;', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.blogs.authors.create(id: string, avatar: string, bio: string, created: string, deletedAt: string, displayName: string, email: string, facebook: string, fullName: string, language: string, linkedin: string, name: string, slug: string, translatedFromId: number, twitter: string, updated: string, website: string): string`\n\n**post** `/cms/blogs/2026-03/authors`\n\nCreate a new Blog Author.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Author.\n\n- `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n\n- `bio: string`\n A short biography of the blog author.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n\n- `displayName: string`\n The full name of the Blog Author to be displayed.\n\n- `email: string`\n Email address of the Blog Author.\n\n- `facebook: string`\n URL to the Blog Author's Facebook page.\n\n- `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n\n- `linkedin: string`\n URL to the blog author's LinkedIn page.\n\n- `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n\n- `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n\n- `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n\n- `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n\n- `website: string`\n URL to the website of the Blog Author.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.create({\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.create({\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.create(\n id="id",\n avatar="avatar",\n bio="bio",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n display_name="displayName",\n email="email",\n facebook="facebook",\n full_name="fullName",\n language="aa",\n linkedin="linkedin",\n name="name",\n slug="slug",\n translated_from_id=0,\n twitter="twitter",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n website="website",\n)\nprint(author)\ncontent = author.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogAuthor params = BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build();\n HttpResponse author = client.cms().blogs().authors().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.New(context.TODO(), cms.BlogAuthorNewParams{\n\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\tID: "id",\n\t\t\tAvatar: "avatar",\n\t\t\tBio: "bio",\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tDisplayName: "displayName",\n\t\t\tEmail: "email",\n\t\t\tFacebook: "facebook",\n\t\t\tFullName: "fullName",\n\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\tLinkedin: "linkedin",\n\t\t\tName: "name",\n\t\t\tSlug: "slug",\n\t\t\tTranslatedFromID: 0,\n\t\t\tTwitter: "twitter",\n\t\t\tUpdated: time.Now(),\n\t\t\tWebsite: "website",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.create(\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n display_name: "displayName",\n email: "email",\n facebook: "facebook",\n full_name: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n)\n\nputs(author)', + }, + php: { + method: 'cms->blogs->authors->create', + example: + "cms->blogs->authors->create(\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n twitter: 'twitter',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n website: 'website',\n);\n\nvar_dump($author);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\'', + }, + }, + }, + { + name: 'create_language_variation', + endpoint: '/cms/blogs/2026-03/authors/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a new language variation', + description: 'Create a new language variation from an existing Blog Author.', + stainlessPath: '(resource) cms.blogs.authors > (method) create_language_variation', + qualified: 'client.cms.blogs.authors.createLanguageVariation', + params: [ + 'id: string;', + 'blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; };', + 'language?: string;', + 'primaryLanguage?: string;', + 'usePublished?: boolean;', + ], + response: 'string', + markdown: + "## create_language_variation\n\n`client.cms.blogs.authors.createLanguageVariation(id: string, blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }, language?: string, primaryLanguage?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/create-language-variation`\n\nCreate a new language variation from an existing Blog Author.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }`\n - `id: string`\n The unique ID of the Blog Author.\n - `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n - `bio: string`\n A short biography of the blog author.\n - `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n - `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n - `displayName: string`\n The full name of the Blog Author to be displayed.\n - `email: string`\n Email address of the Blog Author.\n - `facebook: string`\n URL to the Blog Author's Facebook page.\n - `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n - `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n - `linkedin: string`\n URL to the blog author's LinkedIn page.\n - `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n - `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n - `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n - `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n - `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n - `website: string`\n URL to the website of the Blog Author.\n\n- `language?: string`\n Language of newly cloned object.\n\n- `primaryLanguage?: string`\n Primary language in multi-language group.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.createLanguageVariation({\n id: 'id',\n blogAuthor: {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n},\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.createLanguageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.createLanguageVariation({\n id: 'id',\n blogAuthor: {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n },\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.create_language_variation', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.create_language_variation(\n id="id",\n blog_author={\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "display_name": "displayName",\n "email": "email",\n "facebook": "facebook",\n "full_name": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "twitter": "twitter",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "website": "website",\n },\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().createLanguageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthorCloneRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogAuthorCloneRequestVNext params = BlogAuthorCloneRequestVNext.builder()\n .id("id")\n .blogAuthor(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse response = client.cms().blogs().authors().createLanguageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.NewLanguageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.NewLanguageVariation(context.TODO(), cms.BlogAuthorNewLanguageVariationParams{\n\t\tBlogAuthorCloneRequestVNext: cms.BlogAuthorCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.create_language_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.create_language_variation(\n id: "id",\n blog_author: {\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n displayName: "displayName",\n email: "email",\n facebook: "facebook",\n fullName: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n }\n)\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->createLanguageVariation', + example: + "cms->blogs->authors->createLanguageVariation(\n id: 'id',\n blogAuthor: [\n 'id' => 'id',\n 'avatar' => 'avatar',\n 'bio' => 'bio',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'displayName' => 'displayName',\n 'email' => 'email',\n 'facebook' => 'facebook',\n 'fullName' => 'fullName',\n 'language' => 'aa',\n 'linkedin' => 'linkedin',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'twitter' => 'twitter',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'website' => 'website',\n ],\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "blogAuthor": {\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/authors/{objectId}', + httpMethod: 'delete', + summary: 'Delete a Blog Author', + description: 'Delete the Blog Author object identified by the id in the path.', + stainlessPath: '(resource) cms.blogs.authors > (method) delete', + qualified: 'client.cms.blogs.authors.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.blogs.authors.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/authors/{objectId}`\n\nDelete the Blog Author object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.delete('objectId');", + }, + python: { + method: 'cms.blogs.authors.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().blogs().authors().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().authors().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->authors->delete', + example: + "cms->blogs->authors->delete('objectId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Detach a Blog Author from a multi-language group', + description: 'Detach a Blog Author from a multi-language group.', + stainlessPath: '(resource) cms.blogs.authors > (method) detach_from_lang_group', + qualified: 'client.cms.blogs.authors.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.blogs.authors.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group`\n\nDetach a Blog Author from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().authors().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.DetachFromLangGroup(context.TODO(), cms.BlogAuthorDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->detachFromLangGroup', + example: + "cms->blogs->authors->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blogs/2026-03/authors/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a Blog Author', + description: 'Retrieve the Blog Author object identified by the id in the path.', + stainlessPath: '(resource) cms.blogs.authors > (method) get', + qualified: 'client.cms.blogs.authors.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: 'string', + markdown: + "## get\n\n`client.cms.blogs.authors.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/{objectId}`\n\nRetrieve the Blog Author object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.get('objectId');\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.get('objectId');\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.get(\n object_id="objectId",\n)\nprint(author)\ncontent = author.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse author = client.cms().blogs().authors().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.get("objectId")\n\nputs(author)', + }, + php: { + method: 'cms->blogs->authors->get', + example: + "cms->blogs->authors->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($author);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_cursor', + endpoint: '/cms/blogs/2026-03/authors/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_cursor', + qualified: 'client.cms.blogs.authors.getCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_cursor\n\n`client.cms.blogs.authors.getCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetCursor(context.TODO(), cms.BlogAuthorGetCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getCursor', + example: + "cms->blogs->authors->getCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_cursor_by_query', + endpoint: '/cms/blogs/2026-03/authors/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_cursor_by_query', + qualified: 'client.cms.blogs.authors.getCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_cursor_by_query\n\n`client.cms.blogs.authors.getCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetCursorByQuery(context.TODO(), cms.BlogAuthorGetCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getCursorByQuery', + example: + "cms->blogs->authors->getCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_posts_cursor', + endpoint: '/cms/blogs/2026-03/posts/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_posts_cursor', + qualified: 'client.cms.blogs.authors.getPostsCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_posts_cursor\n\n`client.cms.blogs.authors.getPostsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getPostsCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_posts_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_posts_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getPostsCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetPostsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getPostsCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetPostsCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetPostsCursor(context.TODO(), cms.BlogAuthorGetPostsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_posts_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_posts_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getPostsCursor', + example: + "cms->blogs->authors->getPostsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_posts_cursor_by_query', + endpoint: '/cms/blogs/2026-03/posts/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_posts_cursor_by_query', + qualified: 'client.cms.blogs.authors.getPostsCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_posts_cursor_by_query\n\n`client.cms.blogs.authors.getPostsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getPostsCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_posts_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_posts_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getPostsCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetPostsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getPostsCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetPostsCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetPostsCursorByQuery(context.TODO(), cms.BlogAuthorGetPostsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_posts_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_posts_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getPostsCursorByQuery', + example: + "cms->blogs->authors->getPostsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_tags_cursor', + endpoint: '/cms/blogs/2026-03/tags/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_tags_cursor', + qualified: 'client.cms.blogs.authors.getTagsCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_tags_cursor\n\n`client.cms.blogs.authors.getTagsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getTagsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getTagsCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getTagsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_tags_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_tags_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getTagsCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetTagsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getTagsCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetTagsCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetTagsCursor(context.TODO(), cms.BlogAuthorGetTagsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_tags_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_tags_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getTagsCursor', + example: + "cms->blogs->authors->getTagsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_tags_cursor_by_query', + endpoint: '/cms/blogs/2026-03/tags/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.authors > (method) get_tags_cursor_by_query', + qualified: 'client.cms.blogs.authors.getTagsCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## get_tags_cursor_by_query\n\n`client.cms.blogs.authors.getTagsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getTagsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.getTagsCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getTagsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.get_tags_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_tags_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().getTagsCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetTagsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getTagsCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.GetTagsCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetTagsCursorByQuery(context.TODO(), cms.BlogAuthorGetTagsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.get_tags_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_tags_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->getTagsCursorByQuery', + example: + "cms->blogs->authors->getTagsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/blogs/2026-03/authors', + httpMethod: 'get', + summary: 'Get all Blog Authors', + description: + 'Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', + stainlessPath: '(resource) cms.blogs.authors > (method) list', + qualified: 'client.cms.blogs.authors.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list\n\n`client.cms.blogs.authors.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors`\n\nGet the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst authors = await client.cms.blogs.authors.list();\n\nconsole.log(authors);\n\nconst content = await authors.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst authors = await client.cms.blogs.authors.list();\n\nconsole.log(authors);\n\nconst content = await authors.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthors = client.cms.blogs.authors.list()\nprint(authors)\ncontent = authors.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse authors = client.cms().blogs().authors().list();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthors, err := client.Cms.Blogs.Authors.List(context.TODO(), cms.BlogAuthorListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", authors)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthors = hubspot.cms.blogs.authors.list\n\nputs(authors)', + }, + php: { + method: 'cms->blogs->authors->list', + example: + "cms->blogs->authors->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($authors);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'set_new_lang_primary', + endpoint: '/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set a new primary language', + description: 'Set a Blog Author as the primary language of a multi-language group.', + stainlessPath: '(resource) cms.blogs.authors > (method) set_new_lang_primary', + qualified: 'client.cms.blogs.authors.setNewLangPrimary', + params: ['id: string;'], + markdown: + "## set_new_lang_primary\n\n`client.cms.blogs.authors.setNewLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary`\n\nSet a Blog Author as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.setNewLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.setNewLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.setNewLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.blogs.authors.set_new_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.set_new_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().blogs().authors().setNewLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().authors().setNewLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.SetNewLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.SetNewLangPrimary(context.TODO(), cms.BlogAuthorSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.set_new_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.set_new_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->authors->setNewLangPrimary', + example: + "cms->blogs->authors->setNewLangPrimary(id: 'id');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/blogs/2026-03/authors/{objectId}', + httpMethod: 'patch', + summary: 'Update a Blog Author', + description: + 'Sparse updates a single Blog Author object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n', + stainlessPath: '(resource) cms.blogs.authors > (method) update', + qualified: 'client.cms.blogs.authors.update', + params: [ + 'objectId: string;', + 'id: string;', + 'avatar: string;', + 'bio: string;', + 'created: string;', + 'deletedAt: string;', + 'displayName: string;', + 'email: string;', + 'facebook: string;', + 'fullName: string;', + 'language: string;', + 'linkedin: string;', + 'name: string;', + 'slug: string;', + 'translatedFromId: number;', + 'twitter: string;', + 'updated: string;', + 'website: string;', + 'archived?: boolean;', + ], + response: 'string', + markdown: + "## update\n\n`client.cms.blogs.authors.update(objectId: string, id: string, avatar: string, bio: string, created: string, deletedAt: string, displayName: string, email: string, facebook: string, fullName: string, language: string, linkedin: string, name: string, slug: string, translatedFromId: number, twitter: string, updated: string, website: string, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/authors/{objectId}`\n\nSparse updates a single Blog Author object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Author.\n\n- `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n\n- `bio: string`\n A short biography of the blog author.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n\n- `displayName: string`\n The full name of the Blog Author to be displayed.\n\n- `email: string`\n Email address of the Blog Author.\n\n- `facebook: string`\n URL to the Blog Author's Facebook page.\n\n- `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n\n- `linkedin: string`\n URL to the blog author's LinkedIn page.\n\n- `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n\n- `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n\n- `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n\n- `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n\n- `website: string`\n URL to the website of the Blog Author.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.update('objectId', {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.update('objectId', {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.update(\n object_id="objectId",\n id="id",\n avatar="avatar",\n bio="bio",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n display_name="displayName",\n email="email",\n facebook="facebook",\n full_name="fullName",\n language="aa",\n linkedin="linkedin",\n name="name",\n slug="slug",\n translated_from_id=0,\n twitter="twitter",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n website="website",\n)\nprint(author)\ncontent = author.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorUpdateParams;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AuthorUpdateParams params = AuthorUpdateParams.builder()\n .objectId("objectId")\n .blogAuthor(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse author = client.cms().blogs().authors().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorUpdateParams{\n\t\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.update(\n "objectId",\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n display_name: "displayName",\n email: "email",\n facebook: "facebook",\n full_name: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n)\n\nputs(author)', + }, + php: { + method: 'cms->blogs->authors->update', + example: + "cms->blogs->authors->update(\n 'objectId',\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n twitter: 'twitter',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n website: 'website',\n archived: true,\n);\n\nvar_dump($author);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\'', + }, + }, + }, + { + name: 'update_languages', + endpoint: '/cms/blogs/2026-03/authors/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update languages of multi-language group', + description: 'Explicitly set new languages for each Blog Author in a multi-language group.', + stainlessPath: '(resource) cms.blogs.authors > (method) update_languages', + qualified: 'client.cms.blogs.authors.updateLanguages', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_languages\n\n`client.cms.blogs.authors.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/update-languages`\n\nExplicitly set new languages for each Blog Author in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.updateLanguages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.update_languages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().updateLanguages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().authors().updateLanguages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.UpdateLanguages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.UpdateLanguages(context.TODO(), cms.BlogAuthorUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.update_languages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.update_languages(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->authors->updateLanguages', + example: + "cms->blogs->authors->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/blogs/2026-03/authors/batch/create', + httpMethod: 'post', + summary: 'Create a batch of Blog Authors', + description: 'Create the Blog Author objects detailed in the request body.', + stainlessPath: '(resource) cms.blogs.authors.batch > (method) create', + qualified: 'client.cms.blogs.authors.batch.create', + params: [ + 'inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[];', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.blogs.authors.batch.create(inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[]): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/create`\n\nCreate the Blog Author objects detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[]`\n Blog authors to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.create({ inputs: [{\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.create({\n inputs: [\n {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n },\n ],\n});\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.batch.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.create(\n inputs=[{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "display_name": "displayName",\n "email": "email",\n "facebook": "facebook",\n "full_name": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "twitter": "twitter",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "website": "website",\n }],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BatchInputBlogAuthor;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputBlogAuthor params = BatchInputBlogAuthor.builder()\n .addInput(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.New(context.TODO(), cms.BlogAuthorBatchNewParams{\n\t\tBatchInputBlogAuthor: cms.BatchInputBlogAuthorParam{\n\t\t\tInputs: []cms.BlogAuthorParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.create(\n inputs: [\n {\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n displayName: "displayName",\n email: "email",\n facebook: "facebook",\n fullName: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n }\n ]\n)\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->authors->batch->create', + example: + "cms->blogs->authors->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'avatar' => 'avatar',\n 'bio' => 'bio',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'displayName' => 'displayName',\n 'email' => 'email',\n 'facebook' => 'facebook',\n 'fullName' => 'fullName',\n 'language' => 'aa',\n 'linkedin' => 'linkedin',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'twitter' => 'twitter',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'website' => 'website',\n ],\n ],\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/authors/batch/archive', + httpMethod: 'post', + summary: 'Delete a batch of Blog Authors', + description: 'Delete the Blog Author objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.authors.batch > (method) delete', + qualified: 'client.cms.blogs.authors.batch.delete', + params: ['inputs: string[];'], + markdown: + "## delete\n\n`client.cms.blogs.authors.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/authors/batch/archive`\n\nDelete the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.batch.delete({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.batch.delete({ inputs: ['string'] });", + }, + python: { + method: 'cms.blogs.authors.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.batch.delete(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().blogs().authors().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().authors().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.Batch.Delete(context.TODO(), cms.BlogAuthorBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.batch.delete(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->blogs->authors->batch->delete', + example: + "cms->blogs->authors->batch->delete(inputs: ['string']);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blogs/2026-03/authors/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of Blog Authors', + description: 'Retrieve the Blog Author objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.authors.batch > (method) get', + qualified: 'client.cms.blogs.authors.batch.get', + params: ['inputs: string[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## get\n\n`client.cms.blogs.authors.batch.get(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/read`\n\nRetrieve the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.get(\n inputs=["string"],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.Get(context.TODO(), cms.BlogAuthorBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.get(inputs: ["string"])\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->authors->batch->get', + example: + "cms->blogs->authors->batch->get(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/blogs/2026-03/authors/batch/update', + httpMethod: 'post', + summary: 'Update a batch of Blog Authors', + description: 'Update the Blog Author objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.authors.batch > (method) update', + qualified: 'client.cms.blogs.authors.batch.update', + params: ['inputs: object[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## update\n\n`client.cms.blogs.authors.batch.update(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/update`\n\nUpdate the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.authors.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.authors.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.update(\n inputs=[{}],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().authors().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Authors.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.Update(context.TODO(), cms.BlogAuthorBatchUpdateParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.authors.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.update(inputs: [{}])\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->authors->batch->update', + example: + "cms->blogs->authors->batch->update(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'clone', + endpoint: '/cms/blogs/2026-03/posts/clone', + httpMethod: 'post', + summary: 'Clone a blog post', + description: 'Clone a blog post, making a copy of it in a new blog post.', + stainlessPath: '(resource) cms.blogs.posts > (method) clone', + qualified: 'client.cms.blogs.posts.clone', + params: ['id: string;', 'cloneName?: string;'], + response: 'string', + markdown: + "## clone\n\n`client.cms.blogs.posts.clone(id: string, cloneName?: string): string`\n\n**post** `/cms/blogs/2026-03/posts/clone`\n\nClone a blog post, making a copy of it in a new blog post.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.clone({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.clone', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.clone({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.clone', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.clone(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().clone', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().clone(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Clone', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Clone(context.TODO(), cms.BlogPostCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.clone_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.clone_(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->clone', + example: + "cms->blogs->posts->clone(id: 'id', cloneName: 'cloneName');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/blogs/2026-03/posts', + httpMethod: 'post', + summary: 'Create a new post', + description: 'Create a new blog post, specifying its content in the request body.', + stainlessPath: '(resource) cms.blogs.posts > (method) create', + qualified: 'client.cms.blogs.posts.create', + params: [ + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: number;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'blogAuthorId: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableGoogleAmpOutputOverride: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'password: string;', + 'postBody: string;', + 'postSummary: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'rssBody: string;', + 'rssSummary: string;', + 'slug: string;', + 'state: string;', + 'tagIds: number[];', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.blogs.posts.create(id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): string`\n\n**post** `/cms/blogs/2026-03/posts`\n\nCreate a new blog post, specifying its content in the request body.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(post)\ncontent = post.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogPost params = BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n HttpResponse post = client.cms().blogs().posts().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.New(context.TODO(), cms.BlogPostNewParams{\n\t\tBlogPost: cms.BlogPostParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: 0,\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPassword: "password",\n\t\t\tPostBody: "postBody",\n\t\t\tPostSummary: "postSummary",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tRssBody: "rssBody",\n\t\t\tRssSummary: "rssSummary",\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tTagIDs: []int64{0},\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(post)', + }, + php: { + method: 'cms->blogs->posts->create', + example: + "cms->blogs->posts->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($post);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/posts/{objectId}', + httpMethod: 'delete', + summary: 'Delete a blog post', + description: 'Delete a blog post by ID.', + stainlessPath: '(resource) cms.blogs.posts > (method) delete', + qualified: 'client.cms.blogs.posts.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.blogs.posts.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/posts/{objectId}`\n\nDelete a blog post by ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.delete('objectId');", + }, + python: { + method: 'cms.blogs.posts.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().blogs().posts().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->delete', + example: + "cms->blogs->posts->delete('objectId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blogs/2026-03/posts/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a blog post', + description: 'Retrieve a blog post by the post ID.', + stainlessPath: '(resource) cms.blogs.posts > (method) get', + qualified: 'client.cms.blogs.posts.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: 'string', + markdown: + "## get\n\n`client.cms.blogs.posts.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}`\n\nRetrieve a blog post by the post ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.get('objectId');\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.get('objectId');\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.get(\n object_id="objectId",\n)\nprint(post)\ncontent = post.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse post = client.cms().blogs().posts().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.get("objectId")\n\nputs(post)', + }, + php: { + method: 'cms->blogs->posts->get', + example: + "cms->blogs->posts->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($post);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_draft_by_id', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft', + httpMethod: 'get', + summary: 'Retrieve the full draft version of the Blog Post', + description: 'Retrieve the full draft version of a blog post.', + stainlessPath: '(resource) cms.blogs.posts > (method) get_draft_by_id', + qualified: 'client.cms.blogs.posts.getDraftByID', + params: ['objectId: string;'], + response: 'string', + markdown: + "## get_draft_by_id\n\n`client.cms.blogs.posts.getDraftByID(objectId: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/draft`\n\nRetrieve the full draft version of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.getDraftByID('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.getDraftByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.getDraftByID('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.get_draft_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.get_draft_by_id(\n "objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().getDraftById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostGetDraftByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().getDraftById("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.GetDraftByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.GetDraftByID(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.get_draft_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.get_draft_by_id("objectId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->getDraftByID', + example: + "cms->blogs->posts->getDraftByID('objectId');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/blogs/2026-03/posts/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) list', + qualified: 'client.cms.blogs.posts.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list\n\n`client.cms.blogs.posts.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst posts = await client.cms.blogs.posts.list();\n\nconsole.log(posts);\n\nconst content = await posts.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst posts = await client.cms.blogs.posts.list();\n\nconsole.log(posts);\n\nconst content = await posts.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nposts = client.cms.blogs.posts.list()\nprint(posts)\ncontent = posts.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse posts = client.cms().blogs().posts().list();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tposts, err := client.Cms.Blogs.Posts.List(context.TODO(), cms.BlogPostListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", posts)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nposts = hubspot.cms.blogs.posts.list\n\nputs(posts)', + }, + php: { + method: 'cms->blogs->posts->list', + example: + "cms->blogs->posts->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($posts);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_authors', + endpoint: '/cms/blogs/2026-03/authors/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) list_authors', + qualified: 'client.cms.blogs.posts.listAuthors', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_authors\n\n`client.cms.blogs.posts.listAuthors(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.listAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.listAuthors', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.listAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.list_authors', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.list_authors()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().listAuthors', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListAuthorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().listAuthors();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.ListAuthors', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.ListAuthors(context.TODO(), cms.BlogPostListAuthorsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.list_authors', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.list_authors\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->listAuthors', + example: + "cms->blogs->posts->listAuthors(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_tags', + endpoint: '/cms/blogs/2026-03/tags/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) list_tags', + qualified: 'client.cms.blogs.posts.listTags', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_tags\n\n`client.cms.blogs.posts.listTags(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.listTags();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.listTags', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.listTags();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.list_tags', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.list_tags()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().listTags', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListTagsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().listTags();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.ListTags', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.ListTags(context.TODO(), cms.BlogPostListTagsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.list_tags', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.list_tags\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->listTags', + example: + "cms->blogs->posts->listTags(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'push_live', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft/push-live', + httpMethod: 'post', + summary: 'Publish blog post draft', + description: 'Publish the draft version of the blog post, sending its content to the live page.', + stainlessPath: '(resource) cms.blogs.posts > (method) push_live', + qualified: 'client.cms.blogs.posts.pushLive', + params: ['objectId: string;'], + markdown: + "## push_live\n\n`client.cms.blogs.posts.pushLive(objectId: string): void`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/draft/push-live`\n\nPublish the draft version of the blog post, sending its content to the live page.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.pushLive('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.pushLive', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.pushLive('objectId');", + }, + python: { + method: 'cms.blogs.posts.push_live', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.push_live(\n "objectId",\n)', + }, + java: { + method: 'cms().blogs().posts().pushLive', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostPushLiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().pushLive("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.PushLive', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.PushLive(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.push_live', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.push_live("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->pushLive', + example: + "cms->blogs->posts->pushLive('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'query', + endpoint: '/cms/blogs/2026-03/posts/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) query', + qualified: 'client.cms.blogs.posts.query', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## query\n\n`client.cms.blogs.posts.query(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.query();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.query', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.query();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().query', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().query();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Query', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Query(context.TODO(), cms.BlogPostQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->query', + example: + "cms->blogs->posts->query(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'query_authors', + endpoint: '/cms/blogs/2026-03/authors/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) query_authors', + qualified: 'client.cms.blogs.posts.queryAuthors', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## query_authors\n\n`client.cms.blogs.posts.queryAuthors(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.queryAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.queryAuthors', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.queryAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.query_authors', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query_authors()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().queryAuthors', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryAuthorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().queryAuthors();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.QueryAuthors', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.QueryAuthors(context.TODO(), cms.BlogPostQueryAuthorsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.query_authors', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query_authors\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->queryAuthors', + example: + "cms->blogs->posts->queryAuthors(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'query_tags', + endpoint: '/cms/blogs/2026-03/tags/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.posts > (method) query_tags', + qualified: 'client.cms.blogs.posts.queryTags', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## query_tags\n\n`client.cms.blogs.posts.queryTags(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.queryTags();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.queryTags', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.queryTags();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.query_tags', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query_tags()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().queryTags', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryTagsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().queryTags();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.QueryTags', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.QueryTags(context.TODO(), cms.BlogPostQueryTagsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.query_tags', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query_tags\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->queryTags', + example: + "cms->blogs->posts->queryTags(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset_draft', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft/reset', + httpMethod: 'post', + summary: 'Reset post draft to the live version', + description: + 'Discard all drafted content, resetting the draft to contain the content in the currently published version.', + stainlessPath: '(resource) cms.blogs.posts > (method) reset_draft', + qualified: 'client.cms.blogs.posts.resetDraft', + params: ['objectId: string;'], + markdown: + "## reset_draft\n\n`client.cms.blogs.posts.resetDraft(objectId: string): void`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/draft/reset`\n\nDiscard all drafted content, resetting the draft to contain the content in the currently published version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.resetDraft('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.resetDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.resetDraft('objectId');", + }, + python: { + method: 'cms.blogs.posts.reset_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.reset_draft(\n "objectId",\n)', + }, + java: { + method: 'cms().blogs().posts().resetDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().resetDraft("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.ResetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.ResetDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.reset_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.reset_draft("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->resetDraft', + example: + "cms->blogs->posts->resetDraft('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'schedule', + endpoint: '/cms/blogs/2026-03/posts/schedule', + httpMethod: 'post', + summary: 'Schedule a post to be published', + description: 'Schedule a blog post to be published at a specified time.', + stainlessPath: '(resource) cms.blogs.posts > (method) schedule', + qualified: 'client.cms.blogs.posts.schedule', + params: ['id: string;', 'publishDate: string;'], + markdown: + "## schedule\n\n`client.cms.blogs.posts.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/blogs/2026-03/posts/schedule`\n\nSchedule a blog post to be published at a specified time.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.schedule', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", + }, + python: { + method: 'cms.blogs.posts.schedule', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', + }, + java: { + method: 'cms().blogs().posts().schedule', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().blogs().posts().schedule(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Schedule', + example: + 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Schedule(context.TODO(), cms.BlogPostScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.schedule', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->schedule', + example: + "cms->blogs->posts->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/blogs/2026-03/posts/{objectId}', + httpMethod: 'patch', + summary: 'Update a post', + description: + 'Partially updates a single blog post by ID. You only need to specify the values that you want to update.', + stainlessPath: '(resource) cms.blogs.posts > (method) update', + qualified: 'client.cms.blogs.posts.update', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: number;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'blogAuthorId: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableGoogleAmpOutputOverride: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'password: string;', + 'postBody: string;', + 'postSummary: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'rssBody: string;', + 'rssSummary: string;', + 'slug: string;', + 'state: string;', + 'tagIds: number[];', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + 'archived?: boolean;', + ], + response: 'string', + markdown: + "## update\n\n`client.cms.blogs.posts.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/posts/{objectId}`\n\nPartially updates a single blog post by ID. You only need to specify the values that you want to update.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(post)\ncontent = post.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostUpdateParams params = PostUpdateParams.builder()\n .objectId("objectId")\n .blogPost(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse post = client.cms().blogs().posts().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostUpdateParams{\n\t\t\tBlogPost: cms.BlogPostParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(post)', + }, + php: { + method: 'cms->blogs->posts->update', + example: + "cms->blogs->posts->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($post);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'update_draft', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft', + httpMethod: 'patch', + summary: 'Update the draft of a post', + description: + 'Partially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update.', + stainlessPath: '(resource) cms.blogs.posts > (method) update_draft', + qualified: 'client.cms.blogs.posts.updateDraft', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: number;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'blogAuthorId: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableGoogleAmpOutputOverride: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'password: string;', + 'postBody: string;', + 'postSummary: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'rssBody: string;', + 'rssSummary: string;', + 'slug: string;', + 'state: string;', + 'tagIds: number[];', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'string', + markdown: + "## update_draft\n\n`client.cms.blogs.posts.updateDraft(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): string`\n\n**patch** `/cms/blogs/2026-03/posts/{objectId}/draft`\n\nPartially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.updateDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.update_draft', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.update_draft(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().updateDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostUpdateDraftParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostUpdateDraftParams params = PostUpdateDraftParams.builder()\n .objectId("objectId")\n .blogPost(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse response = client.cms().blogs().posts().updateDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.UpdateDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostUpdateDraftParams{\n\t\t\tBlogPost: cms.BlogPostParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.update_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.update_draft(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->updateDraft', + example: + "cms->blogs->posts->updateDraft(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/blogs/2026-03/posts/batch/create', + httpMethod: 'post', + summary: 'Create a batch of blog posts', + description: 'Create a batch of blog posts, specifying their content in the request body.', + stainlessPath: '(resource) cms.blogs.posts.batch > (method) create', + qualified: 'client.cms.blogs.posts.batch.create', + params: [ + 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.blogs.posts.batch.create(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/create`\n\nCreate a batch of blog posts, specifying their content in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Blog posts to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.create({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.create({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.batch.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.create(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": 0,\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "blog_author_id": "blogAuthorId",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_google_amp_output_override": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "password": "password",\n "post_body": "postBody",\n "post_summary": "postSummary",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "rss_body": "rssBody",\n "rss_summary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tag_ids": [0],\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BatchInputBlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputBlogPost params = BatchInputBlogPost.builder()\n .addInput(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.New(context.TODO(), cms.BlogPostBatchNewParams{\n\t\tBatchInputBlogPost: cms.BatchInputBlogPostParam{\n\t\t\tInputs: []cms.BlogPostParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.create(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n blogAuthorId: "blogAuthorId",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n password: "password",\n postBody: "postBody",\n postSummary: "postSummary",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n rssBody: "rssBody",\n rssSummary: "rssSummary",\n slug: "slug",\n state: "state",\n tagIds: [0],\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->posts->batch->create', + example: + "cms->blogs->posts->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => 0,\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'blogAuthorID' => 'blogAuthorId',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableGoogleAmpOutputOverride' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'password' => 'password',\n 'postBody' => 'postBody',\n 'postSummary' => 'postSummary',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'rssBody' => 'rssBody',\n 'rssSummary' => 'rssSummary',\n 'slug' => 'slug',\n 'state' => 'state',\n 'tagIDs' => [0],\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/posts/batch/archive', + httpMethod: 'post', + summary: 'Delete a batch of blog posts', + description: + 'Delete a blog post by ID. \nNote: This is not the same as the in-app `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', + stainlessPath: '(resource) cms.blogs.posts.batch > (method) delete', + qualified: 'client.cms.blogs.posts.batch.delete', + params: ['inputs: string[];'], + markdown: + "## delete\n\n`client.cms.blogs.posts.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/posts/batch/archive`\n\nDelete a blog post by ID. \nNote: This is not the same as the in-app `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.batch.delete({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.batch.delete({ inputs: ['string'] });", + }, + python: { + method: 'cms.blogs.posts.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.batch.delete(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().blogs().posts().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().posts().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Batch.Delete(context.TODO(), cms.BlogPostBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.batch.delete(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->batch->delete', + example: + "cms->blogs->posts->batch->delete(inputs: ['string']);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blogs/2026-03/posts/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of Blog Posts', + description: 'Retrieve a batch of blog posts by ID. identified in the request body.', + stainlessPath: '(resource) cms.blogs.posts.batch > (method) get', + qualified: 'client.cms.blogs.posts.batch.get', + params: ['inputs: string[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## get\n\n`client.cms.blogs.posts.batch.get(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/read`\n\nRetrieve a batch of blog posts by ID. identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.get(\n inputs=["string"],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.Get(context.TODO(), cms.BlogPostBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.get(inputs: ["string"])\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->posts->batch->get', + example: + "cms->blogs->posts->batch->get(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/blogs/2026-03/posts/batch/update', + httpMethod: 'post', + summary: 'Update a batch of Blog Posts', + description: 'Update a batch of blog posts.', + stainlessPath: '(resource) cms.blogs.posts.batch > (method) update', + qualified: 'client.cms.blogs.posts.batch.update', + params: ['inputs: object[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## update\n\n`client.cms.blogs.posts.batch.update(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/update`\n\nUpdate a batch of blog posts.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.update(\n inputs=[{}],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.Update(context.TODO(), cms.BlogPostBatchUpdateParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.update(inputs: [{}])\n\nputs(batch)', + }, + php: { + method: 'cms->blogs->posts->batch->update', + example: + "cms->blogs->posts->batch->update(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batch);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Attach post to a multi-language group', + description: + 'Attach a blog post to a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', + stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) attach_to_lang_group', + qualified: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.blogs.posts.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group`\n\nAttach a blog post to a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.multi_language.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().multiLanguage().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.MultiLanguage.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.AttachToLangGroup(context.TODO(), cms.BlogPostMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.multi_language.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->multiLanguage->attachToLangGroup', + example: + "cms->blogs->posts->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create_lang_variation', + endpoint: '/cms/blogs/2026-03/posts/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a language variation', + description: 'Create a new language variation from an existing blog post', + stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) create_lang_variation', + qualified: 'client.cms.blogs.posts.multiLanguage.createLangVariation', + params: ['id: string;', 'language?: string;', 'usePublished?: boolean;'], + response: 'string', + markdown: + "## create_lang_variation\n\n`client.cms.blogs.posts.multiLanguage.createLangVariation(id: string, language?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/create-language-variation`\n\nCreate a new language variation from an existing blog post\n\n### Parameters\n\n- `id: string`\n ID of blog post to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.createLangVariation({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.multiLanguage.createLangVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.createLangVariation({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.multi_language.create_lang_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.create_lang_variation(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().multiLanguage().createLangVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPostLanguageCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogPostLanguageCloneRequestVNext params = BlogPostLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().createLangVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.MultiLanguage.NewLangVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.NewLangVariation(context.TODO(), cms.BlogPostMultiLanguageNewLangVariationParams{\n\t\tBlogPostLanguageCloneRequestVNext: cms.BlogPostLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.multi_language.create_lang_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.create_lang_variation(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->multiLanguage->createLangVariation', + example: + "cms->blogs->posts->multiLanguage->createLangVariation(\n id: 'id', language: 'language', usePublished: true\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Detach post from a multi-language group', + description: + 'Detach a blog post from a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', + stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) detach_from_lang_group', + qualified: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.blogs.posts.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group`\n\nDetach a blog post from a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.multi_language.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().multiLanguage().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.MultiLanguage.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.BlogPostMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.multi_language.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->multiLanguage->detachFromLangGroup', + example: + "cms->blogs->posts->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'set_lang_primary', + endpoint: '/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set a new primary language', + description: + 'Set the primary language of a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content) to the language of the provided post (specified as an ID in the request body)', + stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) set_lang_primary', + qualified: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', + params: ['id: string;'], + markdown: + "## set_lang_primary\n\n`client.cms.blogs.posts.multiLanguage.setLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary`\n\nSet the primary language of a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content) to the language of the provided post (specified as an ID in the request body)\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.multiLanguage.setLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.multiLanguage.setLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.blogs.posts.multi_language.set_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.multi_language.set_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().blogs().posts().multiLanguage().setLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().posts().multiLanguage().setLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.MultiLanguage.SetLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.MultiLanguage.SetLangPrimary(context.TODO(), cms.BlogPostMultiLanguageSetLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.multi_language.set_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.multi_language.set_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->posts->multiLanguage->setLangPrimary', + example: + "cms->blogs->posts->multiLanguage->setLangPrimary(id: 'id');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update_langs', + endpoint: '/cms/blogs/2026-03/posts/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update languages of multi-language group', + description: + 'Explicitly set new languages for each post in a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', + stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) update_langs', + qualified: 'client.cms.blogs.posts.multiLanguage.updateLangs', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_langs\n\n`client.cms.blogs.posts.multiLanguage.updateLangs(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/update-languages`\n\nExplicitly set new languages for each post in a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.multiLanguage.updateLangs', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.multi_language.update_langs', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.update_langs(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().multiLanguage().updateLangs', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().updateLangs(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.MultiLanguage.UpdateLangs', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.UpdateLangs(context.TODO(), cms.BlogPostMultiLanguageUpdateLangsParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.multi_language.update_langs', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.update_langs(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->multiLanguage->updateLangs', + example: + "cms->blogs->posts->multiLanguage->updateLangs(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'get_previous_version', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Retrieve a previous version of a blog post', + description: 'Retrieve a previous version of a blog post.', + stainlessPath: '(resource) cms.blogs.posts.revisions > (method) get_previous_version', + qualified: 'client.cms.blogs.posts.revisions.getPreviousVersion', + params: ['objectId: string;', 'revisionId: string;'], + response: 'string', + markdown: + "## get_previous_version\n\n`client.cms.blogs.posts.revisions.getPreviousVersion(objectId: string, revisionId: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersion('revisionId', { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.revisions.getPreviousVersion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersion('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.revisions.get_previous_version', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.get_previous_version(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().revisions().getPreviousVersion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionGetPreviousVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetPreviousVersionParams params = RevisionGetPreviousVersionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().getPreviousVersion(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Revisions.GetPreviousVersion', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.GetPreviousVersion(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogPostRevisionGetPreviousVersionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.revisions.get_previous_version', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.get_previous_version("revisionId", object_id_: "objectId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->revisions->getPreviousVersion', + example: + "cms->blogs->posts->revisions->getPreviousVersion(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_previous_versions', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions', + httpMethod: 'get', + summary: 'Retrieves all previous versions of a post', + description: 'Retrieve all the previous versions of a blog post.', + stainlessPath: '(resource) cms.blogs.posts.revisions > (method) get_previous_versions', + qualified: 'client.cms.blogs.posts.revisions.getPreviousVersions', + params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: 'string', + markdown: + "## get_previous_versions\n\n`client.cms.blogs.posts.revisions.getPreviousVersions(objectId: string, after?: string, before?: string, limit?: number): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/revisions`\n\nRetrieve all the previous versions of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersions('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.revisions.getPreviousVersions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersions('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.revisions.get_previous_versions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.get_previous_versions(\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().revisions().getPreviousVersions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionGetPreviousVersionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().revisions().getPreviousVersions("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Revisions.GetPreviousVersions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.GetPreviousVersions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostRevisionGetPreviousVersionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.revisions.get_previous_versions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.get_previous_versions("objectId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->revisions->getPreviousVersions', + example: + "cms->blogs->posts->revisions->getPreviousVersions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_previous_version', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore', + httpMethod: 'post', + summary: 'Restore a previous version', + description: 'Restores a blog post to one of its previous versions.', + stainlessPath: '(resource) cms.blogs.posts.revisions > (method) restore_previous_version', + qualified: 'client.cms.blogs.posts.revisions.restorePreviousVersion', + params: ['objectId: string;', 'revisionId: string;'], + response: 'string', + markdown: + "## restore_previous_version\n\n`client.cms.blogs.posts.revisions.restorePreviousVersion(objectId: string, revisionId: string): string`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore`\n\nRestores a blog post to one of its previous versions.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersion('revisionId', { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.revisions.restorePreviousVersion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersion('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.revisions.restore_previous_version', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.restore_previous_version(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().revisions().restorePreviousVersion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionRestorePreviousVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestorePreviousVersionParams params = RevisionRestorePreviousVersionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().restorePreviousVersion(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Revisions.RestorePreviousVersion', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.RestorePreviousVersion(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogPostRevisionRestorePreviousVersionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.revisions.restore_previous_version', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.restore_previous_version("revisionId", object_id_: "objectId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->revisions->restorePreviousVersion', + example: + "cms->blogs->posts->revisions->restorePreviousVersion(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_previous_version_to_draft', + endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft', + httpMethod: 'post', + summary: 'Restore a draft to a previous version', + description: + 'Takes a specified version of a blog post, sets it as the new draft version of the blog post.', + stainlessPath: '(resource) cms.blogs.posts.revisions > (method) restore_previous_version_to_draft', + qualified: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', + params: ['objectId: string;', 'revisionId: number;'], + response: 'string', + markdown: + "## restore_previous_version_to_draft\n\n`client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(objectId: string, revisionId: number): string`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nTakes a specified version of a blog post, sets it as the new draft version of the blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(0, {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.posts.revisions.restore_previous_version_to_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.restore_previous_version_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().posts().revisions().restorePreviousVersionToDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionRestorePreviousVersionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestorePreviousVersionToDraftParams params = RevisionRestorePreviousVersionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().restorePreviousVersionToDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Posts.Revisions.RestorePreviousVersionToDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.RestorePreviousVersionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.BlogPostRevisionRestorePreviousVersionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.posts.revisions.restore_previous_version_to_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.restore_previous_version_to_draft(0, object_id_: "objectId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->posts->revisions->restorePreviousVersionToDraft', + example: + "cms\n ->blogs\n ->posts\n ->revisions\n ->restorePreviousVersionToDraft(0, objectID: 'objectId');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blog-settings/2026-03/settings/{blogId}', + httpMethod: 'get', + summary: 'Retrieve a blog', + description: 'Retrieve a specific blog by its ID.', + stainlessPath: '(resource) cms.blogs.settings > (method) get', + qualified: 'client.cms.blogs.settings.get', + params: ['blogId: string;'], + response: + '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', + markdown: + "## get\n\n`client.cms.blogs.settings.get(blogId: string): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}`\n\nRetrieve a specific blog by its ID.\n\n### Parameters\n\n- `blogId: string`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blog = await client.cms.blogs.settings.get('blogId');\n\nconsole.log(blog);\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blog = await client.cms.blogs.settings.get('blogId');\n\nconsole.log(blog.id);", + }, + python: { + method: 'cms.blogs.settings.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog = client.cms.blogs.settings.get(\n "blogId",\n)\nprint(blog.id)', + }, + java: { + method: 'cms().blogs().settings().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.Blog;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Blog blog = client.cms().blogs().settings().get("blogId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblog, err := client.Cms.Blogs.Settings.Get(context.TODO(), "blogId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blog.ID)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog = hubspot.cms.blogs.settings.get("blogId")\n\nputs(blog)', + }, + php: { + method: 'cms->blogs->settings->get', + example: + "cms->blogs->settings->get('blogId');\n\nvar_dump($blog);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_revision', + endpoint: '/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Get a specific blog revision', + description: 'Get a specific blog revision.', + stainlessPath: '(resource) cms.blogs.settings > (method) get_revision', + qualified: 'client.cms.blogs.settings.getRevision', + params: ['blogId: string;', 'revisionId: string;'], + response: + '{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', + markdown: + "## get_revision\n\n`client.cms.blogs.settings.getRevision(blogId: string, revisionId: string): { id: string; object: blog; updatedAt: string; user: version_user; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}`\n\nGet a specific blog revision.\n\n### Parameters\n\n- `blogId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blogVersion = await client.cms.blogs.settings.getRevision('revisionId', { blogId: 'blogId' });\n\nconsole.log(blogVersion);\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.getRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blogVersion = await client.cms.blogs.settings.getRevision('revisionId', { blogId: 'blogId' });\n\nconsole.log(blogVersion.id);", + }, + python: { + method: 'cms.blogs.settings.get_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog_version = client.cms.blogs.settings.get_revision(\n revision_id="revisionId",\n blog_id="blogId",\n)\nprint(blog_version.id)', + }, + java: { + method: 'cms().blogs().settings().getRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.BlogVersion;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingGetRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingGetRevisionParams params = SettingGetRevisionParams.builder()\n .blogId("blogId")\n .revisionId("revisionId")\n .build();\n BlogVersion blogVersion = client.cms().blogs().settings().getRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.GetRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblogVersion, err := client.Cms.Blogs.Settings.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogSettingGetRevisionParams{\n\t\t\tBlogID: "blogId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blogVersion.ID)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.get_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog_version = hubspot.cms.blogs.settings.get_revision("revisionId", blog_id: "blogId")\n\nputs(blog_version)', + }, + php: { + method: 'cms->blogs->settings->getRevision', + example: + "cms->blogs->settings->getRevision(\n 'revisionId', blogID: 'blogId'\n);\n\nvar_dump($blogVersion);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/blog-settings/2026-03/settings', + httpMethod: 'get', + summary: 'Retrieve all blogs', + description: 'Get the list of blogs. Results can be limited and filtered by creation or updated date.', + stainlessPath: '(resource) cms.blogs.settings > (method) list', + qualified: 'client.cms.blogs.settings.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', + markdown: + "## list\n\n`client.cms.blogs.settings.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**get** `/cms/blog-settings/2026-03/settings`\n\nGet the list of blogs. Results can be limited and filtered by creation or updated date.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const blog of client.cms.blogs.settings.list()) {\n console.log(blog);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const blog of client.cms.blogs.settings.list()) {\n console.log(blog.id);\n}", + }, + python: { + method: 'cms.blogs.settings.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.blogs.settings.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().blogs().settings().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListPage;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingListPage page = client.cms().blogs().settings().list();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Blogs.Settings.List(context.TODO(), cms.BlogSettingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.blogs.settings.list\n\nputs(page)', + }, + php: { + method: 'cms->blogs->settings->list', + example: + "cms->blogs->settings->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_revisions', + endpoint: '/cms/blog-settings/2026-03/settings/{blogId}/revisions', + httpMethod: 'get', + summary: 'Get all blog revisions', + description: + 'Get the list of blog revisions. Results can be limited and filtered by creation or updated date.', + stainlessPath: '(resource) cms.blogs.settings > (method) list_revisions', + qualified: 'client.cms.blogs.settings.listRevisions', + params: ['blogId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: + '{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', + markdown: + "## list_revisions\n\n`client.cms.blogs.settings.listRevisions(blogId: string, after?: string, before?: string, limit?: number): { id: string; object: blog; updatedAt: string; user: version_user; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}/revisions`\n\nGet the list of blog revisions. Results can be limited and filtered by creation or updated date.\n\n### Parameters\n\n- `blogId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const versionBlog of client.cms.blogs.settings.listRevisions('blogId')) {\n console.log(versionBlog);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.listRevisions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const versionBlog of client.cms.blogs.settings.listRevisions('blogId')) {\n console.log(versionBlog.id);\n}", + }, + python: { + method: 'cms.blogs.settings.list_revisions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.blogs.settings.list_revisions(\n blog_id="blogId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().blogs().settings().listRevisions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListRevisionsPage;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingListRevisionsPage page = client.cms().blogs().settings().listRevisions("blogId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.ListRevisions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Blogs.Settings.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"blogId",\n\t\tcms.BlogSettingListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.list_revisions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.blogs.settings.list_revisions("blogId")\n\nputs(page)', + }, + php: { + method: 'cms->blogs->settings->listRevisions', + example: + "cms->blogs->settings->listRevisions(\n 'blogId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Add a blog to a multi-language group', + description: 'Attach a blog to a multi-language group.', + stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) attach_to_lang_group', + qualified: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.blogs.settings.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group`\n\nAttach a blog to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.settings.multi_language.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().settings().multiLanguage().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.MultiLanguage.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.AttachToLangGroup(context.TODO(), cms.BlogSettingMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.multi_language.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->blogs->settings->multiLanguage->attachToLangGroup', + example: + "cms->blogs->settings->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create_language_variation', + endpoint: '/cms/blog-settings/2026-03/settings/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a language variation from an existing blog', + description: 'Create a new language variation from an existing blog.', + stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) create_language_variation', + qualified: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', + params: [ + 'id: string;', + 'language?: string;', + 'primaryLanguage?: string;', + 'slug?: string;', + 'usePublished?: boolean;', + ], + response: + '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', + markdown: + "## create_language_variation\n\n`client.cms.blogs.settings.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, slug?: string, usePublished?: boolean): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/create-language-variation`\n\nCreate a new language variation from an existing blog.\n\n### Parameters\n\n- `id: string`\n ID of blog to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary blog to clone.\n\n- `slug?: string`\n Path to this blog.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blog = await client.cms.blogs.settings.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(blog);\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blog = await client.cms.blogs.settings.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(blog.id);", + }, + python: { + method: 'cms.blogs.settings.multi_language.create_language_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog = client.cms.blogs.settings.multi_language.create_language_variation(\n id="id",\n)\nprint(blog.id)', + }, + java: { + method: 'cms().blogs().settings().multiLanguage().createLanguageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.Blog;\nimport com.hubspot.sdk.models.cms.blogs.settings.BlogLanguageCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogLanguageCloneRequestVNext params = BlogLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n Blog blog = client.cms().blogs().settings().multiLanguage().createLanguageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.MultiLanguage.NewLanguageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblog, err := client.Cms.Blogs.Settings.MultiLanguage.NewLanguageVariation(context.TODO(), cms.BlogSettingMultiLanguageNewLanguageVariationParams{\n\t\tBlogLanguageCloneRequestVNext: cms.BlogLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blog.ID)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.multi_language.create_language_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog = hubspot.cms.blogs.settings.multi_language.create_language_variation(id: "id")\n\nputs(blog)', + }, + php: { + method: 'cms->blogs->settings->multiLanguage->createLanguageVariation', + example: + "cms->blogs->settings->multiLanguage->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n slug: 'slug',\n usePublished: true,\n);\n\nvar_dump($blog);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/create-language-variation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Remove a blog from a multi-language group', + description: 'Detaches a blog from a multi-language group.', + stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) detach_from_lang_group', + qualified: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.blogs.settings.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group`\n\nDetaches a blog from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.settings.multi_language.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().settings().multiLanguage().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.MultiLanguage.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.BlogSettingMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.multi_language.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->settings->multiLanguage->detachFromLangGroup', + example: + "cms->blogs->settings->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'set_new_lang_primary', + endpoint: '/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set primary language to match a specific blog', + description: 'Set a blog as the primary language of a multi-language group.', + stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) set_new_lang_primary', + qualified: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', + params: ['id: string;'], + markdown: + "## set_new_lang_primary\n\n`client.cms.blogs.settings.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary`\n\nSet a blog as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.settings.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.settings.multiLanguage.setNewLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.blogs.settings.multi_language.set_new_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.settings.multi_language.set_new_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().blogs().settings().multiLanguage().setNewLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().settings().multiLanguage().setNewLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.MultiLanguage.SetNewLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Settings.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.BlogSettingMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.multi_language.set_new_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.settings.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->settings->multiLanguage->setNewLangPrimary', + example: + "cms->blogs->settings->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update_languages', + endpoint: '/cms/blog-settings/2026-03/settings/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update blog languages', + description: 'Explicitly set new languages for each blog in a multi-language group.', + stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) update_languages', + qualified: 'client.cms.blogs.settings.multiLanguage.updateLanguages', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_languages\n\n`client.cms.blogs.settings.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/update-languages`\n\nExplicitly set new languages for each blog in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.settings.multiLanguage.updateLanguages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.settings.multi_language.update_languages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().settings().multiLanguage().updateLanguages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().updateLanguages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Settings.MultiLanguage.UpdateLanguages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.UpdateLanguages(context.TODO(), cms.BlogSettingMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.settings.multi_language.update_languages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.update_languages(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->settings->multiLanguage->updateLanguages', + example: + "cms->blogs->settings->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/update-languages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Attach a Blog Tag to a multi-language group', + description: 'Attach a Blog Tag to a multi-language group.', + stainlessPath: '(resource) cms.blogs.tags > (method) attach_to_lang_group', + qualified: 'client.cms.blogs.tags.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.blogs.tags.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group`\n\nAttach a Blog Tag to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().tags().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.AttachToLangGroup(context.TODO(), cms.BlogTagAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.attach_to_lang_group(id: "id", language: :aa, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->attachToLangGroup', + example: + "cms->blogs->tags->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/blogs/2026-03/tags', + httpMethod: 'post', + summary: 'Create a new Blog Tag', + description: 'Create a new Blog Tag.', + stainlessPath: '(resource) cms.blogs.tags > (method) create', + qualified: 'client.cms.blogs.tags.create', + params: [ + 'id: string;', + 'created: string;', + 'deletedAt: string;', + 'language: string;', + 'name: string;', + 'slug: string;', + 'translatedFromId: number;', + 'updated: string;', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.blogs.tags.create(id: string, created: string, deletedAt: string, language: string, name: string, slug: string, translatedFromId: number, updated: string): string`\n\n**post** `/cms/blogs/2026-03/tags`\n\nCreate a new Blog Tag.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Tag.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Tag was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Tag was deleted.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the tag.\n\n- `name: string`\n The name of the tag.\n\n- `slug: string`\n\n- `translatedFromId: number`\n ID of the primary tag this object was translated from.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Tag was updated.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.create({\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.create({\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.create(\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n language="aa",\n name="name",\n slug="slug",\n translated_from_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Tag params = Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n HttpResponse tag = client.cms().blogs().tags().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.New(context.TODO(), cms.BlogTagNewParams{\n\t\tTag: cms.TagParam{\n\t\t\tID: "id",\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\tName: "name",\n\t\t\tSlug: "slug",\n\t\t\tTranslatedFromID: 0,\n\t\t\tUpdated: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.create(\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(tag)', + }, + php: { + method: 'cms->blogs->tags->create', + example: + "cms->blogs->tags->create(\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($tag);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'create_lang_variation', + endpoint: '/cms/blogs/2026-03/tags/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a new language variation', + description: 'Create a new language variation from an existing Blog Tag', + stainlessPath: '(resource) cms.blogs.tags > (method) create_lang_variation', + qualified: 'client.cms.blogs.tags.createLangVariation', + params: [ + 'id: string;', + 'name: string;', + 'language?: string;', + 'primaryLanguage?: string;', + 'usePublished?: boolean;', + ], + response: 'string', + markdown: + "## create_lang_variation\n\n`client.cms.blogs.tags.createLangVariation(id: string, name: string, language?: string, primaryLanguage?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/create-language-variation`\n\nCreate a new language variation from an existing Blog Tag\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `name: string`\n Name of newly cloned blog tag.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary blog tag to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.createLangVariation({ id: 'id', name: 'name' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.createLangVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.createLangVariation({ id: 'id', name: 'name' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.create_lang_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.create_lang_variation(\n id="id",\n name="name",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().createLangVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TagCloneRequestVNext params = TagCloneRequestVNext.builder()\n .id("id")\n .name("name")\n .build();\n HttpResponse response = client.cms().blogs().tags().createLangVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.NewLangVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.NewLangVariation(context.TODO(), cms.BlogTagNewLangVariationParams{\n\t\tTagCloneRequestVNext: cms.TagCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.create_lang_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.create_lang_variation(id: "id", name: "name")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->createLangVariation', + example: + "cms->blogs->tags->createLangVariation(\n id: 'id',\n name: 'name',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/tags/{objectId}', + httpMethod: 'delete', + summary: 'Delete a Blog Tag', + description: 'Delete the Blog Tag object identified by the id in the path.', + stainlessPath: '(resource) cms.blogs.tags > (method) delete', + qualified: 'client.cms.blogs.tags.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.blogs.tags.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/tags/{objectId}`\n\nDelete the Blog Tag object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.delete('objectId');", + }, + python: { + method: 'cms.blogs.tags.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().blogs().tags().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().tags().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->tags->delete', + example: + "cms->blogs->tags->delete('objectId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Detach a Blog Tag from a multi-language group', + description: 'Detach a Blog Tag from a multi-language group.', + stainlessPath: '(resource) cms.blogs.tags > (method) detach_from_lang_group', + qualified: 'client.cms.blogs.tags.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.blogs.tags.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group`\n\nDetach a Blog Tag from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().tags().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.DetachFromLangGroup(context.TODO(), cms.BlogTagDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->detachFromLangGroup', + example: + "cms->blogs->tags->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/blogs/2026-03/tags/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a Blog Tag', + description: 'Retrieve the Blog Tag object identified by the id in the path.', + stainlessPath: '(resource) cms.blogs.tags > (method) get', + qualified: 'client.cms.blogs.tags.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: 'string', + markdown: + "## get\n\n`client.cms.blogs.tags.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/{objectId}`\n\nRetrieve the Blog Tag object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.get('objectId');\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.get('objectId');\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.get(\n object_id="objectId",\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse tag = client.cms().blogs().tags().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.get("objectId")\n\nputs(tag)', + }, + php: { + method: 'cms->blogs->tags->get', + example: + "cms->blogs->tags->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($tag);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/blogs/2026-03/tags', + httpMethod: 'get', + summary: 'Get all Blog Tags', + description: + 'Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', + stainlessPath: '(resource) cms.blogs.tags > (method) list', + qualified: 'client.cms.blogs.tags.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list\n\n`client.cms.blogs.tags.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags`\n\nGet the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tags = await client.cms.blogs.tags.list();\n\nconsole.log(tags);\n\nconst content = await tags.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tags = await client.cms.blogs.tags.list();\n\nconsole.log(tags);\n\nconst content = await tags.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntags = client.cms.blogs.tags.list()\nprint(tags)\ncontent = tags.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse tags = client.cms().blogs().tags().list();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttags, err := client.Cms.Blogs.Tags.List(context.TODO(), cms.BlogTagListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tags)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntags = hubspot.cms.blogs.tags.list\n\nputs(tags)', + }, + php: { + method: 'cms->blogs->tags->list', + example: + "cms->blogs->tags->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($tags);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_authors_cursor', + endpoint: '/cms/blogs/2026-03/authors/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_authors_cursor', + qualified: 'client.cms.blogs.tags.listAuthorsCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_authors_cursor\n\n`client.cms.blogs.tags.listAuthorsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listAuthorsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listAuthorsCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listAuthorsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_authors_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_authors_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listAuthorsCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListAuthorsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listAuthorsCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListAuthorsCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListAuthorsCursor(context.TODO(), cms.BlogTagListAuthorsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_authors_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_authors_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listAuthorsCursor', + example: + "cms->blogs->tags->listAuthorsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_authors_cursor_by_query', + endpoint: '/cms/blogs/2026-03/authors/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_authors_cursor_by_query', + qualified: 'client.cms.blogs.tags.listAuthorsCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_authors_cursor_by_query\n\n`client.cms.blogs.tags.listAuthorsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listAuthorsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listAuthorsCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listAuthorsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_authors_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_authors_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listAuthorsCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListAuthorsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listAuthorsCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListAuthorsCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListAuthorsCursorByQuery(context.TODO(), cms.BlogTagListAuthorsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_authors_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_authors_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listAuthorsCursorByQuery', + example: + "cms->blogs->tags->listAuthorsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_cursor', + endpoint: '/cms/blogs/2026-03/tags/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_cursor', + qualified: 'client.cms.blogs.tags.listCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_cursor\n\n`client.cms.blogs.tags.listCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListCursor(context.TODO(), cms.BlogTagListCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listCursor', + example: + "cms->blogs->tags->listCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_cursor_by_query', + endpoint: '/cms/blogs/2026-03/tags/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_cursor_by_query', + qualified: 'client.cms.blogs.tags.listCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_cursor_by_query\n\n`client.cms.blogs.tags.listCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListCursorByQuery(context.TODO(), cms.BlogTagListCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listCursorByQuery', + example: + "cms->blogs->tags->listCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_posts_cursor', + endpoint: '/cms/blogs/2026-03/posts/cursor', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_posts_cursor', + qualified: 'client.cms.blogs.tags.listPostsCursor', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_posts_cursor\n\n`client.cms.blogs.tags.listPostsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listPostsCursor', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_posts_cursor', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_posts_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listPostsCursor', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListPostsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listPostsCursor();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListPostsCursor', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListPostsCursor(context.TODO(), cms.BlogTagListPostsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_posts_cursor', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_posts_cursor\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listPostsCursor', + example: + "cms->blogs->tags->listPostsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_posts_cursor_by_query', + endpoint: '/cms/blogs/2026-03/posts/cursor/query', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.blogs.tags > (method) list_posts_cursor_by_query', + qualified: 'client.cms.blogs.tags.listPostsCursorByQuery', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'string', + markdown: + "## list_posts_cursor_by_query\n\n`client.cms.blogs.tags.listPostsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.listPostsCursorByQuery', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.list_posts_cursor_by_query', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_posts_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().listPostsCursorByQuery', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListPostsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listPostsCursorByQuery();\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.ListPostsCursorByQuery', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListPostsCursorByQuery(context.TODO(), cms.BlogTagListPostsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.list_posts_cursor_by_query', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_posts_cursor_by_query\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->listPostsCursorByQuery', + example: + "cms->blogs->tags->listPostsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'set_lang_primary', + endpoint: '/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set a new primary language', + description: 'Set a Blog Tag as the primary language of a multi-language group.', + stainlessPath: '(resource) cms.blogs.tags > (method) set_lang_primary', + qualified: 'client.cms.blogs.tags.setLangPrimary', + params: ['id: string;'], + markdown: + "## set_lang_primary\n\n`client.cms.blogs.tags.setLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary`\n\nSet a Blog Tag as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.setLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.setLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.setLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.blogs.tags.set_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.set_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().blogs().tags().setLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().tags().setLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.SetLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.SetLangPrimary(context.TODO(), cms.BlogTagSetLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.set_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.set_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->blogs->tags->setLangPrimary', + example: + "cms->blogs->tags->setLangPrimary(id: 'id');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/blogs/2026-03/tags/{objectId}', + httpMethod: 'patch', + summary: 'Update a Blog Tag', + description: + 'Sparse updates a single Blog Tag object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n', + stainlessPath: '(resource) cms.blogs.tags > (method) update', + qualified: 'client.cms.blogs.tags.update', + params: [ + 'objectId: string;', + 'id: string;', + 'created: string;', + 'deletedAt: string;', + 'language: string;', + 'name: string;', + 'slug: string;', + 'translatedFromId: number;', + 'updated: string;', + 'archived?: boolean;', + ], + response: 'string', + markdown: + "## update\n\n`client.cms.blogs.tags.update(objectId: string, id: string, created: string, deletedAt: string, language: string, name: string, slug: string, translatedFromId: number, updated: string, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/tags/{objectId}`\n\nSparse updates a single Blog Tag object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Tag.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Tag was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Tag was deleted.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the tag.\n\n- `name: string`\n The name of the tag.\n\n- `slug: string`\n\n- `translatedFromId: number`\n ID of the primary tag this object was translated from.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Tag was updated.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.update('objectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.update('objectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.update(\n object_id="objectId",\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n language="aa",\n name="name",\n slug="slug",\n translated_from_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TagUpdateParams params = TagUpdateParams.builder()\n .objectId("objectId")\n .tag(Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n HttpResponse tag = client.cms().blogs().tags().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagUpdateParams{\n\t\t\tTag: cms.TagParam{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.update(\n "objectId",\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(tag)', + }, + php: { + method: 'cms->blogs->tags->update', + example: + "cms->blogs->tags->update(\n 'objectId',\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archived: true,\n);\n\nvar_dump($tag);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'update_langs', + endpoint: '/cms/blogs/2026-03/tags/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update languages of multi-language group', + description: 'Explicitly set new languages for each Blog Tag in a multi-language group.', + stainlessPath: '(resource) cms.blogs.tags > (method) update_langs', + qualified: 'client.cms.blogs.tags.updateLangs', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_langs\n\n`client.cms.blogs.tags.updateLangs(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/update-languages`\n\nExplicitly set new languages for each Blog Tag in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.updateLangs', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.update_langs', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.update_langs(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().updateLangs', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().tags().updateLangs(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.UpdateLangs', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.UpdateLangs(context.TODO(), cms.BlogTagUpdateLangsParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.update_langs', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.update_langs(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->updateLangs', + example: + "cms->blogs->tags->updateLangs(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create_batch', + endpoint: '/cms/blogs/2026-03/tags/batch/create', + httpMethod: 'post', + summary: 'Create a batch of Blog Tags', + description: 'Create the Blog Tag objects detailed in the request body.', + stainlessPath: '(resource) cms.blogs.tags.batch > (method) create_batch', + qualified: 'client.cms.blogs.tags.batch.createBatch', + params: [ + 'inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[];', + ], + response: 'string', + markdown: + "## create_batch\n\n`client.cms.blogs.tags.batch.createBatch(inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[]): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/create`\n\nCreate the Blog Tag objects detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[]`\n Blog tags to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.createBatch({ inputs: [{\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.batch.createBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.createBatch({\n inputs: [\n {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n },\n ],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.batch.create_batch', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.create_batch(\n inputs=[{\n "id": "id",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().batch().createBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.BatchInputTag;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputTag params = BatchInputTag.builder()\n .addInput(Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().createBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Batch.NewBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.NewBatch(context.TODO(), cms.BlogTagBatchNewBatchParams{\n\t\tBatchInputTag: cms.BatchInputTagParam{\n\t\t\tInputs: []cms.TagParam{{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.batch.create_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.create_batch(\n inputs: [\n {\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n updated: "2019-12-27T18:11:19.117Z"\n }\n ]\n)\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->batch->createBatch', + example: + "cms->blogs->tags->batch->createBatch(\n inputs: [\n [\n 'id' => 'id',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'language' => 'aa',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/blogs/2026-03/tags/batch/archive', + httpMethod: 'post', + summary: 'Delete a batch of Blog Tags', + description: 'Delete the Blog Tag objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.tags.batch > (method) delete', + qualified: 'client.cms.blogs.tags.batch.delete', + params: ['inputs: string[];'], + markdown: + "## delete\n\n`client.cms.blogs.tags.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/tags/batch/archive`\n\nDelete the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.batch.delete({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.batch.delete({ inputs: ['string'] });", + }, + python: { + method: 'cms.blogs.tags.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.batch.delete(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().blogs().tags().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().tags().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.Batch.Delete(context.TODO(), cms.BlogTagBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.batch.delete(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->blogs->tags->batch->delete', + example: + "cms->blogs->tags->batch->delete(inputs: ['string']);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_batch', + endpoint: '/cms/blogs/2026-03/tags/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of Blog Tags', + description: 'Retrieve the Blog Tag objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.tags.batch > (method) get_batch', + qualified: 'client.cms.blogs.tags.batch.getBatch', + params: ['inputs: string[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## get_batch\n\n`client.cms.blogs.tags.batch.getBatch(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/read`\n\nRetrieve the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.getBatch({ inputs: ['string'] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.batch.getBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.getBatch({ inputs: ['string'] });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.batch.get_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.get_batch(\n inputs=["string"],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().batch().getBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().getBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Batch.GetBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.GetBatch(context.TODO(), cms.BlogTagBatchGetBatchParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.batch.get_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.get_batch(inputs: ["string"])\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->batch->getBatch', + example: + "cms->blogs->tags->batch->getBatch(\n inputs: ['string'], archived: true\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update_batch', + endpoint: '/cms/blogs/2026-03/tags/batch/update', + httpMethod: 'post', + summary: 'Update a batch of Blog Tags', + description: 'Update the Blog Tag objects identified in the request body.', + stainlessPath: '(resource) cms.blogs.tags.batch > (method) update_batch', + qualified: 'client.cms.blogs.tags.batch.updateBatch', + params: ['inputs: object[];', 'archived?: boolean;'], + response: 'string', + markdown: + "## update_batch\n\n`client.cms.blogs.tags.batch.updateBatch(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/update`\n\nUpdate the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.updateBatch({ inputs: [{}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.blogs.tags.batch.updateBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.updateBatch({ inputs: [{}] });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.blogs.tags.batch.update_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.update_batch(\n inputs=[{}],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().blogs().tags().batch().updateBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().updateBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Blogs.Tags.Batch.UpdateBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.UpdateBatch(context.TODO(), cms.BlogTagBatchUpdateBatchParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.blogs.tags.batch.update_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.update_batch(inputs: [{}])\n\nputs(response)', + }, + php: { + method: 'cms->blogs->tags->batch->updateBatch', + example: + "cms->blogs->tags->batch->updateBatch(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/domains/2026-03/{domainId}', + httpMethod: 'get', + summary: 'Get a single domain', + description: 'Returns a single domains with the id specified.', + stainlessPath: '(resource) cms.domains > (method) get', + qualified: 'client.cms.domains.get', + params: ['domainId: string;'], + response: + '{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }', + markdown: + "## get\n\n`client.cms.domains.get(domainId: string): { id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n**get** `/cms/domains/2026-03/{domainId}`\n\nReturns a single domains with the id specified.\n\n### Parameters\n\n- `domainId: string`\n\n### Returns\n\n- `{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n - `id: string`\n - `correctCname: string`\n - `created: string`\n - `domain: string`\n - `isResolving: boolean`\n - `isSslEnabled: boolean`\n - `isSslOnly: boolean`\n - `isUsedForBlogPost: boolean`\n - `isUsedForEmail: boolean`\n - `isUsedForKnowledge: boolean`\n - `isUsedForLandingPage: boolean`\n - `isUsedForSitePage: boolean`\n - `manuallyMarkedAsResolving: boolean`\n - `primaryBlogPost: boolean`\n - `primaryEmail: boolean`\n - `primaryKnowledge: boolean`\n - `primaryLandingPage: boolean`\n - `primarySitePage: boolean`\n - `secondaryToDomain: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst domain = await client.cms.domains.get('domainId');\n\nconsole.log(domain);\n```", + perLanguage: { + typescript: { + method: 'client.cms.domains.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst domain = await client.cms.domains.get('domainId');\n\nconsole.log(domain.id);", + }, + python: { + method: 'cms.domains.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ndomain = client.cms.domains.get(\n "domainId",\n)\nprint(domain.id)', + }, + java: { + method: 'cms().domains().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.domains.Domain;\nimport com.hubspot.sdk.models.cms.domains.DomainGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Domain domain = client.cms().domains().get("domainId");\n }\n}', + }, + go: { + method: 'client.Cms.Domains.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdomain, err := client.Cms.Domains.Get(context.TODO(), "domainId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", domain.ID)\n}\n', + }, + ruby: { + method: 'cms.domains.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ndomain = hubspot.cms.domains.get("domainId")\n\nputs(domain)', + }, + php: { + method: 'cms->domains->get', + example: + "cms->domains->get('domainId');\n\nvar_dump($domain);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/domains/2026-03/$DOMAIN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/domains/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) cms.domains > (method) list', + qualified: 'client.cms.domains.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }', + markdown: + "## list\n\n`client.cms.domains.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n**get** `/cms/domains/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n - `id: string`\n - `correctCname: string`\n - `created: string`\n - `domain: string`\n - `isResolving: boolean`\n - `isSslEnabled: boolean`\n - `isSslOnly: boolean`\n - `isUsedForBlogPost: boolean`\n - `isUsedForEmail: boolean`\n - `isUsedForKnowledge: boolean`\n - `isUsedForLandingPage: boolean`\n - `isUsedForSitePage: boolean`\n - `manuallyMarkedAsResolving: boolean`\n - `primaryBlogPost: boolean`\n - `primaryEmail: boolean`\n - `primaryKnowledge: boolean`\n - `primaryLandingPage: boolean`\n - `primarySitePage: boolean`\n - `secondaryToDomain: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const domain of client.cms.domains.list()) {\n console.log(domain);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.domains.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const domain of client.cms.domains.list()) {\n console.log(domain.id);\n}", + }, + python: { + method: 'cms.domains.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.domains.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().domains().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.domains.DomainListPage;\nimport com.hubspot.sdk.models.cms.domains.DomainListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DomainListPage page = client.cms().domains().list();\n }\n}', + }, + go: { + method: 'client.Cms.Domains.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Domains.List(context.TODO(), cms.DomainListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.domains.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.domains.list\n\nputs(page)', + }, + php: { + method: 'cms->domains->list', + example: + "cms->domains->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/domains/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'clone_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone', + httpMethod: 'post', + summary: 'Clone rows in batch', + description: + 'Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.', + stainlessPath: '(resource) cms.hubdb.rows > (method) clone_batch', + qualified: 'client.cms.hubdb.rows.cloneBatch', + params: ['tableIdOrName: string;', 'inputs: { id: string; name?: string; }[];'], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## clone_batch\n\n`client.cms.hubdb.rows.cloneBatch(tableIdOrName: string, inputs: { id: string; name?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone`\n\nClones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { id: string; name?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.cloneBatch('tableIdOrName', { inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.cloneBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.cloneBatch('tableIdOrName', {\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.clone_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.clone_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().cloneBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowBatchCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowBatchCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCloneBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCloneBatchParams params = RowCloneBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowBatchCloneRequest(BatchInputHubDbTableRowBatchCloneRequest.builder()\n .addInput(HubDbTableRowBatchCloneRequest.builder()\n .id("id")\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().cloneBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.CloneBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.CloneBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowCloneBatchParams{\n\t\t\tBatchInputHubDBTableRowBatchCloneRequest: cms.BatchInputHubDBTableRowBatchCloneRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowBatchCloneRequestParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.clone_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.clone_batch("tableIdOrName", inputs: [{id: "id"}])\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->cloneBatch', + example: + "cms->hubdb->rows->cloneBatch(\n 'tableIdOrName', inputs: [['id' => 'id', 'name' => 'name']]\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'clone_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone', + httpMethod: 'post', + summary: 'Clone a row', + description: 'Clones a single row in the draft version of a table.', + stainlessPath: '(resource) cms.hubdb.rows > (method) clone_draft', + qualified: 'client.cms.hubdb.rows.cloneDraft', + params: ['tableIdOrName: string;', 'rowId: string;', 'name?: string;'], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## clone_draft\n\n`client.cms.hubdb.rows.cloneDraft(tableIdOrName: string, rowId: string, name?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone`\n\nClones a single row in the draft version of a table.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.cloneDraft('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.cloneDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.cloneDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.clone_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.clone_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().cloneDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCloneDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCloneDraftParams params = RowCloneDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().cloneDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.CloneDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.CloneDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowCloneDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.clone_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.clone_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->cloneDraft', + example: + "cms->hubdb->rows->cloneDraft(\n '321669910225', tableIDOrName: 'tableIdOrName', name: 'name'\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft/clone \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', + httpMethod: 'post', + summary: 'Add a row to a table', + description: + 'Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use the `/publish` endpoint to push these changes to published version.', + stainlessPath: '(resource) cms.hubdb.rows > (method) create', + qualified: 'client.cms.hubdb.rows.create', + params: [ + 'tableIdOrName: string;', + 'childTableId: number;', + 'displayIndex: number;', + 'values: object;', + 'name?: string;', + 'path?: string;', + ], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## create\n\n`client.cms.hubdb.rows.create(tableIdOrName: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows`\n\nAdd a new row to a HubDB table. New rows will be added to the draft version of the table. Use the `/publish` endpoint to push these changes to published version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.create('tableIdOrName', {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.create('tableIdOrName', {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.create(\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCreateParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCreateParams params = RowCreateParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.New(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowNewParams{\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.create(\n "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->create', + example: + "cms->hubdb->rows->create(\n 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', + }, + }, + }, + { + name: 'create_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create', + httpMethod: 'post', + summary: 'Create rows in batch', + description: + 'Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.', + stainlessPath: '(resource) cms.hubdb.rows > (method) create_batch', + qualified: 'client.cms.hubdb.rows.createBatch', + params: [ + 'tableIdOrName: string;', + 'inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create_batch\n\n`client.cms.hubdb.rows.createBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create`\n\nCreates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.createBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.createBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.createBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.create_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.create_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().createBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCreateBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCreateBatchParams params = RowCreateBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3Request(BatchInputHubDbTableRowV3Request.builder()\n .addInput(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().createBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.NewBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.NewBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowNewBatchParams{\n\t\t\tBatchInputHubDBTableRowV3Request: cms.BatchInputHubDBTableRowV3RequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3RequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.create_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.create_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->createBatch', + example: + "cms->hubdb->rows->createBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + httpMethod: 'delete', + summary: 'Permanently deletes a row', + description: "Permanently deletes a row from a table's draft version.", + stainlessPath: '(resource) cms.hubdb.rows > (method) delete_draft', + qualified: 'client.cms.hubdb.rows.deleteDraft', + params: ['tableIdOrName: string;', 'rowId: string;'], + markdown: + "## delete_draft\n\n`client.cms.hubdb.rows.deleteDraft(tableIdOrName: string, rowId: string): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nPermanently deletes a row from a table's draft version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.rows.deleteDraft('321669910225', { tableIdOrName: 'tableIdOrName' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.deleteDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.rows.deleteDraft('321669910225', { tableIdOrName: 'tableIdOrName' });", + }, + python: { + method: 'cms.hubdb.rows.delete_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.rows.delete_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)', + }, + java: { + method: 'cms().hubdb().rows().deleteDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowDeleteDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowDeleteDraftParams params = RowDeleteDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n client.cms().hubdb().rows().deleteDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.DeleteDraft', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Rows.DeleteDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowDeleteDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.delete_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.rows.delete_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(result)', + }, + php: { + method: 'cms->hubdb->rows->deleteDraft', + example: + "cms->hubdb->rows->deleteDraft(\n '321669910225', tableIDOrName: 'tableIdOrName'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}', + httpMethod: 'get', + summary: 'Get a table row', + description: + 'Get a single row by ID from the published version of a table.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.', + stainlessPath: '(resource) cms.hubdb.rows > (method) get', + qualified: 'client.cms.hubdb.rows.get', + params: ['tableIdOrName: string;', 'rowId: string;', 'archived?: boolean;'], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## get\n\n`client.cms.hubdb.rows.get(tableIdOrName: string, rowId: string, archived?: boolean): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}`\n\nGet a single row by ID from the published version of a table.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.get('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.get('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.get(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetParams params = RowGetParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().get(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.Get(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowGetParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.get("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->get', + example: + "cms->hubdb->rows->get(\n '321669910225', tableIDOrName: 'tableIdOrName', archived: true\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read', + httpMethod: 'post', + summary: 'Get a set of rows', + description: + 'Returns rows in the published version of the specified table, given a set of row IDs.\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.', + stainlessPath: '(resource) cms.hubdb.rows > (method) get_batch', + qualified: 'client.cms.hubdb.rows.getBatch', + params: ['tableIdOrName: string;', 'inputs: string[];'], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_batch\n\n`client.cms.hubdb.rows.getBatch(tableIdOrName: string, inputs: string[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read`\n\nReturns rows in the published version of the specified table, given a set of row IDs.\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getBatch('tableIdOrName', { inputs: ['string'] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.getBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getBatch('tableIdOrName', {\n inputs: ['string'],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.get_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.get_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().getBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetBatchParams params = RowGetBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().getBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.GetBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowGetBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.get_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_batch("tableIdOrName", inputs: ["string"])\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->getBatch', + example: + "cms->hubdb->rows->getBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + httpMethod: 'get', + summary: 'Get a row from the draft table', + description: "Get a single row by ID from a table's draft version.", + stainlessPath: '(resource) cms.hubdb.rows > (method) get_draft', + qualified: 'client.cms.hubdb.rows.getDraft', + params: ['tableIdOrName: string;', 'rowId: string;', 'archived?: boolean;'], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## get_draft\n\n`client.cms.hubdb.rows.getDraft(tableIdOrName: string, rowId: string, archived?: boolean): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nGet a single row by ID from a table's draft version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.getDraft('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.getDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.getDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.get_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.get_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().getDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetDraftParams params = RowGetDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().getDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.GetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowGetDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.get_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->getDraft', + example: + "cms->hubdb->rows->getDraft(\n '321669910225', tableIDOrName: 'tableIdOrName', archived: true\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_draft_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read', + httpMethod: 'post', + summary: 'Get a set of rows from draft table', + description: 'Returns rows in the draft version of the specified table, given a set of row IDs.', + stainlessPath: '(resource) cms.hubdb.rows > (method) get_draft_batch', + qualified: 'client.cms.hubdb.rows.getDraftBatch', + params: ['tableIdOrName: string;', 'inputs: string[];'], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_draft_batch\n\n`client.cms.hubdb.rows.getDraftBatch(tableIdOrName: string, inputs: string[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read`\n\nReturns rows in the draft version of the specified table, given a set of row IDs.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getDraftBatch('tableIdOrName', { inputs: ['string'] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.getDraftBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getDraftBatch('tableIdOrName', {\n inputs: ['string'],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.get_draft_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.get_draft_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().getDraftBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetDraftBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetDraftBatchParams params = RowGetDraftBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().getDraftBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.GetDraftBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetDraftBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowGetDraftBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.get_draft_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_draft_batch("tableIdOrName", inputs: ["string"])\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->getDraftBatch', + example: + "cms->hubdb->rows->getDraftBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', + httpMethod: 'get', + summary: 'Get rows for a table', + description: + 'Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.', + stainlessPath: '(resource) cms.hubdb.rows > (method) list', + qualified: 'client.cms.hubdb.rows.list', + params: [ + 'tableIdOrName: string;', + 'after?: string;', + 'archived?: boolean;', + 'limit?: number;', + 'offset?: number;', + 'properties?: string[];', + 'sort?: string[];', + ], + response: + "{ results: object[]; total: number; type: 'RANDOM_ACCESS'; paging?: object; } | { results: object[]; total: number; type: 'STREAMING'; paging?: object; }", + markdown: + "## list\n\n`client.cms.hubdb.rows.list(tableIdOrName: string, after?: string, archived?: boolean, limit?: number, offset?: number, properties?: string[], sort?: string[]): object | object`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows`\n\nReturns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `offset?: number`\n\n- `properties?: string[]`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ results: object[]; total: number; type: 'RANDOM_ACCESS'; paging?: object; } | { results: object[]; total: number; type: 'STREAMING'; paging?: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst unifiedCollectionResponseWithTotalBaseHubDBTableRowV3 = await client.cms.hubdb.rows.list('tableIdOrName');\n\nconsole.log(unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst unifiedCollectionResponseWithTotalBaseHubDBTableRowV3 = await client.cms.hubdb.rows.list(\n 'tableIdOrName',\n);\n\nconsole.log(unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);", + }, + python: { + method: 'cms.hubdb.rows.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nunified_collection_response_with_total_base_hub_db_table_row_v3 = client.cms.hubdb.rows.list(\n table_id_or_name="tableIdOrName",\n)\nprint(unified_collection_response_with_total_base_hub_db_table_row_v3)', + }, + java: { + method: 'cms().hubdb().rows().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3 unifiedCollectionResponseWithTotalBaseHubDbTableRowV3 = client.cms().hubdb().rows().list("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunifiedCollectionResponseWithTotalBaseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.List(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unifiedCollectionResponseWithTotalBaseHubDBTableRowV3)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nunified_collection_response_with_total_base_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.list("tableIdOrName")\n\nputs(unified_collection_response_with_total_base_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->list', + example: + "cms\n ->hubdb\n ->rows\n ->list(\n 'tableIdOrName',\n after: 'after',\n archived: true,\n limit: 0,\n offset: 0,\n properties: ['string'],\n sort: ['string'],\n);\n\nvar_dump($unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'purge_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge', + httpMethod: 'post', + summary: 'Delete rows', + description: + 'Permanently delete rows from the draft version of a table, given a set of row IDs. Maximum of 100 row IDs per call.', + stainlessPath: '(resource) cms.hubdb.rows > (method) purge_batch', + qualified: 'client.cms.hubdb.rows.purgeBatch', + params: ['tableIdOrName: string;', 'inputs: string[];'], + markdown: + "## purge_batch\n\n`client.cms.hubdb.rows.purgeBatch(tableIdOrName: string, inputs: string[]): void`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge`\n\nPermanently delete rows from the draft version of a table, given a set of row IDs. Maximum of 100 row IDs per call.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.rows.purgeBatch('tableIdOrName', { inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.purgeBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.rows.purgeBatch('tableIdOrName', { inputs: ['string'] });", + }, + python: { + method: 'cms.hubdb.rows.purge_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.rows.purge_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)', + }, + java: { + method: 'cms().hubdb().rows().purgeBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowPurgeBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowPurgeBatchParams params = RowPurgeBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n client.cms().hubdb().rows().purgeBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.PurgeBatch', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Rows.PurgeBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowPurgeBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.purge_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.rows.purge_batch("tableIdOrName", inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->hubdb->rows->purgeBatch', + example: + "cms->hubdb->rows->purgeBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/purge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'replace_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace', + httpMethod: 'post', + summary: 'Replace rows in batch in draft table', + description: + 'Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PUT /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.', + stainlessPath: '(resource) cms.hubdb.rows > (method) replace_batch', + qualified: 'client.cms.hubdb.rows.replaceBatch', + params: [ + 'tableIdOrName: string;', + 'inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## replace_batch\n\n`client.cms.hubdb.rows.replaceBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace`\n\nReplaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PUT /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.replaceBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.replaceBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.replaceBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.replace_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.replace_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().replaceBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowReplaceBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowReplaceBatchParams params = RowReplaceBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3BatchUpdateRequest(BatchInputHubDbTableRowV3BatchUpdateRequest.builder()\n .addInput(HubDbTableRowV3BatchUpdateRequest.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3BatchUpdateRequest.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().replaceBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.ReplaceBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.ReplaceBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowReplaceBatchParams{\n\t\t\tBatchInputHubDBTableRowV3BatchUpdateRequest: cms.BatchInputHubDBTableRowV3BatchUpdateRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3BatchUpdateRequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.replace_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.replace_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->replaceBatch', + example: + "cms->hubdb->rows->replaceBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'id' => 'id',\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/replace \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'replace_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + httpMethod: 'put', + summary: 'Replace an existing row', + description: + 'Replace a single row in the draft version of a table. All column values must be specified. If a column has a value in the target table and this request doesn\'t define that value, it will be deleted.\nSee the "Create a row" endpoint for instructions on how to format the JSON row definitions.', + stainlessPath: '(resource) cms.hubdb.rows > (method) replace_draft', + qualified: 'client.cms.hubdb.rows.replaceDraft', + params: [ + 'tableIdOrName: string;', + 'rowId: string;', + 'childTableId: number;', + 'displayIndex: number;', + 'values: object;', + 'name?: string;', + 'path?: string;', + ], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## replace_draft\n\n`client.cms.hubdb.rows.replaceDraft(tableIdOrName: string, rowId: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**put** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nReplace a single row in the draft version of a table. All column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted.\nSee the \"Create a row\" endpoint for instructions on how to format the JSON row definitions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.replaceDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.replaceDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.replaceDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.replace_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.replace_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().replaceDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowReplaceDraftParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowReplaceDraftParams params = RowReplaceDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().replaceDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.ReplaceDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.ReplaceDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowReplaceDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.replace_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.replace_draft(\n "321669910225",\n table_id_or_name: "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->replaceDraft', + example: + "cms->hubdb->rows->replaceDraft(\n '321669910225',\n tableIDOrName: 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', + }, + }, + }, + { + name: 'update_batch', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update', + httpMethod: 'post', + summary: 'Update rows in batch in draft table', + description: + 'Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PATCH /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.', + stainlessPath: '(resource) cms.hubdb.rows > (method) update_batch', + qualified: 'client.cms.hubdb.rows.updateBatch', + params: [ + 'tableIdOrName: string;', + 'inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update_batch\n\n`client.cms.hubdb.rows.updateBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update`\n\nUpdates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PATCH /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.updateBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.updateBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.updateBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", + }, + python: { + method: 'cms.hubdb.rows.update_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.update_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', + }, + java: { + method: 'cms().hubdb().rows().updateBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowUpdateBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowUpdateBatchParams params = RowUpdateBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3BatchUpdateRequest(BatchInputHubDbTableRowV3BatchUpdateRequest.builder()\n .addInput(HubDbTableRowV3BatchUpdateRequest.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3BatchUpdateRequest.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().updateBatch(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.UpdateBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.UpdateBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowUpdateBatchParams{\n\t\t\tBatchInputHubDBTableRowV3BatchUpdateRequest: cms.BatchInputHubDBTableRowV3BatchUpdateRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3BatchUpdateRequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.update_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.update_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->updateBatch', + example: + "cms->hubdb->rows->updateBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'id' => 'id',\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + httpMethod: 'patch', + summary: 'Update a row', + description: + 'Partially update a single row in the table\'s draft version.\nAll the column values need not be specified. Only the columns or fields that needs to be modified can be specified.\nSee the "Create a row" endpoint for instructions on how to format the JSON row definitions.', + stainlessPath: '(resource) cms.hubdb.rows > (method) update_draft', + qualified: 'client.cms.hubdb.rows.updateDraft', + params: [ + 'tableIdOrName: string;', + 'rowId: string;', + 'childTableId: number;', + 'displayIndex: number;', + 'values: object;', + 'name?: string;', + 'path?: string;', + ], + response: + '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', + markdown: + "## update_draft\n\n`client.cms.hubdb.rows.updateDraft(tableIdOrName: string, rowId: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**patch** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nPartially update a single row in the table's draft version.\nAll the column values need not be specified. Only the columns or fields that needs to be modified can be specified.\nSee the \"Create a row\" endpoint for instructions on how to format the JSON row definitions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.updateDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.rows.updateDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.updateDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", + }, + python: { + method: 'cms.hubdb.rows.update_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.update_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', + }, + java: { + method: 'cms().hubdb().rows().updateDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowUpdateDraftParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowUpdateDraftParams params = RowUpdateDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().updateDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Rows.UpdateDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowUpdateDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.rows.update_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.update_draft(\n "321669910225",\n table_id_or_name: "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', + }, + php: { + method: 'cms->hubdb->rows->updateDraft', + example: + "cms->hubdb->rows->updateDraft(\n '321669910225',\n tableIDOrName: 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', + }, + }, + }, + { + name: 'clone_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone', + httpMethod: 'post', + summary: 'Clone a table', + description: + 'Clone an existing HubDB table. The `newName` and `newLabel` of the new table can be sent as JSON in the request body. This will create the cloned table as a draft.', + stainlessPath: '(resource) cms.hubdb.tables > (method) clone_draft', + qualified: 'client.cms.hubdb.tables.cloneDraft', + params: [ + 'tableIdOrName: string;', + 'copyRows: boolean;', + 'isHubspotDefined: boolean;', + 'newLabel?: string;', + 'newName?: string;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## clone_draft\n\n`client.cms.hubdb.tables.cloneDraft(tableIdOrName: string, copyRows: boolean, isHubspotDefined: boolean, newLabel?: string, newName?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone`\n\nClone an existing HubDB table. The `newName` and `newLabel` of the new table can be sent as JSON in the request body. This will create the cloned table as a draft.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `copyRows: boolean`\n Specifies whether to copy the rows during clone\n\n- `isHubspotDefined: boolean`\n Indicates whether the table is defined by HubSpot.\n\n- `newLabel?: string`\n The new label for the cloned table\n\n- `newName?: string`\n The new name for the cloned table\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', { copyRows: true, isHubspotDefined: true });\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.cloneDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', {\n copyRows: true,\n isHubspotDefined: true,\n});\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.clone_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.clone_draft(\n table_id_or_name="tableIdOrName",\n copy_rows=True,\n is_hubspot_defined=True,\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().cloneDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableCloneDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableCloneDraftParams params = TableCloneDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableCloneRequest(HubDbTableCloneRequest.builder()\n .copyRows(true)\n .isHubSpotDefined(true)\n .build())\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().cloneDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.CloneDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.CloneDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableCloneDraftParams{\n\t\t\tHubDBTableCloneRequest: cms.HubDBTableCloneRequestParam{\n\t\t\t\tCopyRows: true,\n\t\t\t\tIsHubSpotDefined: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.clone_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.clone_draft("tableIdOrName", copy_rows: true, is_hubspot_defined: true)\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->cloneDraft', + example: + "cms->hubdb->tables->cloneDraft(\n 'tableIdOrName',\n copyRows: true,\n isHubSpotDefined: true,\n newLabel: 'newLabel',\n newName: 'newName',\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "copyRows": true,\n "isHubspotDefined": true\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/hubdb/2026-03/tables', + httpMethod: 'post', + summary: 'Create a table', + description: + 'Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.', + stainlessPath: '(resource) cms.hubdb.tables > (method) create', + qualified: 'client.cms.hubdb.tables.create', + params: [ + 'allowChildTables: boolean;', + 'allowPublicApiAccess: boolean;', + 'columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[];', + 'dynamicMetaTags: object;', + 'enableChildTablePages: boolean;', + 'label: string;', + 'name: string;', + 'useForPages: boolean;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## create\n\n`client.cms.hubdb.tables.create(allowChildTables: boolean, allowPublicApiAccess: boolean, columns: { id: number; label: string; name: string; options: hubdb_option[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[], dynamicMetaTags: object, enableChildTablePages: boolean, label: string, name: string, useForPages: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables`\n\nCreates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.\n\n### Parameters\n\n- `allowChildTables: boolean`\n Specifies whether child tables can be created\n\n- `allowPublicApiAccess: boolean`\n Specifies whether the table can be read by public without authorization\n\n- `columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[]`\n List of columns in the table\n\n- `dynamicMetaTags: object`\n Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.\n\n- `enableChildTablePages: boolean`\n Specifies creation of multi-level dynamic pages using child tables\n\n- `label: string`\n Label of the table\n\n- `name: string`\n Name of the table\n\n- `useForPages: boolean`\n Specifies whether the table can be used for creation of dynamic pages\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.create({\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [{\n id: 0,\n label: 'label',\n name: 'name',\n options: [{\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n}],\n type: 'BOOLEAN',\n}],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.create({\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [\n {\n id: 0,\n label: 'label',\n name: 'name',\n options: [\n {\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n },\n ],\n type: 'BOOLEAN',\n },\n ],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.create(\n allow_child_tables=True,\n allow_public_api_access=True,\n columns=[{\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [{\n "id": "id",\n "created_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updated_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n "type": "BOOLEAN",\n }],\n dynamic_meta_tags={\n "foo": 0\n },\n enable_child_table_pages=True,\n label="label",\n name="name",\n use_for_pages=True,\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.ColumnRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.HubdbOption;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3Request params = HubDbTableV3Request.builder()\n .allowChildTables(true)\n .allowPublicApiAccess(true)\n .addColumn(ColumnRequest.builder()\n .id(0)\n .label("label")\n .name("name")\n .addOption(HubdbOption.builder()\n .id("id")\n .createdAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .label("label")\n .name("name")\n .order(0)\n .type("type")\n .updatedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .type(ColumnRequest.Type.BOOLEAN)\n .build())\n .dynamicMetaTags(HubDbTableV3Request.DynamicMetaTags.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .enableChildTablePages(true)\n .label("label")\n .name("name")\n .useForPages(true)\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.New(context.TODO(), cms.HubdbTableNewParams{\n\t\tHubDBTableV3Request: cms.HubDBTableV3RequestParam{\n\t\t\tAllowChildTables: true,\n\t\t\tAllowPublicAPIAccess: true,\n\t\t\tColumns: []cms.ColumnRequestParam{{\n\t\t\t\tID: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tOptions: []cms.HubdbOptionParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tCreatedAt: time.Now(),\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tOrder: 0,\n\t\t\t\t\tType: "type",\n\t\t\t\t\tUpdatedAt: time.Now(),\n\t\t\t\t}},\n\t\t\t\tType: cms.ColumnRequestTypeBoolean,\n\t\t\t}},\n\t\t\tDynamicMetaTags: map[string]int64{\n\t\t\t\t"foo": 0,\n\t\t\t},\n\t\t\tEnableChildTablePages: true,\n\t\t\tLabel: "label",\n\t\t\tName: "name",\n\t\t\tUseForPages: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.create(\n allow_child_tables: true,\n allow_public_api_access: true,\n columns: [\n {\n id: 0,\n label: "label",\n name: "name",\n options: [\n {\n id: "id",\n createdAt: "2019-12-27T18:11:19.117Z",\n label: "label",\n name: "name",\n order: 0,\n type: "type",\n updatedAt: "2019-12-27T18:11:19.117Z"\n }\n ],\n type: :BOOLEAN\n }\n ],\n dynamic_meta_tags: {foo: 0},\n enable_child_table_pages: true,\n label: "label",\n name: "name",\n use_for_pages: true\n)\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->create', + example: + "cms->hubdb->tables->create(\n allowChildTables: true,\n allowPublicAPIAccess: true,\n columns: [\n [\n 'id' => 0,\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n [\n 'id' => 'id',\n 'createdAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'label' => 'label',\n 'name' => 'name',\n 'order' => 0,\n 'type' => 'type',\n 'updatedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'createdByUserID' => 0,\n 'updatedBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'updatedByUserID' => 0,\n ],\n ],\n 'type' => 'BOOLEAN',\n 'foreignColumnID' => 0,\n 'foreignTableID' => 0,\n 'maxNumberOfCharacters' => 0,\n 'maxNumberOfOptions' => 0,\n ],\n ],\n dynamicMetaTags: ['foo' => 0],\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowChildTables": true,\n "allowPublicApiAccess": true,\n "columns": [\n {\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [\n {\n "id": "id",\n "createdAt": "2019-12-27T18:11:19.117Z",\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updatedAt": "2019-12-27T18:11:19.117Z"\n }\n ],\n "type": "BOOLEAN"\n }\n ],\n "dynamicMetaTags": {\n "foo": 0\n },\n "enableChildTablePages": true,\n "label": "label",\n "name": "name",\n "useForPages": true\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}', + httpMethod: 'delete', + summary: 'Archive a table', + description: + 'Archive (soft delete) an existing HubDB table. This archives both the published and draft versions.', + stainlessPath: '(resource) cms.hubdb.tables > (method) delete', + qualified: 'client.cms.hubdb.tables.delete', + params: ['tableIdOrName: string;'], + markdown: + "## delete\n\n`client.cms.hubdb.tables.delete(tableIdOrName: string): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}`\n\nArchive (soft delete) an existing HubDB table. This archives both the published and draft versions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.tables.delete('tableIdOrName')\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.tables.delete('tableIdOrName');", + }, + python: { + method: 'cms.hubdb.tables.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.tables.delete(\n "tableIdOrName",\n)', + }, + java: { + method: 'cms().hubdb().tables().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().hubdb().tables().delete("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Tables.Delete(context.TODO(), "tableIdOrName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.tables.delete("tableIdOrName")\n\nputs(result)', + }, + php: { + method: 'cms->hubdb->tables->delete', + example: + "cms->hubdb->tables->delete('tableIdOrName');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_version', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}', + httpMethod: 'delete', + summary: 'Delete a table version', + description: 'Delete a specific version of a table', + stainlessPath: '(resource) cms.hubdb.tables > (method) delete_version', + qualified: 'client.cms.hubdb.tables.deleteVersion', + params: ['tableIdOrName: string;', 'versionId: number;'], + markdown: + "## delete_version\n\n`client.cms.hubdb.tables.deleteVersion(tableIdOrName: string, versionId: number): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}`\n\nDelete a specific version of a table\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `versionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.tables.deleteVersion(0, { tableIdOrName: 'tableIdOrName' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.deleteVersion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.tables.deleteVersion(0, { tableIdOrName: 'tableIdOrName' });", + }, + python: { + method: 'cms.hubdb.tables.delete_version', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.tables.delete_version(\n version_id=0,\n table_id_or_name="tableIdOrName",\n)', + }, + java: { + method: 'cms().hubdb().tables().deleteVersion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableDeleteVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableDeleteVersionParams params = TableDeleteVersionParams.builder()\n .tableIdOrName("tableIdOrName")\n .versionId(0L)\n .build();\n client.cms().hubdb().tables().deleteVersion(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.DeleteVersion', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Tables.DeleteVersion(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.HubdbTableDeleteVersionParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.delete_version', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.tables.delete_version(0, table_id_or_name: "tableIdOrName")\n\nputs(result)', + }, + php: { + method: 'cms->hubdb->tables->deleteVersion', + example: + "cms->hubdb->tables->deleteVersion(\n 0, tableIDOrName: 'tableIdOrName'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/versions/$VERSION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'export', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/export', + httpMethod: 'get', + summary: 'Export a published version of a table', + description: 'Exports the published version of a table in a specified format.', + stainlessPath: '(resource) cms.hubdb.tables > (method) export', + qualified: 'client.cms.hubdb.tables.export', + params: ['tableIdOrName: string;', 'format?: string;'], + response: 'string', + markdown: + "## export\n\n`client.cms.hubdb.tables.export(tableIdOrName: string, format?: string): string`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/export`\n\nExports the published version of a table in a specified format.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `format?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.hubdb.tables.export('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.export', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.hubdb.tables.export('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.hubdb.tables.export', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.hubdb.tables.export(\n table_id_or_name="tableIdOrName",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().hubdb().tables().export', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableExportParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().hubdb().tables().export("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.Export', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Hubdb.Tables.Export(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableExportParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.export', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.hubdb.tables.export("tableIdOrName")\n\nputs(response)', + }, + php: { + method: 'cms->hubdb->tables->export', + example: + "cms->hubdb->tables->export(\n 'tableIdOrName', format: 'format'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/export \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'export_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export', + httpMethod: 'get', + summary: 'Export a draft table', + description: 'Exports the draft version of a table to CSV / EXCEL format.', + stainlessPath: '(resource) cms.hubdb.tables > (method) export_draft', + qualified: 'client.cms.hubdb.tables.exportDraft', + params: ['tableIdOrName: string;', 'format?: string;'], + response: 'string', + markdown: + "## export_draft\n\n`client.cms.hubdb.tables.exportDraft(tableIdOrName: string, format?: string): string`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export`\n\nExports the draft version of a table to CSV / EXCEL format.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `format?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.hubdb.tables.exportDraft('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.exportDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.hubdb.tables.exportDraft('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.hubdb.tables.export_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.hubdb.tables.export_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().hubdb().tables().exportDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableExportDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().hubdb().tables().exportDraft("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.ExportDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Hubdb.Tables.ExportDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableExportDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.export_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.hubdb.tables.export_draft("tableIdOrName")\n\nputs(response)', + }, + php: { + method: 'cms->hubdb->tables->exportDraft', + example: + "cms->hubdb->tables->exportDraft(\n 'tableIdOrName', format: 'format'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/export \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}', + httpMethod: 'get', + summary: 'Get details of a published table', + description: + "Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a `portalId` query parameter.", + stainlessPath: '(resource) cms.hubdb.tables > (method) get', + qualified: 'client.cms.hubdb.tables.get', + params: [ + 'tableIdOrName: string;', + 'archived?: boolean;', + 'includeForeignIds?: boolean;', + 'isGetLocalizedSchema?: boolean;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## get\n\n`client.cms.hubdb.tables.get(tableIdOrName: string, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}`\n\nReturns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a `portalId` query parameter.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.get('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.get('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.get(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().get("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.Get(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.get("tableIdOrName")\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->get', + example: + "cms->hubdb->tables->get(\n 'tableIdOrName',\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', + httpMethod: 'get', + summary: 'Get details for a draft table', + description: + 'Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.', + stainlessPath: '(resource) cms.hubdb.tables > (method) get_draft', + qualified: 'client.cms.hubdb.tables.getDraft', + params: [ + 'tableIdOrName: string;', + 'archived?: boolean;', + 'includeForeignIds?: boolean;', + 'isGetLocalizedSchema?: boolean;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## get_draft\n\n`client.cms.hubdb.tables.getDraft(tableIdOrName: string, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft`\n\nGet the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.getDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.getDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.getDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.get_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.get_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().getDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().getDraft("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.GetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.GetDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableGetDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.get_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.get_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->getDraft', + example: + "cms->hubdb->tables->getDraft(\n 'tableIdOrName',\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'import_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import', + httpMethod: 'post', + summary: 'Import data into draft table', + description: + 'Import the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use the `/publish` endpoint to push these changes to the published version.\nThis endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as `config`. The second part will be the CSV file you want to import and you can specify this with the name as `file`. Refer the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables) to check the details and format of the JSON-formatted options for the import.', + stainlessPath: '(resource) cms.hubdb.tables > (method) import_draft', + qualified: 'client.cms.hubdb.tables.importDraft', + params: ['tableIdOrName: string;', 'config?: string;', 'file?: string;'], + response: + '{ duplicateRows: number; errors: { category: string; correlationId: string; message: string; context?: object; errors?: error_detail[]; links?: object; subCategory?: string; }[]; rowLimitExceeded: boolean; rowsImported: number; }', + markdown: + "## import_draft\n\n`client.cms.hubdb.tables.importDraft(tableIdOrName: string, config?: string, file?: string): { duplicateRows: number; errors: error_data[]; rowLimitExceeded: boolean; rowsImported: number; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import`\n\nImport the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use the `/publish` endpoint to push these changes to the published version.\nThis endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as `config`. The second part will be the CSV file you want to import and you can specify this with the name as `file`. Refer the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables) to check the details and format of the JSON-formatted options for the import.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `config?: string`\n\n- `file?: string`\n\n### Returns\n\n- `{ duplicateRows: number; errors: { category: string; correlationId: string; message: string; context?: object; errors?: error_detail[]; links?: object; subCategory?: string; }[]; rowLimitExceeded: boolean; rowsImported: number; }`\n\n - `duplicateRows: number`\n - `errors: { category: string; correlationId: string; message: string; context?: object; errors?: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links?: object; subCategory?: string; }[]`\n - `rowLimitExceeded: boolean`\n - `rowsImported: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst importResult = await client.cms.hubdb.tables.importDraft('tableIdOrName');\n\nconsole.log(importResult);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.importDraft', + example: + "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst importResult = await client.cms.hubdb.tables.importDraft('tableIdOrName');\n\nconsole.log(importResult.duplicateRows);", + }, + python: { + method: 'cms.hubdb.tables.import_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nimport_result = client.cms.hubdb.tables.import_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(import_result.duplicate_rows)', + }, + java: { + method: 'cms().hubdb().tables().importDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportResult importResult = client.cms().hubdb().tables().importDraft("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.ImportDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\timportResult, err := client.Cms.Hubdb.Tables.ImportDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableImportDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", importResult.DuplicateRows)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.import_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nimport_result = hubspot.cms.hubdb.tables.import_draft("tableIdOrName")\n\nputs(import_result)', + }, + php: { + method: 'cms->hubdb->tables->importDraft', + example: + "cms->hubdb->tables->importDraft(\n 'tableIdOrName',\n config: 'config',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n);\n\nvar_dump($importResult);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/import \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/hubdb/2026-03/tables', + httpMethod: 'get', + summary: 'Get all published tables', + description: + 'Returns the details for the published version of each table defined in an account, including column definitions.', + stainlessPath: '(resource) cms.hubdb.tables > (method) list', + qualified: 'client.cms.hubdb.tables.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'contentType?: string;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'isGetLocalizedSchema?: boolean;', + 'limit?: number;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## list\n\n`client.cms.hubdb.tables.list(after?: string, archived?: boolean, contentType?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, isGetLocalizedSchema?: boolean, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables`\n\nReturns the details for the published version of each table defined in an account, including column definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `contentType?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `isGetLocalizedSchema?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.list()) {\n console.log(hubDBTableV3);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.list()) {\n console.log(hubDBTableV3.id);\n}", + }, + python: { + method: 'cms.hubdb.tables.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.hubdb.tables.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().hubdb().tables().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListPage;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableListPage page = client.cms().hubdb().tables().list();\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Hubdb.Tables.List(context.TODO(), cms.HubdbTableListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.hubdb.tables.list\n\nputs(page)', + }, + php: { + method: 'cms->hubdb->tables->list', + example: + "cms->hubdb->tables->list(\n after: 'after',\n archived: true,\n contentType: 'contentType',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isGetLocalizedSchema: true,\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_draft', + endpoint: '/cms/hubdb/2026-03/tables/draft', + httpMethod: 'get', + summary: 'Return all draft tables', + description: + 'Returns the details for each draft table defined in the specified account, including column definitions.', + stainlessPath: '(resource) cms.hubdb.tables > (method) list_draft', + qualified: 'client.cms.hubdb.tables.listDraft', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'contentType?: string;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'isGetLocalizedSchema?: boolean;', + 'limit?: number;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## list_draft\n\n`client.cms.hubdb.tables.listDraft(after?: string, archived?: boolean, contentType?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, isGetLocalizedSchema?: boolean, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/draft`\n\nReturns the details for each draft table defined in the specified account, including column definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `contentType?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `isGetLocalizedSchema?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.listDraft()) {\n console.log(hubDBTableV3);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.listDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.listDraft()) {\n console.log(hubDBTableV3.id);\n}", + }, + python: { + method: 'cms.hubdb.tables.list_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.hubdb.tables.list_draft()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().hubdb().tables().listDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListDraftPage;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableListDraftPage page = client.cms().hubdb().tables().listDraft();\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.ListDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Hubdb.Tables.ListDraft(context.TODO(), cms.HubdbTableListDraftParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.list_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.hubdb.tables.list_draft\n\nputs(page)', + }, + php: { + method: 'cms->hubdb->tables->listDraft', + example: + "cms->hubdb->tables->listDraft(\n after: 'after',\n archived: true,\n contentType: 'contentType',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isGetLocalizedSchema: true,\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'publish_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish', + httpMethod: 'post', + summary: 'Publish a table from draft', + description: + 'Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.', + stainlessPath: '(resource) cms.hubdb.tables > (method) publish_draft', + qualified: 'client.cms.hubdb.tables.publishDraft', + params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## publish_draft\n\n`client.cms.hubdb.tables.publishDraft(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish`\n\nPublishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.publishDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.publishDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.publishDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.publish_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.publish_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().publishDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TablePublishDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().publishDraft("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.PublishDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.PublishDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTablePublishDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.publish_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.publish_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->publishDraft', + example: + "cms->hubdb->tables->publishDraft(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/publish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset', + httpMethod: 'post', + summary: 'Reset a table draft', + description: + 'Replaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.', + stainlessPath: '(resource) cms.hubdb.tables > (method) reset_draft', + qualified: 'client.cms.hubdb.tables.resetDraft', + params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## reset_draft\n\n`client.cms.hubdb.tables.resetDraft(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset`\n\nReplaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.resetDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.resetDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.resetDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.reset_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.reset_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().resetDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().resetDraft("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.ResetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.ResetDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableResetDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.reset_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.reset_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->resetDraft', + example: + "cms->hubdb->tables->resetDraft(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'unpublish', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish', + httpMethod: 'post', + summary: 'Unpublish a table', + description: + 'Unpublishes the table, meaning any website pages using data from the table will not render any data.', + stainlessPath: '(resource) cms.hubdb.tables > (method) unpublish', + qualified: 'client.cms.hubdb.tables.unpublish', + params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## unpublish\n\n`client.cms.hubdb.tables.unpublish(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish`\n\nUnpublishes the table, meaning any website pages using data from the table will not render any data.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.unpublish('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.unpublish', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.unpublish('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.unpublish', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.unpublish(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().unpublish', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableUnpublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().unpublish("tableIdOrName");\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.Unpublish', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.Unpublish(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableUnpublishParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.unpublish', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.unpublish("tableIdOrName")\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->unpublish', + example: + "cms->hubdb->tables->unpublish(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/unpublish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_draft', + endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', + httpMethod: 'patch', + summary: 'Update an existing table', + description: + 'Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the `/publish` endpoint to push all the changes to the published version. To restore a table, include the query parameter `archived=true` and `"archived": false` in the json body.\n**Note:** You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.', + stainlessPath: '(resource) cms.hubdb.tables > (method) update_draft', + qualified: 'client.cms.hubdb.tables.updateDraft', + params: [ + 'tableIdOrName: string;', + 'allowChildTables: boolean;', + 'allowPublicApiAccess: boolean;', + 'columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[];', + 'dynamicMetaTags: object;', + 'enableChildTablePages: boolean;', + 'label: string;', + 'name: string;', + 'useForPages: boolean;', + 'archived?: boolean;', + 'includeForeignIds?: boolean;', + 'isGetLocalizedSchema?: boolean;', + ], + response: + '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', + markdown: + "## update_draft\n\n`client.cms.hubdb.tables.updateDraft(tableIdOrName: string, allowChildTables: boolean, allowPublicApiAccess: boolean, columns: { id: number; label: string; name: string; options: hubdb_option[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[], dynamicMetaTags: object, enableChildTablePages: boolean, label: string, name: string, useForPages: boolean, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**patch** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft`\n\nUpdate an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the `/publish` endpoint to push all the changes to the published version. To restore a table, include the query parameter `archived=true` and `\"archived\": false` in the json body.\n**Note:** You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `allowChildTables: boolean`\n Specifies whether child tables can be created\n\n- `allowPublicApiAccess: boolean`\n Specifies whether the table can be read by public without authorization\n\n- `columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[]`\n List of columns in the table\n\n- `dynamicMetaTags: object`\n Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.\n\n- `enableChildTablePages: boolean`\n Specifies creation of multi-level dynamic pages using child tables\n\n- `label: string`\n Label of the table\n\n- `name: string`\n Name of the table\n\n- `useForPages: boolean`\n Specifies whether the table can be used for creation of dynamic pages\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.updateDraft('tableIdOrName', {\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [{\n id: 0,\n label: 'label',\n name: 'name',\n options: [{\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n}],\n type: 'BOOLEAN',\n}],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3);\n```", + perLanguage: { + typescript: { + method: 'client.cms.hubdb.tables.updateDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.updateDraft('tableIdOrName', {\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [\n {\n id: 0,\n label: 'label',\n name: 'name',\n options: [\n {\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n },\n ],\n type: 'BOOLEAN',\n },\n ],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3.id);", + }, + python: { + method: 'cms.hubdb.tables.update_draft', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.update_draft(\n table_id_or_name="tableIdOrName",\n allow_child_tables=True,\n allow_public_api_access=True,\n columns=[{\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [{\n "id": "id",\n "created_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updated_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n "type": "BOOLEAN",\n }],\n dynamic_meta_tags={\n "foo": 0\n },\n enable_child_table_pages=True,\n label="label",\n name="name",\n use_for_pages=True,\n)\nprint(hub_db_table_v3.id)', + }, + java: { + method: 'cms().hubdb().tables().updateDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.ColumnRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.HubdbOption;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableUpdateDraftParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableUpdateDraftParams params = TableUpdateDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableV3Request(HubDbTableV3Request.builder()\n .allowChildTables(true)\n .allowPublicApiAccess(true)\n .addColumn(ColumnRequest.builder()\n .id(0)\n .label("label")\n .name("name")\n .addOption(HubdbOption.builder()\n .id("id")\n .createdAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .label("label")\n .name("name")\n .order(0)\n .type("type")\n .updatedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .type(ColumnRequest.Type.BOOLEAN)\n .build())\n .dynamicMetaTags(HubDbTableV3Request.DynamicMetaTags.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .enableChildTablePages(true)\n .label("label")\n .name("name")\n .useForPages(true)\n .build())\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().updateDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Hubdb.Tables.UpdateDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableUpdateDraftParams{\n\t\t\tHubDBTableV3Request: cms.HubDBTableV3RequestParam{\n\t\t\t\tAllowChildTables: true,\n\t\t\t\tAllowPublicAPIAccess: true,\n\t\t\t\tColumns: []cms.ColumnRequestParam{{\n\t\t\t\t\tID: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tOptions: []cms.HubdbOptionParam{{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\tCreatedAt: time.Now(),\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOrder: 0,\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tUpdatedAt: time.Now(),\n\t\t\t\t\t}},\n\t\t\t\t\tType: cms.ColumnRequestTypeBoolean,\n\t\t\t\t}},\n\t\t\t\tDynamicMetaTags: map[string]int64{\n\t\t\t\t\t"foo": 0,\n\t\t\t\t},\n\t\t\t\tEnableChildTablePages: true,\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tUseForPages: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', + }, + ruby: { + method: 'cms.hubdb.tables.update_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.update_draft(\n "tableIdOrName",\n allow_child_tables: true,\n allow_public_api_access: true,\n columns: [\n {\n id: 0,\n label: "label",\n name: "name",\n options: [\n {\n id: "id",\n createdAt: "2019-12-27T18:11:19.117Z",\n label: "label",\n name: "name",\n order: 0,\n type: "type",\n updatedAt: "2019-12-27T18:11:19.117Z"\n }\n ],\n type: :BOOLEAN\n }\n ],\n dynamic_meta_tags: {foo: 0},\n enable_child_table_pages: true,\n label: "label",\n name: "name",\n use_for_pages: true\n)\n\nputs(hub_db_table_v3)', + }, + php: { + method: 'cms->hubdb->tables->updateDraft', + example: + "cms->hubdb->tables->updateDraft(\n 'tableIdOrName',\n allowChildTables: true,\n allowPublicAPIAccess: true,\n columns: [\n [\n 'id' => 0,\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n [\n 'id' => 'id',\n 'createdAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'label' => 'label',\n 'name' => 'name',\n 'order' => 0,\n 'type' => 'type',\n 'updatedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'createdByUserID' => 0,\n 'updatedBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'updatedByUserID' => 0,\n ],\n ],\n 'type' => 'BOOLEAN',\n 'foreignColumnID' => 0,\n 'foreignTableID' => 0,\n 'maxNumberOfCharacters' => 0,\n 'maxNumberOfOptions' => 0,\n ],\n ],\n dynamicMetaTags: ['foo' => 0],\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowChildTables": true,\n "allowPublicApiAccess": true,\n "columns": [\n {\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [\n {\n "id": "id",\n "createdAt": "2019-12-27T18:11:19.117Z",\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updatedAt": "2019-12-27T18:11:19.117Z"\n }\n ],\n "type": "BOOLEAN"\n }\n ],\n "dynamicMetaTags": {\n "foo": 0\n },\n "enableChildTablePages": true,\n "label": "label",\n "name": "name",\n "useForPages": true\n }\'', + }, + }, + }, + { + name: 'create_association', + endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations', + httpMethod: 'post', + summary: 'Create association definition', + description: 'Create a new association definition for the specified object type.', + stainlessPath: '(resource) cms.media_bridge > (method) create_association', + qualified: 'client.cms.mediaBridge.createAssociation', + params: [ + 'appId: number;', + 'objectType: string;', + 'fromObjectTypeId: string;', + 'toObjectTypeId: string;', + 'name?: string;', + ], + response: + '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', + markdown: + "## create_association\n\n`client.cms.mediaBridge.createAssociation(appId: number, objectType: string, fromObjectTypeId: string, toObjectTypeId: string, name?: string): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/schemas/{objectType}/associations`\n\nCreate a new association definition for the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.cms.mediaBridge.createAssociation('objectType', {\n appId: 0,\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createAssociation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.cms.mediaBridge.createAssociation('objectType', {\n appId: 0,\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition.id);", + }, + python: { + method: 'cms.media_bridge.create_association', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.cms.media_bridge.create_association(\n object_type="objectType",\n app_id=0,\n from_object_type_id="fromObjectTypeId",\n to_object_type_id="toObjectTypeId",\n)\nprint(association_definition.id)', + }, + java: { + method: 'cms().mediaBridge().createAssociation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.AssociationDefinitionEgg;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateAssociationParams params = MediaBridgeCreateAssociationParams.builder()\n .appId(0)\n .objectType("objectType")\n .associationDefinitionEgg(AssociationDefinitionEgg.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build())\n .build();\n AssociationDefinition associationDefinition = client.cms().mediaBridge().createAssociation(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewAssociation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Cms.MediaBridge.NewAssociation(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewAssociationParams{\n\t\t\tAppID: 0,\n\t\t\tAssociationDefinitionEgg: shared.AssociationDefinitionEggParam{\n\t\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t\t\tToObjectTypeID: "toObjectTypeId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_association', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.cms.media_bridge.create_association(\n "objectType",\n app_id: 0,\n from_object_type_id: "fromObjectTypeId",\n to_object_type_id: "toObjectTypeId"\n)\n\nputs(association_definition)', + }, + php: { + method: 'cms->mediaBridge->createAssociation', + example: + "cms->mediaBridge->createAssociation(\n 'objectType',\n appID: 0,\n fromObjectTypeID: 'fromObjectTypeId',\n toObjectTypeID: 'toObjectTypeId',\n name: 'name',\n);\n\nvar_dump($associationDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE/associations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromObjectTypeId": "fromObjectTypeId",\n "toObjectTypeId": "toObjectTypeId"\n }\'', + }, + }, + }, + { + name: 'create_attention_span_event', + endpoint: '/media-bridge/2026-03/events/attention-span', + httpMethod: 'post', + summary: 'Create an attention span event', + description: 'Create an event containing the viewers attention span details for the media.', + stainlessPath: '(resource) cms.media_bridge > (method) create_attention_span_event', + qualified: 'client.cms.mediaBridge.createAttentionSpanEvent', + params: [ + "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", + 'occurredTimestamp: number;', + 'rawDataMap: object;', + 'sessionId: string;', + '_hsenc?: string;', + 'contactId?: number;', + 'contactUtk?: string;', + 'derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; };', + 'externalId?: string;', + "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", + 'mediaBridgeId?: number;', + 'mediaName?: string;', + 'mediaUrl?: string;', + 'pageId?: number;', + 'pageName?: string;', + 'pageUrl?: string;', + 'rawDataString?: string;', + ], + response: + "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }", + markdown: + "## create_attention_span_event\n\n`client.cms.mediaBridge.createAttentionSpanEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, rawDataMap: object, sessionId: string, _hsenc?: string, contactId?: number, contactUtk?: string, derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; }, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string, rawDataString?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }`\n\n**post** `/media-bridge/2026-03/events/attention-span`\n\nCreate an event containing the viewers attention span details for the media.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `rawDataMap: object`\n\n- `sessionId: string`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; }`\n - `totalPercentPlayed: number`\n - `totalSecondsPlayed: number`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n- `rawDataString?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `percentRange: string`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `totalPercentPlayed: number`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n - `rawData?: string`\n - `totalSecondsPlayed?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attentionSpanEvent = await client.cms.mediaBridge.createAttentionSpanEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: { foo: 0 },\n sessionId: 'sessionId',\n});\n\nconsole.log(attentionSpanEvent);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createAttentionSpanEvent', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attentionSpanEvent = await client.cms.mediaBridge.createAttentionSpanEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: { foo: 0 },\n sessionId: 'sessionId',\n});\n\nconsole.log(attentionSpanEvent.mediaBridgeId);", + }, + python: { + method: 'cms.media_bridge.create_attention_span_event', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattention_span_event = client.cms.media_bridge.create_attention_span_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n raw_data_map={\n "foo": 0\n },\n session_id="sessionId",\n)\nprint(attention_span_event.media_bridge_id)', + }, + java: { + method: 'cms().mediaBridge().createAttentionSpanEvent', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.mediabridge.AttentionSpanEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.AttentionSpanEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttentionSpanEventRequest params = AttentionSpanEventRequest.builder()\n .mediaType(AttentionSpanEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .rawDataMap(AttentionSpanEventRequest.RawDataMap.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .sessionId("sessionId")\n .build();\n AttentionSpanEvent attentionSpanEvent = client.cms().mediaBridge().createAttentionSpanEvent(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewAttentionSpanEvent', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattentionSpanEvent, err := client.Cms.MediaBridge.NewAttentionSpanEvent(context.TODO(), cms.MediaBridgeNewAttentionSpanEventParams{\n\t\tAttentionSpanEventRequest: cms.AttentionSpanEventRequestParam{\n\t\t\tMediaType: cms.AttentionSpanEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tRawDataMap: map[string]int64{\n\t\t\t\t"foo": 0,\n\t\t\t},\n\t\t\tSessionID: "sessionId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attentionSpanEvent.MediaBridgeID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_attention_span_event', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattention_span_event = hubspot.cms.media_bridge.create_attention_span_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n raw_data_map: {foo: 0},\n session_id: "sessionId"\n)\n\nputs(attention_span_event)', + }, + php: { + method: 'cms->mediaBridge->createAttentionSpanEvent', + example: + "cms->mediaBridge->createAttentionSpanEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: ['foo' => 0],\n sessionID: 'sessionId',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n derivedValues: ['totalPercentPlayed' => 0, 'totalSecondsPlayed' => 0],\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n rawDataString: 'rawDataString',\n);\n\nvar_dump($attentionSpanEvent);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/events/attention-span \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "rawDataMap": {\n "foo": 0\n },\n "sessionId": "sessionId"\n }\'', + }, + }, + }, + { + name: 'create_media_played_event', + endpoint: '/media-bridge/2026-03/events/media-played', + httpMethod: 'post', + summary: 'Create a played event', + description: 'Create an event for when a user begins playing a piece of media.', + stainlessPath: '(resource) cms.media_bridge > (method) create_media_played_event', + qualified: 'client.cms.mediaBridge.createMediaPlayedEvent', + params: [ + "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", + 'occurredTimestamp: number;', + 'sessionId: string;', + "state: 'STARTED' | 'VIEWED';", + '_hsenc?: string;', + 'contactId?: number;', + 'contactUtk?: string;', + 'externalId?: string;', + "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", + 'iframeUrl?: string;', + 'mediaBridgeId?: number;', + 'mediaName?: string;', + 'mediaUrl?: string;', + 'pageId?: number;', + 'pageName?: string;', + 'pageUrl?: string;', + ], + response: + "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }", + markdown: + "## create_media_played_event\n\n`client.cms.mediaBridge.createMediaPlayedEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, sessionId: string, state: 'STARTED' | 'VIEWED', _hsenc?: string, contactId?: number, contactUtk?: string, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', iframeUrl?: string, mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n**post** `/media-bridge/2026-03/events/media-played`\n\nCreate an event for when a user begins playing a piece of media.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `sessionId: string`\n\n- `state: 'STARTED' | 'VIEWED'`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `iframeUrl?: string`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `state: 'STARTED' | 'VIEWED'`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `iframeUrl?: string`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaPlayedEvent = await client.cms.mediaBridge.createMediaPlayedEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionId: 'sessionId',\n state: 'STARTED',\n});\n\nconsole.log(mediaPlayedEvent);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createMediaPlayedEvent', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaPlayedEvent = await client.cms.mediaBridge.createMediaPlayedEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionId: 'sessionId',\n state: 'STARTED',\n});\n\nconsole.log(mediaPlayedEvent.mediaBridgeId);", + }, + python: { + method: 'cms.media_bridge.create_media_played_event', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_played_event = client.cms.media_bridge.create_media_played_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n session_id="sessionId",\n state="STARTED",\n)\nprint(media_played_event.media_bridge_id)', + }, + java: { + method: 'cms().mediaBridge().createMediaPlayedEvent', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaPlayedEventRequest params = MediaPlayedEventRequest.builder()\n .mediaType(MediaPlayedEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .sessionId("sessionId")\n .state(MediaPlayedEventRequest.State.STARTED)\n .build();\n MediaPlayedEvent mediaPlayedEvent = client.cms().mediaBridge().createMediaPlayedEvent(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewMediaPlayedEvent', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaPlayedEvent, err := client.Cms.MediaBridge.NewMediaPlayedEvent(context.TODO(), cms.MediaBridgeNewMediaPlayedEventParams{\n\t\tMediaPlayedEventRequest: cms.MediaPlayedEventRequestParam{\n\t\t\tMediaType: cms.MediaPlayedEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tSessionID: "sessionId",\n\t\t\tState: cms.MediaPlayedEventRequestStateStarted,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaPlayedEvent.MediaBridgeID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_media_played_event', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_played_event = hubspot.cms.media_bridge.create_media_played_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n session_id: "sessionId",\n state: :STARTED\n)\n\nputs(media_played_event)', + }, + php: { + method: 'cms->mediaBridge->createMediaPlayedEvent', + example: + "cms->mediaBridge->createMediaPlayedEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionID: 'sessionId',\n state: 'STARTED',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n iframeURL: 'iframeUrl',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n);\n\nvar_dump($mediaPlayedEvent);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/events/media-played \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "sessionId": "sessionId",\n "state": "STARTED"\n }\'', + }, + }, + }, + { + name: 'create_media_played_percent_event', + endpoint: '/media-bridge/2026-03/events/media-played-percent', + httpMethod: 'post', + summary: 'Create a quartile event', + description: + "Create an event representing a user reaching quarterly milestones in a piece of media they're viewing.", + stainlessPath: '(resource) cms.media_bridge > (method) create_media_played_percent_event', + qualified: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', + params: [ + "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", + 'occurredTimestamp: number;', + 'playedPercent: number;', + 'sessionId: string;', + '_hsenc?: string;', + 'contactId?: number;', + 'contactUtk?: string;', + 'externalId?: string;', + "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", + 'mediaBridgeId?: number;', + 'mediaName?: string;', + 'mediaUrl?: string;', + 'pageId?: number;', + 'pageName?: string;', + 'pageUrl?: string;', + ], + response: + "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }", + markdown: + "## create_media_played_percent_event\n\n`client.cms.mediaBridge.createMediaPlayedPercentEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, playedPercent: number, sessionId: string, _hsenc?: string, contactId?: number, contactUtk?: string, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n**post** `/media-bridge/2026-03/events/media-played-percent`\n\nCreate an event representing a user reaching quarterly milestones in a piece of media they're viewing.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `playedPercent: number`\n\n- `sessionId: string`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `playedPercent: number`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaPlayedPercentageEvent = await client.cms.mediaBridge.createMediaPlayedPercentEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionId: 'sessionId',\n});\n\nconsole.log(mediaPlayedPercentageEvent);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaPlayedPercentageEvent = await client.cms.mediaBridge.createMediaPlayedPercentEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionId: 'sessionId',\n});\n\nconsole.log(mediaPlayedPercentageEvent.mediaBridgeId);", + }, + python: { + method: 'cms.media_bridge.create_media_played_percent_event', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_played_percentage_event = client.cms.media_bridge.create_media_played_percent_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n played_percent=0,\n session_id="sessionId",\n)\nprint(media_played_percentage_event.media_bridge_id)', + }, + java: { + method: 'cms().mediaBridge().createMediaPlayedPercentEvent', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedPercentageEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedPercentageEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaPlayedPercentageEventRequest params = MediaPlayedPercentageEventRequest.builder()\n .mediaType(MediaPlayedPercentageEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .playedPercent(0)\n .sessionId("sessionId")\n .build();\n MediaPlayedPercentageEvent mediaPlayedPercentageEvent = client.cms().mediaBridge().createMediaPlayedPercentEvent(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewMediaPlayedPercentEvent', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaPlayedPercentageEvent, err := client.Cms.MediaBridge.NewMediaPlayedPercentEvent(context.TODO(), cms.MediaBridgeNewMediaPlayedPercentEventParams{\n\t\tMediaPlayedPercentageEventRequest: cms.MediaPlayedPercentageEventRequestParam{\n\t\t\tMediaType: cms.MediaPlayedPercentageEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tPlayedPercent: 0,\n\t\t\tSessionID: "sessionId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaPlayedPercentageEvent.MediaBridgeID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_media_played_percent_event', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_played_percentage_event = hubspot.cms.media_bridge.create_media_played_percent_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n played_percent: 0,\n session_id: "sessionId"\n)\n\nputs(media_played_percentage_event)', + }, + php: { + method: 'cms->mediaBridge->createMediaPlayedPercentEvent', + example: + "cms\n ->mediaBridge\n ->createMediaPlayedPercentEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionID: 'sessionId',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n);\n\nvar_dump($mediaPlayedPercentageEvent);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/events/media-played-percent \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "playedPercent": 0,\n "sessionId": "sessionId"\n }\'', + }, + }, + }, + { + name: 'create_object_type', + endpoint: '/media-bridge/2026-03/{appId}/settings/object-definitions', + httpMethod: 'post', + summary: 'Create a new object type', + description: 'Create a new media object type', + stainlessPath: '(resource) cms.media_bridge > (method) create_object_type', + qualified: 'client.cms.mediaBridge.createObjectType', + params: ['appId: number;', "mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[];"], + response: '{ createdObjects: object; }', + markdown: + "## create_object_type\n\n`client.cms.mediaBridge.createObjectType(appId: number, mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[]): { createdObjects: object; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/object-definitions`\n\nCreate a new media object type\n\n### Parameters\n\n- `appId: number`\n\n- `mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[]`\n\n### Returns\n\n- `{ createdObjects: object; }`\n\n - `createdObjects: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst bulkIntegratorObjectCreationResponse = await client.cms.mediaBridge.createObjectType(0, { mediaTypes: ['VIDEO'] });\n\nconsole.log(bulkIntegratorObjectCreationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createObjectType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst bulkIntegratorObjectCreationResponse = await client.cms.mediaBridge.createObjectType(0, {\n mediaTypes: ['VIDEO'],\n});\n\nconsole.log(bulkIntegratorObjectCreationResponse.createdObjects);", + }, + python: { + method: 'cms.media_bridge.create_object_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbulk_integrator_object_creation_response = client.cms.media_bridge.create_object_type(\n app_id=0,\n media_types=["VIDEO"],\n)\nprint(bulk_integrator_object_creation_response.created_objects)', + }, + java: { + method: 'cms().mediaBridge().createObjectType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.BulkIntegratorObjectCreationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorObjectCreationRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateObjectTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateObjectTypeParams params = MediaBridgeCreateObjectTypeParams.builder()\n .appId(0)\n .integratorObjectCreationRequest(IntegratorObjectCreationRequest.builder()\n .addMediaType(IntegratorObjectCreationRequest.MediaType.VIDEO)\n .build())\n .build();\n BulkIntegratorObjectCreationResponse bulkIntegratorObjectCreationResponse = client.cms().mediaBridge().createObjectType(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewObjectType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbulkIntegratorObjectCreationResponse, err := client.Cms.MediaBridge.NewObjectType(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeNewObjectTypeParams{\n\t\t\tIntegratorObjectCreationRequest: cms.IntegratorObjectCreationRequestParam{\n\t\t\t\tMediaTypes: []string{"VIDEO"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", bulkIntegratorObjectCreationResponse.CreatedObjects)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_object_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbulk_integrator_object_creation_response = hubspot.cms.media_bridge.create_object_type(0, media_types: [:VIDEO])\n\nputs(bulk_integrator_object_creation_response)', + }, + php: { + method: 'cms->mediaBridge->createObjectType', + example: + "cms\n ->mediaBridge\n ->createObjectType(0, mediaTypes: ['VIDEO']);\n\nvar_dump($bulkIntegratorObjectCreationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/object-definitions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaTypes": [\n "VIDEO"\n ]\n }\'', + }, + }, + }, + { + name: 'create_oembed_domain', + endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + httpMethod: 'post', + summary: 'Set up a new oEmbed domain', + description: 'Set up a new oEmbed domain for your media bridge app.', + stainlessPath: '(resource) cms.media_bridge > (method) create_oembed_domain', + qualified: 'client.cms.mediaBridge.createOembedDomain', + params: [ + 'appId: number;', + 'endpoints: { discovery: boolean; schemes: string[]; url: string; };', + 'portalId?: number;', + ], + response: + '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', + markdown: + "## create_oembed_domain\n\n`client.cms.mediaBridge.createOembedDomain(appId: number, endpoints: { discovery: boolean; schemes: string[]; url: string; }, portalId?: number): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nSet up a new oEmbed domain for your media bridge app.\n\n### Parameters\n\n- `appId: number`\n\n- `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `discovery: boolean`\n - `schemes: string[]`\n - `url: string`\n\n- `portalId?: number`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.createOembedDomain(0, { endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n} });\n\nconsole.log(integratorOEmbedDomainModel);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createOembedDomain', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.createOembedDomain(0, {\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n },\n});\n\nconsole.log(integratorOEmbedDomainModel.id);", + }, + python: { + method: 'cms.media_bridge.create_oembed_domain', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.create_oembed_domain(\n app_id=0,\n endpoints={\n "discovery": True,\n "schemes": ["string"],\n "url": "url",\n },\n)\nprint(integrator_o_embed_domain_model.id)', + }, + java: { + method: 'cms().mediaBridge().createOembedDomain', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.Endpoints;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateOembedDomainParams params = MediaBridgeCreateOembedDomainParams.builder()\n .appId(0)\n .integratorOEmbedDomainRequest(IntegratorOEmbedDomainRequest.builder()\n .endpoints(Endpoints.builder()\n .discovery(true)\n .addScheme("string")\n .url("url")\n .build())\n .build())\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().createOembedDomain(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewOembedDomain', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.NewOembedDomain(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeNewOembedDomainParams{\n\t\t\tIntegratorOEmbedDomainRequest: cms.IntegratorOEmbedDomainRequestParam{\n\t\t\t\tEndpoints: cms.EndpointsParam{\n\t\t\t\t\tDiscovery: true,\n\t\t\t\t\tSchemes: []string{"string"},\n\t\t\t\t\tURL: "url",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_oembed_domain', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.create_oembed_domain(\n 0,\n endpoints: {discovery: true, schemes: ["string"], url: "url"}\n)\n\nputs(integrator_o_embed_domain_model)', + }, + php: { + method: 'cms->mediaBridge->createOembedDomain', + example: + "cms->mediaBridge->createOembedDomain(\n 0,\n endpoints: ['discovery' => true, 'schemes' => ['string'], 'url' => 'url'],\n portalID: 0,\n);\n\nvar_dump($integratorOEmbedDomainModel);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endpoints": {\n "discovery": true,\n "schemes": [\n "string"\n ],\n "url": "url"\n }\n }\'', + }, + }, + }, + { + name: 'create_property', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}', + httpMethod: 'post', + summary: 'Create a new property', + description: 'Create a new property for the specified media type', + stainlessPath: '(resource) cms.media_bridge > (method) create_property', + qualified: 'client.cms.mediaBridge.createProperty', + params: [ + 'appId: number;', + 'objectType: string;', + 'fieldType: string;', + 'groupName: string;', + 'label: string;', + 'name: string;', + "type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", + 'calculationFormula?: string;', + 'currencyPropertyName?: string;', + "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'description?: string;', + 'displayOrder?: number;', + 'externalOptions?: boolean;', + 'formField?: boolean;', + 'hasUniqueValue?: boolean;', + 'hidden?: boolean;', + "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + 'referencedObjectType?: string;', + 'showCurrencySymbol?: boolean;', + ], + response: 'object', + markdown: + "## create_property\n\n`client.cms.mediaBridge.createProperty(appId: number, objectType: string, fieldType: string, groupName: string, label: string, name: string, type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string', calculationFormula?: string, currencyPropertyName?: string, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', description?: string, displayOrder?: number, externalOptions?: boolean, formField?: boolean, hasUniqueValue?: boolean, hidden?: boolean, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], referencedObjectType?: string, showCurrencySymbol?: boolean): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}`\n\nCreate a new property for the specified media type\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `fieldType: string`\n\n- `groupName: string`\n\n- `label: string`\n\n- `name: string`\n\n- `type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `externalOptions?: boolean`\n\n- `formField?: boolean`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `referencedObjectType?: string`\n\n- `showCurrencySymbol?: boolean`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.createProperty('objectType', {\n appId: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(mediaBridgeProperty);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.createProperty('objectType', {\n appId: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", + }, + python: { + method: 'cms.media_bridge.create_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.create_property(\n object_type="objectType",\n app_id=0,\n field_type="booleancheckbox",\n group_name="groupName",\n label="label",\n name="name",\n type="bool",\n)\nprint(media_bridge_property.hidden)', + }, + java: { + method: 'cms().mediaBridge().createProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreatePropertyParams;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreatePropertyParams params = MediaBridgeCreatePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyCreate(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().createProperty(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewProperty', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.NewProperty(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewPropertyParams{\n\t\t\tAppID: 0,\n\t\t\tPropertyCreate: shared.PropertyCreateParam{\n\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\tGroupName: "groupName",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.create_property(\n "objectType",\n app_id: 0,\n field_type: :booleancheckbox,\n group_name: "groupName",\n label: "label",\n name: "name",\n type: :bool\n)\n\nputs(media_bridge_property)', + }, + php: { + method: 'cms->mediaBridge->createProperty', + example: + "cms->mediaBridge->createProperty(\n 'objectType',\n appID: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n dataSensitivity: 'highly_sensitive',\n description: 'description',\n displayOrder: 0,\n externalOptions: true,\n formField: true,\n hasUniqueValue: true,\n hidden: true,\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n referencedObjectType: 'referencedObjectType',\n showCurrencySymbol: true,\n);\n\nvar_dump($mediaBridgeProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\'', + }, + }, + }, + { + name: 'create_property_group', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', + httpMethod: 'post', + summary: 'Create a new property group', + description: 'Create a new property group for the specified object type.', + stainlessPath: '(resource) cms.media_bridge > (method) create_property_group', + qualified: 'client.cms.mediaBridge.createPropertyGroup', + params: [ + 'appId: number;', + 'objectType: string;', + 'label: string;', + 'name: string;', + 'displayOrder?: number;', + ], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## create_property_group\n\n`client.cms.mediaBridge.createPropertyGroup(appId: number, objectType: string, label: string, name: string, displayOrder?: number): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups`\n\nCreate a new property group for the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `label: string`\n\n- `name: string`\n\n- `displayOrder?: number`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.createPropertyGroup('objectType', {\n appId: 0,\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createPropertyGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.createPropertyGroup('objectType', {\n appId: 0,\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'cms.media_bridge.create_property_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.create_property_group(\n object_type="objectType",\n app_id=0,\n label="label",\n name="name",\n)\nprint(property_group.archived)', + }, + java: { + method: 'cms().mediaBridge().createPropertyGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreatePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreatePropertyGroupParams params = MediaBridgeCreatePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyGroupCreate(PropertyGroupCreate.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().createPropertyGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewPropertyGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.NewPropertyGroup(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewPropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tPropertyGroupCreate: shared.PropertyGroupCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_property_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.create_property_group("objectType", app_id: 0, label: "label", name: "name")\n\nputs(property_group)', + }, + php: { + method: 'cms->mediaBridge->createPropertyGroup', + example: + "cms->mediaBridge->createPropertyGroup(\n 'objectType', appID: 0, label: 'label', name: 'name', displayOrder: 0\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'create_video_association_definition', + endpoint: '/media-bridge/2026-03/{appId}/settings/video-association-definition', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) cms.media_bridge > (method) create_video_association_definition', + qualified: 'client.cms.mediaBridge.createVideoAssociationDefinition', + params: ['appId: number;'], + response: + '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', + markdown: + "## create_video_association_definition\n\n`client.cms.mediaBridge.createVideoAssociationDefinition(appId: number): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/video-association-definition`\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.cms.mediaBridge.createVideoAssociationDefinition(0);\n\nconsole.log(associationDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.createVideoAssociationDefinition', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.cms.mediaBridge.createVideoAssociationDefinition(0);\n\nconsole.log(associationDefinition.id);", + }, + python: { + method: 'cms.media_bridge.create_video_association_definition', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.cms.media_bridge.create_video_association_definition(\n 0,\n)\nprint(association_definition.id)', + }, + java: { + method: 'cms().mediaBridge().createVideoAssociationDefinition', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateVideoAssociationDefinitionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationDefinition associationDefinition = client.cms().mediaBridge().createVideoAssociationDefinition(0);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.NewVideoAssociationDefinition', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Cms.MediaBridge.NewVideoAssociationDefinition(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.create_video_association_definition', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.cms.media_bridge.create_video_association_definition(0)\n\nputs(association_definition)', + }, + php: { + method: 'cms->mediaBridge->createVideoAssociationDefinition', + example: + "cms\n ->mediaBridge\n ->createVideoAssociationDefinition(0);\n\nvar_dump($associationDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/video-association-definition \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_association', + endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}', + httpMethod: 'delete', + summary: 'Delete an association definition', + description: 'Delete an existing association definition for an object type.', + stainlessPath: '(resource) cms.media_bridge > (method) delete_association', + qualified: 'client.cms.mediaBridge.deleteAssociation', + params: ['appId: number;', 'objectType: string;', 'associationId: string;'], + markdown: + "## delete_association\n\n`client.cms.mediaBridge.deleteAssociation(appId: number, objectType: string, associationId: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}`\n\nDelete an existing association definition for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `associationId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteAssociation('associationId', { appId: 0, objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.deleteAssociation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteAssociation('associationId', {\n appId: 0,\n objectType: 'objectType',\n});", + }, + python: { + method: 'cms.media_bridge.delete_association', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_association(\n association_id="associationId",\n app_id=0,\n object_type="objectType",\n)', + }, + java: { + method: 'cms().mediaBridge().deleteAssociation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeleteAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeleteAssociationParams params = MediaBridgeDeleteAssociationParams.builder()\n .appId(0)\n .objectType("objectType")\n .associationId("associationId")\n .build();\n client.cms().mediaBridge().deleteAssociation(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.DeleteAssociation', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteAssociation(\n\t\tcontext.TODO(),\n\t\t"associationId",\n\t\tcms.MediaBridgeDeleteAssociationParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.media_bridge.delete_association', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_association("associationId", app_id: 0, object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'cms->mediaBridge->deleteAssociation', + example: + "cms->mediaBridge->deleteAssociation(\n 'associationId', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE/associations/$ASSOCIATION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_oembed_domain', + endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + httpMethod: 'delete', + summary: 'Delete an oEmbed domain', + description: 'Delete an existing oEmbed domain.', + stainlessPath: '(resource) cms.media_bridge > (method) delete_oembed_domain', + qualified: 'client.cms.mediaBridge.deleteOembedDomain', + params: ['appId: number;', 'id?: number;', 'domainPortalId?: number;'], + markdown: + "## delete_oembed_domain\n\n`client.cms.mediaBridge.deleteOembedDomain(appId: number, id?: number, domainPortalId?: number): void`\n\n**delete** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nDelete an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `id?: number`\n\n- `domainPortalId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteOembedDomain(0)\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.deleteOembedDomain', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteOembedDomain(0);", + }, + python: { + method: 'cms.media_bridge.delete_oembed_domain', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_oembed_domain(\n app_id=0,\n)', + }, + java: { + method: 'cms().mediaBridge().deleteOembedDomain', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeleteOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().mediaBridge().deleteOembedDomain(0);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.DeleteOembedDomain', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteOembedDomain(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeDeleteOembedDomainParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.media_bridge.delete_oembed_domain', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_oembed_domain(0)\n\nputs(result)', + }, + php: { + method: 'cms->mediaBridge->deleteOembedDomain', + example: + "cms->mediaBridge->deleteOembedDomain(\n 0, id: 0, domainPortalID: 0\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_property', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + httpMethod: 'delete', + summary: 'Delete a property', + description: 'Delete an existing property for an object type.', + stainlessPath: '(resource) cms.media_bridge > (method) delete_property', + qualified: 'client.cms.mediaBridge.deleteProperty', + params: ['appId: number;', 'objectType: string;', 'propertyName: string;'], + markdown: + "## delete_property\n\n`client.cms.mediaBridge.deleteProperty(appId: number, objectType: string, propertyName: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nDelete an existing property for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteProperty('propertyName', { appId: 0, objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.deleteProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteProperty('propertyName', { appId: 0, objectType: 'objectType' });", + }, + python: { + method: 'cms.media_bridge.delete_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)', + }, + java: { + method: 'cms().mediaBridge().deleteProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeletePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeletePropertyParams params = MediaBridgeDeletePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n client.cms().mediaBridge().deleteProperty(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.DeleteProperty', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeDeletePropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.media_bridge.delete_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'cms->mediaBridge->deleteProperty', + example: + "cms->mediaBridge->deleteProperty(\n 'propertyName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_property_group', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + httpMethod: 'delete', + summary: 'Delete a property group', + description: 'Delete an existing property group by name', + stainlessPath: '(resource) cms.media_bridge > (method) delete_property_group', + qualified: 'client.cms.mediaBridge.deletePropertyGroup', + params: ['appId: number;', 'objectType: string;', 'groupName: string;'], + markdown: + "## delete_property_group\n\n`client.cms.mediaBridge.deletePropertyGroup(appId: number, objectType: string, groupName: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nDelete an existing property group by name\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deletePropertyGroup('groupName', { appId: 0, objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.deletePropertyGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deletePropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});", + }, + python: { + method: 'cms.media_bridge.delete_property_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)', + }, + java: { + method: 'cms().mediaBridge().deletePropertyGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeletePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeletePropertyGroupParams params = MediaBridgeDeletePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .build();\n client.cms().mediaBridge().deletePropertyGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.DeletePropertyGroup', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeletePropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeDeletePropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.media_bridge.delete_property_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'cms->mediaBridge->deletePropertyGroup', + example: + "cms->mediaBridge->deletePropertyGroup(\n 'groupName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_event_visibility_settings', + endpoint: '/media-bridge/2026-03/{appId}/settings/event-visibility', + httpMethod: 'get', + summary: 'View event visibility settings', + description: 'Get the visibility settings for media bridge events for your apps.', + stainlessPath: '(resource) cms.media_bridge > (method) get_event_visibility_settings', + qualified: 'client.cms.mediaBridge.getEventVisibilitySettings', + params: ['appId: number;'], + response: + "{ createdAt: string; visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]; }", + markdown: + "## get_event_visibility_settings\n\n`client.cms.mediaBridge.getEventVisibilitySettings(appId: number): { createdAt: string; visibilitySettings: event_visibility_change[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/event-visibility`\n\nGet the visibility settings for media bridge events for your apps.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]; }`\n\n - `createdAt: string`\n - `visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventVisibilityResponse = await client.cms.mediaBridge.getEventVisibilitySettings(0);\n\nconsole.log(eventVisibilityResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.getEventVisibilitySettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventVisibilityResponse = await client.cms.mediaBridge.getEventVisibilitySettings(0);\n\nconsole.log(eventVisibilityResponse.createdAt);", + }, + python: { + method: 'cms.media_bridge.get_event_visibility_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_visibility_response = client.cms.media_bridge.get_event_visibility_settings(\n 0,\n)\nprint(event_visibility_response.created_at)', + }, + java: { + method: 'cms().mediaBridge().getEventVisibilitySettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.EventVisibilityResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetEventVisibilitySettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventVisibilityResponse eventVisibilityResponse = client.cms().mediaBridge().getEventVisibilitySettings(0);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.GetEventVisibilitySettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventVisibilityResponse, err := client.Cms.MediaBridge.GetEventVisibilitySettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventVisibilityResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.get_event_visibility_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_visibility_response = hubspot.cms.media_bridge.get_event_visibility_settings(0)\n\nputs(event_visibility_response)', + }, + php: { + method: 'cms->mediaBridge->getEventVisibilitySettings', + example: + "cms\n ->mediaBridge\n ->getEventVisibilitySettings(0);\n\nvar_dump($eventVisibilityResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/event-visibility \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_oembed_domain', + endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', + httpMethod: 'get', + summary: 'Get an oEmbed domain', + description: 'Get the details for an existing oEmbed domain.', + stainlessPath: '(resource) cms.media_bridge > (method) get_oembed_domain', + qualified: 'client.cms.mediaBridge.getOembedDomain', + params: ['appId: number;', 'oEmbedDomainId: string;'], + response: + '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', + markdown: + "## get_oembed_domain\n\n`client.cms.mediaBridge.getOembedDomain(appId: number, oEmbedDomainId: string): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}`\n\nGet the details for an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `oEmbedDomainId: string`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.getOembedDomain('oEmbedDomainId', { appId: 0 });\n\nconsole.log(integratorOEmbedDomainModel);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.getOembedDomain', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.getOembedDomain('oEmbedDomainId', {\n appId: 0,\n});\n\nconsole.log(integratorOEmbedDomainModel.id);", + }, + python: { + method: 'cms.media_bridge.get_oembed_domain', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.get_oembed_domain(\n o_embed_domain_id="oEmbedDomainId",\n app_id=0,\n)\nprint(integrator_o_embed_domain_model.id)', + }, + java: { + method: 'cms().mediaBridge().getOembedDomain', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetOembedDomainParams params = MediaBridgeGetOembedDomainParams.builder()\n .appId(0)\n .oEmbedDomainId("oEmbedDomainId")\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().getOembedDomain(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.GetOembedDomain', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.GetOembedDomain(\n\t\tcontext.TODO(),\n\t\t"oEmbedDomainId",\n\t\tcms.MediaBridgeGetOembedDomainParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.get_oembed_domain', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.get_oembed_domain("oEmbedDomainId", app_id: 0)\n\nputs(integrator_o_embed_domain_model)', + }, + php: { + method: 'cms->mediaBridge->getOembedDomain', + example: + "cms->mediaBridge->getOembedDomain(\n 'oEmbedDomainId', appID: 0\n);\n\nvar_dump($integratorOEmbedDomainModel);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains/$O_EMBED_DOMAIN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_property', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + httpMethod: 'get', + summary: 'Get the details for a property', + description: 'Get the details for an existing property by name.', + stainlessPath: '(resource) cms.media_bridge > (method) get_property', + qualified: 'client.cms.mediaBridge.getProperty', + params: [ + 'appId: number;', + 'objectType: string;', + 'propertyName: string;', + 'archived?: boolean;', + 'properties?: string;', + ], + response: 'object', + markdown: + "## get_property\n\n`client.cms.mediaBridge.getProperty(appId: number, objectType: string, propertyName: string, archived?: boolean, properties?: string): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nGet the details for an existing property by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `properties?: string`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.getProperty('propertyName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(mediaBridgeProperty);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.getProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.getProperty('propertyName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", + }, + python: { + method: 'cms.media_bridge.get_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.get_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)\nprint(media_bridge_property.hidden)', + }, + java: { + method: 'cms().mediaBridge().getProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetPropertyParams;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetPropertyParams params = MediaBridgeGetPropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().getProperty(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.GetProperty', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.GetProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeGetPropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.get_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.get_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(media_bridge_property)', + }, + php: { + method: 'cms->mediaBridge->getProperty', + example: + "cms->mediaBridge->getProperty(\n 'propertyName',\n appID: 0,\n objectType: 'objectType',\n archived: true,\n properties: 'properties',\n);\n\nvar_dump($mediaBridgeProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_property_group', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + httpMethod: 'get', + summary: 'Get a specific property group', + description: 'Get the details of an existing property group by name.', + stainlessPath: '(resource) cms.media_bridge > (method) get_property_group', + qualified: 'client.cms.mediaBridge.getPropertyGroup', + params: ['appId: number;', 'objectType: string;', 'groupName: string;'], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## get_property_group\n\n`client.cms.mediaBridge.getPropertyGroup(appId: number, objectType: string, groupName: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nGet the details of an existing property group by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.getPropertyGroup('groupName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.getPropertyGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.getPropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'cms.media_bridge.get_property_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.get_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)\nprint(property_group.archived)', + }, + java: { + method: 'cms().mediaBridge().getPropertyGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetPropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetPropertyGroupParams params = MediaBridgeGetPropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().getPropertyGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.GetPropertyGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.GetPropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeGetPropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.get_property_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.get_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(property_group)', + }, + php: { + method: 'cms->mediaBridge->getPropertyGroup', + example: + "cms->mediaBridge->getPropertyGroup(\n 'groupName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_schema', + endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}', + httpMethod: 'get', + summary: 'Get the schema for an object type', + description: 'Get the schema for a specified object type.', + stainlessPath: '(resource) cms.media_bridge > (method) get_schema', + qualified: 'client.cms.mediaBridge.getSchema', + params: ['appId: number;', 'objectType: string;'], + response: + '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', + markdown: + "## get_schema\n\n`client.cms.mediaBridge.getSchema(appId: number, objectType: string): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/schemas/{objectType}`\n\nGet the schema for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.cms.mediaBridge.getSchema('objectType', { appId: 0 });\n\nconsole.log(objectSchema);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.getSchema', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.cms.mediaBridge.getSchema('objectType', { appId: 0 });\n\nconsole.log(objectSchema.id);", + }, + python: { + method: 'cms.media_bridge.get_schema', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.cms.media_bridge.get_schema(\n object_type="objectType",\n app_id=0,\n)\nprint(object_schema.id)', + }, + java: { + method: 'cms().mediaBridge().getSchema', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetSchemaParams;\nimport com.hubspot.sdk.models.cms.mediabridge.ObjectSchema;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetSchemaParams params = MediaBridgeGetSchemaParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n ObjectSchema objectSchema = client.cms().mediaBridge().getSchema(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.GetSchema', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Cms.MediaBridge.GetSchema(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeGetSchemaParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.get_schema', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.cms.media_bridge.get_schema("objectType", app_id: 0)\n\nputs(object_schema)', + }, + php: { + method: 'cms->mediaBridge->getSchema', + example: + "cms->mediaBridge->getSchema('objectType', appID: 0);\n\nvar_dump($objectSchema);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_object_types_by_media_type', + endpoint: '/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}', + httpMethod: 'get', + summary: 'Get object types for a supported media', + description: 'Get the existing objects types that belong to the specified media type.', + stainlessPath: '(resource) cms.media_bridge > (method) list_object_types_by_media_type', + qualified: 'client.cms.mediaBridge.listObjectTypesByMediaType', + params: [ + 'appId: number;', + "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", + 'includeFullDefinition?: boolean;', + ], + response: + '{ objectTypeId: string; objectTypeName: string; properties: object[]; propertyGroups: object[]; schema?: object; }', + markdown: + "## list_object_types_by_media_type\n\n`client.cms.mediaBridge.listObjectTypesByMediaType(appId: number, mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', includeFullDefinition?: boolean): { objectTypeId: string; objectTypeName: string; properties: property_definition[]; propertyGroups: group_view[]; schema?: inbound_db_object_type; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}`\n\nGet the existing objects types that belong to the specified media type.\n\n### Parameters\n\n- `appId: number`\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `includeFullDefinition?: boolean`\n\n### Returns\n\n- `{ objectTypeId: string; objectTypeName: string; properties: { objectTypeId: string; property: media_bridge_property; calculationExpression?: object; calculationFormula?: string; definitionSource?: property_definition_source; extensionData?: extension_data; externalOptionsMetaData?: external_options_meta_data; fulcrumPortalId?: number; fulcrumTimestamp?: number; janusGroup?: string; lookupAssociationSpec?: lookup_association_spec; permission?: field_level_permission; propertyDefinitionSource?: definition_source; propertyRequirements?: default_requirements; rollupExpression?: rollup_expression; }[]; propertyGroups: { displayName: string; displayOrder: number; fulcrumPortalId: number; fulcrumTimestamp: number; hubspotDefined: boolean; name: string; }[]; schema?: { id: number; allowsSensitiveProperties: boolean; createDatePropertyName: string; defaultSearchPropertyNames: string[]; deleted: boolean; fullyQualifiedName: string; hasCustomProperties: boolean; hasDefaultProperties: boolean; hasExternalObjectIds: boolean; hasOwners: boolean; hasPipelines: boolean; indexedForFiltersAndReports: boolean; lastModifiedPropertyName: string; metaType: string; metaTypeId: number; name: string; objectTypeId: string; objectTypeIdString: string; permissioningType: 'ALL_OR_NONE' | 'DO_NOT_CHECK_PERMISSIONS' | 'EXPLICIT' | 'OWNER_BASED' | 'TEAM_BASED'; pipelinePropertyName: string; pipelineStagePropertyName: string; requiredProperties: string[]; restorable: boolean; scopeMappings: scope_mapping[]; secondaryDisplayLabelPropertyNames: string[]; accessScopeName?: string; createdAt?: number; description?: string; integrationAppId?: number; janusGroup?: string; ownerPortalId?: number; pipelineCloseDatePropertyName?: string; pipelineTimeToClosePropertyName?: string; pluralForm?: string; primaryDisplayLabelPropertyName?: string; readScopeName?: string; singularForm?: string; status?: 'Deprecated' | 'In development' | 'Live'; visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; writeScopeName?: string; }; }`\n\n - `objectTypeId: string`\n - `objectTypeName: string`\n - `properties: { objectTypeId: string; property: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }; calculationExpression?: object; calculationFormula?: string; definitionSource?: { type: 'GLOBAL' | 'HAVEN_BRANCH' | 'OBJECT_TYPE' | 'PORTAL'; name?: string; }; extensionData?: { extensionStatusMap: object; tags: string[]; caseChangeTestExtensionData?: case_change_test_extension_data; optionDecoratorsExtensionData?: option_decorators_extension_data; requiredPropertiesExtensionData?: required_properties_extension_data; softRequiredPropertiesExtensionData?: soft_required_properties_extension_data; }; externalOptionsMetaData?: { filter?: filtering_meta_data; relatedObjectTypeId?: string; }; fulcrumPortalId?: number; fulcrumTimestamp?: number; janusGroup?: string; lookupAssociationSpec?: { associationSpec: association_spec; cardinality?: 'ONE_TO_MANY' | 'ONE_TO_ONE'; maxToObjectIds?: number; toObjectTypeId?: string; }; permission?: { accessLevel: string; }; propertyDefinitionSource?: { type: 'GLOBAL' | 'HAVEN_BRANCH' | 'OBJECT_TYPE' | 'PORTAL'; name?: string; }; propertyRequirements?: { gates: string[]; operator: 'AND' | 'OR'; scopeNames: string[]; settings: string[]; }; rollupExpression?: { associationTypes: association_spec[]; rollupOperator: string; sourceObjectTypeId: string; sourcePropertyName: string; conditionalExpression?: object; conditionalFormula?: string; emptyRollupValue?: string; sourceCompareByPropertyName?: string; }; }[]`\n - `propertyGroups: { displayName: string; displayOrder: number; fulcrumPortalId: number; fulcrumTimestamp: number; hubspotDefined: boolean; name: string; }[]`\n - `schema?: { id: number; allowsSensitiveProperties: boolean; createDatePropertyName: string; defaultSearchPropertyNames: string[]; deleted: boolean; fullyQualifiedName: string; hasCustomProperties: boolean; hasDefaultProperties: boolean; hasExternalObjectIds: boolean; hasOwners: boolean; hasPipelines: boolean; indexedForFiltersAndReports: boolean; lastModifiedPropertyName: string; metaType: string; metaTypeId: number; name: string; objectTypeId: string; objectTypeIdString: string; permissioningType: 'ALL_OR_NONE' | 'DO_NOT_CHECK_PERMISSIONS' | 'EXPLICIT' | 'OWNER_BASED' | 'TEAM_BASED'; pipelinePropertyName: string; pipelineStagePropertyName: string; requiredProperties: string[]; restorable: boolean; scopeMappings: { accessLevel: 'ALL' | 'OWNED' | 'TEAM_OWNED' | 'UNASSIGNED'; requestAction: 'COMMUNICATE' | 'DELETE' | 'EDIT' | 'EDIT_ASSOCIATION' | 'MERGE' | 'VIEW'; scopeName: string; }[]; secondaryDisplayLabelPropertyNames: string[]; accessScopeName?: string; createdAt?: number; description?: string; integrationAppId?: number; janusGroup?: string; ownerPortalId?: number; pipelineCloseDatePropertyName?: string; pipelineTimeToClosePropertyName?: string; pluralForm?: string; primaryDisplayLabelPropertyName?: string; readScopeName?: string; singularForm?: string; status?: 'Deprecated' | 'In development' | 'Live'; visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; writeScopeName?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectDefinitionResponse = await client.cms.mediaBridge.listObjectTypesByMediaType('AUDIO', { appId: 0 });\n\nconsole.log(objectDefinitionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.listObjectTypesByMediaType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectDefinitionResponse = await client.cms.mediaBridge.listObjectTypesByMediaType('AUDIO', {\n appId: 0,\n});\n\nconsole.log(objectDefinitionResponse.objectTypeId);", + }, + python: { + method: 'cms.media_bridge.list_object_types_by_media_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_definition_response = client.cms.media_bridge.list_object_types_by_media_type(\n media_type="AUDIO",\n app_id=0,\n)\nprint(object_definition_response.object_type_id)', + }, + java: { + method: 'cms().mediaBridge().listObjectTypesByMediaType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListObjectTypesByMediaTypeParams;\nimport com.hubspot.sdk.models.cms.mediabridge.ObjectDefinitionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListObjectTypesByMediaTypeParams params = MediaBridgeListObjectTypesByMediaTypeParams.builder()\n .appId(0)\n .mediaType(MediaBridgeListObjectTypesByMediaTypeParams.MediaType.AUDIO)\n .build();\n ObjectDefinitionResponse objectDefinitionResponse = client.cms().mediaBridge().listObjectTypesByMediaType(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.ListObjectTypesByMediaType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectDefinitionResponse, err := client.Cms.MediaBridge.ListObjectTypesByMediaType(\n\t\tcontext.TODO(),\n\t\tcms.MediaBridgeListObjectTypesByMediaTypeParamsMediaTypeAudio,\n\t\tcms.MediaBridgeListObjectTypesByMediaTypeParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectDefinitionResponse.ObjectTypeID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.list_object_types_by_media_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_definition_response = hubspot.cms.media_bridge.list_object_types_by_media_type(:AUDIO, app_id: 0)\n\nputs(object_definition_response)', + }, + php: { + method: 'cms->mediaBridge->listObjectTypesByMediaType', + example: + "cms\n ->mediaBridge\n ->listObjectTypesByMediaType('AUDIO', appID: 0, includeFullDefinition: true);\n\nvar_dump($objectDefinitionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/object-definitions/$MEDIA_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_oembed_domains', + endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + httpMethod: 'get', + summary: 'Get oEmbed domains', + description: 'Get the details for existing oEmbed domains for your app', + stainlessPath: '(resource) cms.media_bridge > (method) list_oembed_domains', + qualified: 'client.cms.mediaBridge.listOembedDomains', + params: ['appId: number;', 'domainPortalId?: number;'], + response: + '{ results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }[]; totalCount?: number; }', + markdown: + "## list_oembed_domains\n\n`client.cms.mediaBridge.listOembedDomains(appId: number, domainPortalId?: number): { results: integrator_o_embed_domain_model[]; totalCount?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nGet the details for existing oEmbed domains for your app\n\n### Parameters\n\n- `appId: number`\n\n- `domainPortalId?: number`\n\n### Returns\n\n- `{ results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }[]; totalCount?: number; }`\n\n - `results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }[]`\n - `totalCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst oEmbedDomainsCollectionResponse = await client.cms.mediaBridge.listOembedDomains(0);\n\nconsole.log(oEmbedDomainsCollectionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.listOembedDomains', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst oEmbedDomainsCollectionResponse = await client.cms.mediaBridge.listOembedDomains(0);\n\nconsole.log(oEmbedDomainsCollectionResponse.results);", + }, + python: { + method: 'cms.media_bridge.list_oembed_domains', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\no_embed_domains_collection_response = client.cms.media_bridge.list_oembed_domains(\n app_id=0,\n)\nprint(o_embed_domains_collection_response.results)', + }, + java: { + method: 'cms().mediaBridge().listOembedDomains', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListOembedDomainsParams;\nimport com.hubspot.sdk.models.cms.mediabridge.OEmbedDomainsCollectionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OEmbedDomainsCollectionResponse oEmbedDomainsCollectionResponse = client.cms().mediaBridge().listOembedDomains(0);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.ListOembedDomains', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\toEmbedDomainsCollectionResponse, err := client.Cms.MediaBridge.ListOembedDomains(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeListOembedDomainsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", oEmbedDomainsCollectionResponse.Results)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.list_oembed_domains', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\no_embed_domains_collection_response = hubspot.cms.media_bridge.list_oembed_domains(0)\n\nputs(o_embed_domains_collection_response)', + }, + php: { + method: 'cms->mediaBridge->listOembedDomains', + example: + "cms->mediaBridge->listOembedDomains(\n 0, domainPortalID: 0\n);\n\nvar_dump($oEmbedDomainsCollectionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_properties', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}', + httpMethod: 'get', + summary: 'Get the properties for an object type.', + description: 'Get the existing properties defined for a media object type.', + stainlessPath: '(resource) cms.media_bridge > (method) list_properties', + qualified: 'client.cms.mediaBridge.listProperties', + params: ['appId: number;', 'objectType: string;', 'archived?: boolean;', 'properties?: string;'], + response: + "{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }", + markdown: + "## list_properties\n\n`client.cms.mediaBridge.listProperties(appId: number, objectType: string, archived?: boolean, properties?: string): { results: property_1[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}`\n\nGet the existing properties defined for a media object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `properties?: string`\n\n### Returns\n\n- `{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }`\n\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyNoPaging = await client.cms.mediaBridge.listProperties('objectType', { appId: 0 });\n\nconsole.log(collectionResponsePropertyNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.listProperties', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyNoPaging = await client.cms.mediaBridge.listProperties(\n 'objectType',\n { appId: 0 },\n);\n\nconsole.log(collectionResponsePropertyNoPaging.results);", + }, + python: { + method: 'cms.media_bridge.list_properties', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_no_paging = client.cms.media_bridge.list_properties(\n object_type="objectType",\n app_id=0,\n)\nprint(collection_response_property_no_paging.results)', + }, + java: { + method: 'cms().mediaBridge().listProperties', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.CollectionResponsePropertyNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListPropertiesParams params = MediaBridgeListPropertiesParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n CollectionResponsePropertyNoPaging collectionResponsePropertyNoPaging = client.cms().mediaBridge().listProperties(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.ListProperties', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyNoPaging, err := client.Cms.MediaBridge.ListProperties(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeListPropertiesParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyNoPaging.Results)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.list_properties', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_no_paging = hubspot.cms.media_bridge.list_properties("objectType", app_id: 0)\n\nputs(collection_response_property_no_paging)', + }, + php: { + method: 'cms->mediaBridge->listProperties', + example: + "cms->mediaBridge->listProperties(\n 'objectType', appID: 0, archived: true, properties: 'properties'\n);\n\nvar_dump($collectionResponsePropertyNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_property_groups', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', + httpMethod: 'get', + summary: 'Get property groups', + description: 'Get the property groups for a specified object type.', + stainlessPath: '(resource) cms.media_bridge > (method) list_property_groups', + qualified: 'client.cms.mediaBridge.listPropertyGroups', + params: ['appId: number;', 'objectType: string;'], + response: '{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }', + markdown: + "## list_property_groups\n\n`client.cms.mediaBridge.listPropertyGroups(appId: number, objectType: string): { results: property_group[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups`\n\nGet the property groups for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n### Returns\n\n- `{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }`\n\n - `results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyGroupNoPaging = await client.cms.mediaBridge.listPropertyGroups('objectType', { appId: 0 });\n\nconsole.log(collectionResponsePropertyGroupNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.listPropertyGroups', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyGroupNoPaging = await client.cms.mediaBridge.listPropertyGroups(\n 'objectType',\n { appId: 0 },\n);\n\nconsole.log(collectionResponsePropertyGroupNoPaging.results);", + }, + python: { + method: 'cms.media_bridge.list_property_groups', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_group_no_paging = client.cms.media_bridge.list_property_groups(\n object_type="objectType",\n app_id=0,\n)\nprint(collection_response_property_group_no_paging.results)', + }, + java: { + method: 'cms().mediaBridge().listPropertyGroups', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.CollectionResponsePropertyGroupNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListPropertyGroupsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListPropertyGroupsParams params = MediaBridgeListPropertyGroupsParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n CollectionResponsePropertyGroupNoPaging collectionResponsePropertyGroupNoPaging = client.cms().mediaBridge().listPropertyGroups(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.ListPropertyGroups', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyGroupNoPaging, err := client.Cms.MediaBridge.ListPropertyGroups(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeListPropertyGroupsParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyGroupNoPaging.Results)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.list_property_groups', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_group_no_paging = hubspot.cms.media_bridge.list_property_groups("objectType", app_id: 0)\n\nputs(collection_response_property_group_no_paging)', + }, + php: { + method: 'cms->mediaBridge->listPropertyGroups', + example: + "cms\n ->mediaBridge\n ->listPropertyGroups('objectType', appID: 0);\n\nvar_dump($collectionResponsePropertyGroupNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_schemas', + endpoint: '/media-bridge/2026-03/{appId}/schemas', + httpMethod: 'get', + summary: 'Get all schemas ', + description: 'Get the schemas for all object types.', + stainlessPath: '(resource) cms.media_bridge > (method) list_schemas', + qualified: 'client.cms.mediaBridge.listSchemas', + params: ['appId: number;', 'archived?: boolean;'], + response: + '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', + markdown: + "## list_schemas\n\n`client.cms.mediaBridge.listSchemas(appId: number, archived?: boolean): { results: object_schema[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/schemas`\n\nGet the schemas for all object types.\n\n### Parameters\n\n- `appId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.cms.mediaBridge.listSchemas(0);\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.listSchemas', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.cms.mediaBridge.listSchemas(0);\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", + }, + python: { + method: 'cms.media_bridge.list_schemas', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.cms.media_bridge.list_schemas(\n app_id=0,\n)\nprint(collection_response_object_schema_no_paging.results)', + }, + java: { + method: 'cms().mediaBridge().listSchemas', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListSchemasParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.cms().mediaBridge().listSchemas(0);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.ListSchemas', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Cms.MediaBridge.ListSchemas(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeListSchemasParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.list_schemas', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.cms.media_bridge.list_schemas(0)\n\nputs(collection_response_object_schema_no_paging)', + }, + php: { + method: 'cms->mediaBridge->listSchemas', + example: + "cms\n ->mediaBridge\n ->listSchemas(0, archived: true);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'register_app_name', + endpoint: '/media-bridge/2026-03/{appId}/settings/register', + httpMethod: 'post', + summary: 'Register the media bridge app name', + description: 'Register the name that your app will display when a user is selecting media bridge items.', + stainlessPath: '(resource) cms.media_bridge > (method) register_app_name', + qualified: 'client.cms.mediaBridge.registerAppName', + params: [ + 'appId: number;', + 'updatedAt: number;', + 'allowImportOnDisconnect?: boolean;', + 'moduleName?: string;', + 'name?: string;', + ], + response: '{ appId: number; name: string; }', + markdown: + "## register_app_name\n\n`client.cms.mediaBridge.registerAppName(appId: number, updatedAt: number, allowImportOnDisconnect?: boolean, moduleName?: string, name?: string): { appId: number; name: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/register`\n\nRegister the name that your app will display when a user is selecting media bridge items.\n\n### Parameters\n\n- `appId: number`\n\n- `updatedAt: number`\n\n- `allowImportOnDisconnect?: boolean`\n\n- `moduleName?: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ appId: number; name: string; }`\n\n - `appId: number`\n - `name: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.registerAppName(0, { updatedAt: 0 });\n\nconsole.log(mediaBridgeProviderRegistrationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.registerAppName', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.registerAppName(0, {\n updatedAt: 0,\n});\n\nconsole.log(mediaBridgeProviderRegistrationResponse.appId);", + }, + python: { + method: 'cms.media_bridge.register_app_name', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_provider_registration_response = client.cms.media_bridge.register_app_name(\n app_id=0,\n updated_at=0,\n)\nprint(media_bridge_provider_registration_response.app_id)', + }, + java: { + method: 'cms().mediaBridge().registerAppName', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderPartial;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderRegistrationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeRegisterAppNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeRegisterAppNameParams params = MediaBridgeRegisterAppNameParams.builder()\n .appId(0)\n .mediaBridgeProviderPartial(MediaBridgeProviderPartial.builder()\n .updatedAt(0L)\n .build())\n .build();\n MediaBridgeProviderRegistrationResponse mediaBridgeProviderRegistrationResponse = client.cms().mediaBridge().registerAppName(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.RegisterAppName', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProviderRegistrationResponse, err := client.Cms.MediaBridge.RegisterAppName(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeRegisterAppNameParams{\n\t\t\tMediaBridgeProviderPartial: cms.MediaBridgeProviderPartialParam{\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProviderRegistrationResponse.AppID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.register_app_name', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_provider_registration_response = hubspot.cms.media_bridge.register_app_name(0, updated_at: 0)\n\nputs(media_bridge_provider_registration_response)', + }, + php: { + method: 'cms->mediaBridge->registerAppName', + example: + "cms\n ->mediaBridge\n ->registerAppName(\n 0,\n updatedAt: 0,\n allowImportOnDisconnect: true,\n moduleName: 'moduleName',\n name: 'name',\n);\n\nvar_dump($mediaBridgeProviderRegistrationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/register \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "updatedAt": 0\n }\'', + }, + }, + }, + { + name: 'update_event_visibility_settings', + endpoint: '/media-bridge/2026-03/{appId}/settings/event-visibility', + httpMethod: 'patch', + summary: 'Create or update event visibility settings', + description: 'Set the visibility settings for media bridge events created by your app.', + stainlessPath: '(resource) cms.media_bridge > (method) update_event_visibility_settings', + qualified: 'client.cms.mediaBridge.updateEventVisibilitySettings', + params: [ + 'appId: number;', + "eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT';", + 'updatedAt: number;', + 'showInReporting?: boolean;', + 'showInTimeline?: boolean;', + 'showInWorkflows?: boolean;', + ], + response: + "{ eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }", + markdown: + "## update_event_visibility_settings\n\n`client.cms.mediaBridge.updateEventVisibilitySettings(appId: number, eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT', updatedAt: number, showInReporting?: boolean, showInTimeline?: boolean, showInWorkflows?: boolean): { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }`\n\n**patch** `/media-bridge/2026-03/{appId}/settings/event-visibility`\n\nSet the visibility settings for media bridge events created by your app.\n\n### Parameters\n\n- `appId: number`\n\n- `eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'`\n\n- `updatedAt: number`\n\n- `showInReporting?: boolean`\n\n- `showInTimeline?: boolean`\n\n- `showInWorkflows?: boolean`\n\n### Returns\n\n- `{ eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }`\n\n - `eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'`\n - `updatedAt: number`\n - `showInReporting?: boolean`\n - `showInTimeline?: boolean`\n - `showInWorkflows?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventVisibilityChange = await client.cms.mediaBridge.updateEventVisibilitySettings(0, { eventType: 'ALL', updatedAt: 0 });\n\nconsole.log(eventVisibilityChange);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updateEventVisibilitySettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventVisibilityChange = await client.cms.mediaBridge.updateEventVisibilitySettings(0, {\n eventType: 'ALL',\n updatedAt: 0,\n});\n\nconsole.log(eventVisibilityChange.eventType);", + }, + python: { + method: 'cms.media_bridge.update_event_visibility_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_visibility_change = client.cms.media_bridge.update_event_visibility_settings(\n app_id=0,\n event_type="ALL",\n updated_at=0,\n)\nprint(event_visibility_change.event_type)', + }, + java: { + method: 'cms().mediaBridge().updateEventVisibilitySettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.EventVisibilityChange;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateEventVisibilitySettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateEventVisibilitySettingsParams params = MediaBridgeUpdateEventVisibilitySettingsParams.builder()\n .appId(0)\n .eventVisibilityChange(EventVisibilityChange.builder()\n .eventType(EventVisibilityChange.EventType.ALL)\n .updatedAt(0L)\n .build())\n .build();\n EventVisibilityChange eventVisibilityChange = client.cms().mediaBridge().updateEventVisibilitySettings(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdateEventVisibilitySettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventVisibilityChange, err := client.Cms.MediaBridge.UpdateEventVisibilitySettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeUpdateEventVisibilitySettingsParams{\n\t\t\tEventVisibilityChange: cms.EventVisibilityChangeParam{\n\t\t\t\tEventType: cms.EventVisibilityChangeEventTypeAll,\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventVisibilityChange.EventType)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_event_visibility_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_visibility_change = hubspot.cms.media_bridge.update_event_visibility_settings(0, event_type: :ALL, updated_at: 0)\n\nputs(event_visibility_change)', + }, + php: { + method: 'cms->mediaBridge->updateEventVisibilitySettings', + example: + "cms\n ->mediaBridge\n ->updateEventVisibilitySettings(\n 0,\n eventType: 'ALL',\n updatedAt: 0,\n showInReporting: true,\n showInTimeline: true,\n showInWorkflows: true,\n);\n\nvar_dump($eventVisibilityChange);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/event-visibility \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventType": "ALL",\n "updatedAt": 0\n }\'', + }, + }, + }, + { + name: 'update_oembed_domain', + endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', + httpMethod: 'patch', + summary: 'Update an oEmbed domain', + description: 'Update an existing oEmbed domain.', + stainlessPath: '(resource) cms.media_bridge > (method) update_oembed_domain', + qualified: 'client.cms.mediaBridge.updateOembedDomain', + params: [ + 'appId: number;', + 'oEmbedDomainId: string;', + 'endpoints: { discovery: boolean; schemes: string[]; url: string; };', + 'portalId?: number;', + ], + response: + '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', + markdown: + "## update_oembed_domain\n\n`client.cms.mediaBridge.updateOembedDomain(appId: number, oEmbedDomainId: string, endpoints: { discovery: boolean; schemes: string[]; url: string; }, portalId?: number): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}`\n\nUpdate an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `oEmbedDomainId: string`\n\n- `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `discovery: boolean`\n - `schemes: string[]`\n - `url: string`\n\n- `portalId?: number`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.updateOembedDomain('oEmbedDomainId', {\n appId: 0,\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n},\n});\n\nconsole.log(integratorOEmbedDomainModel);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updateOembedDomain', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.updateOembedDomain(\n 'oEmbedDomainId',\n {\n appId: 0,\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n },\n },\n);\n\nconsole.log(integratorOEmbedDomainModel.id);", + }, + python: { + method: 'cms.media_bridge.update_oembed_domain', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.update_oembed_domain(\n o_embed_domain_id="oEmbedDomainId",\n app_id=0,\n endpoints={\n "discovery": True,\n "schemes": ["string"],\n "url": "url",\n },\n)\nprint(integrator_o_embed_domain_model.id)', + }, + java: { + method: 'cms().mediaBridge().updateOembedDomain', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.Endpoints;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateOembedDomainParams params = MediaBridgeUpdateOembedDomainParams.builder()\n .appId(0)\n .oEmbedDomainId("oEmbedDomainId")\n .integratorOEmbedDomainRequest(IntegratorOEmbedDomainRequest.builder()\n .endpoints(Endpoints.builder()\n .discovery(true)\n .addScheme("string")\n .url("url")\n .build())\n .build())\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().updateOembedDomain(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdateOembedDomain', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.UpdateOembedDomain(\n\t\tcontext.TODO(),\n\t\t"oEmbedDomainId",\n\t\tcms.MediaBridgeUpdateOembedDomainParams{\n\t\t\tAppID: 0,\n\t\t\tIntegratorOEmbedDomainRequest: cms.IntegratorOEmbedDomainRequestParam{\n\t\t\t\tEndpoints: cms.EndpointsParam{\n\t\t\t\t\tDiscovery: true,\n\t\t\t\t\tSchemes: []string{"string"},\n\t\t\t\t\tURL: "url",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_oembed_domain', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.update_oembed_domain(\n "oEmbedDomainId",\n app_id: 0,\n endpoints: {discovery: true, schemes: ["string"], url: "url"}\n)\n\nputs(integrator_o_embed_domain_model)', + }, + php: { + method: 'cms->mediaBridge->updateOembedDomain', + example: + "cms->mediaBridge->updateOembedDomain(\n 'oEmbedDomainId',\n appID: 0,\n endpoints: ['discovery' => true, 'schemes' => ['string'], 'url' => 'url'],\n portalID: 0,\n);\n\nvar_dump($integratorOEmbedDomainModel);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains/$O_EMBED_DOMAIN_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endpoints": {\n "discovery": true,\n "schemes": [\n "string"\n ],\n "url": "url"\n }\n }\'', + }, + }, + }, + { + name: 'update_property', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + httpMethod: 'patch', + summary: 'Update a property', + description: 'Update an existing property for an object type.', + stainlessPath: '(resource) cms.media_bridge > (method) update_property', + qualified: 'client.cms.mediaBridge.updateProperty', + params: [ + 'appId: number;', + 'objectType: string;', + 'propertyName: string;', + 'calculationFormula?: string;', + 'currencyPropertyName?: string;', + 'description?: string;', + 'displayOrder?: number;', + 'fieldType?: string;', + 'formField?: boolean;', + 'groupName?: string;', + 'hasUniqueValue?: boolean;', + 'hidden?: boolean;', + 'label?: string;', + "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + 'showCurrencySymbol?: boolean;', + "type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", + ], + response: 'object', + markdown: + "## update_property\n\n`client.cms.mediaBridge.updateProperty(appId: number, objectType: string, propertyName: string, calculationFormula?: string, currencyPropertyName?: string, description?: string, displayOrder?: number, fieldType?: string, formField?: boolean, groupName?: string, hasUniqueValue?: boolean, hidden?: boolean, label?: string, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], showCurrencySymbol?: boolean, type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nUpdate an existing property for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `fieldType?: string`\n\n- `formField?: boolean`\n\n- `groupName?: string`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `label?: string`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `showCurrencySymbol?: boolean`\n\n- `type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.updateProperty('propertyName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(mediaBridgeProperty);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updateProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.updateProperty('propertyName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", + }, + python: { + method: 'cms.media_bridge.update_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.update_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)\nprint(media_bridge_property.hidden)', + }, + java: { + method: 'cms().mediaBridge().updateProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgePropertyUpdate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdatePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdatePropertyParams params = MediaBridgeUpdatePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .mediaBridgePropertyUpdate(MediaBridgePropertyUpdate.builder().build())\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().updateProperty(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdateProperty', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.UpdateProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeUpdatePropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t\tMediaBridgePropertyUpdate: cms.MediaBridgePropertyUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.update_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(media_bridge_property)', + }, + php: { + method: 'cms->mediaBridge->updateProperty', + example: + "cms->mediaBridge->updateProperty(\n 'propertyName',\n appID: 0,\n objectType: 'objectType',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n description: 'description',\n displayOrder: 0,\n fieldType: 'booleancheckbox',\n formField: true,\n groupName: 'groupName',\n hasUniqueValue: true,\n hidden: true,\n label: 'label',\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n showCurrencySymbol: true,\n type: 'bool',\n);\n\nvar_dump($mediaBridgeProperty);", + }, + http: { + example: + "curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_property_group', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + httpMethod: 'patch', + summary: 'Update a property group', + description: 'Update an existing property group by name.', + stainlessPath: '(resource) cms.media_bridge > (method) update_property_group', + qualified: 'client.cms.mediaBridge.updatePropertyGroup', + params: [ + 'appId: number;', + 'objectType: string;', + 'groupName: string;', + 'displayOrder?: number;', + 'label?: string;', + ], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## update_property_group\n\n`client.cms.mediaBridge.updatePropertyGroup(appId: number, objectType: string, groupName: string, displayOrder?: number, label?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nUpdate an existing property group by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `displayOrder?: number`\n\n- `label?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.updatePropertyGroup('groupName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updatePropertyGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.updatePropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'cms.media_bridge.update_property_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.update_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)\nprint(property_group.archived)', + }, + java: { + method: 'cms().mediaBridge().updatePropertyGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupUpdate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdatePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdatePropertyGroupParams params = MediaBridgeUpdatePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .propertyGroupUpdate(PropertyGroupUpdate.builder().build())\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().updatePropertyGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdatePropertyGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.UpdatePropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeUpdatePropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyGroupUpdate: shared.PropertyGroupUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_property_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.update_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(property_group)', + }, + php: { + method: 'cms->mediaBridge->updatePropertyGroup', + example: + "cms->mediaBridge->updatePropertyGroup(\n 'groupName',\n appID: 0,\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + "curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_schema', + endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}', + httpMethod: 'patch', + summary: 'Update the schema for an object type', + description: 'Update the schema for an existing object type', + stainlessPath: '(resource) cms.media_bridge > (method) update_schema', + qualified: 'client.cms.mediaBridge.updateSchema', + params: [ + 'appId: number;', + 'objectType: string;', + 'clearDescription: boolean;', + 'allowsSensitiveProperties?: boolean;', + 'description?: string;', + 'labels?: { plural?: string; singular?: string; };', + 'primaryDisplayProperty?: string;', + 'requiredProperties?: string[];', + 'restorable?: boolean;', + 'searchableProperties?: string[];', + 'secondaryDisplayProperties?: string[];', + ], + response: + '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }', + markdown: + "## update_schema\n\n`client.cms.mediaBridge.updateSchema(appId: number, objectType: string, clearDescription: boolean, allowsSensitiveProperties?: boolean, description?: string, labels?: { plural?: string; singular?: string; }, primaryDisplayProperty?: string, requiredProperties?: string[], restorable?: boolean, searchableProperties?: string[], secondaryDisplayProperties?: string[]): { id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n**patch** `/media-bridge/2026-03/{appId}/schemas/{objectType}`\n\nUpdate the schema for an existing object type\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `clearDescription: boolean`\n\n- `allowsSensitiveProperties?: boolean`\n\n- `description?: string`\n\n- `labels?: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `primaryDisplayProperty?: string`\n\n- `requiredProperties?: string[]`\n\n- `restorable?: boolean`\n\n- `searchableProperties?: string[]`\n\n- `secondaryDisplayProperties?: string[]`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `description?: string`\n - `portalId?: number`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeDefinition = await client.cms.mediaBridge.updateSchema('objectType', { appId: 0, clearDescription: true });\n\nconsole.log(objectTypeDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updateSchema', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeDefinition = await client.cms.mediaBridge.updateSchema('objectType', {\n appId: 0,\n clearDescription: true,\n});\n\nconsole.log(objectTypeDefinition.id);", + }, + python: { + method: 'cms.media_bridge.update_schema', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_definition = client.cms.media_bridge.update_schema(\n object_type="objectType",\n app_id=0,\n clear_description=True,\n)\nprint(object_type_definition.id)', + }, + java: { + method: 'cms().mediaBridge().updateSchema', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinition;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionPatch;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateSchemaParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateSchemaParams params = MediaBridgeUpdateSchemaParams.builder()\n .appId(0)\n .objectType("objectType")\n .objectTypeDefinitionPatch(ObjectTypeDefinitionPatch.builder()\n .clearDescription(true)\n .build())\n .build();\n ObjectTypeDefinition objectTypeDefinition = client.cms().mediaBridge().updateSchema(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdateSchema', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeDefinition, err := client.Cms.MediaBridge.UpdateSchema(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeUpdateSchemaParams{\n\t\t\tAppID: 0,\n\t\t\tObjectTypeDefinitionPatch: shared.ObjectTypeDefinitionPatchParam{\n\t\t\t\tClearDescription: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeDefinition.ID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_schema', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_definition = hubspot.cms.media_bridge.update_schema("objectType", app_id: 0, clear_description: true)\n\nputs(object_type_definition)', + }, + php: { + method: 'cms->mediaBridge->updateSchema', + example: + "cms->mediaBridge->updateSchema(\n 'objectType',\n appID: 0,\n clearDescription: true,\n allowsSensitiveProperties: true,\n description: 'description',\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n primaryDisplayProperty: 'primaryDisplayProperty',\n requiredProperties: ['string'],\n restorable: true,\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n);\n\nvar_dump($objectTypeDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearDescription": true\n }\'', + }, + }, + }, + { + name: 'update_settings', + endpoint: '/media-bridge/2026-03/{appId}/settings', + httpMethod: 'put', + summary: 'Update the media bridge app name', + description: 'Update the name that your app will display when a user is selecting media bridge items.', + stainlessPath: '(resource) cms.media_bridge > (method) update_settings', + qualified: 'client.cms.mediaBridge.updateSettings', + params: [ + 'appId: number;', + 'updatedAt: number;', + 'allowImportOnDisconnect?: boolean;', + 'moduleName?: string;', + 'name?: string;', + ], + response: '{ appId: number; name: string; }', + markdown: + "## update_settings\n\n`client.cms.mediaBridge.updateSettings(appId: number, updatedAt: number, allowImportOnDisconnect?: boolean, moduleName?: string, name?: string): { appId: number; name: string; }`\n\n**put** `/media-bridge/2026-03/{appId}/settings`\n\nUpdate the name that your app will display when a user is selecting media bridge items.\n\n### Parameters\n\n- `appId: number`\n\n- `updatedAt: number`\n\n- `allowImportOnDisconnect?: boolean`\n\n- `moduleName?: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ appId: number; name: string; }`\n\n - `appId: number`\n - `name: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.updateSettings(0, { updatedAt: 0 });\n\nconsole.log(mediaBridgeProviderRegistrationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.updateSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.updateSettings(0, {\n updatedAt: 0,\n});\n\nconsole.log(mediaBridgeProviderRegistrationResponse.appId);", + }, + python: { + method: 'cms.media_bridge.update_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_provider_registration_response = client.cms.media_bridge.update_settings(\n app_id=0,\n updated_at=0,\n)\nprint(media_bridge_provider_registration_response.app_id)', + }, + java: { + method: 'cms().mediaBridge().updateSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderPartial;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderRegistrationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateSettingsParams params = MediaBridgeUpdateSettingsParams.builder()\n .appId(0)\n .mediaBridgeProviderPartial(MediaBridgeProviderPartial.builder()\n .updatedAt(0L)\n .build())\n .build();\n MediaBridgeProviderRegistrationResponse mediaBridgeProviderRegistrationResponse = client.cms().mediaBridge().updateSettings(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.UpdateSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProviderRegistrationResponse, err := client.Cms.MediaBridge.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeUpdateSettingsParams{\n\t\t\tMediaBridgeProviderPartial: cms.MediaBridgeProviderPartialParam{\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProviderRegistrationResponse.AppID)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.update_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_provider_registration_response = hubspot.cms.media_bridge.update_settings(0, updated_at: 0)\n\nputs(media_bridge_provider_registration_response)', + }, + php: { + method: 'cms->mediaBridge->updateSettings', + example: + "cms\n ->mediaBridge\n ->updateSettings(\n 0,\n updatedAt: 0,\n allowImportOnDisconnect: true,\n moduleName: 'moduleName',\n name: 'name',\n);\n\nvar_dump($mediaBridgeProviderRegistrationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "updatedAt": 0\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create', + httpMethod: 'post', + summary: 'Create multiple properties', + description: 'Create a batch of properties of the specified object type.', + stainlessPath: '(resource) cms.media_bridge.batch > (method) create', + qualified: 'client.cms.mediaBridge.batch.create', + params: [ + 'appId: number;', + 'objectType: string;', + "inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[];", + ], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.cms.mediaBridge.batch.create(appId: number, objectType: string, inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]): { completedAt: string; results: media_bridge_property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create`\n\nCreate a batch of properties of the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.create('objectType', { appId: 0, inputs: [{\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n}] });\n\nconsole.log(batchResponseProperty);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.create('objectType', {\n appId: 0,\n inputs: [\n {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n});\n\nconsole.log(batchResponseProperty.completedAt);", + }, + python: { + method: 'cms.media_bridge.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.cms.media_bridge.batch.create(\n object_type="objectType",\n app_id=0,\n inputs=[{\n "field_type": "booleancheckbox",\n "group_name": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n)\nprint(batch_response_property.completed_at)', + }, + java: { + method: 'cms().mediaBridge().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyCreate;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.BatchResponseProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchInputPropertyCreate(BatchInputPropertyCreate.builder()\n .addInput(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.cms().mediaBridge().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Cms.MediaBridge.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchNewParams{\n\t\t\tAppID: 0,\n\t\t\tBatchInputPropertyCreate: shared.BatchInputPropertyCreateParam{\n\t\t\t\tInputs: []shared.PropertyCreateParam{{\n\t\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\t\tGroupName: "groupName",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.cms.media_bridge.batch.create(\n "objectType",\n app_id: 0,\n inputs: [{fieldType: :booleancheckbox, groupName: "groupName", label: "label", name: "name", type: :bool}]\n)\n\nputs(batch_response_property)', + }, + php: { + method: 'cms->mediaBridge->batch->create', + example: + "cms->mediaBridge->batch->create(\n 'objectType',\n appID: 0,\n inputs: [\n [\n 'fieldType' => 'booleancheckbox',\n 'groupName' => 'groupName',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'calculationFormula' => 'calculationFormula',\n 'currencyPropertyName' => 'currencyPropertyName',\n 'dataSensitivity' => 'highly_sensitive',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptions' => true,\n 'formField' => true,\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'referencedObjectType' => 'referencedObjectType',\n 'showCurrencySymbol' => true,\n ],\n ],\n);\n\nvar_dump($batchResponseProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive', + httpMethod: 'post', + summary: 'Archive multiple properties', + description: 'Archive a batch of existing properties for the specified types.', + stainlessPath: '(resource) cms.media_bridge.batch > (method) delete', + qualified: 'client.cms.mediaBridge.batch.delete', + params: ['appId: number;', 'objectType: string;', 'inputs: { name: string; }[];'], + markdown: + "## delete\n\n`client.cms.mediaBridge.batch.delete(appId: number, objectType: string, inputs: { name: string; }[]): void`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive`\n\nArchive a batch of existing properties for the specified types.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `inputs: { name: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.batch.delete('objectType', { appId: 0, inputs: [{ name: 'name' }] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.batch.delete('objectType', { appId: 0, inputs: [{ name: 'name' }] });", + }, + python: { + method: 'cms.media_bridge.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.batch.delete(\n object_type="objectType",\n app_id=0,\n inputs=[{\n "name": "name"\n }],\n)', + }, + java: { + method: 'cms().mediaBridge().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchInputPropertyName(BatchInputPropertyName.builder()\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n client.cms().mediaBridge().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tBatchInputPropertyName: shared.BatchInputPropertyNameParam{\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.media_bridge.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.batch.delete("objectType", app_id: 0, inputs: [{name: "name"}])\n\nputs(result)', + }, + php: { + method: 'cms->mediaBridge->batch->delete', + example: + "cms->mediaBridge->batch->delete(\n 'objectType', appID: 0, inputs: [['name' => 'name']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read', + httpMethod: 'post', + summary: 'Get the details for multiple properties', + description: 'Get the details for a batch of properties for a specified object type.', + stainlessPath: '(resource) cms.media_bridge.batch > (method) get', + qualified: 'client.cms.mediaBridge.batch.get', + params: [ + 'appId: number;', + 'objectType: string;', + 'archived: boolean;', + "dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'inputs: { name: string; }[];', + ], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.cms.mediaBridge.batch.get(appId: number, objectType: string, archived: boolean, dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive', inputs: { name: string; }[]): { completedAt: string; results: media_bridge_property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read`\n\nGet the details for a batch of properties for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `archived: boolean`\n\n- `dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `inputs: { name: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.get('objectType', {\n appId: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty);\n```", + perLanguage: { + typescript: { + method: 'client.cms.mediaBridge.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.get('objectType', {\n appId: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty.completedAt);", + }, + python: { + method: 'cms.media_bridge.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.cms.media_bridge.batch.get(\n object_type="objectType",\n app_id=0,\n archived=True,\n data_sensitivity="highly_sensitive",\n inputs=[{\n "name": "name"\n }],\n)\nprint(batch_response_property.completed_at)', + }, + java: { + method: 'cms().mediaBridge().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchReadInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.cms.mediabridge.BatchResponseProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchReadInputPropertyName(BatchReadInputPropertyName.builder()\n .archived(true)\n .dataSensitivity(BatchReadInputPropertyName.DataSensitivity.HIGHLY_SENSITIVE)\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.cms().mediaBridge().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Cms.MediaBridge.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Cms.MediaBridge.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchGetParams{\n\t\t\tAppID: 0,\n\t\t\tBatchReadInputPropertyName: shared.BatchReadInputPropertyNameParam{\n\t\t\t\tArchived: true,\n\t\t\t\tDataSensitivity: shared.BatchReadInputPropertyNameDataSensitivityHighlySensitive,\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.media_bridge.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.cms.media_bridge.batch.get(\n "objectType",\n app_id: 0,\n archived: true,\n data_sensitivity: :highly_sensitive,\n inputs: [{name: "name"}]\n)\n\nputs(batch_response_property)', + }, + php: { + method: 'cms->mediaBridge->batch->get', + example: + "cms->mediaBridge->batch->get(\n 'objectType',\n appID: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [['name' => 'name']],\n);\n\nvar_dump($batchResponseProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "archived": true,\n "dataSensitivity": "highly_sensitive",\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'clone', + endpoint: '/cms/pages/2026-03/landing-pages/clone', + httpMethod: 'post', + summary: 'Clone a landing page', + description: 'Create a copy of an existing landing page.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) clone', + qualified: 'client.cms.pages.landingPages.clone', + params: ['id: string;', 'cloneName?: string;'], + response: 'object', + markdown: + "## clone\n\n`client.cms.pages.landingPages.clone(id: string, cloneName?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/clone`\n\nCreate a copy of an existing landing page.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.clone({ id: 'id' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.clone', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.clone({ id: 'id' });\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.clone', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.clone(\n id="id",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().clone', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().clone(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Clone', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Clone(context.TODO(), cms.PageLandingPageCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.clone_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.clone_(id: "id")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->clone', + example: + "cms->pages->landingPages->clone(\n id: 'id', cloneName: 'cloneName'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/pages/2026-03/landing-pages', + httpMethod: 'post', + summary: 'Create a landing page', + description: 'Create a new landing page.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) create', + qualified: 'client.cms.pages.landingPages.create', + params: [ + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'object', + markdown: + "## create\n\n`client.cms.pages.landingPages.create(id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages`\n\nCreate a new landing page.\n\n### Parameters\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage params = PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.New(context.TODO(), cms.PageLandingPageNewParams{\n\t\tPagesPage: cms.PagesPageParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: time.Now(),\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPageRedirected: true,\n\t\t\tPassword: "password",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tSubcategory: "subcategory",\n\t\t\tTemplatePath: "templatePath",\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->create', + example: + "cms->pages->landingPages->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', + httpMethod: 'delete', + summary: 'Delete a landing page', + description: 'Delete a landing page, specified by its ID.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) delete', + qualified: 'client.cms.pages.landingPages.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.pages.landingPages.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nDelete a landing page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.delete('objectId');", + }, + python: { + method: 'cms.pages.landing_pages.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().pages().landingPages().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->delete', + example: + "cms->pages->landingPages->delete('objectId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a landing page', + description: 'Retrieve a landing page, specified by its ID.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) get', + qualified: 'client.cms.pages.landingPages.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: 'object', + markdown: + "## get\n\n`client.cms.pages.landingPages.get(objectId: string, archived?: boolean, property?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nRetrieve a landing page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n A specific property of the landing page to include in the response.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.get('objectId');\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.get('objectId');\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.get(\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().landingPages().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.get("objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->get', + example: + "cms->pages->landingPages->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/pages/2026-03/landing-pages', + httpMethod: 'get', + summary: 'List landing pages', + description: + 'Retrieve a list of landing pages in your HubSpot account. This endpoint allows you to filter landing pages based on creation and update timestamps, sort them, and paginate through results. You can also choose to include archived pages or specify certain properties to be included in the response.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) list', + qualified: 'client.cms.pages.landingPages.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'object', + markdown: + "## list\n\n`client.cms.pages.landingPages.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages`\n\nRetrieve a list of landing pages in your HubSpot account. This endpoint allows you to filter landing pages based on creation and update timestamps, sort them, and paginate through results. You can also choose to include archived pages or specify certain properties to be included in the response.\n\n### Parameters\n\n- `after?: string`\n A cursor token for pagination. Use the value from the previous response's paging.next.after field.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter landing pages created after a specific date and time.\n\n- `createdAt?: string`\n Filter landing pages by their creation timestamp.\n\n- `createdBefore?: string`\n Filter landing pages created before a specific date and time.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify which properties of the landing pages to include in the response.\n\n- `sort?: string[]`\n Specify the order in which results are returned. Accepts an array of strings.\n\n- `updatedAfter?: string`\n Filter landing pages updated after a specific date and time.\n\n- `updatedAt?: string`\n Filter landing pages by their last updated timestamp.\n\n- `updatedBefore?: string`\n Filter landing pages updated before a specific date and time.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.landingPages.list()) {\n console.log(pagesPage);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.landingPages.list()) {\n console.log(pagesPage.id);\n}", + }, + python: { + method: 'cms.pages.landing_pages.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().landingPages().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageListPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LandingPageListPage page = client.cms().pages().landingPages().list();\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.List(context.TODO(), cms.PageLandingPageListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.list\n\nputs(page)', + }, + php: { + method: 'cms->pages->landingPages->list', + example: + "cms->pages->landingPages->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'schedule', + endpoint: '/cms/pages/2026-03/landing-pages/schedule', + httpMethod: 'post', + summary: 'Schedule landing page publishing', + description: 'Schedule a landing page to be published.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) schedule', + qualified: 'client.cms.pages.landingPages.schedule', + params: ['id: string;', 'publishDate: string;'], + markdown: + "## schedule\n\n`client.cms.pages.landingPages.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/schedule`\n\nSchedule a landing page to be published.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.schedule', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", + }, + python: { + method: 'cms.pages.landing_pages.schedule', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', + }, + java: { + method: 'cms().pages().landingPages().schedule', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().pages().landingPages().schedule(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Schedule', + example: + 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Schedule(context.TODO(), cms.PageLandingPageScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.schedule', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->schedule', + example: + "cms->pages->landingPages->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', + httpMethod: 'patch', + summary: 'Update a landing page', + description: + 'Sparse updates a single Landing Page object identified by the id in the path.\nYou only need to specify the column values that you are modifying.', + stainlessPath: '(resource) cms.pages.landing-pages > (method) update', + qualified: 'client.cms.pages.landingPages.update', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + 'archived?: boolean;', + ], + response: 'object', + markdown: + "## update\n\n`client.cms.pages.landingPages.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nSparse updates a single Landing Page object identified by the id in the path.\nYou only need to specify the column values that you are modifying.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LandingPageUpdateParams params = LandingPageUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->update', + example: + "cms->pages->landingPages->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'create_landing_page_variation', + endpoint: '/cms/pages/2026-03/landing-pages/ab-test/create-variation', + httpMethod: 'post', + summary: 'Create a new A/B test variation', + description: 'Create a new A/B test variation based on the information provided in the request body.\n', + stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) create_landing_page_variation', + qualified: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', + params: ['contentId: string;', 'variationName: string;'], + response: 'object', + markdown: + "## create_landing_page_variation\n\n`client.cms.pages.landingPages.abTest.createLandingPageVariation(contentId: string, variationName: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/create-variation`\n\nCreate a new A/B test variation based on the information provided in the request body.\n\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.abTest.createLandingPageVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.abTest.createLandingPageVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.ab_test.create_landing_page_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.ab_test.create_landing_page_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().abTest().createLandingPageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().abTest().createLandingPageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.AbTest.NewLandingPageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.AbTest.NewLandingPageVariation(context.TODO(), cms.PageLandingPageAbTestNewLandingPageVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.ab_test.create_landing_page_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.ab_test.create_landing_page_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->abTest->createLandingPageVariation', + example: + "cms\n ->pages\n ->landingPages\n ->abTest\n ->createLandingPageVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/create-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', + }, + }, + }, + { + name: 'end_landing_page_test', + endpoint: '/cms/pages/2026-03/landing-pages/ab-test/end', + httpMethod: 'post', + summary: 'End an active A/B test', + description: 'End an active A/B test and designate a winner.', + stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) end_landing_page_test', + qualified: 'client.cms.pages.landingPages.abTest.endLandingPageTest', + params: ['abTestId: string;', 'winnerId: string;'], + markdown: + "## end_landing_page_test\n\n`client.cms.pages.landingPages.abTest.endLandingPageTest(abTestId: string, winnerId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/end`\n\nEnd an active A/B test and designate a winner.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to end.\n\n- `winnerId: string`\n ID of the object to designate as the test winner.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.abTest.endLandingPageTest({ abTestId: 'abTestId', winnerId: 'winnerId' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.abTest.endLandingPageTest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.abTest.endLandingPageTest({\n abTestId: 'abTestId',\n winnerId: 'winnerId',\n});", + }, + python: { + method: 'cms.pages.landing_pages.ab_test.end_landing_page_test', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.ab_test.end_landing_page_test(\n ab_test_id="abTestId",\n winner_id="winnerId",\n)', + }, + java: { + method: 'cms().pages().landingPages().abTest().endLandingPageTest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestEndRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestEndRequestVNext params = AbTestEndRequestVNext.builder()\n .abTestId("abTestId")\n .winnerId("winnerId")\n .build();\n client.cms().pages().landingPages().abTest().endLandingPageTest(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.AbTest.EndLandingPageTest', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.AbTest.EndLandingPageTest(context.TODO(), cms.PageLandingPageAbTestEndLandingPageTestParams{\n\t\tAbTestEndRequestVNext: cms.AbTestEndRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tWinnerID: "winnerId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.ab_test.end_landing_page_test', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.ab_test.end_landing_page_test(\n ab_test_id: "abTestId",\n winner_id: "winnerId"\n)\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->abTest->endLandingPageTest', + example: + "cms->pages->landingPages->abTest->endLandingPageTest(\n abTestID: 'abTestId', winnerID: 'winnerId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/end \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "winnerId": "winnerId"\n }\'', + }, + }, + }, + { + name: 'rerun_landing_page_test', + endpoint: '/cms/pages/2026-03/landing-pages/ab-test/rerun', + httpMethod: 'post', + summary: 'Rerun a previous A/B test', + description: 'Rerun a previous A/B test.', + stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) rerun_landing_page_test', + qualified: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', + params: ['abTestId: string;', 'variationId: string;'], + markdown: + "## rerun_landing_page_test\n\n`client.cms.pages.landingPages.abTest.rerunLandingPageTest(abTestId: string, variationId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/rerun`\n\nRerun a previous A/B test.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to rerun.\n\n- `variationId: string`\n ID of the object to reactivate as a test variation.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.abTest.rerunLandingPageTest({ abTestId: 'abTestId', variationId: 'variationId' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.abTest.rerunLandingPageTest({\n abTestId: 'abTestId',\n variationId: 'variationId',\n});", + }, + python: { + method: 'cms.pages.landing_pages.ab_test.rerun_landing_page_test', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.ab_test.rerun_landing_page_test(\n ab_test_id="abTestId",\n variation_id="variationId",\n)', + }, + java: { + method: 'cms().pages().landingPages().abTest().rerunLandingPageTest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestRerunRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestRerunRequestVNext params = AbTestRerunRequestVNext.builder()\n .abTestId("abTestId")\n .variationId("variationId")\n .build();\n client.cms().pages().landingPages().abTest().rerunLandingPageTest(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.AbTest.RerunLandingPageTest', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.AbTest.RerunLandingPageTest(context.TODO(), cms.PageLandingPageAbTestRerunLandingPageTestParams{\n\t\tAbTestRerunRequestVNext: cms.AbTestRerunRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tVariationID: "variationId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.ab_test.rerun_landing_page_test', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.ab_test.rerun_landing_page_test(\n ab_test_id: "abTestId",\n variation_id: "variationId"\n)\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->abTest->rerunLandingPageTest', + example: + "cms->pages->landingPages->abTest->rerunLandingPageTest(\n abTestID: 'abTestId', variationID: 'variationId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/rerun \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "variationId": "variationId"\n }\'', + }, + }, + }, + { + name: 'create_landing_pages', + endpoint: '/cms/pages/2026-03/landing-pages/batch/create', + httpMethod: 'post', + summary: 'Create landing pages', + description: 'Create a batch of landing pages as detailed in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) create_landing_pages', + qualified: 'client.cms.pages.landingPages.batch.createLandingPages', + params: [ + 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', + ], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create_landing_pages\n\n`client.cms.pages.landingPages.batch.createLandingPages(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/create`\n\nCreate a batch of landing pages as detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Pages to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.createLandingPages({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.batch.createLandingPages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.createLandingPages({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.batch.create_landing_pages', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.create_landing_pages(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "page_redirected": True,\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "template_path": "templatePath",\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().batch().createLandingPages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.BatchInputPage;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPage params = BatchInputPage.builder()\n .addInput(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().createLandingPages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Batch.NewLandingPages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.NewLandingPages(context.TODO(), cms.PageLandingPageBatchNewLandingPagesParams{\n\t\tBatchInputPage: cms.BatchInputPageParam{\n\t\t\tInputs: []cms.PagesPageParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.batch.create_landing_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.create_landing_pages(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: "2019-12-27T18:11:19.117Z",\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n pageRedirected: true,\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n templatePath: "templatePath",\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->landingPages->batch->createLandingPages', + example: + "cms\n ->pages\n ->landingPages\n ->batch\n ->createLandingPages(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'pageRedirected' => true,\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'slug' => 'slug',\n 'state' => 'state',\n 'subcategory' => 'subcategory',\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_landing_pages', + endpoint: '/cms/pages/2026-03/landing-pages/batch/archive', + httpMethod: 'post', + summary: 'Delete landing pages', + description: + 'Delete landing pages specified by ID in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', + stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) delete_landing_pages', + qualified: 'client.cms.pages.landingPages.batch.deleteLandingPages', + params: ['inputs: string[];'], + markdown: + "## delete_landing_pages\n\n`client.cms.pages.landingPages.batch.deleteLandingPages(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/archive`\n\nDelete landing pages specified by ID in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.batch.deleteLandingPages({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.batch.deleteLandingPages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.batch.deleteLandingPages({ inputs: ['string'] });", + }, + python: { + method: 'cms.pages.landing_pages.batch.delete_landing_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.batch.delete_landing_pages(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().pages().landingPages().batch().deleteLandingPages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().landingPages().batch().deleteLandingPages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Batch.DeleteLandingPages', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Batch.DeleteLandingPages(context.TODO(), cms.PageLandingPageBatchDeleteLandingPagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.batch.delete_landing_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.batch.delete_landing_pages(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->batch->deleteLandingPages', + example: + "cms->pages->landingPages->batch->deleteLandingPages(\n inputs: ['string']\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_landing_pages', + endpoint: '/cms/pages/2026-03/landing-pages/batch/read', + httpMethod: 'post', + summary: 'Retrieve landing pages', + description: 'Retrieve a batch of landing pages as specified in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) get_landing_pages', + qualified: 'client.cms.pages.landingPages.batch.getLandingPages', + params: ['inputs: string[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_landing_pages\n\n`client.cms.pages.landingPages.batch.getLandingPages(inputs: string[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/read`\n\nRetrieve a batch of landing pages as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.getLandingPages({ inputs: ['string'] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.batch.getLandingPages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.getLandingPages({\n inputs: ['string'],\n});\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.batch.get_landing_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.get_landing_pages(\n inputs=["string"],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().batch().getLandingPages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().getLandingPages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Batch.GetLandingPages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.GetLandingPages(context.TODO(), cms.PageLandingPageBatchGetLandingPagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.batch.get_landing_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.get_landing_pages(inputs: ["string"])\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->landingPages->batch->getLandingPages', + example: + "cms->pages->landingPages->batch->getLandingPages(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update_landing_pages', + endpoint: '/cms/pages/2026-03/landing-pages/batch/update', + httpMethod: 'post', + summary: 'Update landing pages', + description: 'Update a batch of landing pages as specified in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) update_landing_pages', + qualified: 'client.cms.pages.landingPages.batch.updateLandingPages', + params: ['inputs: object[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update_landing_pages\n\n`client.cms.pages.landingPages.batch.updateLandingPages(inputs: object[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/update`\n\nUpdate a batch of landing pages as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.updateLandingPages({ inputs: [{}] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.batch.updateLandingPages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.updateLandingPages({\n inputs: [{}],\n});\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.batch.update_landing_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.update_landing_pages(\n inputs=[{}],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().batch().updateLandingPages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().updateLandingPages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Batch.UpdateLandingPages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.UpdateLandingPages(context.TODO(), cms.PageLandingPageBatchUpdateLandingPagesParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.batch.update_landing_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.update_landing_pages(inputs: [{}])\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->landingPages->batch->updateLandingPages', + example: + "cms\n ->pages\n ->landingPages\n ->batch\n ->updateLandingPages(inputs: [(object) []], archived: true);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft', + httpMethod: 'get', + summary: 'Retrieve a landing page draft', + description: 'Retrieve the full draft version of a landing page, specified by page ID.', + stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) get', + qualified: 'client.cms.pages.landingPages.draft.get', + params: ['objectId: string;'], + response: 'object', + markdown: + "## get\n\n`client.cms.pages.landingPages.draft.get(objectId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/draft`\n\nRetrieve the full draft version of a landing page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.draft.get('objectId');\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.draft.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.draft.get('objectId');\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.draft.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.draft.get(\n "objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().draft().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().landingPages().draft().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Draft.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Draft.Get(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.draft.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.draft.get("objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->draft->get', + example: + "cms->pages->landingPages->draft->get('objectId');\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'push_live', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live', + httpMethod: 'post', + summary: 'Push Landing Page draft edits live', + description: + 'Take any changes from the draft version of the Landing Page and apply them to the live version.', + stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) push_live', + qualified: 'client.cms.pages.landingPages.draft.pushLive', + params: ['objectId: string;'], + markdown: + "## push_live\n\n`client.cms.pages.landingPages.draft.pushLive(objectId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live`\n\nTake any changes from the draft version of the Landing Page and apply them to the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.draft.pushLive('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.draft.pushLive', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.draft.pushLive('objectId');", + }, + python: { + method: 'cms.pages.landing_pages.draft.push_live', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.draft.push_live(\n "objectId",\n)', + }, + java: { + method: 'cms().pages().landingPages().draft().pushLive', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftPushLiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().draft().pushLive("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Draft.PushLive', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Draft.PushLive(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.draft.push_live', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.draft.push_live("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->draft->pushLive', + example: + "cms->pages->landingPages->draft->pushLive('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft/reset', + httpMethod: 'post', + summary: 'Reset a landing page draft', + description: 'Discards any edits and resets the draft to match the live version.', + stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) reset', + qualified: 'client.cms.pages.landingPages.draft.reset', + params: ['objectId: string;'], + markdown: + "## reset\n\n`client.cms.pages.landingPages.draft.reset(objectId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/draft/reset`\n\nDiscards any edits and resets the draft to match the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.draft.reset('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.draft.reset', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.draft.reset('objectId');", + }, + python: { + method: 'cms.pages.landing_pages.draft.reset', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.draft.reset(\n "objectId",\n)', + }, + java: { + method: 'cms().pages().landingPages().draft().reset', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftResetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().draft().reset("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Draft.Reset', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Draft.Reset(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.draft.reset', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.draft.reset("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->draft->reset', + example: + "cms->pages->landingPages->draft->reset('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft', + httpMethod: 'patch', + summary: 'Update the draft of a landing page', + description: + 'Partially updates the draft version of a single landing page, specified by its ID. You only need to specify the column values that you are modifying.\n', + stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) update', + qualified: 'client.cms.pages.landingPages.draft.update', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'object', + markdown: + "## update\n\n`client.cms.pages.landingPages.draft.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/{objectId}/draft`\n\nPartially updates the draft version of a single landing page, specified by its ID. You only need to specify the column values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.draft.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.draft.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.draft.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.draft.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.draft.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().draft().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DraftUpdateParams params = DraftUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().draft().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Draft.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Draft.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageDraftUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.draft.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.draft.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->draft->update', + example: + "cms->pages->landingPages->draft->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'batch_get', + endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/read', + httpMethod: 'post', + summary: 'Retrieve folders', + description: 'Retrieve a batch of landing page folders as identified in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) batch_get', + qualified: 'client.cms.pages.landingPages.folders.batchGet', + params: ['inputs: string[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## batch_get\n\n`client.cms.pages.landingPages.folders.batchGet(inputs: string[], archived?: boolean): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/read`\n\nRetrieve a batch of landing page folders as identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.batchGet({ inputs: ['string'] });\n\nconsole.log(batchResponseContentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.batchGet', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.batchGet({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.folders.batch_get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.batch_get(\n inputs=["string"],\n)\nprint(batch_response_content_folder.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().folders().batchGet', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().batchGet(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.BatchGet', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.BatchGet(context.TODO(), cms.PageLandingPageFolderBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.batch_get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.batch_get(inputs: ["string"])\n\nputs(batch_response_content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->batchGet', + example: + "cms\n ->pages\n ->landingPages\n ->folders\n ->batchGet(inputs: ['string'], archived: true);\n\nvar_dump($batchResponseContentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/pages/2026-03/landing-pages/folders', + httpMethod: 'post', + summary: 'Create a landing page folder', + description: 'Create a new folder for landing pages.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) create', + qualified: 'client.cms.pages.landingPages.folders.create', + params: [ + 'id: string;', + 'category: number;', + 'created: string;', + 'deletedAt: string;', + 'name: string;', + 'parentFolderId: number;', + 'updated: string;', + ], + response: + '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', + markdown: + "## create\n\n`client.cms.pages.landingPages.folders.create(id: string, category: number, created: string, deletedAt: string, name: string, parentFolderId: number, updated: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders`\n\nCreate a new folder for landing pages.\n\n### Parameters\n\n- `id: string`\n The unique ID of the content folder.\n\n- `category: number`\n The type of object this folder applies to. Should always be LANDING_PAGE.\n\n- `created: string`\n The timestamp indicating when the content folder was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this content folder was deleted.\n\n- `name: string`\n The name of the folder which will show up in the app dashboard\n\n- `parentFolderId: number`\n The ID of the content folder this folder is nested under\n\n- `updated: string`\n The timestamp indicating when the content folder was last updated.\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.create({\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.create({\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder.id);", + }, + python: { + method: 'cms.pages.landing_pages.folders.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.create(\n id="id",\n category=0,\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n name="name",\n parent_folder_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(content_folder.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentFolder params = ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.New(context.TODO(), cms.PageLandingPageFolderNewParams{\n\t\tContentFolder: cms.ContentFolderParam{\n\t\t\tID: "id",\n\t\t\tCategory: 0,\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tName: "name",\n\t\t\tParentFolderID: 0,\n\t\t\tUpdated: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.create(\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n name: "name",\n parent_folder_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->create', + example: + "cms->pages->landingPages->folders->create(\n id: 'id',\n category: 0,\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n name: 'name',\n parentFolderID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($contentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'create_folders', + endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/create', + httpMethod: 'post', + summary: 'Create folders', + description: 'Create a batch of folders as detailed in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) create_folders', + qualified: 'client.cms.pages.landingPages.folders.createFolders', + params: [ + 'inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create_folders\n\n`client.cms.pages.landingPages.folders.createFolders(inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/create`\n\nCreate a batch of folders as detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n Content folders to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.createFolders({ inputs: [{\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n}] });\n\nconsole.log(batchResponseContentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.createFolders', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.createFolders({\n inputs: [\n {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n },\n ],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.folders.create_folders', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.create_folders(\n inputs=[{\n "id": "id",\n "category": 0,\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "parent_folder_id": 0,\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n)\nprint(batch_response_content_folder.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().folders().createFolders', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.BatchInputContentFolder;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputContentFolder params = BatchInputContentFolder.builder()\n .addInput(ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().createFolders(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.NewFolders', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.NewFolders(context.TODO(), cms.PageLandingPageFolderNewFoldersParams{\n\t\tBatchInputContentFolder: cms.BatchInputContentFolderParam{\n\t\t\tInputs: []cms.ContentFolderParam{{\n\t\t\t\tID: "id",\n\t\t\t\tCategory: 0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tName: "name",\n\t\t\t\tParentFolderID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.create_folders', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.create_folders(\n inputs: [\n {\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n name: "name",\n parentFolderId: 0,\n updated: "2019-12-27T18:11:19.117Z"\n }\n ]\n)\n\nputs(batch_response_content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->createFolders', + example: + "cms\n ->pages\n ->landingPages\n ->folders\n ->createFolders(\n inputs: [\n [\n 'id' => 'id',\n 'category' => 0,\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'parentFolderID' => 0,\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseContentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + httpMethod: 'delete', + summary: 'Delete a landing page folder', + description: 'Delete a landing page folder, specified by its ID.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) delete', + qualified: 'client.cms.pages.landingPages.folders.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.pages.landingPages.folders.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nDelete a landing page folder, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.folders.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.folders.delete('objectId');", + }, + python: { + method: 'cms.pages.landing_pages.folders.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.folders.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().pages().landingPages().folders().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().folders().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Folders.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.folders.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->folders->delete', + example: + "cms->pages->landingPages->folders->delete(\n 'objectId', archived: true\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_folders', + endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/archive', + httpMethod: 'post', + summary: 'Delete folders', + description: 'Delete a batch of folders as specified in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) delete_folders', + qualified: 'client.cms.pages.landingPages.folders.deleteFolders', + params: ['inputs: string[];'], + markdown: + "## delete_folders\n\n`client.cms.pages.landingPages.folders.deleteFolders(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/archive`\n\nDelete a batch of folders as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.folders.deleteFolders({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.deleteFolders', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.folders.deleteFolders({ inputs: ['string'] });", + }, + python: { + method: 'cms.pages.landing_pages.folders.delete_folders', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.folders.delete_folders(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().pages().landingPages().folders().deleteFolders', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().landingPages().folders().deleteFolders(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.DeleteFolders', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Folders.DeleteFolders(context.TODO(), cms.PageLandingPageFolderDeleteFoldersParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.delete_folders', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.folders.delete_folders(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->folders->deleteFolders', + example: + "cms->pages->landingPages->folders->deleteFolders(\n inputs: ['string']\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a landing page folder', + description: 'Retrieve a landing page folder, specified by its ID.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) get', + qualified: 'client.cms.pages.landingPages.folders.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: + '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', + markdown: + "## get\n\n`client.cms.pages.landingPages.folders.get(objectId: string, archived?: boolean, property?: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nRetrieve a landing page folder, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.get('objectId');\n\nconsole.log(contentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.get('objectId');\n\nconsole.log(contentFolder.id);", + }, + python: { + method: 'cms.pages.landing_pages.folders.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.get(\n object_id="objectId",\n)\nprint(content_folder.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.get("objectId")\n\nputs(content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->get', + example: + "cms->pages->landingPages->folders->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($contentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_revision', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Retrieve a previous version of a folder', + description: 'Retrieve a previous version of a folder, specified by the folder ID and revision ID.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) get_revision', + qualified: 'client.cms.pages.landingPages.folders.getRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: + '{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', + markdown: + "## get_revision\n\n`client.cms.pages.landingPages.folders.getRevision(objectId: string, revisionId: string): { id: string; object: content_folder; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a folder, specified by the folder ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolderVersion = await client.cms.pages.landingPages.folders.getRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(contentFolderVersion);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.getRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolderVersion = await client.cms.pages.landingPages.folders.getRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(contentFolderVersion.id);", + }, + python: { + method: 'cms.pages.landing_pages.folders.get_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder_version = client.cms.pages.landing_pages.folders.get_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(content_folder_version.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().getRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolderVersion;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderGetRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderGetRevisionParams params = FolderGetRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n ContentFolderVersion contentFolderVersion = client.cms().pages().landingPages().folders().getRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.GetRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolderVersion, err := client.Cms.Pages.LandingPages.Folders.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageFolderGetRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolderVersion.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.get_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder_version = hubspot.cms.pages.landing_pages.folders.get_revision("revisionId", object_id_: "objectId")\n\nputs(content_folder_version)', + }, + php: { + method: 'cms->pages->landingPages->folders->getRevision', + example: + "cms->pages->landingPages->folders->getRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($contentFolderVersion);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/pages/2026-03/landing-pages/folders', + httpMethod: 'get', + summary: 'Get all landing page folders', + description: + 'Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) list', + qualified: 'client.cms.pages.landingPages.folders.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', + markdown: + "## list\n\n`client.cms.pages.landingPages.folders.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders`\n\nGet the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter folders created after the specified date and time.\n\n- `createdAt?: string`\n Filter folders by their exact creation date and time.\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify a property to include in the response.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolder of client.cms.pages.landingPages.folders.list()) {\n console.log(contentFolder);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolder of client.cms.pages.landingPages.folders.list()) {\n console.log(contentFolder.id);\n}", + }, + python: { + method: 'cms.pages.landing_pages.folders.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.folders.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderListPage page = client.cms().pages().landingPages().folders().list();\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Folders.List(context.TODO(), cms.PageLandingPageFolderListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.folders.list\n\nputs(page)', + }, + php: { + method: 'cms->pages->landingPages->folders->list', + example: + "cms->pages->landingPages->folders->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_revisions', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions', + httpMethod: 'get', + summary: 'Retrieves previous versions of a folder', + description: 'Retrieves all the previous versions of a landing page folder.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) list_revisions', + qualified: 'client.cms.pages.landingPages.folders.listRevisions', + params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: + '{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', + markdown: + "## list_revisions\n\n`client.cms.pages.landingPages.folders.listRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: content_folder; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions`\n\nRetrieves all the previous versions of a landing page folder.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolderVersion of client.cms.pages.landingPages.folders.listRevisions('objectId')) {\n console.log(contentFolderVersion);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.listRevisions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolderVersion of client.cms.pages.landingPages.folders.listRevisions(\n 'objectId',\n)) {\n console.log(contentFolderVersion.id);\n}", + }, + python: { + method: 'cms.pages.landing_pages.folders.list_revisions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.folders.list_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().listRevisions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderListRevisionsPage page = client.cms().pages().landingPages().folders().listRevisions("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.ListRevisions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Folders.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.list_revisions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.folders.list_revisions("objectId")\n\nputs(page)', + }, + php: { + method: 'cms->pages->landingPages->folders->listRevisions', + example: + "cms->pages->landingPages->folders->listRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_revision', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore', + httpMethod: 'post', + summary: 'Restore a previous version of a folder', + description: 'Takes a specified version of a landing page folder and restores it.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) restore_revision', + qualified: 'client.cms.pages.landingPages.folders.restoreRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: + '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', + markdown: + "## restore_revision\n\n`client.cms.pages.landingPages.folders.restoreRevision(objectId: string, revisionId: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore`\n\nTakes a specified version of a landing page folder and restores it.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.restoreRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(contentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.restoreRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.restoreRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(contentFolder.id);", + }, + python: { + method: 'cms.pages.landing_pages.folders.restore_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.restore_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(content_folder.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().restoreRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderRestoreRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderRestoreRevisionParams params = FolderRestoreRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().restoreRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.RestoreRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.RestoreRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageFolderRestoreRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.restore_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.restore_revision("revisionId", object_id_: "objectId")\n\nputs(content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->restoreRevision', + example: + "cms->pages->landingPages->folders->restoreRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($contentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + httpMethod: 'patch', + summary: 'Update a landing page folder', + description: + 'Partially update a landing page folder, specified by the folder ID. You only need to specify the details values that you are modifying.\n', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) update', + qualified: 'client.cms.pages.landingPages.folders.update', + params: [ + 'objectId: string;', + 'id: string;', + 'category: number;', + 'created: string;', + 'deletedAt: string;', + 'name: string;', + 'parentFolderId: number;', + 'updated: string;', + 'archived?: boolean;', + ], + response: + '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', + markdown: + "## update\n\n`client.cms.pages.landingPages.folders.update(objectId: string, id: string, category: number, created: string, deletedAt: string, name: string, parentFolderId: number, updated: string, archived?: boolean): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nPartially update a landing page folder, specified by the folder ID. You only need to specify the details values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the content folder.\n\n- `category: number`\n The type of object this folder applies to. Should always be LANDING_PAGE.\n\n- `created: string`\n The timestamp indicating when the content folder was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this content folder was deleted.\n\n- `name: string`\n The name of the folder which will show up in the app dashboard\n\n- `parentFolderId: number`\n The ID of the content folder this folder is nested under\n\n- `updated: string`\n The timestamp indicating when the content folder was last updated.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.update('objectId', {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.update('objectId', {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder.id);", + }, + python: { + method: 'cms.pages.landing_pages.folders.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.update(\n object_id="objectId",\n id="id",\n category=0,\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n name="name",\n parent_folder_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(content_folder.id)', + }, + java: { + method: 'cms().pages().landingPages().folders().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateParams params = FolderUpdateParams.builder()\n .objectId("objectId")\n .contentFolder(ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderUpdateParams{\n\t\t\tContentFolder: cms.ContentFolderParam{\n\t\t\t\tID: "id",\n\t\t\t\tCategory: 0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tName: "name",\n\t\t\t\tParentFolderID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.update(\n "objectId",\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n name: "name",\n parent_folder_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->update', + example: + "cms->pages->landingPages->folders->update(\n 'objectId',\n id: 'id',\n category: 0,\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n name: 'name',\n parentFolderID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archived: true,\n);\n\nvar_dump($contentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'update_folders', + endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/update', + httpMethod: 'post', + summary: 'Update folders', + description: 'Update a batch of landing page folders as specified in the request body.', + stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) update_folders', + qualified: 'client.cms.pages.landingPages.folders.updateFolders', + params: ['inputs: object[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update_folders\n\n`client.cms.pages.landingPages.folders.updateFolders(inputs: object[], archived?: boolean): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/update`\n\nUpdate a batch of landing page folders as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.updateFolders({ inputs: [{}] });\n\nconsole.log(batchResponseContentFolder);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.folders.updateFolders', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.updateFolders({\n inputs: [{}],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", + }, + python: { + method: 'cms.pages.landing_pages.folders.update_folders', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.update_folders(\n inputs=[{}],\n)\nprint(batch_response_content_folder.completed_at)', + }, + java: { + method: 'cms().pages().landingPages().folders().updateFolders', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().updateFolders(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Folders.UpdateFolders', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.UpdateFolders(context.TODO(), cms.PageLandingPageFolderUpdateFoldersParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.folders.update_folders', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.update_folders(inputs: [{}])\n\nputs(batch_response_content_folder)', + }, + php: { + method: 'cms->pages->landingPages->folders->updateFolders', + example: + "cms\n ->pages\n ->landingPages\n ->folders\n ->updateFolders(inputs: [(object) []], archived: true);\n\nvar_dump($batchResponseContentFolder);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Add a landing page to a multi-language group', + description: 'Attach a landing page to a multi-language group.', + stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) attach_to_lang_group', + qualified: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.pages.landingPages.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group`\n\nAttach a landing page to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.landing_pages.multi_language.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().landingPages().multiLanguage().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.MultiLanguage.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.AttachToLangGroup(context.TODO(), cms.PageLandingPageMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.multi_language.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->pages->landingPages->multiLanguage->attachToLangGroup', + example: + "cms->pages->landingPages->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create_language_variation', + endpoint: '/cms/pages/2026-03/landing-pages/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a new language variation', + description: + 'Create a new language variation from an existing landing page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source landing page](/api-reference/latest/cms/pages/landing-pages/drafts/get-landing-page-draft).', + stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) create_language_variation', + qualified: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', + params: ['id: string;', 'language?: string;', 'primaryLanguage?: string;', 'usePublished?: boolean;'], + response: 'object', + markdown: + "## create_language_variation\n\n`client.cms.pages.landingPages.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, usePublished?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/create-language-variation`\n\nCreate a new language variation from an existing landing page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source landing page](/api-reference/latest/cms/pages/landing-pages/drafts/get-landing-page-draft).\n\n### Parameters\n\n- `id: string`\n ID of content to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary content to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.multiLanguage.createLanguageVariation({\n id: 'id',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.multi_language.create_language_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.multi_language.create_language_variation(\n id="id",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().multiLanguage().createLanguageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentLanguageCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentLanguageCloneRequestVNext params = ContentLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().multiLanguage().createLanguageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.MultiLanguage.NewLanguageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.MultiLanguage.NewLanguageVariation(context.TODO(), cms.PageLandingPageMultiLanguageNewLanguageVariationParams{\n\t\tContentLanguageCloneRequestVNext: cms.ContentLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.multi_language.create_language_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.multi_language.create_language_variation(id: "id")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->multiLanguage->createLanguageVariation', + example: + "cms\n ->pages\n ->landingPages\n ->multiLanguage\n ->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Remove a landing page from a multi-language group', + description: 'Detach a landing page from a multi-language group.', + stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) detach_from_lang_group', + qualified: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.pages.landingPages.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group`\n\nDetach a landing page from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.detachFromLangGroup({\n id: 'id',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.landing_pages.multi_language.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().landingPages().multiLanguage().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.MultiLanguage.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.PageLandingPageMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.multi_language.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->pages->landingPages->multiLanguage->detachFromLangGroup', + example: + "cms\n ->pages\n ->landingPages\n ->multiLanguage\n ->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'set_new_lang_primary', + endpoint: '/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set a new primary language', + description: 'Set a landing page as the primary language of a multi-language group.', + stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) set_new_lang_primary', + qualified: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', + params: ['id: string;'], + markdown: + "## set_new_lang_primary\n\n`client.cms.pages.landingPages.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary`\n\nSet a landing page as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.multiLanguage.setNewLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.pages.landing_pages.multi_language.set_new_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.multi_language.set_new_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().pages().landingPages().multiLanguage().setNewLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().pages().landingPages().multiLanguage().setNewLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.MultiLanguage.SetNewLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.PageLandingPageMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.multi_language.set_new_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->pages->landingPages->multiLanguage->setNewLangPrimary', + example: + "cms->pages->landingPages->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update_languages', + endpoint: '/cms/pages/2026-03/landing-pages/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update languages of multi-language group', + description: 'Explicitly set new languages for each landing page in a multi-language group.', + stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) update_languages', + qualified: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_languages\n\n`client.cms.pages.landingPages.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/update-languages`\n\nExplicitly set new languages for each landing page in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.landing_pages.multi_language.update_languages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().landingPages().multiLanguage().updateLanguages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().updateLanguages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.MultiLanguage.UpdateLanguages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.UpdateLanguages(context.TODO(), cms.PageLandingPageMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.multi_language.update_languages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.update_languages(\n languages: {foo: :aa},\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->pages->landingPages->multiLanguage->updateLanguages', + example: + "cms->pages->landingPages->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'get_landing_page_revision', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Retrieve a previous version of a landing page', + description: 'Retrieve a previous version of a landing page, specified by page ID and revision ID.', + stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) get_landing_page_revision', + qualified: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## get_landing_page_revision\n\n`client.cms.pages.landingPages.revisions.getLandingPageRevision(objectId: string, revisionId: string): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a landing page, specified by page ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pageVersion = await client.cms.pages.landingPages.revisions.getLandingPageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pageVersion);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pageVersion = await client.cms.pages.landingPages.revisions.getLandingPageRevision(\n 'revisionId',\n { objectId: 'objectId' },\n);\n\nconsole.log(pageVersion.id);", + }, + python: { + method: 'cms.pages.landing_pages.revisions.get_landing_page_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage_version = client.cms.pages.landing_pages.revisions.get_landing_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(page_version.id)', + }, + java: { + method: 'cms().pages().landingPages().revisions().getLandingPageRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PageVersion;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionGetLandingPageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetLandingPageRevisionParams params = RevisionGetLandingPageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PageVersion pageVersion = client.cms().pages().landingPages().revisions().getLandingPageRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Revisions.GetLandingPageRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpageVersion, err := client.Cms.Pages.LandingPages.Revisions.GetLandingPageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageRevisionGetLandingPageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pageVersion.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.revisions.get_landing_page_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage_version = hubspot.cms.pages.landing_pages.revisions.get_landing_page_revision("revisionId", object_id_: "objectId")\n\nputs(page_version)', + }, + php: { + method: 'cms->pages->landingPages->revisions->getLandingPageRevision', + example: + "cms\n ->pages\n ->landingPages\n ->revisions\n ->getLandingPageRevision('revisionId', objectID: 'objectId');\n\nvar_dump($pageVersion);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_landing_page_revisions', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions', + httpMethod: 'get', + summary: 'Retrieve all previous versions of a landing page', + description: 'Retrieve all the previous versions of a landing page, specified by page ID.', + stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) list_landing_page_revisions', + qualified: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', + params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## list_landing_page_revisions\n\n`client.cms.pages.landingPages.revisions.listLandingPageRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/revisions`\n\nRetrieve all the previous versions of a landing page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.landingPages.revisions.listLandingPageRevisions('objectId')) {\n console.log(pageVersion);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.landingPages.revisions.listLandingPageRevisions(\n 'objectId',\n)) {\n console.log(pageVersion.id);\n}", + }, + python: { + method: 'cms.pages.landing_pages.revisions.list_landing_page_revisions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.revisions.list_landing_page_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().landingPages().revisions().listLandingPageRevisions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionListLandingPageRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionListLandingPageRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListLandingPageRevisionsPage page = client.cms().pages().landingPages().revisions().listLandingPageRevisions("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Revisions.ListLandingPageRevisions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Revisions.ListLandingPageRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageRevisionListLandingPageRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.revisions.list_landing_page_revisions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.revisions.list_landing_page_revisions("objectId")\n\nputs(page)', + }, + php: { + method: 'cms->pages->landingPages->revisions->listLandingPageRevisions', + example: + "cms->pages->landingPages->revisions->listLandingPageRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_landing_page_revision', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore', + httpMethod: 'post', + summary: 'Restore a previous version of a landing page', + description: 'Restores a previous version of a landing page, specified by page ID and revision ID.', + stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) restore_landing_page_revision', + qualified: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: 'object', + markdown: + "## restore_landing_page_revision\n\n`client.cms.pages.landingPages.revisions.restoreLandingPageRevision(objectId: string, revisionId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore`\n\nRestores a previous version of a landing page, specified by page ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevision(\n 'revisionId',\n { objectId: 'objectId' },\n);\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.revisions.restore_landing_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().revisions().restoreLandingPageRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionRestoreLandingPageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreLandingPageRevisionParams params = RevisionRestoreLandingPageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().revisions().restoreLandingPageRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageRevisionRestoreLandingPageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.revisions.restore_landing_page_revision(\n "revisionId",\n object_id_: "objectId"\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->revisions->restoreLandingPageRevision', + example: + "cms\n ->pages\n ->landingPages\n ->revisions\n ->restoreLandingPageRevision('revisionId', objectID: 'objectId');\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_landing_page_revision_to_draft', + endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft', + httpMethod: 'post', + summary: 'Restore a previous version of a landing page', + description: 'Specify a previous version of a landing page to set as the page draft.', + stainlessPath: + '(resource) cms.pages.landing-pages.revisions > (method) restore_landing_page_revision_to_draft', + qualified: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', + params: ['objectId: string;', 'revisionId: number;'], + response: 'object', + markdown: + "## restore_landing_page_revision_to_draft\n\n`client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(objectId: string, revisionId: number): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nSpecify a previous version of a landing page to set as the page draft.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(\n 0,\n { objectId: 'objectId' },\n);\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().landingPages().revisions().restoreLandingPageRevisionToDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionRestoreLandingPageRevisionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreLandingPageRevisionToDraftParams params = RevisionRestoreLandingPageRevisionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().revisions().restoreLandingPageRevisionToDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevisionToDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.PageLandingPageRevisionRestoreLandingPageRevisionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft(\n 0,\n object_id_: "objectId"\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->landingPages->revisions->restoreLandingPageRevisionToDraft', + example: + "cms\n ->pages\n ->landingPages\n ->revisions\n ->restoreLandingPageRevisionToDraft(0, objectID: 'objectId');\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'clone', + endpoint: '/cms/pages/2026-03/site-pages/clone', + httpMethod: 'post', + summary: 'Clone a website page', + description: 'Create a copy of an existing website page.', + stainlessPath: '(resource) cms.pages.site-pages > (method) clone', + qualified: 'client.cms.pages.sitePages.clone', + params: ['id: string;', 'cloneName?: string;'], + response: 'object', + markdown: + "## clone\n\n`client.cms.pages.sitePages.clone(id: string, cloneName?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/clone`\n\nCreate a copy of an existing website page.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.clone({ id: 'id' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.clone', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.clone({ id: 'id' });\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.clone', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.clone(\n id="id",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().clone', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().clone(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Clone', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Clone(context.TODO(), cms.PageSitePageCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.clone_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.clone_(id: "id")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->clone', + example: + "cms->pages->sitePages->clone(\n id: 'id', cloneName: 'cloneName'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/pages/2026-03/site-pages', + httpMethod: 'post', + summary: 'Create a website page', + description: 'Create a new website page.', + stainlessPath: '(resource) cms.pages.site-pages > (method) create', + qualified: 'client.cms.pages.sitePages.create', + params: [ + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'object', + markdown: + "## create\n\n`client.cms.pages.sitePages.create(id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages`\n\nCreate a new website page.\n\n### Parameters\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage params = PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.New(context.TODO(), cms.PageSitePageNewParams{\n\t\tPagesPage: cms.PagesPageParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: time.Now(),\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPageRedirected: true,\n\t\t\tPassword: "password",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tSubcategory: "subcategory",\n\t\t\tTemplatePath: "templatePath",\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->create', + example: + "cms->pages->sitePages->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}', + httpMethod: 'delete', + summary: 'Delete a website page', + description: 'Delete a website page, specified by its ID.', + stainlessPath: '(resource) cms.pages.site-pages > (method) delete', + qualified: 'client.cms.pages.sitePages.delete', + params: ['objectId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.cms.pages.sitePages.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/site-pages/{objectId}`\n\nDelete a website page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.delete('objectId');", + }, + python: { + method: 'cms.pages.site_pages.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.delete(\n object_id="objectId",\n)', + }, + java: { + method: 'cms().pages().sitePages().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->delete', + example: + "cms->pages->sitePages->delete('objectId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}', + httpMethod: 'get', + summary: 'Retrieve a website page', + description: 'Retrieve a website page by its ID.', + stainlessPath: '(resource) cms.pages.site-pages > (method) get', + qualified: 'client.cms.pages.sitePages.get', + params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], + response: 'object', + markdown: + "## get\n\n`client.cms.pages.sitePages.get(objectId: string, archived?: boolean, property?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}`\n\nRetrieve a website page by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.get('objectId');\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.get('objectId');\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.get(\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().sitePages().get("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.get("objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->get', + example: + "cms->pages->sitePages->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/pages/2026-03/site-pages', + httpMethod: 'get', + summary: 'Retrieve all website pages', + description: + 'Retrieve all website pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.', + stainlessPath: '(resource) cms.pages.site-pages > (method) list', + qualified: 'client.cms.pages.sitePages.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'property?: string;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: 'object', + markdown: + "## list\n\n`client.cms.pages.sitePages.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages`\n\nRetrieve all website pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter pages created after a specific date and time.\n\n- `createdAt?: string`\n Filter pages by the exact creation timestamp. Format is date-time.\n\n- `createdBefore?: string`\n Filter pages created before a specific date-time.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify properties to include in the response.\n\n- `sort?: string[]`\n Specify the order of results. Accepts an array of field names to sort by.\n\n- `updatedAfter?: string`\n Filter pages updated after the specified date-time.\n\n- `updatedAt?: string`\n Filter pages by their exact update timestamp in ISO 8601 format.\n\n- `updatedBefore?: string`\n Filter pages updated before a specific date and time. Format should be date-time.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.sitePages.list()) {\n console.log(pagesPage);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.sitePages.list()) {\n console.log(pagesPage.id);\n}", + }, + python: { + method: 'cms.pages.site_pages.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.site_pages.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().sitePages().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageListPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SitePageListPage page = client.cms().pages().sitePages().list();\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.SitePages.List(context.TODO(), cms.PageSitePageListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.site_pages.list\n\nputs(page)', + }, + php: { + method: 'cms->pages->sitePages->list', + example: + "cms->pages->sitePages->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'schedule', + endpoint: '/cms/pages/2026-03/site-pages/schedule', + httpMethod: 'post', + summary: 'Schedule a website page to be published', + description: 'Schedule a website page to published at a future time.', + stainlessPath: '(resource) cms.pages.site-pages > (method) schedule', + qualified: 'client.cms.pages.sitePages.schedule', + params: ['id: string;', 'publishDate: string;'], + markdown: + "## schedule\n\n`client.cms.pages.sitePages.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/schedule`\n\nSchedule a website page to published at a future time.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.schedule', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", + }, + python: { + method: 'cms.pages.site_pages.schedule', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', + }, + java: { + method: 'cms().pages().sitePages().schedule', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().pages().sitePages().schedule(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Schedule', + example: + 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Schedule(context.TODO(), cms.PageSitePageScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.schedule', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->schedule', + example: + "cms->pages->sitePages->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}', + httpMethod: 'patch', + summary: 'Update a website page', + description: + 'Partially updates a single website page, specified by its ID. You only need to specify the column values that you are modifying.\n', + stainlessPath: '(resource) cms.pages.site-pages > (method) update', + qualified: 'client.cms.pages.sitePages.update', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + 'archived?: boolean;', + ], + response: 'object', + markdown: + "## update\n\n`client.cms.pages.sitePages.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/site-pages/{objectId}`\n\nPartially updates a single website page, specified by its ID. You only need to specify the column values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SitePageUpdateParams params = SitePageUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->update', + example: + "cms->pages->sitePages->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'create_site_page_variation', + endpoint: '/cms/pages/2026-03/site-pages/ab-test/create-variation', + httpMethod: 'post', + summary: 'Create a new A/B test variation', + description: 'Create a new A/B test variation based on the information provided in the request body.\n', + stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) create_site_page_variation', + qualified: 'client.cms.pages.sitePages.abTest.createSitePageVariation', + params: ['contentId: string;', 'variationName: string;'], + response: 'object', + markdown: + "## create_site_page_variation\n\n`client.cms.pages.sitePages.abTest.createSitePageVariation(contentId: string, variationName: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/create-variation`\n\nCreate a new A/B test variation based on the information provided in the request body.\n\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.abTest.createSitePageVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.abTest.createSitePageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.abTest.createSitePageVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.ab_test.create_site_page_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.ab_test.create_site_page_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().abTest().createSitePageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().abTest().createSitePageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.AbTest.NewSitePageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.AbTest.NewSitePageVariation(context.TODO(), cms.PageSitePageAbTestNewSitePageVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.ab_test.create_site_page_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.ab_test.create_site_page_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->abTest->createSitePageVariation', + example: + "cms->pages->sitePages->abTest->createSitePageVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/create-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', + }, + }, + }, + { + name: 'end_site_page_test', + endpoint: '/cms/pages/2026-03/site-pages/ab-test/end', + httpMethod: 'post', + summary: 'End an active A/B test', + description: 'End an active A/B test and designate a winner.', + stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) end_site_page_test', + qualified: 'client.cms.pages.sitePages.abTest.endSitePageTest', + params: ['abTestId: string;', 'winnerId: string;'], + markdown: + "## end_site_page_test\n\n`client.cms.pages.sitePages.abTest.endSitePageTest(abTestId: string, winnerId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/end`\n\nEnd an active A/B test and designate a winner.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to end.\n\n- `winnerId: string`\n ID of the object to designate as the test winner.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.abTest.endSitePageTest({ abTestId: 'abTestId', winnerId: 'winnerId' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.abTest.endSitePageTest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.abTest.endSitePageTest({\n abTestId: 'abTestId',\n winnerId: 'winnerId',\n});", + }, + python: { + method: 'cms.pages.site_pages.ab_test.end_site_page_test', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.ab_test.end_site_page_test(\n ab_test_id="abTestId",\n winner_id="winnerId",\n)', + }, + java: { + method: 'cms().pages().sitePages().abTest().endSitePageTest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestEndRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestEndRequestVNext params = AbTestEndRequestVNext.builder()\n .abTestId("abTestId")\n .winnerId("winnerId")\n .build();\n client.cms().pages().sitePages().abTest().endSitePageTest(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.AbTest.EndSitePageTest', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.AbTest.EndSitePageTest(context.TODO(), cms.PageSitePageAbTestEndSitePageTestParams{\n\t\tAbTestEndRequestVNext: cms.AbTestEndRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tWinnerID: "winnerId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.ab_test.end_site_page_test', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.ab_test.end_site_page_test(ab_test_id: "abTestId", winner_id: "winnerId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->abTest->endSitePageTest', + example: + "cms->pages->sitePages->abTest->endSitePageTest(\n abTestID: 'abTestId', winnerID: 'winnerId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/end \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "winnerId": "winnerId"\n }\'', + }, + }, + }, + { + name: 'rerun_site_page_test', + endpoint: '/cms/pages/2026-03/site-pages/ab-test/rerun', + httpMethod: 'post', + summary: 'Rerun a previous A/B test', + description: 'Rerun a previous A/B test.', + stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) rerun_site_page_test', + qualified: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', + params: ['abTestId: string;', 'variationId: string;'], + markdown: + "## rerun_site_page_test\n\n`client.cms.pages.sitePages.abTest.rerunSitePageTest(abTestId: string, variationId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/rerun`\n\nRerun a previous A/B test.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to rerun.\n\n- `variationId: string`\n ID of the object to reactivate as a test variation.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.abTest.rerunSitePageTest({ abTestId: 'abTestId', variationId: 'variationId' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.abTest.rerunSitePageTest({\n abTestId: 'abTestId',\n variationId: 'variationId',\n});", + }, + python: { + method: 'cms.pages.site_pages.ab_test.rerun_site_page_test', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.ab_test.rerun_site_page_test(\n ab_test_id="abTestId",\n variation_id="variationId",\n)', + }, + java: { + method: 'cms().pages().sitePages().abTest().rerunSitePageTest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestRerunRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestRerunRequestVNext params = AbTestRerunRequestVNext.builder()\n .abTestId("abTestId")\n .variationId("variationId")\n .build();\n client.cms().pages().sitePages().abTest().rerunSitePageTest(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.AbTest.RerunSitePageTest', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.AbTest.RerunSitePageTest(context.TODO(), cms.PageSitePageAbTestRerunSitePageTestParams{\n\t\tAbTestRerunRequestVNext: cms.AbTestRerunRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tVariationID: "variationId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.ab_test.rerun_site_page_test', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.ab_test.rerun_site_page_test(\n ab_test_id: "abTestId",\n variation_id: "variationId"\n)\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->abTest->rerunSitePageTest', + example: + "cms->pages->sitePages->abTest->rerunSitePageTest(\n abTestID: 'abTestId', variationID: 'variationId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/rerun \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "variationId": "variationId"\n }\'', + }, + }, + }, + { + name: 'create_site_pages', + endpoint: '/cms/pages/2026-03/site-pages/batch/create', + httpMethod: 'post', + summary: 'Create website pages', + description: 'Create a batch of website pages as specified in the request body.', + stainlessPath: '(resource) cms.pages.site-pages.batch > (method) create_site_pages', + qualified: 'client.cms.pages.sitePages.batch.createSitePages', + params: [ + 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', + ], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create_site_pages\n\n`client.cms.pages.sitePages.batch.createSitePages(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/create`\n\nCreate a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Pages to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.createSitePages({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.batch.createSitePages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.createSitePages({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.site_pages.batch.create_site_pages', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.create_site_pages(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "page_redirected": True,\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "template_path": "templatePath",\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().sitePages().batch().createSitePages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.BatchInputPage;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPage params = BatchInputPage.builder()\n .addInput(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().createSitePages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Batch.NewSitePages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.NewSitePages(context.TODO(), cms.PageSitePageBatchNewSitePagesParams{\n\t\tBatchInputPage: cms.BatchInputPageParam{\n\t\t\tInputs: []cms.PagesPageParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.batch.create_site_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.create_site_pages(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: "2019-12-27T18:11:19.117Z",\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n pageRedirected: true,\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n templatePath: "templatePath",\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->sitePages->batch->createSitePages', + example: + "cms->pages->sitePages->batch->createSitePages(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'pageRedirected' => true,\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'slug' => 'slug',\n 'state' => 'state',\n 'subcategory' => 'subcategory',\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_site_pages', + endpoint: '/cms/pages/2026-03/site-pages/batch/archive', + httpMethod: 'post', + summary: 'Delete website pages', + description: + 'Delete a batch of website pages as specified in the request body. Note that this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', + stainlessPath: '(resource) cms.pages.site-pages.batch > (method) delete_site_pages', + qualified: 'client.cms.pages.sitePages.batch.deleteSitePages', + params: ['inputs: string[];'], + markdown: + "## delete_site_pages\n\n`client.cms.pages.sitePages.batch.deleteSitePages(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/site-pages/batch/archive`\n\nDelete a batch of website pages as specified in the request body. Note that this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.batch.deleteSitePages({ inputs: ['string'] })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.batch.deleteSitePages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.batch.deleteSitePages({ inputs: ['string'] });", + }, + python: { + method: 'cms.pages.site_pages.batch.delete_site_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.batch.delete_site_pages(\n inputs=["string"],\n)', + }, + java: { + method: 'cms().pages().sitePages().batch().deleteSitePages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().sitePages().batch().deleteSitePages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Batch.DeleteSitePages', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Batch.DeleteSitePages(context.TODO(), cms.PageSitePageBatchDeleteSitePagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.batch.delete_site_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.batch.delete_site_pages(inputs: ["string"])\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->batch->deleteSitePages', + example: + "cms->pages->sitePages->batch->deleteSitePages(\n inputs: ['string']\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_site_pages', + endpoint: '/cms/pages/2026-03/site-pages/batch/read', + httpMethod: 'post', + summary: 'Retrieve website pages', + description: 'Retrieve a batch of website pages as specified in the request body.', + stainlessPath: '(resource) cms.pages.site-pages.batch > (method) get_site_pages', + qualified: 'client.cms.pages.sitePages.batch.getSitePages', + params: ['inputs: string[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_site_pages\n\n`client.cms.pages.sitePages.batch.getSitePages(inputs: string[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/read`\n\nRetrieve a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.getSitePages({ inputs: ['string'] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.batch.getSitePages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.getSitePages({\n inputs: ['string'],\n});\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.site_pages.batch.get_site_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.get_site_pages(\n inputs=["string"],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().sitePages().batch().getSitePages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().getSitePages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Batch.GetSitePages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.GetSitePages(context.TODO(), cms.PageSitePageBatchGetSitePagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.batch.get_site_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.get_site_pages(inputs: ["string"])\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->sitePages->batch->getSitePages', + example: + "cms->pages->sitePages->batch->getSitePages(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update_site_pages', + endpoint: '/cms/pages/2026-03/site-pages/batch/update', + httpMethod: 'post', + summary: 'Update website pages', + description: 'Update a batch of website pages as specified in the request body.', + stainlessPath: '(resource) cms.pages.site-pages.batch > (method) update_site_pages', + qualified: 'client.cms.pages.sitePages.batch.updateSitePages', + params: ['inputs: object[];', 'archived?: boolean;'], + response: + "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update_site_pages\n\n`client.cms.pages.sitePages.batch.updateSitePages(inputs: object[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/update`\n\nUpdate a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.updateSitePages({ inputs: [{}] });\n\nconsole.log(batchResponsePage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.batch.updateSitePages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.updateSitePages({ inputs: [{}] });\n\nconsole.log(batchResponsePage.completedAt);", + }, + python: { + method: 'cms.pages.site_pages.batch.update_site_pages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.update_site_pages(\n inputs=[{}],\n)\nprint(batch_response_page.completed_at)', + }, + java: { + method: 'cms().pages().sitePages().batch().updateSitePages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().updateSitePages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Batch.UpdateSitePages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.UpdateSitePages(context.TODO(), cms.PageSitePageBatchUpdateSitePagesParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.batch.update_site_pages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.update_site_pages(inputs: [{}])\n\nputs(batch_response_page)', + }, + php: { + method: 'cms->pages->sitePages->batch->updateSitePages', + example: + "cms->pages->sitePages->batch->updateSitePages(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batchResponsePage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', + }, + }, + }, + { + name: 'get_draft', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft', + httpMethod: 'get', + summary: 'Retrieve a website page draft', + description: 'Retrieve the full draft version of a website page, specified by its ID.', + stainlessPath: '(resource) cms.pages.site-pages.draft > (method) get_draft', + qualified: 'client.cms.pages.sitePages.draft.getDraft', + params: ['objectId: string;'], + response: 'object', + markdown: + "## get_draft\n\n`client.cms.pages.sitePages.draft.getDraft(objectId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/draft`\n\nRetrieve the full draft version of a website page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.draft.getDraft('objectId');\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.draft.getDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.draft.getDraft('objectId');\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.draft.get_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.draft.get_draft(\n "objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().draft().getDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().sitePages().draft().getDraft("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Draft.GetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Draft.GetDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.draft.get_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.draft.get_draft("objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->draft->getDraft', + example: + "cms->pages->sitePages->draft->getDraft('objectId');\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'publish_draft', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft/push-live', + httpMethod: 'post', + summary: 'Publish website page draft', + description: + 'Take any changes from the draft version of the website page and apply them to the live version.', + stainlessPath: '(resource) cms.pages.site-pages.draft > (method) publish_draft', + qualified: 'client.cms.pages.sitePages.draft.publishDraft', + params: ['objectId: string;'], + markdown: + "## publish_draft\n\n`client.cms.pages.sitePages.draft.publishDraft(objectId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/draft/push-live`\n\nTake any changes from the draft version of the website page and apply them to the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.draft.publishDraft('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.draft.publishDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.draft.publishDraft('objectId');", + }, + python: { + method: 'cms.pages.site_pages.draft.publish_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.draft.publish_draft(\n "objectId",\n)', + }, + java: { + method: 'cms().pages().sitePages().draft().publishDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftPublishDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().draft().publishDraft("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Draft.PublishDraft', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Draft.PublishDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.draft.publish_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.draft.publish_draft("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->draft->publishDraft', + example: + "cms->pages->sitePages->draft->publishDraft('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset_site_page_draft', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft/reset', + httpMethod: 'post', + summary: 'Reset the draft of a website page', + description: 'Discards any edits and resets the draft to match the live version.', + stainlessPath: '(resource) cms.pages.site-pages.draft > (method) reset_site_page_draft', + qualified: 'client.cms.pages.sitePages.draft.resetSitePageDraft', + params: ['objectId: string;'], + markdown: + "## reset_site_page_draft\n\n`client.cms.pages.sitePages.draft.resetSitePageDraft(objectId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/draft/reset`\n\nDiscards any edits and resets the draft to match the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.draft.resetSitePageDraft('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.draft.resetSitePageDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.draft.resetSitePageDraft('objectId');", + }, + python: { + method: 'cms.pages.site_pages.draft.reset_site_page_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.draft.reset_site_page_draft(\n "objectId",\n)', + }, + java: { + method: 'cms().pages().sitePages().draft().resetSitePageDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftResetSitePageDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().draft().resetSitePageDraft("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Draft.ResetSitePageDraft', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Draft.ResetSitePageDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.draft.reset_site_page_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.draft.reset_site_page_draft("objectId")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->draft->resetSitePageDraft', + example: + "cms->pages->sitePages->draft->resetSitePageDraft('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_draft', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft', + httpMethod: 'patch', + summary: 'Update a website page draft', + description: + "Partially update the draft version of a website page, specified by page ID. You only need to specify the values for the details that you're modifying.", + stainlessPath: '(resource) cms.pages.site-pages.draft > (method) update_draft', + qualified: 'client.cms.pages.sitePages.draft.updateDraft', + params: [ + 'objectId: string;', + 'id: string;', + 'abStatus: string;', + 'abTestId: string;', + 'archivedAt: string;', + 'archivedInDashboard: boolean;', + 'attachedStylesheets: object[];', + 'authorName: string;', + 'campaign: string;', + 'categoryId: number;', + 'contentGroupId: string;', + 'contentTypeCategory: string;', + 'created: string;', + 'createdById: string;', + 'currentlyPublished: boolean;', + 'currentState: string;', + 'domain: string;', + 'dynamicPageDataSourceId: string;', + 'dynamicPageDataSourceType: number;', + 'dynamicPageHubDbTableId: string;', + 'enableDomainStylesheets: boolean;', + 'enableLayoutStylesheets: boolean;', + 'featuredImage: string;', + 'featuredImageAltText: string;', + 'folderId: string;', + 'footerHtml: string;', + 'headHtml: string;', + 'htmlTitle: string;', + 'includeDefaultCustomCss: boolean;', + 'language: string;', + 'layoutSections: object;', + 'linkRelCanonicalUrl: string;', + 'mabExperimentId: string;', + 'metaDescription: string;', + 'name: string;', + 'pageExpiryDate: number;', + 'pageExpiryEnabled: boolean;', + 'pageExpiryRedirectId: number;', + 'pageExpiryRedirectUrl: string;', + 'pageRedirected: boolean;', + 'password: string;', + 'publicAccessRules: object[];', + 'publicAccessRulesEnabled: boolean;', + 'publishDate: string;', + 'publishImmediately: boolean;', + 'slug: string;', + 'state: string;', + 'subcategory: string;', + 'templatePath: string;', + 'themeSettingsValues: object;', + 'translatedFromId: string;', + 'translations: object;', + 'updated: string;', + 'updatedById: string;', + 'url: string;', + 'useFeaturedImage: boolean;', + 'widgetContainers: object;', + 'widgets: object;', + ], + response: 'object', + markdown: + "## update_draft\n\n`client.cms.pages.sitePages.draft.updateDraft(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/site-pages/{objectId}/draft`\n\nPartially update the draft version of a website page, specified by page ID. You only need to specify the values for the details that you're modifying.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.draft.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.draft.updateDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.draft.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.draft.update_draft', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.draft.update_draft(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().draft().updateDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftUpdateDraftParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DraftUpdateDraftParams params = DraftUpdateDraftParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().draft().updateDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Draft.UpdateDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Draft.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageDraftUpdateDraftParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.draft.update_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.draft.update_draft(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->draft->updateDraft', + example: + "cms->pages->sitePages->draft->updateDraft(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', + }, + }, + }, + { + name: 'attach_to_lang_group', + endpoint: '/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group', + httpMethod: 'post', + summary: 'Add a website page to a multi-language group', + description: 'Attach a site page to a multi-language group.', + stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) attach_to_lang_group', + qualified: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', + params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], + response: 'string', + markdown: + "## attach_to_lang_group\n\n`client.cms.pages.sitePages.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group`\n\nAttach a site page to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.site_pages.multi_language.attach_to_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().sitePages().multiLanguage().attachToLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().attachToLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.MultiLanguage.AttachToLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.AttachToLangGroup(context.TODO(), cms.PageSitePageMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.multi_language.attach_to_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->pages->sitePages->multiLanguage->attachToLangGroup', + example: + "cms->pages->sitePages->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'create_language_variation', + endpoint: '/cms/pages/2026-03/site-pages/multi-language/create-language-variation', + httpMethod: 'post', + summary: 'Create a new language variation', + description: + 'Create a new language variation from an existing website page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source website page](/api-reference/latest/cms/pages/website-pages/drafts/get-website-page-draft).', + stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) create_language_variation', + qualified: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', + params: ['id: string;', 'language?: string;', 'primaryLanguage?: string;', 'usePublished?: boolean;'], + response: 'object', + markdown: + "## create_language_variation\n\n`client.cms.pages.sitePages.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, usePublished?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/create-language-variation`\n\nCreate a new language variation from an existing website page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source website page](/api-reference/latest/cms/pages/website-pages/drafts/get-website-page-draft).\n\n### Parameters\n\n- `id: string`\n ID of content to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary content to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.multiLanguage.createLanguageVariation({\n id: 'id',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.multi_language.create_language_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.multi_language.create_language_variation(\n id="id",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().multiLanguage().createLanguageVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentLanguageCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentLanguageCloneRequestVNext params = ContentLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().multiLanguage().createLanguageVariation(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.MultiLanguage.NewLanguageVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.MultiLanguage.NewLanguageVariation(context.TODO(), cms.PageSitePageMultiLanguageNewLanguageVariationParams{\n\t\tContentLanguageCloneRequestVNext: cms.ContentLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.multi_language.create_language_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.multi_language.create_language_variation(id: "id")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->multiLanguage->createLanguageVariation', + example: + "cms\n ->pages\n ->sitePages\n ->multiLanguage\n ->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'detach_from_lang_group', + endpoint: '/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group', + httpMethod: 'post', + summary: 'Remove a website page from a multi-language group', + description: 'Detach a website page from a multi-language group.', + stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) detach_from_lang_group', + qualified: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', + params: ['id: string;'], + response: 'string', + markdown: + "## detach_from_lang_group\n\n`client.cms.pages.sitePages.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group`\n\nDetach a website page from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.site_pages.multi_language.detach_from_lang_group', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().sitePages().multiLanguage().detachFromLangGroup', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().detachFromLangGroup(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.MultiLanguage.DetachFromLangGroup', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.PageSitePageMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.multi_language.detach_from_lang_group', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', + }, + php: { + method: 'cms->pages->sitePages->multiLanguage->detachFromLangGroup', + example: + "cms->pages->sitePages->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'set_new_lang_primary', + endpoint: '/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary', + httpMethod: 'put', + summary: 'Set a new primary language', + description: 'Set a site page as the primary language of a multi-language group.', + stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) set_new_lang_primary', + qualified: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', + params: ['id: string;'], + markdown: + "## set_new_lang_primary\n\n`client.cms.pages.sitePages.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary`\n\nSet a site page as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.multiLanguage.setNewLangPrimary({ id: 'id' });", + }, + python: { + method: 'cms.pages.site_pages.multi_language.set_new_lang_primary', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.multi_language.set_new_lang_primary(\n id="id",\n)', + }, + java: { + method: 'cms().pages().sitePages().multiLanguage().setNewLangPrimary', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().pages().sitePages().multiLanguage().setNewLangPrimary(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.MultiLanguage.SetNewLangPrimary', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.PageSitePageMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.multi_language.set_new_lang_primary', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', + }, + php: { + method: 'cms->pages->sitePages->multiLanguage->setNewLangPrimary', + example: + "cms->pages->sitePages->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update_languages', + endpoint: '/cms/pages/2026-03/site-pages/multi-language/update-languages', + httpMethod: 'post', + summary: 'Update languages of multi-language group', + description: 'Explicitly set new languages for each site page in a multi-language group.', + stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) update_languages', + qualified: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', + params: ['languages: object;', 'primaryId: string;'], + response: 'string', + markdown: + "## update_languages\n\n`client.cms.pages.sitePages.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/update-languages`\n\nExplicitly set new languages for each site page in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.pages.site_pages.multi_language.update_languages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'cms().pages().sitePages().multiLanguage().updateLanguages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().updateLanguages(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.MultiLanguage.UpdateLanguages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.UpdateLanguages(context.TODO(), cms.PageSitePageMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.multi_language.update_languages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.update_languages(\n languages: {foo: :aa},\n primary_id: "primaryId"\n)\n\nputs(response)', + }, + php: { + method: 'cms->pages->sitePages->multiLanguage->updateLanguages', + example: + "cms->pages->sitePages->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', + }, + }, + }, + { + name: 'get_site_page_revision', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Retrieve a previous version of a website page', + description: 'Retrieve a previous version of a website page by the revision ID.', + stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) get_site_page_revision', + qualified: 'client.cms.pages.sitePages.revisions.getSitePageRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## get_site_page_revision\n\n`client.cms.pages.sitePages.revisions.getSitePageRevision(objectId: string, revisionId: string): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a website page by the revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pageVersion = await client.cms.pages.sitePages.revisions.getSitePageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pageVersion);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.revisions.getSitePageRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pageVersion = await client.cms.pages.sitePages.revisions.getSitePageRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(pageVersion.id);", + }, + python: { + method: 'cms.pages.site_pages.revisions.get_site_page_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage_version = client.cms.pages.site_pages.revisions.get_site_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(page_version.id)', + }, + java: { + method: 'cms().pages().sitePages().revisions().getSitePageRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PageVersion;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionGetSitePageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetSitePageRevisionParams params = RevisionGetSitePageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PageVersion pageVersion = client.cms().pages().sitePages().revisions().getSitePageRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Revisions.GetSitePageRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpageVersion, err := client.Cms.Pages.SitePages.Revisions.GetSitePageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageSitePageRevisionGetSitePageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pageVersion.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.revisions.get_site_page_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage_version = hubspot.cms.pages.site_pages.revisions.get_site_page_revision("revisionId", object_id_: "objectId")\n\nputs(page_version)', + }, + php: { + method: 'cms->pages->sitePages->revisions->getSitePageRevision', + example: + "cms->pages->sitePages->revisions->getSitePageRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($pageVersion);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_site_page_revisions', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions', + httpMethod: 'get', + summary: 'Retrieve all previous versions of a website page', + description: 'Retrieves all the previous versions of a website page, specified by page ID.', + stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) list_site_page_revisions', + qualified: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', + params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## list_site_page_revisions\n\n`client.cms.pages.sitePages.revisions.listSitePageRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/revisions`\n\nRetrieves all the previous versions of a website page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.sitePages.revisions.listSitePageRevisions('objectId')) {\n console.log(pageVersion);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.sitePages.revisions.listSitePageRevisions(\n 'objectId',\n)) {\n console.log(pageVersion.id);\n}", + }, + python: { + method: 'cms.pages.site_pages.revisions.list_site_page_revisions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.site_pages.revisions.list_site_page_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().pages().sitePages().revisions().listSitePageRevisions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionListSitePageRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionListSitePageRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListSitePageRevisionsPage page = client.cms().pages().sitePages().revisions().listSitePageRevisions("objectId");\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Revisions.ListSitePageRevisions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.SitePages.Revisions.ListSitePageRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageRevisionListSitePageRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.revisions.list_site_page_revisions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.site_pages.revisions.list_site_page_revisions("objectId")\n\nputs(page)', + }, + php: { + method: 'cms->pages->sitePages->revisions->listSitePageRevisions', + example: + "cms->pages->sitePages->revisions->listSitePageRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_site_page_revision', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore', + httpMethod: 'post', + summary: 'Restore a previous version of a website page', + description: 'Restores a website page to a previous version, specified by page ID and version ID.', + stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) restore_site_page_revision', + qualified: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', + params: ['objectId: string;', 'revisionId: string;'], + response: 'object', + markdown: + "## restore_site_page_revision\n\n`client.cms.pages.sitePages.revisions.restoreSitePageRevision(objectId: string, revisionId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore`\n\nRestores a website page to a previous version, specified by page ID and version ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.revisions.restore_site_page_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.revisions.restore_site_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().revisions().restoreSitePageRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionRestoreSitePageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreSitePageRevisionParams params = RevisionRestoreSitePageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().revisions().restoreSitePageRevision(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageSitePageRevisionRestoreSitePageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.revisions.restore_site_page_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.revisions.restore_site_page_revision("revisionId", object_id_: "objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->revisions->restoreSitePageRevision', + example: + "cms->pages->sitePages->revisions->restoreSitePageRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_site_page_revision_to_draft', + endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft', + httpMethod: 'post', + summary: 'Restore a previous draft of a website page', + description: + 'Takes a specified version of a website page and sets it as the new draft version of the page.', + stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) restore_site_page_revision_to_draft', + qualified: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', + params: ['objectId: string;', 'revisionId: number;'], + response: 'object', + markdown: + "## restore_site_page_revision_to_draft\n\n`client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(objectId: string, revisionId: number): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nTakes a specified version of a website page and sets it as the new draft version of the page.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", + perLanguage: { + typescript: { + method: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(0, {\n objectId: 'objectId',\n});\n\nconsole.log(pagesPage.id);", + }, + python: { + method: 'cms.pages.site_pages.revisions.restore_site_page_revision_to_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.revisions.restore_site_page_revision_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(pages_page.id)', + }, + java: { + method: 'cms().pages().sitePages().revisions().restoreSitePageRevisionToDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionRestoreSitePageRevisionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreSitePageRevisionToDraftParams params = RevisionRestoreSitePageRevisionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().revisions().restoreSitePageRevisionToDraft(params);\n }\n}', + }, + go: { + method: 'client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevisionToDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.PageSitePageRevisionRestoreSitePageRevisionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', + }, + ruby: { + method: 'cms.pages.site_pages.revisions.restore_site_page_revision_to_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.revisions.restore_site_page_revision_to_draft(0, object_id_: "objectId")\n\nputs(pages_page)', + }, + php: { + method: 'cms->pages->sitePages->revisions->restoreSitePageRevisionToDraft', + example: + "cms\n ->pages\n ->sitePages\n ->revisions\n ->restoreSitePageRevisionToDraft(0, objectID: 'objectId');\n\nvar_dump($pagesPage);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_indexed_data', + endpoint: '/cms/site-search/2026-03/indexed-data/{contentId}', + httpMethod: 'get', + summary: 'Get indexed properties', + description: + 'Return all indexed data for an asset (e.g., page, blog post, HubDB table), specified by ID. This is useful when debugging why a particular asset is not returned from a custom search.', + stainlessPath: '(resource) cms.site_search > (method) get_indexed_data', + qualified: 'client.cms.siteSearch.getIndexedData', + params: ['contentId: string;', 'type?: string;'], + response: '{ id: string; fields: object; type: string; }', + markdown: + "## get_indexed_data\n\n`client.cms.siteSearch.getIndexedData(contentId: string, type?: string): { id: string; fields: object; type: string; }`\n\n**get** `/cms/site-search/2026-03/indexed-data/{contentId}`\n\nReturn all indexed data for an asset (e.g., page, blog post, HubDB table), specified by ID. This is useful when debugging why a particular asset is not returned from a custom search.\n\n### Parameters\n\n- `contentId: string`\n\n- `type?: string`\n\n### Returns\n\n- `{ id: string; fields: object; type: string; }`\n\n - `id: string`\n - `fields: object`\n - `type: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst indexedData = await client.cms.siteSearch.getIndexedData('contentId');\n\nconsole.log(indexedData);\n```", + perLanguage: { + typescript: { + method: 'client.cms.siteSearch.getIndexedData', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst indexedData = await client.cms.siteSearch.getIndexedData('contentId');\n\nconsole.log(indexedData.id);", + }, + python: { + method: 'cms.site_search.get_indexed_data', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nindexed_data = client.cms.site_search.get_indexed_data(\n content_id="contentId",\n)\nprint(indexed_data.id)', + }, + java: { + method: 'cms().siteSearch().getIndexedData', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.sitesearch.IndexedData;\nimport com.hubspot.sdk.models.cms.sitesearch.SiteSearchGetIndexedDataParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndexedData indexedData = client.cms().siteSearch().getIndexedData("contentId");\n }\n}', + }, + go: { + method: 'client.Cms.SiteSearch.GetIndexedData', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindexedData, err := client.Cms.SiteSearch.GetIndexedData(\n\t\tcontext.TODO(),\n\t\t"contentId",\n\t\tcms.SiteSearchGetIndexedDataParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", indexedData.ID)\n}\n', + }, + ruby: { + method: 'cms.site_search.get_indexed_data', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nindexed_data = hubspot.cms.site_search.get_indexed_data("contentId")\n\nputs(indexed_data)', + }, + php: { + method: 'cms->siteSearch->getIndexedData', + example: + "cms->siteSearch->getIndexedData(\n 'contentId', type: 'type'\n);\n\nvar_dump($indexedData);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/site-search/2026-03/indexed-data/$CONTENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'extract_async', + endpoint: '/cms/source-code/2026-03/extract/async', + httpMethod: 'post', + summary: 'Extract a zip file', + description: + 'Extract a zip file in the developer file system. Extraction status can be checked with the `/extract/async/tasks/taskId/status` endpoint below.', + stainlessPath: '(resource) cms.source_code > (method) extract_async', + qualified: 'client.cms.sourceCode.extractAsync', + params: ['path: string;'], + response: '{ id: string; links?: object; }', + markdown: + "## extract_async\n\n`client.cms.sourceCode.extractAsync(path: string): { id: string; links?: object; }`\n\n**post** `/cms/source-code/2026-03/extract/async`\n\nExtract a zip file in the developer file system. Extraction status can be checked with the `/extract/async/tasks/taskId/status` endpoint below.\n\n### Parameters\n\n- `path: string`\n The file system location where the zip file is to be extracted.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst taskLocator = await client.cms.sourceCode.extractAsync({ path: 'path' });\n\nconsole.log(taskLocator);\n```", + perLanguage: { + typescript: { + method: 'client.cms.sourceCode.extractAsync', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst taskLocator = await client.cms.sourceCode.extractAsync({ path: 'path' });\n\nconsole.log(taskLocator.id);", + }, + python: { + method: 'cms.source_code.extract_async', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntask_locator = client.cms.source_code.extract_async(\n path="path",\n)\nprint(task_locator.id)', + }, + java: { + method: 'cms().sourceCode().extractAsync', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.TaskLocator;\nimport com.hubspot.sdk.models.cms.sourcecode.FileExtractRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileExtractRequest params = FileExtractRequest.builder()\n .path("path")\n .build();\n TaskLocator taskLocator = client.cms().sourceCode().extractAsync(params);\n }\n}', + }, + go: { + method: 'client.Cms.SourceCode.ExtractAsync', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttaskLocator, err := client.Cms.SourceCode.ExtractAsync(context.TODO(), cms.SourceCodeExtractAsyncParams{\n\t\tFileExtractRequest: cms.FileExtractRequestParam{\n\t\t\tPath: "path",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", taskLocator.ID)\n}\n', + }, + ruby: { + method: 'cms.source_code.extract_async', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntask_locator = hubspot.cms.source_code.extract_async(path: "path")\n\nputs(task_locator)', + }, + php: { + method: 'cms->sourceCode->extractAsync', + example: + "cms->sourceCode->extractAsync(path: 'path');\n\nvar_dump($taskLocator);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/source-code/2026-03/extract/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "path": "path"\n }\'', + }, + }, + }, + { + name: 'get_extraction_status', + endpoint: '/cms/source-code/2026-03/extract/async/tasks/{taskId}/status', + httpMethod: 'get', + summary: 'Get extraction status', + description: + 'Get the status of an extraction by the `taskId` returned from the initial `extract/async` request.', + stainlessPath: '(resource) cms.source_code > (method) get_extraction_status', + qualified: 'client.cms.sourceCode.getExtractionStatus', + params: ['taskId: number;'], + response: + "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_extraction_status\n\n`client.cms.sourceCode.getExtractionStatus(taskId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/cms/source-code/2026-03/extract/async/tasks/{taskId}/status`\n\nGet the status of an extraction by the `taskId` returned from the initial `extract/async` request.\n\n### Parameters\n\n- `taskId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponse = await client.cms.sourceCode.getExtractionStatus(0);\n\nconsole.log(actionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.cms.sourceCode.getExtractionStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponse = await client.cms.sourceCode.getExtractionStatus(0);\n\nconsole.log(actionResponse.completedAt);", + }, + python: { + method: 'cms.source_code.get_extraction_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response = client.cms.source_code.get_extraction_status(\n 0,\n)\nprint(action_response.completed_at)', + }, + java: { + method: 'cms().sourceCode().getExtractionStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ActionResponse;\nimport com.hubspot.sdk.models.cms.sourcecode.SourceCodeGetExtractionStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponse actionResponse = client.cms().sourceCode().getExtractionStatus(0);\n }\n}', + }, + go: { + method: 'client.Cms.SourceCode.GetExtractionStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponse, err := client.Cms.SourceCode.GetExtractionStatus(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'cms.source_code.get_extraction_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response = hubspot.cms.source_code.get_extraction_status(0)\n\nputs(action_response)', + }, + php: { + method: 'cms->sourceCode->getExtractionStatus', + example: + "cms->sourceCode->getExtractionStatus(0);\n\nvar_dump($actionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/source-code/2026-03/extract/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/url-mappings/2026-03/url-mappings', + httpMethod: 'post', + summary: 'Create URL mapping', + description: + 'Create a new URL mapping in your HubSpot account. This endpoint allows you to define URL redirections and mappings, which can be useful for managing site navigation and SEO. The request body must include all required properties of the UrlMapping schema.', + stainlessPath: '(resource) cms.url_mappings > (method) create', + qualified: 'client.cms.urlMappings.create', + params: [ + 'id: number;', + 'cdnPurgeEmbargoTime: number;', + 'contentGroupId: number;', + 'cosObjectType: string;', + 'created: number;', + 'createdById: number;', + 'deletedAt: number;', + 'destination: string;', + 'internallyCreated: boolean;', + 'isActive: boolean;', + 'isMatchFullUrl: boolean;', + 'isMatchQueryString: boolean;', + 'isOnlyAfterNotFound: boolean;', + 'isPattern: boolean;', + 'isProtocolAgnostic: boolean;', + 'isRegex: boolean;', + 'isTrailingSlashOptional: boolean;', + 'label: string;', + 'lastUsedAt: number;', + 'name: string;', + 'note: string;', + 'portalId: number;', + 'precedence: number;', + 'redirectStyle: number;', + 'routePrefix: string;', + 'updated: number;', + 'updatedById: number;', + ], + response: 'string', + markdown: + "## create\n\n`client.cms.urlMappings.create(id: number, cdnPurgeEmbargoTime: number, contentGroupId: number, cosObjectType: string, created: number, createdById: number, deletedAt: number, destination: string, internallyCreated: boolean, isActive: boolean, isMatchFullUrl: boolean, isMatchQueryString: boolean, isOnlyAfterNotFound: boolean, isPattern: boolean, isProtocolAgnostic: boolean, isRegex: boolean, isTrailingSlashOptional: boolean, label: string, lastUsedAt: number, name: string, note: string, portalId: number, precedence: number, redirectStyle: number, routePrefix: string, updated: number, updatedById: number): string`\n\n**post** `/url-mappings/2026-03/url-mappings`\n\nCreate a new URL mapping in your HubSpot account. This endpoint allows you to define URL redirections and mappings, which can be useful for managing site navigation and SEO. The request body must include all required properties of the UrlMapping schema.\n\n### Parameters\n\n- `id: number`\n The unique identifier for the URL mapping, represented as a 64-bit integer.\n\n- `cdnPurgeEmbargoTime: number`\n A Unix timestamp in milliseconds indicating the embargo time for CDN purge related to the URL mapping.\n\n- `contentGroupId: number`\n A 64-bit integer representing the content group associated with the URL mapping.\n\n- `cosObjectType: string`\n A string representing the type of content object associated with the URL mapping. Valid values include various content types such as 'CONTENT', 'LAYOUT', 'FILE', etc.\n\n- `created: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was created.\n\n- `createdById: number`\n The identifier of the user who created the URL mapping.\n\n- `deletedAt: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was deleted.\n\n- `destination: string`\n The destination URL to which the routePrefix is redirected.\n\n- `internallyCreated: boolean`\n A boolean indicating if the URL mapping was created internally by the system.\n\n- `isActive: boolean`\n A boolean indicating if the URL mapping is currently active.\n\n- `isMatchFullUrl: boolean`\n A boolean indicating if the full URL should be matched.\n\n- `isMatchQueryString: boolean`\n A boolean indicating if the query string should be matched.\n\n- `isOnlyAfterNotFound: boolean`\n A boolean indicating if the mapping should only be applied after a 404 Not Found response.\n\n- `isPattern: boolean`\n A boolean indicating if the routePrefix is a pattern.\n\n- `isProtocolAgnostic: boolean`\n A boolean indicating if the mapping should ignore the URL protocol (http/https).\n\n- `isRegex: boolean`\n A boolean indicating if the routePrefix should be treated as a regular expression.\n\n- `isTrailingSlashOptional: boolean`\n A boolean indicating if the trailing slash in the URL is optional.\n\n- `label: string`\n A label for the URL mapping.\n\n- `lastUsedAt: number`\n\n- `name: string`\n The name of the URL mapping.\n\n- `note: string`\n A string containing notes about the URL mapping.\n\n- `portalId: number`\n The identifier for the HubSpot portal associated with this URL mapping.\n\n- `precedence: number`\n An integer representing the precedence of the URL mapping, used to determine order of evaluation.\n\n- `redirectStyle: number`\n An integer representing the style of redirection used.\n\n- `routePrefix: string`\n The prefix of the URL path that is being mapped.\n\n- `updated: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was last updated.\n\n- `updatedById: number`\n The identifier of the user who last updated the URL mapping.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlMappings.create({\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupId: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdById: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalId: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedById: 0,\n});\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlMappings.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlMappings.create({\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupId: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdById: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalId: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedById: 0,\n});\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.url_mappings.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_mappings.create(\n id=0,\n cdn_purge_embargo_time=0,\n content_group_id=0,\n cos_object_type="ACCESS_GROUP_MEMBERSHIP",\n created=0,\n created_by_id=0,\n deleted_at=0,\n destination="destination",\n internally_created=True,\n is_active=True,\n is_match_full_url=True,\n is_match_query_string=True,\n is_only_after_not_found=True,\n is_pattern=True,\n is_protocol_agnostic=True,\n is_regex=True,\n is_trailing_slash_optional=True,\n label="label",\n last_used_at=0,\n name="name",\n note="note",\n portal_id=0,\n precedence=0,\n redirect_style=0,\n route_prefix="routePrefix",\n updated=0,\n updated_by_id=0,\n)\nprint(url_mapping)\ncontent = url_mapping.read()\nprint(content)', + }, + java: { + method: 'cms().urlMappings().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingsUrlMapping;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMappingsUrlMapping params = UrlMappingsUrlMapping.builder()\n .id(0L)\n .cdnPurgeEmbargoTime(0L)\n .contentGroupId(0L)\n .cosObjectType(UrlMappingsUrlMapping.CosObjectType.ACCESS_GROUP_MEMBERSHIP)\n .created(0L)\n .createdById(0)\n .deletedAt(0L)\n .destination("destination")\n .internallyCreated(true)\n .isActive(true)\n .isMatchFullUrl(true)\n .isMatchQueryString(true)\n .isOnlyAfterNotFound(true)\n .isPattern(true)\n .isProtocolAgnostic(true)\n .isRegex(true)\n .isTrailingSlashOptional(true)\n .label("label")\n .lastUsedAt(0L)\n .name("name")\n .note("note")\n .portalId(0)\n .precedence(0)\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .updated(0L)\n .updatedById(0)\n .build();\n HttpResponse urlMapping = client.cms().urlMappings().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.URLMappings.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLMappings.New(context.TODO(), cms.URLMappingNewParams{\n\t\tURLMappingsURLMapping: cms.URLMappingsURLMappingParam{\n\t\t\tID: 0,\n\t\t\tCdnPurgeEmbargoTime: 0,\n\t\t\tContentGroupID: 0,\n\t\t\tCosObjectType: cms.URLMappingsURLMappingCosObjectTypeAccessGroupMembership,\n\t\t\tCreated: 0,\n\t\t\tCreatedByID: 0,\n\t\t\tDeletedAt: 0,\n\t\t\tDestination: "destination",\n\t\t\tInternallyCreated: true,\n\t\t\tIsActive: true,\n\t\t\tIsMatchFullURL: true,\n\t\t\tIsMatchQueryString: true,\n\t\t\tIsOnlyAfterNotFound: true,\n\t\t\tIsPattern: true,\n\t\t\tIsProtocolAgnostic: true,\n\t\t\tIsRegex: true,\n\t\t\tIsTrailingSlashOptional: true,\n\t\t\tLabel: "label",\n\t\t\tLastUsedAt: 0,\n\t\t\tName: "name",\n\t\t\tNote: "note",\n\t\t\tPortalID: 0,\n\t\t\tPrecedence: 0,\n\t\t\tRedirectStyle: 0,\n\t\t\tRoutePrefix: "routePrefix",\n\t\t\tUpdated: 0,\n\t\t\tUpdatedByID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping)\n}\n', + }, + ruby: { + method: 'cms.url_mappings.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_mappings.create(\n id: 0,\n cdn_purge_embargo_time: 0,\n content_group_id: 0,\n cos_object_type: :ACCESS_GROUP_MEMBERSHIP,\n created: 0,\n created_by_id: 0,\n deleted_at: 0,\n destination: "destination",\n internally_created: true,\n is_active: true,\n is_match_full_url: true,\n is_match_query_string: true,\n is_only_after_not_found: true,\n is_pattern: true,\n is_protocol_agnostic: true,\n is_regex: true,\n is_trailing_slash_optional: true,\n label: "label",\n last_used_at: 0,\n name: "name",\n note: "note",\n portal_id: 0,\n precedence: 0,\n redirect_style: 0,\n route_prefix: "routePrefix",\n updated: 0,\n updated_by_id: 0\n)\n\nputs(url_mapping)', + }, + php: { + method: 'cms->urlMappings->create', + example: + "cms->urlMappings->create(\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupID: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdByID: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalID: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedByID: 0,\n);\n\nvar_dump($urlMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": 0,\n "cdnPurgeEmbargoTime": 0,\n "contentGroupId": 0,\n "cosObjectType": "ACCESS_GROUP_MEMBERSHIP",\n "created": 0,\n "createdById": 0,\n "deletedAt": 0,\n "destination": "destination",\n "internallyCreated": true,\n "isActive": true,\n "isMatchFullUrl": true,\n "isMatchQueryString": true,\n "isOnlyAfterNotFound": true,\n "isPattern": true,\n "isProtocolAgnostic": true,\n "isRegex": true,\n "isTrailingSlashOptional": true,\n "label": "label",\n "lastUsedAt": 0,\n "name": "name",\n "note": "note",\n "portalId": 0,\n "precedence": 0,\n "redirectStyle": 0,\n "routePrefix": "routePrefix",\n "updated": 0,\n "updatedById": 0\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/url-mappings/2026-03/url-mappings/{id}', + httpMethod: 'delete', + summary: 'Delete URL mapping', + description: + 'Delete a specific URL mapping in your HubSpot account using its unique identifier. This operation will remove the URL mapping permanently, and it requires appropriate write and delete permissions.', + stainlessPath: '(resource) cms.url_mappings > (method) delete', + qualified: 'client.cms.urlMappings.delete', + params: ['id: number;'], + markdown: + "## delete\n\n`client.cms.urlMappings.delete(id: number): void`\n\n**delete** `/url-mappings/2026-03/url-mappings/{id}`\n\nDelete a specific URL mapping in your HubSpot account using its unique identifier. This operation will remove the URL mapping permanently, and it requires appropriate write and delete permissions.\n\n### Parameters\n\n- `id: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.urlMappings.delete(0)\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlMappings.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.urlMappings.delete(0);", + }, + python: { + method: 'cms.url_mappings.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.url_mappings.delete(\n 0,\n)', + }, + java: { + method: 'cms().urlMappings().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().urlMappings().delete(0L);\n }\n}', + }, + go: { + method: 'client.Cms.URLMappings.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.URLMappings.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.url_mappings.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.url_mappings.delete(0)\n\nputs(result)', + }, + php: { + method: 'cms->urlMappings->delete', + example: + "cms->urlMappings->delete(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings/$ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/url-mappings/2026-03/url-mappings/{id}', + httpMethod: 'get', + summary: 'Retrieve URL mapping', + description: + 'Retrieve a specific URL mapping by its unique identifier. This endpoint is useful for obtaining details about a particular URL mapping configuration within your HubSpot account. It requires the ID of the URL mapping as a path parameter.', + stainlessPath: '(resource) cms.url_mappings > (method) get', + qualified: 'client.cms.urlMappings.get', + params: ['id: number;'], + response: 'string', + markdown: + "## get\n\n`client.cms.urlMappings.get(id: number): string`\n\n**get** `/url-mappings/2026-03/url-mappings/{id}`\n\nRetrieve a specific URL mapping by its unique identifier. This endpoint is useful for obtaining details about a particular URL mapping configuration within your HubSpot account. It requires the ID of the URL mapping as a path parameter.\n\n### Parameters\n\n- `id: number`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlMappings.get(0);\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlMappings.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlMappings.get(0);\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.url_mappings.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_mappings.get(\n 0,\n)\nprint(url_mapping)\ncontent = url_mapping.read()\nprint(content)', + }, + java: { + method: 'cms().urlMappings().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse urlMapping = client.cms().urlMappings().get(0L);\n }\n}', + }, + go: { + method: 'client.Cms.URLMappings.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLMappings.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping)\n}\n', + }, + ruby: { + method: 'cms.url_mappings.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_mappings.get(0)\n\nputs(url_mapping)', + }, + php: { + method: 'cms->urlMappings->get', + example: + "cms->urlMappings->get(0);\n\nvar_dump($urlMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings/$ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/url-mappings/2026-03/url-mappings', + httpMethod: 'get', + summary: 'List URL mappings', + description: + 'Retrieve a list of URL mappings from the HubSpot account. This endpoint provides access to URL mapping configurations, which can be used to manage and redirect URLs within the HubSpot CMS. It is useful for understanding how URLs are structured and redirected in your content management setup.', + stainlessPath: '(resource) cms.url_mappings > (method) list', + qualified: 'client.cms.urlMappings.list', + response: 'string', + markdown: + "## list\n\n`client.cms.urlMappings.list(): string`\n\n**get** `/url-mappings/2026-03/url-mappings`\n\nRetrieve a list of URL mappings from the HubSpot account. This endpoint provides access to URL mapping configurations, which can be used to manage and redirect URLs within the HubSpot CMS. It is useful for understanding how URLs are structured and redirected in your content management setup.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMappings = await client.cms.urlMappings.list();\n\nconsole.log(urlMappings);\n\nconst content = await urlMappings.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlMappings.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMappings = await client.cms.urlMappings.list();\n\nconsole.log(urlMappings);\n\nconst content = await urlMappings.blob();\nconsole.log(content);", + }, + python: { + method: 'cms.url_mappings.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mappings = client.cms.url_mappings.list()\nprint(url_mappings)\ncontent = url_mappings.read()\nprint(content)', + }, + java: { + method: 'cms().urlMappings().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse urlMappings = client.cms().urlMappings().list();\n }\n}', + }, + go: { + method: 'client.Cms.URLMappings.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMappings, err := client.Cms.URLMappings.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMappings)\n}\n', + }, + ruby: { + method: 'cms.url_mappings.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mappings = hubspot.cms.url_mappings.list\n\nputs(url_mappings)', + }, + php: { + method: 'cms->urlMappings->list', + example: + "cms->urlMappings->list();\n\nvar_dump($urlMappings);", + }, + http: { + example: + 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/cms/url-redirects/2026-03', + httpMethod: 'post', + summary: 'Create redirect', + description: + 'Create a new URL redirect in your HubSpot account. This endpoint allows you to define a new URL mapping that redirects traffic from a specified route to a destination URL. This is useful for managing URL changes, handling outdated links, or creating short links.', + stainlessPath: '(resource) cms.url_redirects > (method) create', + qualified: 'client.cms.urlRedirects.create', + params: [ + 'destination: string;', + 'redirectStyle: number;', + 'routePrefix: string;', + 'isMatchFullUrl?: boolean;', + 'isMatchQueryString?: boolean;', + 'isOnlyAfterNotFound?: boolean;', + 'isPattern?: boolean;', + 'isProtocolAgnostic?: boolean;', + 'isTrailingSlashOptional?: boolean;', + 'precedence?: number;', + ], + response: + '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', + markdown: + "## create\n\n`client.cms.urlRedirects.create(destination: string, redirectStyle: number, routePrefix: string, isMatchFullUrl?: boolean, isMatchQueryString?: boolean, isOnlyAfterNotFound?: boolean, isPattern?: boolean, isProtocolAgnostic?: boolean, isTrailingSlashOptional?: boolean, precedence?: number): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**post** `/cms/url-redirects/2026-03`\n\nCreate a new URL redirect in your HubSpot account. This endpoint allows you to define a new URL mapping that redirects traffic from a specified route to a destination URL. This is useful for managing URL changes, handling outdated links, or creating short links.\n\n### Parameters\n\n- `destination: string`\n The destination URL, where the target URL should be redirected if it matches the `routePrefix`.\n\n- `redirectStyle: number`\n The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).\n\n- `routePrefix: string`\n The target incoming URL, path, or pattern to match for redirection.\n\n- `isMatchFullUrl?: boolean`\n Whether the `routePrefix` should match on the entire URL, including the domain.\n\n- `isMatchQueryString?: boolean`\n Whether the `routePrefix` should match on the entire URL path, including the query string.\n\n- `isOnlyAfterNotFound?: boolean`\n Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.\n\n- `isPattern?: boolean`\n Whether the `routePrefix` should match based on pattern.\n\n- `isProtocolAgnostic?: boolean`\n Whether the `routePrefix` should match both HTTP and HTTPS protocols.\n\n- `isTrailingSlashOptional?: boolean`\n Whether a trailing slash will be ignored.\n\n- `precedence?: number`\n Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.create({\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n});\n\nconsole.log(urlMapping);\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlRedirects.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.create({\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n});\n\nconsole.log(urlMapping.id);", + }, + python: { + method: 'cms.url_redirects.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.create(\n destination="destination",\n redirect_style=0,\n route_prefix="routePrefix",\n)\nprint(url_mapping.id)', + }, + java: { + method: 'cms().urlRedirects().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMappingCreateRequestBody;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMappingCreateRequestBody params = UrlMappingCreateRequestBody.builder()\n .destination("destination")\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .build();\n UrlMapping urlMapping = client.cms().urlRedirects().create(params);\n }\n}', + }, + go: { + method: 'client.Cms.URLRedirects.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.New(context.TODO(), cms.URLRedirectNewParams{\n\t\tURLMappingCreateRequestBody: cms.URLMappingCreateRequestBodyParam{\n\t\t\tDestination: "destination",\n\t\t\tRedirectStyle: 0,\n\t\t\tRoutePrefix: "routePrefix",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', + }, + ruby: { + method: 'cms.url_redirects.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.create(\n destination: "destination",\n redirect_style: 0,\n route_prefix: "routePrefix"\n)\n\nputs(url_mapping)', + }, + php: { + method: 'cms->urlRedirects->create', + example: + "cms->urlRedirects->create(\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n);\n\nvar_dump($urlMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/url-redirects/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "destination": "destination",\n "redirectStyle": 0,\n "routePrefix": "routePrefix"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', + httpMethod: 'delete', + summary: 'Delete a redirect', + description: 'Delete one existing redirect, so it is no longer mapped.', + stainlessPath: '(resource) cms.url_redirects > (method) delete', + qualified: 'client.cms.urlRedirects.delete', + params: ['urlRedirectId: string;'], + markdown: + "## delete\n\n`client.cms.urlRedirects.delete(urlRedirectId: string): void`\n\n**delete** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nDelete one existing redirect, so it is no longer mapped.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.urlRedirects.delete('urlRedirectId')\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlRedirects.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.urlRedirects.delete('urlRedirectId');", + }, + python: { + method: 'cms.url_redirects.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.url_redirects.delete(\n "urlRedirectId",\n)', + }, + java: { + method: 'cms().urlRedirects().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().urlRedirects().delete("urlRedirectId");\n }\n}', + }, + go: { + method: 'client.Cms.URLRedirects.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.URLRedirects.Delete(context.TODO(), "urlRedirectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'cms.url_redirects.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.url_redirects.delete("urlRedirectId")\n\nputs(result)', + }, + php: { + method: 'cms->urlRedirects->delete', + example: + "cms->urlRedirects->delete('urlRedirectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', + httpMethod: 'get', + summary: 'Get details for a redirect', + description: 'Returns the details for a single existing URL redirect by ID.', + stainlessPath: '(resource) cms.url_redirects > (method) get', + qualified: 'client.cms.urlRedirects.get', + params: ['urlRedirectId: string;'], + response: + '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', + markdown: + "## get\n\n`client.cms.urlRedirects.get(urlRedirectId: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**get** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nReturns the details for a single existing URL redirect by ID.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.get('urlRedirectId');\n\nconsole.log(urlMapping);\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlRedirects.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.get('urlRedirectId');\n\nconsole.log(urlMapping.id);", + }, + python: { + method: 'cms.url_redirects.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.get(\n "urlRedirectId",\n)\nprint(url_mapping.id)', + }, + java: { + method: 'cms().urlRedirects().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMapping urlMapping = client.cms().urlRedirects().get("urlRedirectId");\n }\n}', + }, + go: { + method: 'client.Cms.URLRedirects.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.Get(context.TODO(), "urlRedirectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', + }, + ruby: { + method: 'cms.url_redirects.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.get("urlRedirectId")\n\nputs(url_mapping)', + }, + php: { + method: 'cms->urlRedirects->get', + example: + "cms->urlRedirects->get('urlRedirectId');\n\nvar_dump($urlMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/cms/url-redirects/2026-03', + httpMethod: 'get', + summary: 'Retrieve redirects', + description: + 'Retrieve a list of URL redirects configured in your HubSpot account. This endpoint allows you to filter redirects based on their creation or update timestamps, and sort the results. It supports pagination and can include archived redirects if specified.', + stainlessPath: '(resource) cms.url_redirects > (method) list', + qualified: 'client.cms.urlRedirects.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'limit?: number;', + 'sort?: string[];', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + ], + response: + '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', + markdown: + "## list\n\n`client.cms.urlRedirects.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**get** `/cms/url-redirects/2026-03`\n\nRetrieve a list of URL redirects configured in your HubSpot account. This endpoint allows you to filter redirects based on their creation or update timestamps, and sort the results. It supports pagination and can include archived redirects if specified.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const urlMapping of client.cms.urlRedirects.list()) {\n console.log(urlMapping);\n}\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlRedirects.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const urlMapping of client.cms.urlRedirects.list()) {\n console.log(urlMapping.id);\n}", + }, + python: { + method: 'cms.url_redirects.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.url_redirects.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'cms().urlRedirects().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectListPage;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlRedirectListPage page = client.cms().urlRedirects().list();\n }\n}', + }, + go: { + method: 'client.Cms.URLRedirects.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.URLRedirects.List(context.TODO(), cms.URLRedirectListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'cms.url_redirects.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.url_redirects.list\n\nputs(page)', + }, + php: { + method: 'cms->urlRedirects->list', + example: + "cms->urlRedirects->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/url-redirects/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', + httpMethod: 'patch', + summary: 'Update a redirect', + description: 'Updates the settings for an existing URL redirect.', + stainlessPath: '(resource) cms.url_redirects > (method) update', + qualified: 'client.cms.urlRedirects.update', + params: [ + 'urlRedirectId: string;', + 'id: string;', + 'created: string;', + 'destination: string;', + 'isMatchFullUrl: boolean;', + 'isMatchQueryString: boolean;', + 'isOnlyAfterNotFound: boolean;', + 'isPattern: boolean;', + 'isProtocolAgnostic: boolean;', + 'isTrailingSlashOptional: boolean;', + 'precedence: number;', + 'redirectStyle: number;', + 'routePrefix: string;', + 'updated: string;', + ], + response: + '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', + markdown: + "## update\n\n`client.cms.urlRedirects.update(urlRedirectId: string, id: string, created: string, destination: string, isMatchFullUrl: boolean, isMatchQueryString: boolean, isOnlyAfterNotFound: boolean, isPattern: boolean, isProtocolAgnostic: boolean, isTrailingSlashOptional: boolean, precedence: number, redirectStyle: number, routePrefix: string, updated: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**patch** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nUpdates the settings for an existing URL redirect.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n- `id: string`\n The unique ID of this URL redirect.\n\n- `created: string`\n The date and time when the URL mapping was initially created.\n\n- `destination: string`\n The destination URL, where the target URL should be redirected if it matches the `routePrefix`.\n\n- `isMatchFullUrl: boolean`\n Whether the `routePrefix` should match on the entire URL, including the domain.\n\n- `isMatchQueryString: boolean`\n Whether the `routePrefix` should match on the entire URL path, including the query string.\n\n- `isOnlyAfterNotFound: boolean`\n Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.\n\n- `isPattern: boolean`\n Whether the `routePrefix` should match based on pattern.\n\n- `isProtocolAgnostic: boolean`\n Whether the `routePrefix` should match both HTTP and HTTPS protocols.\n\n- `isTrailingSlashOptional: boolean`\n Whether a trailing slash will be ignored.\n\n- `precedence: number`\n Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.\n\n- `redirectStyle: number`\n The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).\n\n- `routePrefix: string`\n The target incoming URL, path, or pattern to match for redirection.\n\n- `updated: string`\n The date and time when the URL mapping was last modified.\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.update('urlRedirectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n destination: 'destination',\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(urlMapping);\n```", + perLanguage: { + typescript: { + method: 'client.cms.urlRedirects.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.update('urlRedirectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n destination: 'destination',\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(urlMapping.id);", + }, + python: { + method: 'cms.url_redirects.update', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.update(\n url_redirect_id="urlRedirectId",\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n destination="destination",\n is_match_full_url=True,\n is_match_query_string=True,\n is_only_after_not_found=True,\n is_pattern=True,\n is_protocol_agnostic=True,\n is_trailing_slash_optional=True,\n precedence=0,\n redirect_style=0,\n route_prefix="routePrefix",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(url_mapping.id)', + }, + java: { + method: 'cms().urlRedirects().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlRedirectUpdateParams params = UrlRedirectUpdateParams.builder()\n .urlRedirectId("urlRedirectId")\n .urlMapping(UrlMapping.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .destination("destination")\n .isMatchFullUrl(true)\n .isMatchQueryString(true)\n .isOnlyAfterNotFound(true)\n .isPattern(true)\n .isProtocolAgnostic(true)\n .isTrailingSlashOptional(true)\n .precedence(0)\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n UrlMapping urlMapping = client.cms().urlRedirects().update(params);\n }\n}', + }, + go: { + method: 'client.Cms.URLRedirects.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.Update(\n\t\tcontext.TODO(),\n\t\t"urlRedirectId",\n\t\tcms.URLRedirectUpdateParams{\n\t\t\tURLMapping: cms.URLMappingParam{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDestination: "destination",\n\t\t\t\tIsMatchFullURL: true,\n\t\t\t\tIsMatchQueryString: true,\n\t\t\t\tIsOnlyAfterNotFound: true,\n\t\t\t\tIsPattern: true,\n\t\t\t\tIsProtocolAgnostic: true,\n\t\t\t\tIsTrailingSlashOptional: true,\n\t\t\t\tPrecedence: 0,\n\t\t\t\tRedirectStyle: 0,\n\t\t\t\tRoutePrefix: "routePrefix",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', + }, + ruby: { + method: 'cms.url_redirects.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.update(\n "urlRedirectId",\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n destination: "destination",\n is_match_full_url: true,\n is_match_query_string: true,\n is_only_after_not_found: true,\n is_pattern: true,\n is_protocol_agnostic: true,\n is_trailing_slash_optional: true,\n precedence: 0,\n redirect_style: 0,\n route_prefix: "routePrefix",\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(url_mapping)', + }, + php: { + method: 'cms->urlRedirects->update', + example: + "cms->urlRedirects->update(\n 'urlRedirectId',\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n destination: 'destination',\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($urlMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "destination": "destination",\n "isMatchFullUrl": true,\n "isMatchQueryString": true,\n "isOnlyAfterNotFound": true,\n "isPattern": true,\n "isProtocolAgnostic": true,\n "isTrailingSlashOptional": true,\n "precedence": 0,\n "redirectStyle": 0,\n "routePrefix": "routePrefix",\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'generate_links', + endpoint: '/communication-preferences/2026-03/links/generate', + httpMethod: 'post', + summary: 'Generate subscription links', + description: + 'Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.', + stainlessPath: '(resource) communication_preferences > (method) generate_links', + qualified: 'client.communicationPreferences.generateLinks', + params: [ + "channel: 'EMAIL';", + 'subscriberIdString: string;', + 'businessUnitId?: number;', + 'language?: string;', + 'subscriptionId?: number;', + ], + response: + '{ managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }', + markdown: + "## generate_links\n\n`client.communicationPreferences.generateLinks(channel: 'EMAIL', subscriberIdString: string, businessUnitId?: number, language?: string, subscriptionId?: number): { managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }`\n\n**post** `/communication-preferences/2026-03/links/generate`\n\nGenerate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel for which the links are generated. Must be 'EMAIL'.\n\n- `subscriberIdString: string`\n A string representing the unique identifier of the subscriber. This property is required.\n\n- `businessUnitId?: number`\n The identifier of the business unit. Defaults to 0 if not specified.\n\n- `language?: string`\n The language in which the generated link should be presented, represented as a string.\n\n- `subscriptionId?: number`\n The unique identifier for the subscription, represented as an integer in int64 format.\n\n### Returns\n\n- `{ managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }`\n\n - `managePreferencesUrl: string`\n - `subscriberIdString: string`\n - `unsubscribeAllUrl: string`\n - `unsubscribeSingleUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst linkGenerationResponse = await client.communicationPreferences.generateLinks({ channel: 'EMAIL', subscriberIdString: 'subscriberIdString' });\n\nconsole.log(linkGenerationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.generateLinks', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst linkGenerationResponse = await client.communicationPreferences.generateLinks({\n channel: 'EMAIL',\n subscriberIdString: 'subscriberIdString',\n});\n\nconsole.log(linkGenerationResponse.managePreferencesUrl);", + }, + python: { + method: 'communication_preferences.generate_links', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlink_generation_response = client.communication_preferences.generate_links(\n channel="EMAIL",\n subscriber_id_string="subscriberIdString",\n)\nprint(link_generation_response.manage_preferences_url)', + }, + java: { + method: 'communicationPreferences().generateLinks', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGenerateLinksParams;\nimport com.hubspot.sdk.models.communicationpreferences.LinkGenerationRequest;\nimport com.hubspot.sdk.models.communicationpreferences.LinkGenerationResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGenerateLinksParams params = CommunicationPreferenceGenerateLinksParams.builder()\n .channel(CommunicationPreferenceGenerateLinksParams.Channel.EMAIL)\n .linkGenerationRequest(LinkGenerationRequest.builder()\n .subscriberIdString("subscriberIdString")\n .build())\n .build();\n LinkGenerationResponse linkGenerationResponse = client.communicationPreferences().generateLinks(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.GenerateLinks', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlinkGenerationResponse, err := client.CommunicationPreferences.GenerateLinks(context.TODO(), communication_preferences.CommunicationPreferenceGenerateLinksParams{\n\t\tChannel: communication_preferences.CommunicationPreferenceGenerateLinksParamsChannelEmail,\n\t\tLinkGenerationRequest: communication_preferences.LinkGenerationRequestParam{\n\t\t\tSubscriberIDString: "subscriberIdString",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", linkGenerationResponse.ManagePreferencesURL)\n}\n', + }, + ruby: { + method: 'communication_preferences.generate_links', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlink_generation_response = hubspot.communication_preferences.generate_links(\n channel: :EMAIL,\n subscriber_id_string: "subscriberIdString"\n)\n\nputs(link_generation_response)', + }, + php: { + method: 'communicationPreferences->generateLinks', + example: + "communicationPreferences->generateLinks(\n channel: 'EMAIL',\n subscriberIDString: 'subscriberIdString',\n businessUnitID: 0,\n language: 'language',\n subscriptionID: 0,\n);\n\nvar_dump($linkGenerationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/links/generate \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "subscriberIdString": "subscriberIdString"\n }\'', + }, + }, + }, + { + name: 'get_statuses', + endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}', + httpMethod: 'get', + summary: 'Get subscription preferences for a specific contact', + description: "Retrieve a contact's current email subscription preferences.", + stainlessPath: '(resource) communication_preferences > (method) get_statuses', + qualified: 'client.communicationPreferences.getStatuses', + params: ['subscriberIdString: string;', "channel: 'EMAIL';", 'businessUnitId?: number;'], + response: + "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## get_statuses\n\n`client.communicationPreferences.getStatuses(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/statuses/{subscriberIdString}`\n\nRetrieve a contact's current email subscription preferences.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit to filter the subscription status by. This is an optional parameter.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.getStatuses('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.getStatuses', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.getStatuses(\n 'subscriberIdString',\n { channel: 'EMAIL' },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", + }, + python: { + method: 'communication_preferences.get_statuses', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.get_statuses(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_status.completed_at)', + }, + java: { + method: 'communicationPreferences().getStatuses', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGetStatusesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGetStatusesParams params = CommunicationPreferenceGetStatusesParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceGetStatusesParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().getStatuses(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.GetStatuses', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.GetStatuses(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceGetStatusesParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceGetStatusesParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.get_statuses', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.get_statuses("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_status)', + }, + php: { + method: 'communicationPreferences->getStatuses', + example: + "communicationPreferences\n ->getStatuses('subscriberIdString', channel: 'EMAIL', businessUnitID: 0);\n\nvar_dump($actionResponseWithResultsPublicStatus);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_unsubscribe_all_status', + endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', + httpMethod: 'get', + summary: "Retrieve a contact's unsubscribed status", + description: + 'Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty.', + stainlessPath: '(resource) communication_preferences > (method) get_unsubscribe_all_status', + qualified: 'client.communicationPreferences.getUnsubscribeAllStatus', + params: [ + 'subscriberIdString: string;', + "channel: 'EMAIL';", + 'businessUnitId?: number;', + 'verbose?: boolean;', + ], + response: + "{ completedAt: string; results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## get_unsubscribe_all_status\n\n`client.communicationPreferences.getUnsubscribeAllStatus(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_wide_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all`\n\nCheck whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit to which the subscriber belongs. This is an optional parameter.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicWideStatus = await client.communicationPreferences.getUnsubscribeAllStatus('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicWideStatus);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.getUnsubscribeAllStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicWideStatus =\n await client.communicationPreferences.getUnsubscribeAllStatus('subscriberIdString', {\n channel: 'EMAIL',\n });\n\nconsole.log(actionResponseWithResultsPublicWideStatus.completedAt);", + }, + python: { + method: 'communication_preferences.get_unsubscribe_all_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_wide_status = client.communication_preferences.get_unsubscribe_all_status(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_wide_status.completed_at)', + }, + java: { + method: 'communicationPreferences().getUnsubscribeAllStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicWideStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGetUnsubscribeAllStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGetUnsubscribeAllStatusParams params = CommunicationPreferenceGetUnsubscribeAllStatusParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceGetUnsubscribeAllStatusParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicWideStatus actionResponseWithResultsPublicWideStatus = client.communicationPreferences().getUnsubscribeAllStatus(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.GetUnsubscribeAllStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicWideStatus, err := client.CommunicationPreferences.GetUnsubscribeAllStatus(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceGetUnsubscribeAllStatusParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceGetUnsubscribeAllStatusParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicWideStatus.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.get_unsubscribe_all_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_wide_status = hubspot.communication_preferences.get_unsubscribe_all_status("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_wide_status)', + }, + php: { + method: 'communicationPreferences->getUnsubscribeAllStatus', + example: + "communicationPreferences\n ->getUnsubscribeAllStatus(\n 'subscriberIdString', channel: 'EMAIL', businessUnitID: 0, verbose: true\n);\n\nvar_dump($actionResponseWithResultsPublicWideStatus);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING/unsubscribe-all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'unsubscribe_all', + endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', + httpMethod: 'post', + summary: 'Unsubscribe a contact from all subscriptions', + description: 'Unsubscribe a contact from all email subscriptions.', + stainlessPath: '(resource) communication_preferences > (method) unsubscribe_all', + qualified: 'client.communicationPreferences.unsubscribeAll', + params: [ + 'subscriberIdString: string;', + "channel: 'EMAIL';", + 'businessUnitId?: number;', + 'verbose?: boolean;', + ], + response: + "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## unsubscribe_all\n\n`client.communicationPreferences.unsubscribeAll(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all`\n\nUnsubscribe a contact from all email subscriptions.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel to unsubscribe from. Must be 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the request. This is an optional integer parameter.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.unsubscribeAll('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.unsubscribeAll', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.unsubscribeAll(\n 'subscriberIdString',\n { channel: 'EMAIL' },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", + }, + python: { + method: 'communication_preferences.unsubscribe_all', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.unsubscribe_all(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_status.completed_at)', + }, + java: { + method: 'communicationPreferences().unsubscribeAll', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceUnsubscribeAllParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceUnsubscribeAllParams params = CommunicationPreferenceUnsubscribeAllParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceUnsubscribeAllParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().unsubscribeAll(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.UnsubscribeAll', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.UnsubscribeAll(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceUnsubscribeAllParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceUnsubscribeAllParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.unsubscribe_all', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.unsubscribe_all("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_status)', + }, + php: { + method: 'communicationPreferences->unsubscribeAll', + example: + "communicationPreferences\n ->unsubscribeAll(\n 'subscriberIdString', channel: 'EMAIL', businessUnitID: 0, verbose: true\n);\n\nvar_dump($actionResponseWithResultsPublicStatus);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING/unsubscribe-all \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_status', + endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}', + httpMethod: 'post', + summary: "Update a contact's subscription status", + description: 'Set the subscription status of a specific contact.', + stainlessPath: '(resource) communication_preferences > (method) update_status', + qualified: 'client.communicationPreferences.updateStatus', + params: [ + 'subscriberIdString: string;', + "channel: 'EMAIL';", + "statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';", + 'subscriptionId: number;', + 'legalBasis?: string;', + 'legalBasisExplanation?: string;', + ], + response: + "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## update_status\n\n`client.communicationPreferences.updateStatus(subscriberIdString: string, channel: 'EMAIL', statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED', subscriptionId: number, legalBasis?: string, legalBasisExplanation?: string): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/{subscriberIdString}`\n\nSet the subscription status of a specific contact.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The type of communication channel, with 'EMAIL' as the only supported option.\n\n- `statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'`\n The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.\n\n- `subscriptionId: number`\n The unique identifier of the subscription to be updated.\n\n- `legalBasis?: string`\n The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.\n\n- `legalBasisExplanation?: string`\n An explanation for the legal basis used for communication.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.updateStatus('subscriberIdString', {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionId: 0,\n});\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.updateStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.updateStatus(\n 'subscriberIdString',\n {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionId: 0,\n },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", + }, + python: { + method: 'communication_preferences.update_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.update_status(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n status_state="NOT_SPECIFIED",\n subscription_id=0,\n)\nprint(action_response_with_results_public_status.completed_at)', + }, + java: { + method: 'communicationPreferences().updateStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceUpdateStatusParams;\nimport com.hubspot.sdk.models.communicationpreferences.PartialPublicStatusRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceUpdateStatusParams params = CommunicationPreferenceUpdateStatusParams.builder()\n .subscriberIdString("subscriberIdString")\n .partialPublicStatusRequest(PartialPublicStatusRequest.builder()\n .channel(PartialPublicStatusRequest.Channel.EMAIL)\n .statusState(PartialPublicStatusRequest.StatusState.NOT_SPECIFIED)\n .subscriptionId(0L)\n .build())\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().updateStatus(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.UpdateStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.UpdateStatus(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceUpdateStatusParams{\n\t\t\tPartialPublicStatusRequest: communication_preferences.PartialPublicStatusRequestParam{\n\t\t\t\tChannel: communication_preferences.PartialPublicStatusRequestChannelEmail,\n\t\t\t\tStatusState: communication_preferences.PartialPublicStatusRequestStatusStateNotSpecified,\n\t\t\t\tSubscriptionID: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.update_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.update_status(\n "subscriberIdString",\n channel: :EMAIL,\n status_state: :NOT_SPECIFIED,\n subscription_id: 0\n)\n\nputs(action_response_with_results_public_status)', + }, + php: { + method: 'communicationPreferences->updateStatus', + example: + "communicationPreferences\n ->updateStatus(\n 'subscriberIdString',\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionID: 0,\n legalBasis: 'CONSENT_WITH_NOTICE',\n legalBasisExplanation: 'legalBasisExplanation',\n);\n\nvar_dump($actionResponseWithResultsPublicStatus);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "channel": "EMAIL",\n "statusState": "NOT_SPECIFIED",\n "subscriptionId": 0\n }\'', + }, + }, + }, + { + name: 'list', + endpoint: '/communication-preferences/2026-03/definitions', + httpMethod: 'get', + summary: 'Retrieve all subscription status definitions', + description: 'Get a list of subscription status definitions from the account.', + stainlessPath: '(resource) communication_preferences.definitions > (method) list', + qualified: 'client.communicationPreferences.definitions.list', + params: ['businessUnitId?: number;', 'includeTranslations?: boolean;'], + response: + "{ completedAt: string; results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: public_subscription_translation[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## list\n\n`client.communicationPreferences.definitions.list(businessUnitId?: number, includeTranslations?: boolean): { completedAt: string; results: subscription_definition[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/definitions`\n\nGet a list of subscription status definitions from the account.\n\n### Parameters\n\n- `businessUnitId?: number`\n An integer representing the ID of the business unit for which to retrieve subscription definitions.\n\n- `includeTranslations?: boolean`\n A boolean indicating whether to include translations of the communication preferences definitions in the response.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: public_subscription_translation[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: { createdAt: number; description: string; languageCode: string; name: string; subscriptionId: number; updatedAt: number; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsSubscriptionDefinition = await client.communicationPreferences.definitions.list();\n\nconsole.log(actionResponseWithResultsSubscriptionDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.definitions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsSubscriptionDefinition =\n await client.communicationPreferences.definitions.list();\n\nconsole.log(actionResponseWithResultsSubscriptionDefinition.completedAt);", + }, + python: { + method: 'communication_preferences.definitions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_subscription_definition = client.communication_preferences.definitions.list()\nprint(action_response_with_results_subscription_definition.completed_at)', + }, + java: { + method: 'communicationPreferences().definitions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsSubscriptionDefinition;\nimport com.hubspot.sdk.models.communicationpreferences.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponseWithResultsSubscriptionDefinition actionResponseWithResultsSubscriptionDefinition = client.communicationPreferences().definitions().list();\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.Definitions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsSubscriptionDefinition, err := client.CommunicationPreferences.Definitions.List(context.TODO(), communication_preferences.DefinitionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsSubscriptionDefinition.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.definitions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_subscription_definition = hubspot.communication_preferences.definitions.list\n\nputs(action_response_with_results_subscription_definition)', + }, + php: { + method: 'communicationPreferences->definitions->list', + example: + "communicationPreferences\n ->definitions\n ->list(businessUnitID: 0, includeTranslations: true);\n\nvar_dump($actionResponseWithResultsSubscriptionDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/definitions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_unsubscribe_all_statuses', + endpoint: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read', + httpMethod: 'post', + summary: 'Batch retrieve contacts who have opted out of all communications', + description: 'Checks whether a set of contacts have opted out of all communications.', + stainlessPath: + '(resource) communication_preferences.statuses.batch > (method) get_unsubscribe_all_statuses', + qualified: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', + params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;'], + response: + "{ completedAt: string; results: { subscriberIdString: string; wideStatuses: public_wide_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_unsubscribe_all_statuses\n\n`client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses(channel: 'EMAIL', inputs: string[], businessUnitId?: number): { completedAt: string; results: public_wide_status_bulk_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read`\n\nChecks whether a set of contacts have opted out of all communications.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n The ID of the business unit to filter the results. This is an optional parameter.\n\n### Returns\n\n- `{ completedAt: string; results: { subscriberIdString: string; wideStatuses: public_wide_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { subscriberIdString: string; wideStatuses: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicWideStatusBulkResponse = await client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicWideStatusBulkResponse);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicWideStatusBulkResponse =\n await client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicWideStatusBulkResponse.completedAt);", + }, + python: { + method: 'communication_preferences.statuses.batch.get_unsubscribe_all_statuses', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_wide_status_bulk_response = client.communication_preferences.statuses.batch.get_unsubscribe_all_statuses(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_wide_status_bulk_response.completed_at)', + }, + java: { + method: 'communicationPreferences().statuses().batch().getUnsubscribeAllStatuses', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicWideStatusBulkResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchGetUnsubscribeAllStatusesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetUnsubscribeAllStatusesParams params = BatchGetUnsubscribeAllStatusesParams.builder()\n .channel(BatchGetUnsubscribeAllStatusesParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicWideStatusBulkResponse batchResponsePublicWideStatusBulkResponse = client.communicationPreferences().statuses().batch().getUnsubscribeAllStatuses(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.Statuses.Batch.GetUnsubscribeAllStatuses', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicWideStatusBulkResponse, err := client.CommunicationPreferences.Statuses.Batch.GetUnsubscribeAllStatuses(context.TODO(), communication_preferences.StatusBatchGetUnsubscribeAllStatusesParams{\n\t\tChannel: communication_preferences.StatusBatchGetUnsubscribeAllStatusesParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicWideStatusBulkResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.statuses.batch.get_unsubscribe_all_statuses', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_wide_status_bulk_response = hubspot.communication_preferences.statuses.batch.get_unsubscribe_all_statuses(\n channel: :EMAIL,\n inputs: ["string"]\n)\n\nputs(batch_response_public_wide_status_bulk_response)', + }, + php: { + method: 'communicationPreferences->statuses->batch->getUnsubscribeAllStatuses', + example: + "communicationPreferences\n ->statuses\n ->batch\n ->getUnsubscribeAllStatuses(\n channel: 'EMAIL', inputs: ['string'], businessUnitID: 0\n);\n\nvar_dump($batchResponsePublicWideStatusBulkResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'read', + endpoint: '/communication-preferences/2026-03/statuses/batch/read', + httpMethod: 'post', + summary: 'Batch retrieve subscription statuses', + description: 'Batch retrieve subscription statuses for a set of contacts.', + stainlessPath: '(resource) communication_preferences.statuses.batch > (method) read', + qualified: 'client.communicationPreferences.statuses.batch.read', + params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;'], + response: + "{ completedAt: string; results: { statuses: public_status[]; subscriberIdString: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## read\n\n`client.communicationPreferences.statuses.batch.read(channel: 'EMAIL', inputs: string[], businessUnitId?: number): { completedAt: string; results: public_status_bulk_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/read`\n\nBatch retrieve subscription statuses for a set of contacts.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel to filter the subscription statuses. Must be 'EMAIL'.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.\n\n### Returns\n\n- `{ completedAt: string; results: { statuses: public_status[]; subscriberIdString: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { statuses: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; subscriberIdString: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicStatusBulkResponse = await client.communicationPreferences.statuses.batch.read({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicStatusBulkResponse);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.statuses.batch.read', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicStatusBulkResponse =\n await client.communicationPreferences.statuses.batch.read({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicStatusBulkResponse.completedAt);", + }, + python: { + method: 'communication_preferences.statuses.batch.read', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_status_bulk_response = client.communication_preferences.statuses.batch.read(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_status_bulk_response.completed_at)', + }, + java: { + method: 'communicationPreferences().statuses().batch().read', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicStatusBulkResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchReadParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadParams params = BatchReadParams.builder()\n .channel(BatchReadParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicStatusBulkResponse batchResponsePublicStatusBulkResponse = client.communicationPreferences().statuses().batch().read(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.Statuses.Batch.Read', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicStatusBulkResponse, err := client.CommunicationPreferences.Statuses.Batch.Read(context.TODO(), communication_preferences.StatusBatchReadParams{\n\t\tChannel: communication_preferences.StatusBatchReadParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicStatusBulkResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.statuses.batch.read', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_status_bulk_response = hubspot.communication_preferences.statuses.batch.read(channel: :EMAIL, inputs: ["string"])\n\nputs(batch_response_public_status_bulk_response)', + }, + php: { + method: 'communicationPreferences->statuses->batch->read', + example: + "communicationPreferences\n ->statuses\n ->batch\n ->read(channel: 'EMAIL', inputs: ['string'], businessUnitID: 0);\n\nvar_dump($batchResponsePublicStatusBulkResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'unsubscribe_all', + endpoint: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all', + httpMethod: 'post', + summary: 'Batch unsubscribe contacts from all subscriptions', + description: 'Unsubscribe a set of contacts from all email subscriptions.', + stainlessPath: '(resource) communication_preferences.statuses.batch > (method) unsubscribe_all', + qualified: 'client.communicationPreferences.statuses.batch.unsubscribeAll', + params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;', 'verbose?: boolean;'], + response: + "{ completedAt: string; results: { subscriberIdString: string; statuses?: public_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## unsubscribe_all\n\n`client.communicationPreferences.statuses.batch.unsubscribeAll(channel: 'EMAIL', inputs: string[], businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_bulk_opt_out_from_all_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/unsubscribe-all`\n\nUnsubscribe a set of contacts from all email subscriptions.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n An optional integer representing the business unit ID for which the operation is being performed.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { subscriberIdString: string; statuses?: public_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { subscriberIdString: string; statuses?: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicBulkOptOutFromAllResponse = await client.communicationPreferences.statuses.batch.unsubscribeAll({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicBulkOptOutFromAllResponse);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.statuses.batch.unsubscribeAll', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicBulkOptOutFromAllResponse =\n await client.communicationPreferences.statuses.batch.unsubscribeAll({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicBulkOptOutFromAllResponse.completedAt);", + }, + python: { + method: 'communication_preferences.statuses.batch.unsubscribe_all', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_bulk_opt_out_from_all_response = client.communication_preferences.statuses.batch.unsubscribe_all(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_bulk_opt_out_from_all_response.completed_at)', + }, + java: { + method: 'communicationPreferences().statuses().batch().unsubscribeAll', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicBulkOptOutFromAllResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchUnsubscribeAllParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUnsubscribeAllParams params = BatchUnsubscribeAllParams.builder()\n .channel(BatchUnsubscribeAllParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicBulkOptOutFromAllResponse batchResponsePublicBulkOptOutFromAllResponse = client.communicationPreferences().statuses().batch().unsubscribeAll(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.Statuses.Batch.UnsubscribeAll', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicBulkOptOutFromAllResponse, err := client.CommunicationPreferences.Statuses.Batch.UnsubscribeAll(context.TODO(), communication_preferences.StatusBatchUnsubscribeAllParams{\n\t\tChannel: communication_preferences.StatusBatchUnsubscribeAllParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicBulkOptOutFromAllResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.statuses.batch.unsubscribe_all', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_bulk_opt_out_from_all_response = hubspot.communication_preferences.statuses.batch.unsubscribe_all(channel: :EMAIL, inputs: ["string"])\n\nputs(batch_response_public_bulk_opt_out_from_all_response)', + }, + php: { + method: 'communicationPreferences->statuses->batch->unsubscribeAll', + example: + "communicationPreferences\n ->statuses\n ->batch\n ->unsubscribeAll(\n channel: 'EMAIL', inputs: ['string'], businessUnitID: 0, verbose: true\n);\n\nvar_dump($batchResponsePublicBulkOptOutFromAllResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update_statuses', + endpoint: '/communication-preferences/2026-03/statuses/batch/write', + httpMethod: 'post', + summary: 'Batch update subscription status', + description: 'Update the subscription status for a set of contacts.', + stainlessPath: '(resource) communication_preferences.statuses.batch > (method) update_statuses', + qualified: 'client.communicationPreferences.statuses.batch.updateStatuses', + params: [ + "inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[];", + ], + response: + "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## update_statuses\n\n`client.communicationPreferences.statuses.batch.updateStatuses(inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[]): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/write`\n\nUpdate the subscription status for a set of contacts.\n\n### Parameters\n\n- `inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[]`\n An array of PublicStatusRequest objects, each representing a subscription status update request. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicStatus = await client.communicationPreferences.statuses.batch.updateStatuses({ inputs: [{\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriberIdString: 'subscriberIdString',\n subscriptionId: 0,\n}] });\n\nconsole.log(batchResponsePublicStatus);\n```", + perLanguage: { + typescript: { + method: 'client.communicationPreferences.statuses.batch.updateStatuses', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicStatus =\n await client.communicationPreferences.statuses.batch.updateStatuses({\n inputs: [\n {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriberIdString: 'subscriberIdString',\n subscriptionId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicStatus.completedAt);", + }, + python: { + method: 'communication_preferences.statuses.batch.update_statuses', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_status = client.communication_preferences.statuses.batch.update_statuses(\n inputs=[{\n "channel": "EMAIL",\n "status_state": "NOT_SPECIFIED",\n "subscriber_id_string": "subscriberIdString",\n "subscription_id": 0,\n }],\n)\nprint(batch_response_public_status.completed_at)', + }, + java: { + method: 'communicationPreferences().statuses().batch().updateStatuses', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.BatchInputPublicStatusRequest;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.PublicStatusRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicStatusRequest params = BatchInputPublicStatusRequest.builder()\n .addInput(PublicStatusRequest.builder()\n .channel(PublicStatusRequest.Channel.EMAIL)\n .statusState(PublicStatusRequest.StatusState.NOT_SPECIFIED)\n .subscriberIdString("subscriberIdString")\n .subscriptionId(0L)\n .build())\n .build();\n BatchResponsePublicStatus batchResponsePublicStatus = client.communicationPreferences().statuses().batch().updateStatuses(params);\n }\n}', + }, + go: { + method: 'client.CommunicationPreferences.Statuses.Batch.UpdateStatuses', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicStatus, err := client.CommunicationPreferences.Statuses.Batch.UpdateStatuses(context.TODO(), communication_preferences.StatusBatchUpdateStatusesParams{\n\t\tBatchInputPublicStatusRequest: communication_preferences.BatchInputPublicStatusRequestParam{\n\t\t\tInputs: []communication_preferences.PublicStatusRequestParam{{\n\t\t\t\tChannel: communication_preferences.PublicStatusRequestChannelEmail,\n\t\t\t\tStatusState: communication_preferences.PublicStatusRequestStatusStateNotSpecified,\n\t\t\t\tSubscriberIDString: "subscriberIdString",\n\t\t\t\tSubscriptionID: 0,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicStatus.CompletedAt)\n}\n', + }, + ruby: { + method: 'communication_preferences.statuses.batch.update_statuses', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_status = hubspot.communication_preferences.statuses.batch.update_statuses(\n inputs: [\n {channel: :EMAIL, statusState: :NOT_SPECIFIED, subscriberIdString: "subscriberIdString", subscriptionId: 0}\n ]\n)\n\nputs(batch_response_public_status)', + }, + php: { + method: 'communicationPreferences->statuses->batch->updateStatuses', + example: + "communicationPreferences\n ->statuses\n ->batch\n ->updateStatuses(\n inputs: [\n [\n 'channel' => 'EMAIL',\n 'statusState' => 'NOT_SPECIFIED',\n 'subscriberIDString' => 'subscriberIdString',\n 'subscriptionID' => 0,\n 'legalBasis' => 'CONSENT_WITH_NOTICE',\n 'legalBasisExplanation' => 'legalBasisExplanation',\n ],\n ],\n);\n\nvar_dump($batchResponsePublicStatus);", + }, + http: { + example: + 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/write \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "channel": "EMAIL",\n "statusState": "NOT_SPECIFIED",\n "subscriberIdString": "subscriberIdString",\n "subscriptionId": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/conversations/custom-channels/2026-03', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) conversations.custom_channels > (method) create', + qualified: 'client.conversations.customChannels.create', + params: [ + 'capabilities: object;', + 'name: string;', + 'channelAccountConnectionRedirectUrl?: string;', + 'channelDescription?: string;', + 'channelLogoUrl?: string;', + 'webhookUrl?: string;', + ], + response: + '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', + markdown: + "## create\n\n`client.conversations.customChannels.create(capabilities: object, name: string, channelAccountConnectionRedirectUrl?: string, channelDescription?: string, channelLogoUrl?: string, webhookUrl?: string): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**post** `/conversations/custom-channels/2026-03`\n\n### Parameters\n\n- `capabilities: object`\n\n- `name: string`\n\n- `channelAccountConnectionRedirectUrl?: string`\n\n- `channelDescription?: string`\n\n- `channelLogoUrl?: string`\n\n- `webhookUrl?: string`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.create({\n capabilities: { foo: {} },\n name: 'name',\n});\n\nconsole.log(publicChannelIntegrationChannel);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.create({\n capabilities: { foo: {} },\n name: 'name',\n});\n\nconsole.log(publicChannelIntegrationChannel.id);", + }, + python: { + method: 'conversations.custom_channels.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npublic_channel_integration_channel = client.conversations.custom_channels.create(\n capabilities={\n "foo": {}\n },\n name="name",\n)\nprint(public_channel_integration_channel.id)', + }, + java: { + method: 'conversations().customChannels().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannel;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannelCreate;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicChannelIntegrationChannelCreate params = PublicChannelIntegrationChannelCreate.builder()\n .capabilities(PublicChannelIntegrationChannelCreate.Capabilities.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .name("name")\n .build();\n PublicChannelIntegrationChannel publicChannelIntegrationChannel = client.conversations().customChannels().create(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelIntegrationChannel, err := client.Conversations.CustomChannels.New(context.TODO(), conversations.CustomChannelNewParams{\n\t\tPublicChannelIntegrationChannelCreate: conversations.PublicChannelIntegrationChannelCreateParam{\n\t\t\tCapabilities: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelIntegrationChannel.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_integration_channel = hubspot.conversations.custom_channels.create(capabilities: {foo: {}}, name: "name")\n\nputs(public_channel_integration_channel)', + }, + php: { + method: 'conversations->customChannels->create', + example: + "conversations\n ->customChannels\n ->create(\n capabilities: ['foo' => (object) []],\n name: 'name',\n channelAccountConnectionRedirectURL: 'channelAccountConnectionRedirectUrl',\n channelDescription: 'channelDescription',\n channelLogoURL: 'channelLogoUrl',\n webhookURL: 'webhookUrl',\n);\n\nvar_dump($publicChannelIntegrationChannel);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "capabilities": {\n "foo": {}\n },\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/conversations/custom-channels/2026-03/{channelId}', + httpMethod: 'delete', + summary: 'Archive a custom channel', + description: 'Archive an existing registered custom channel', + stainlessPath: '(resource) conversations.custom_channels > (method) delete', + qualified: 'client.conversations.customChannels.delete', + params: ['channelId: number;'], + markdown: + "## delete\n\n`client.conversations.customChannels.delete(channelId: number): void`\n\n**delete** `/conversations/custom-channels/2026-03/{channelId}`\n\nArchive an existing registered custom channel\n\n### Parameters\n\n- `channelId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.conversations.customChannels.delete(0)\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.conversations.customChannels.delete(0);", + }, + python: { + method: 'conversations.custom_channels.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\nclient.conversations.custom_channels.delete(\n 0,\n)', + }, + java: { + method: 'conversations().customChannels().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.conversations().customChannels().delete(0);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Conversations.CustomChannels.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.conversations.custom_channels.delete(0)\n\nputs(result)', + }, + php: { + method: 'conversations->customChannels->delete', + example: + "conversations->customChannels->delete(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', + httpMethod: 'get', + summary: 'Get a channel account by id', + description: + 'Retrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.', + stainlessPath: '(resource) conversations.custom_channels > (method) get', + qualified: 'client.conversations.customChannels.get', + params: ['channelId: number;', 'channelAccountId: number;', 'archived?: boolean;'], + response: + "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", + markdown: + "## get\n\n`client.conversations.customChannels.get(channelId: number, channelAccountId: number, archived?: boolean): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}`\n\nRetrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.\n\n### Parameters\n\n- `channelId: number`\n\n- `channelAccountId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.get(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.get(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount.id);", + }, + python: { + method: 'conversations.custom_channels.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.get(\n channel_account_id=0,\n channel_id=0,\n)\nprint(public_channel_account.id)', + }, + java: { + method: 'conversations().customChannels().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelGetParams;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelGetParams params = CustomChannelGetParams.builder()\n .channelId(0)\n .channelAccountId(0L)\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().get(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelGetParams{\n\t\t\tChannelID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.get(0, channel_id: 0)\n\nputs(public_channel_account)', + }, + php: { + method: 'conversations->customChannels->get', + example: + "conversations->customChannels->get(\n 0, channelID: 0, archived: true\n);\n\nvar_dump($publicChannelAccount);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts/$CHANNEL_ACCOUNT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/conversations/custom-channels/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) conversations.custom_channels > (method) list', + qualified: 'client.conversations.customChannels.list', + params: ['after?: string;', 'defaultPageLength?: number;', 'limit?: number;', 'sort?: string[];'], + response: + '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', + markdown: + "## list\n\n`client.conversations.customChannels.list(after?: string, defaultPageLength?: number, limit?: number, sort?: string[]): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**get** `/conversations/custom-channels/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `defaultPageLength?: number`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelIntegrationChannel of client.conversations.customChannels.list()) {\n console.log(publicChannelIntegrationChannel);\n}\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelIntegrationChannel of client.conversations.customChannels.list()) {\n console.log(publicChannelIntegrationChannel.id);\n}", + }, + python: { + method: 'conversations.custom_channels.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npage = client.conversations.custom_channels.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'conversations().customChannels().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelListPage;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelListPage page = client.conversations().customChannels().list();\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Conversations.CustomChannels.List(context.TODO(), conversations.CustomChannelListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.conversations.custom_channels.list\n\nputs(page)', + }, + php: { + method: 'conversations->customChannels->list', + example: + "conversations->customChannels->list(\n after: 'after', defaultPageLength: 0, limit: 0, sort: ['string']\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/conversations/custom-channels/2026-03/{channelId}', + httpMethod: 'patch', + summary: 'Update a custom channel', + description: + "Update the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.", + stainlessPath: '(resource) conversations.custom_channels > (method) update', + qualified: 'client.conversations.customChannels.update', + params: [ + 'channelId: number;', + 'capabilities: object;', + 'channelAccountConnectionRedirectUrl: object;', + 'channelDescription: object;', + 'channelLogoUrl: object;', + 'name: object;', + 'webhookUrl: object;', + ], + response: + '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', + markdown: + "## update\n\n`client.conversations.customChannels.update(channelId: number, capabilities: object, channelAccountConnectionRedirectUrl: object, channelDescription: object, channelLogoUrl: object, name: object, webhookUrl: object): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}`\n\nUpdate the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.\n\n### Parameters\n\n- `channelId: number`\n\n- `capabilities: object`\n\n- `channelAccountConnectionRedirectUrl: object`\n\n- `channelDescription: object`\n\n- `channelLogoUrl: object`\n\n- `name: object`\n\n- `webhookUrl: object`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.update(0, {\n capabilities: { foo: {} },\n channelAccountConnectionRedirectUrl: {},\n channelDescription: {},\n channelLogoUrl: {},\n name: {},\n webhookUrl: {},\n});\n\nconsole.log(publicChannelIntegrationChannel);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.update(0, {\n capabilities: { foo: {} },\n channelAccountConnectionRedirectUrl: {},\n channelDescription: {},\n channelLogoUrl: {},\n name: {},\n webhookUrl: {},\n});\n\nconsole.log(publicChannelIntegrationChannel.id);", + }, + python: { + method: 'conversations.custom_channels.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npublic_channel_integration_channel = client.conversations.custom_channels.update(\n channel_id=0,\n capabilities={\n "foo": {}\n },\n channel_account_connection_redirect_url={},\n channel_description={},\n channel_logo_url={},\n name={},\n webhook_url={},\n)\nprint(public_channel_integration_channel.id)', + }, + java: { + method: 'conversations().customChannels().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelUpdateParams;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannel;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannelPatch;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelUpdateParams params = CustomChannelUpdateParams.builder()\n .channelId(0)\n .publicChannelIntegrationChannelPatch(PublicChannelIntegrationChannelPatch.builder()\n .capabilities(PublicChannelIntegrationChannelPatch.Capabilities.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .channelAccountConnectionRedirectUrl(JsonValue.from(Map.of()))\n .channelDescription(JsonValue.from(Map.of()))\n .channelLogoUrl(JsonValue.from(Map.of()))\n .name(JsonValue.from(Map.of()))\n .webhookUrl(JsonValue.from(Map.of()))\n .build())\n .build();\n PublicChannelIntegrationChannel publicChannelIntegrationChannel = client.conversations().customChannels().update(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelIntegrationChannel, err := client.Conversations.CustomChannels.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelUpdateParams{\n\t\t\tPublicChannelIntegrationChannelPatch: conversations.PublicChannelIntegrationChannelPatchParam{\n\t\t\t\tCapabilities: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tChannelAccountConnectionRedirectURL: map[string]any{},\n\t\t\t\tChannelDescription: map[string]any{},\n\t\t\t\tChannelLogoURL: map[string]any{},\n\t\t\t\tName: map[string]any{},\n\t\t\t\tWebhookURL: map[string]any{},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelIntegrationChannel.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_integration_channel = hubspot.conversations.custom_channels.update(\n 0,\n capabilities: {foo: {}},\n channel_account_connection_redirect_url: {},\n channel_description: {},\n channel_logo_url: {},\n name: {},\n webhook_url: {}\n)\n\nputs(public_channel_integration_channel)', + }, + php: { + method: 'conversations->customChannels->update', + example: + "conversations\n ->customChannels\n ->update(\n 0,\n capabilities: ['foo' => (object) []],\n channelAccountConnectionRedirectURL: (object) [],\n channelDescription: (object) [],\n channelLogoURL: (object) [],\n name: (object) [],\n webhookURL: (object) [],\n);\n\nvar_dump($publicChannelIntegrationChannel);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "capabilities": {\n "foo": {}\n },\n "channelAccountConnectionRedirectUrl": {},\n "channelDescription": {},\n "channelLogoUrl": {},\n "name": {},\n "webhookUrl": {}\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', + httpMethod: 'post', + summary: 'Create a channel account', + description: + 'Create a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.', + stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) create', + qualified: 'client.conversations.customChannels.channelAccounts.create', + params: [ + 'channelId: number;', + 'authorized: boolean;', + 'inboxId: string;', + 'name: string;', + "deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; };", + ], + response: + "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", + markdown: + "## create\n\n`client.conversations.customChannels.channelAccounts.create(channelId: number, authorized: boolean, inboxId: string, name: string, deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**post** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts`\n\nCreate a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.\n\n### Parameters\n\n- `channelId: number`\n\n- `authorized: boolean`\n\n- `inboxId: string`\n\n- `name: string`\n\n- `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n - `type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'`\n - `value: string`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.create(0, {\n authorized: true,\n inboxId: 'inboxId',\n name: 'name',\n});\n\nconsole.log(publicChannelAccount);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.channelAccounts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.create(0, {\n authorized: true,\n inboxId: 'inboxId',\n name: 'name',\n});\n\nconsole.log(publicChannelAccount.id);", + }, + python: { + method: 'conversations.custom_channels.channel_accounts.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.channel_accounts.create(\n channel_id=0,\n authorized=True,\n inbox_id="inboxId",\n name="name",\n)\nprint(public_channel_account.id)', + }, + java: { + method: 'conversations().customChannels().channelAccounts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountEgg;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountCreateParams params = ChannelAccountCreateParams.builder()\n .channelId(0)\n .publicChannelAccountEgg(PublicChannelAccountEgg.builder()\n .authorized(true)\n .inboxId("inboxId")\n .name("name")\n .build())\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().channelAccounts().create(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.ChannelAccounts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.ChannelAccounts.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountNewParams{\n\t\t\tPublicChannelAccountEgg: conversations.PublicChannelAccountEggParam{\n\t\t\t\tAuthorized: true,\n\t\t\t\tInboxID: "inboxId",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.channel_accounts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.channel_accounts.create(\n 0,\n authorized: true,\n inbox_id: "inboxId",\n name: "name"\n)\n\nputs(public_channel_account)', + }, + php: { + method: 'conversations->customChannels->channelAccounts->create', + example: + "conversations\n ->customChannels\n ->channelAccounts\n ->create(\n 0,\n authorized: true,\n inboxID: 'inboxId',\n name: 'name',\n deliveryIdentifier: [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n);\n\nvar_dump($publicChannelAccount);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "authorized": true,\n "inboxId": "inboxId",\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'list', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', + httpMethod: 'get', + summary: 'Get accounts for a channel', + description: 'Retrieve a list of accounts for a custom channel.', + stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) list', + qualified: 'client.conversations.customChannels.channelAccounts.list', + params: [ + 'channelId: number;', + 'after?: string;', + 'archived?: boolean;', + 'defaultPageLength?: number;', + "deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[];", + 'deliveryIdentifierValue?: string[];', + 'limit?: number;', + 'sort?: string[];', + ], + response: + "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", + markdown: + "## list\n\n`client.conversations.customChannels.channelAccounts.list(channelId: number, after?: string, archived?: boolean, defaultPageLength?: number, deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[], deliveryIdentifierValue?: string[], limit?: number, sort?: string[]): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts`\n\nRetrieve a list of accounts for a custom channel.\n\n### Parameters\n\n- `channelId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `defaultPageLength?: number`\n\n- `deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[]`\n\n- `deliveryIdentifierValue?: string[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelAccount of client.conversations.customChannels.channelAccounts.list(0)) {\n console.log(publicChannelAccount);\n}\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.channelAccounts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelAccount of client.conversations.customChannels.channelAccounts.list(\n 0,\n)) {\n console.log(publicChannelAccount.id);\n}", + }, + python: { + method: 'conversations.custom_channels.channel_accounts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.conversations.custom_channels.channel_accounts.list(\n channel_id=0,\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'conversations().customChannels().channelAccounts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountListPage;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountListPage page = client.conversations().customChannels().channelAccounts().list(0);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.ChannelAccounts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Conversations.CustomChannels.ChannelAccounts.List(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.channel_accounts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.conversations.custom_channels.channel_accounts.list(0)\n\nputs(page)', + }, + php: { + method: 'conversations->customChannels->channelAccounts->list', + example: + "conversations->customChannels->channelAccounts->list(\n 0,\n after: 'after',\n archived: true,\n defaultPageLength: 0,\n deliveryIdentifierType: ['HS_EMAIL_ADDRESS'],\n deliveryIdentifierValue: ['string'],\n limit: 0,\n sort: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', + httpMethod: 'patch', + summary: 'Update a channel account', + description: + "This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.", + stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) update', + qualified: 'client.conversations.customChannels.channelAccounts.update', + params: ['channelId: number;', 'channelAccountId: number;', 'authorized?: boolean;', 'name?: string;'], + response: + "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", + markdown: + "## update\n\n`client.conversations.customChannels.channelAccounts.update(channelId: number, channelAccountId: number, authorized?: boolean, name?: string): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}`\n\nThis API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.\n\n### Parameters\n\n- `channelId: number`\n\n- `channelAccountId: number`\n\n- `authorized?: boolean`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.update(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.channelAccounts.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.update(0, {\n channelId: 0,\n});\n\nconsole.log(publicChannelAccount.id);", + }, + python: { + method: 'conversations.custom_channels.channel_accounts.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.channel_accounts.update(\n channel_account_id=0,\n channel_id=0,\n)\nprint(public_channel_account.id)', + }, + java: { + method: 'conversations().customChannels().channelAccounts().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountUpdateParams params = ChannelAccountUpdateParams.builder()\n .channelId(0)\n .channelAccountId(0L)\n .publicChannelAccountUpdateRequest(PublicChannelAccountUpdateRequest.builder().build())\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().channelAccounts().update(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.ChannelAccounts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.ChannelAccounts.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountUpdateParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelAccountUpdateRequest: conversations.PublicChannelAccountUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.channel_accounts.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.channel_accounts.update(0, channel_id: 0)\n\nputs(public_channel_account)', + }, + php: { + method: 'conversations->customChannels->channelAccounts->update', + example: + "conversations\n ->customChannels\n ->channelAccounts\n ->update(0, channelID: 0, authorized: true, name: 'name');\n\nvar_dump($publicChannelAccount);", + }, + http: { + example: + "curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts/$CHANNEL_ACCOUNT_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_staging_token', + endpoint: + '/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}', + httpMethod: 'patch', + summary: 'Update a channel account staging token', + description: + "Update a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token. This is used for public apps.", + stainlessPath: + '(resource) conversations.custom_channels.channel_accounts > (method) update_staging_token', + qualified: 'client.conversations.customChannels.channelAccounts.updateStagingToken', + params: [ + 'channelId: number;', + 'accountToken: string;', + 'accountName?: string;', + "deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; };", + ], + response: + "{ accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", + markdown: + "## update_staging_token\n\n`client.conversations.customChannels.channelAccounts.updateStagingToken(channelId: number, accountToken: string, accountName?: string, deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }): { accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}`\n\nUpdate a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token. This is used for public apps.\n\n### Parameters\n\n- `channelId: number`\n\n- `accountToken: string`\n\n- `accountName?: string`\n\n- `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n - `type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'`\n - `value: string`\n\n### Returns\n\n- `{ accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `accountToken: string`\n - `createdAt: string`\n - `genericChannelId: number`\n - `inboxId: number`\n - `userId: number`\n - `accountName?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccountStagingToken = await client.conversations.customChannels.channelAccounts.updateStagingToken('accountToken', { channelId: 0 });\n\nconsole.log(publicChannelAccountStagingToken);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.channelAccounts.updateStagingToken', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccountStagingToken =\n await client.conversations.customChannels.channelAccounts.updateStagingToken('accountToken', {\n channelId: 0,\n });\n\nconsole.log(publicChannelAccountStagingToken.accountToken);", + }, + python: { + method: 'conversations.custom_channels.channel_accounts.update_staging_token', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account_staging_token = client.conversations.custom_channels.channel_accounts.update_staging_token(\n account_token="accountToken",\n channel_id=0,\n)\nprint(public_channel_account_staging_token.account_token)', + }, + java: { + method: 'conversations().customChannels().channelAccounts().updateStagingToken', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountStagingToken;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountStagingTokenUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountUpdateStagingTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountUpdateStagingTokenParams params = ChannelAccountUpdateStagingTokenParams.builder()\n .channelId(0)\n .accountToken("accountToken")\n .publicChannelAccountStagingTokenUpdateRequest(PublicChannelAccountStagingTokenUpdateRequest.builder().build())\n .build();\n PublicChannelAccountStagingToken publicChannelAccountStagingToken = client.conversations().customChannels().channelAccounts().updateStagingToken(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.ChannelAccounts.UpdateStagingToken', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccountStagingToken, err := client.Conversations.CustomChannels.ChannelAccounts.UpdateStagingToken(\n\t\tcontext.TODO(),\n\t\t"accountToken",\n\t\tconversations.CustomChannelChannelAccountUpdateStagingTokenParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelAccountStagingTokenUpdateRequest: conversations.PublicChannelAccountStagingTokenUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccountStagingToken.AccountToken)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.channel_accounts.update_staging_token', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account_staging_token = hubspot.conversations.custom_channels.channel_accounts.update_staging_token("accountToken", channel_id: 0)\n\nputs(public_channel_account_staging_token)', + }, + php: { + method: 'conversations->customChannels->channelAccounts->updateStagingToken', + example: + "conversations\n ->customChannels\n ->channelAccounts\n ->updateStagingToken(\n 'accountToken',\n channelID: 0,\n accountName: 'accountName',\n deliveryIdentifier: [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n);\n\nvar_dump($publicChannelAccountStagingToken);", + }, + http: { + example: + "curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-account-staging-tokens/$ACCOUNT_TOKEN \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages', + httpMethod: 'post', + summary: 'Publish a message', + description: 'Publish a message over your custom channel', + stainlessPath: '(resource) conversations.custom_channels.messages > (method) create', + qualified: 'client.conversations.customChannels.messages.create', + params: [ + 'channelId: number;', + "attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[];", + 'channelAccountId: string;', + "messageDirection: 'INCOMING' | 'OUTGOING';", + "recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[];", + "senders: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[];", + 'text: string;', + 'timestamp: string;', + 'associateWithContactId?: number;', + 'inReplyToId?: string;', + 'integrationIdempotencyId?: string;', + 'integrationThreadId?: string;', + 'preResolvedContacts?: { contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]; };', + 'richText?: string;', + ], + response: + "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", + markdown: + "## create\n\n`client.conversations.customChannels.messages.create(channelId: number, attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[], channelAccountId: string, messageDirection: 'INCOMING' | 'OUTGOING', recipients: { deliveryIdentifier: public_delivery_identifier; name?: string; senderActorId?: string; }[], senders: { deliveryIdentifier: public_delivery_identifier; name?: string; senderActorId?: string; }[], text: string, timestamp: string, associateWithContactId?: number, inReplyToId?: string, integrationIdempotencyId?: string, integrationThreadId?: string, preResolvedContacts?: { contacts: pre_resolved_contact[]; }, richText?: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**post** `/conversations/custom-channels/2026-03/{channelId}/messages`\n\nPublish a message over your custom channel\n\n### Parameters\n\n- `channelId: number`\n\n- `attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n\n- `channelAccountId: string`\n\n- `messageDirection: 'INCOMING' | 'OUTGOING'`\n\n- `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[]`\n\n- `senders: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[]`\n\n- `text: string`\n\n- `timestamp: string`\n\n- `associateWithContactId?: number`\n\n- `inReplyToId?: string`\n\n- `integrationIdempotencyId?: string`\n\n- `integrationThreadId?: string`\n\n- `preResolvedContacts?: { contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]; }`\n - `contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]`\n\n- `richText?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.create(0, {\n attachments: [{ fileId: 'fileId', type: 'FILE' }],\n channelAccountId: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n senders: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n text: 'text',\n timestamp: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(publicConversationsMessage);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.messages.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.create(0, {\n attachments: [{ fileId: 'fileId', type: 'FILE' }],\n channelAccountId: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n senders: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n text: 'text',\n timestamp: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(publicConversationsMessage.id);", + }, + python: { + method: 'conversations.custom_channels.messages.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.create(\n channel_id=0,\n attachments=[{\n "file_id": "fileId",\n "type": "FILE",\n }],\n channel_account_id="channelAccountId",\n message_direction="INCOMING",\n recipients=[{\n "delivery_identifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value",\n }\n }],\n senders=[{\n "delivery_identifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value",\n }\n }],\n text="text",\n timestamp=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(public_conversations_message.id)', + }, + java: { + method: 'conversations().customChannels().messages().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.ChannelIntegrationMessageEgg;\nimport com.hubspot.sdk.models.conversations.customchannels.ChannelIntegrationParticipant;\nimport com.hubspot.sdk.models.conversations.customchannels.FileAttachment;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicDeliveryIdentifier;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageCreateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageCreateParams params = MessageCreateParams.builder()\n .channelId(0)\n .channelIntegrationMessageEgg(ChannelIntegrationMessageEgg.builder()\n .addAttachment(FileAttachment.builder()\n .fileId("fileId")\n .type(FileAttachment.Type.FILE)\n .build())\n .channelAccountId("channelAccountId")\n .messageDirection(ChannelIntegrationMessageEgg.MessageDirection.INCOMING)\n .addRecipient(ChannelIntegrationParticipant.builder()\n .deliveryIdentifier(PublicDeliveryIdentifier.builder()\n .type(PublicDeliveryIdentifier.Type.CHANNEL_SPECIFIC_OPAQUE_ID)\n .value("value")\n .build())\n .build())\n .addSender(ChannelIntegrationParticipant.builder()\n .deliveryIdentifier(PublicDeliveryIdentifier.builder()\n .type(PublicDeliveryIdentifier.Type.CHANNEL_SPECIFIC_OPAQUE_ID)\n .value("value")\n .build())\n .build())\n .text("text")\n .timestamp(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().create(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Messages.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelMessageNewParams{\n\t\t\tChannelIntegrationMessageEgg: conversations.ChannelIntegrationMessageEggParam{\n\t\t\t\tAttachments: []conversations.ChannelIntegrationMessageEggAttachmentUnionParam{{\n\t\t\t\t\tOfFile: &conversations.FileAttachmentParam{\n\t\t\t\t\t\tFileID: "fileId",\n\t\t\t\t\t\tType: conversations.FileAttachmentTypeFile,\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tChannelAccountID: "channelAccountId",\n\t\t\t\tMessageDirection: conversations.ChannelIntegrationMessageEggMessageDirectionIncoming,\n\t\t\t\tRecipients: []conversations.ChannelIntegrationParticipantParam{{\n\t\t\t\t\tDeliveryIdentifier: conversations.PublicDeliveryIdentifierParam{\n\t\t\t\t\t\tType: conversations.PublicDeliveryIdentifierTypeChannelSpecificOpaqueID,\n\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tSenders: []conversations.ChannelIntegrationParticipantParam{{\n\t\t\t\t\tDeliveryIdentifier: conversations.PublicDeliveryIdentifierParam{\n\t\t\t\t\t\tType: conversations.PublicDeliveryIdentifierTypeChannelSpecificOpaqueID,\n\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tText: "text",\n\t\t\t\tTimestamp: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.messages.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.create(\n 0,\n attachments: [{fileId: "fileId", type: :FILE}],\n channel_account_id: "channelAccountId",\n message_direction: :INCOMING,\n recipients: [{deliveryIdentifier: {type: :CHANNEL_SPECIFIC_OPAQUE_ID, value: "value"}}],\n senders: [{deliveryIdentifier: {type: :CHANNEL_SPECIFIC_OPAQUE_ID, value: "value"}}],\n text: "text",\n timestamp: "2019-12-27T18:11:19.117Z"\n)\n\nputs(public_conversations_message)', + }, + php: { + method: 'conversations->customChannels->messages->create', + example: + "conversations\n ->customChannels\n ->messages\n ->create(\n 0,\n attachments: [\n ['fileID' => 'fileId', 'type' => 'FILE', 'fileUsageType' => 'AUDIO']\n ],\n channelAccountID: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [\n [\n 'deliveryIdentifier' => [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n 'name' => 'name',\n 'senderActorID' => 'senderActorId',\n ],\n ],\n senders: [\n [\n 'deliveryIdentifier' => [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n 'name' => 'name',\n 'senderActorID' => 'senderActorId',\n ],\n ],\n text: 'text',\n timestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n associateWithContactID: 0,\n inReplyToID: 'inReplyToId',\n integrationIdempotencyID: 'integrationIdempotencyId',\n integrationThreadID: 'integrationThreadId',\n preResolvedContacts: [\n 'contacts' => [\n ['contactPropertiesLeadingToMatch' => ['address'], 'contactVid' => 0]\n ],\n ],\n richText: 'richText',\n);\n\nvar_dump($publicConversationsMessage);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "attachments": [\n {\n "fileId": "fileId",\n "type": "FILE"\n }\n ],\n "channelAccountId": "channelAccountId",\n "messageDirection": "INCOMING",\n "recipients": [\n {\n "deliveryIdentifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value"\n }\n }\n ],\n "senders": [\n {\n "deliveryIdentifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value"\n }\n }\n ],\n "text": "text",\n "timestamp": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', + httpMethod: 'get', + summary: 'Get a message', + description: 'Get the details for a specific message sent over a custom channel', + stainlessPath: '(resource) conversations.custom_channels.messages > (method) get', + qualified: 'client.conversations.customChannels.messages.get', + params: ['channelId: number;', 'messageId: string;'], + response: + "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", + markdown: + "## get\n\n`client.conversations.customChannels.messages.get(channelId: number, messageId: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}`\n\nGet the details for a specific message sent over a custom channel\n\n### Parameters\n\n- `channelId: number`\n\n- `messageId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.get('messageId', { channelId: 0 });\n\nconsole.log(publicConversationsMessage);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.messages.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.get(\n 'messageId',\n { channelId: 0 },\n);\n\nconsole.log(publicConversationsMessage.id);", + }, + python: { + method: 'conversations.custom_channels.messages.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.get(\n message_id="messageId",\n channel_id=0,\n)\nprint(public_conversations_message.id)', + }, + java: { + method: 'conversations().customChannels().messages().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageGetParams params = MessageGetParams.builder()\n .channelId(0)\n .messageId("messageId")\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().get(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Messages.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.Get(\n\t\tcontext.TODO(),\n\t\t"messageId",\n\t\tconversations.CustomChannelMessageGetParams{\n\t\t\tChannelID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.messages.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.get("messageId", channel_id: 0)\n\nputs(public_conversations_message)', + }, + php: { + method: 'conversations->customChannels->messages->get', + example: + "conversations\n ->customChannels\n ->messages\n ->get('messageId', channelID: 0);\n\nvar_dump($publicConversationsMessage);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages/$MESSAGE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', + httpMethod: 'patch', + summary: 'Update a message ', + description: + "Update a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure.", + stainlessPath: '(resource) conversations.custom_channels.messages > (method) update', + qualified: 'client.conversations.customChannels.messages.update', + params: [ + 'channelId: number;', + 'messageId: string;', + "statusType: 'FAILED' | 'READ' | 'SENT';", + 'errorMessage?: string;', + ], + response: + "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", + markdown: + "## update\n\n`client.conversations.customChannels.messages.update(channelId: number, messageId: string, statusType: 'FAILED' | 'READ' | 'SENT', errorMessage?: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}`\n\nUpdate a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure.\n\n### Parameters\n\n- `channelId: number`\n\n- `messageId: string`\n\n- `statusType: 'FAILED' | 'READ' | 'SENT'`\n Valid status are SENT, FAILED, and READ\n\n- `errorMessage?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.update('messageId', { channelId: 0, statusType: 'FAILED' });\n\nconsole.log(publicConversationsMessage);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.customChannels.messages.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.update(\n 'messageId',\n { channelId: 0, statusType: 'FAILED' },\n);\n\nconsole.log(publicConversationsMessage.id);", + }, + python: { + method: 'conversations.custom_channels.messages.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.update(\n message_id="messageId",\n channel_id=0,\n status_type="FAILED",\n)\nprint(public_conversations_message.id)', + }, + java: { + method: 'conversations().customChannels().messages().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationMessageUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageUpdateParams params = MessageUpdateParams.builder()\n .channelId(0)\n .messageId("messageId")\n .publicChannelIntegrationMessageUpdateRequest(PublicChannelIntegrationMessageUpdateRequest.builder()\n .statusType(PublicChannelIntegrationMessageUpdateRequest.StatusType.FAILED)\n .build())\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().update(params);\n }\n}', + }, + go: { + method: 'client.Conversations.CustomChannels.Messages.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.Update(\n\t\tcontext.TODO(),\n\t\t"messageId",\n\t\tconversations.CustomChannelMessageUpdateParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelIntegrationMessageUpdateRequest: conversations.PublicChannelIntegrationMessageUpdateRequestParam{\n\t\t\t\tStatusType: conversations.PublicChannelIntegrationMessageUpdateRequestStatusTypeFailed,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', + }, + ruby: { + method: 'conversations.custom_channels.messages.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.update("messageId", channel_id: 0, status_type: :FAILED)\n\nputs(public_conversations_message)', + }, + php: { + method: 'conversations->customChannels->messages->update', + example: + "conversations\n ->customChannels\n ->messages\n ->update(\n 'messageId', channelID: 0, statusType: 'FAILED', errorMessage: 'errorMessage'\n);\n\nvar_dump($publicConversationsMessage);", + }, + http: { + example: + 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages/$MESSAGE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "statusType": "FAILED"\n }\'', + }, + }, + }, + { + name: 'generate_token', + endpoint: '/visitor-identification/2026-03/tokens/create', + httpMethod: 'post', + summary: 'Generate visitor token', + description: + 'Generate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This allows support agents to recognize and assist the visitor more effectively.', + stainlessPath: '(resource) conversations.visitor_identification > (method) generate_token', + qualified: 'client.conversations.visitorIdentification.generateToken', + params: ['email: string;', 'firstName?: string;', 'lastName?: string;'], + response: '{ token: string; }', + markdown: + "## generate_token\n\n`client.conversations.visitorIdentification.generateToken(email: string, firstName?: string, lastName?: string): { token: string; }`\n\n**post** `/visitor-identification/2026-03/tokens/create`\n\nGenerate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This allows support agents to recognize and assist the visitor more effectively.\n\n### Parameters\n\n- `email: string`\n The email of the visitor that you wish to identify\n\n- `firstName?: string`\n The first name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where first name is unknown. Optional.\n\n- `lastName?: string`\n The last name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where last name is unknown. Optional.\n\n### Returns\n\n- `{ token: string; }`\n\n - `token: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst identificationTokenResponse = await client.conversations.visitorIdentification.generateToken({ email: 'email' });\n\nconsole.log(identificationTokenResponse);\n```", + perLanguage: { + typescript: { + method: 'client.conversations.visitorIdentification.generateToken', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst identificationTokenResponse = await client.conversations.visitorIdentification.generateToken({\n email: 'email',\n});\n\nconsole.log(identificationTokenResponse.token);", + }, + python: { + method: 'conversations.visitor_identification.generate_token', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nidentification_token_response = client.conversations.visitor_identification.generate_token(\n email="email",\n)\nprint(identification_token_response.token)', + }, + java: { + method: 'conversations().visitorIdentification().generateToken', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.visitoridentification.IdentificationTokenGenerationRequest;\nimport com.hubspot.sdk.models.conversations.visitoridentification.IdentificationTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IdentificationTokenGenerationRequest params = IdentificationTokenGenerationRequest.builder()\n .email("email")\n .build();\n IdentificationTokenResponse identificationTokenResponse = client.conversations().visitorIdentification().generateToken(params);\n }\n}', + }, + go: { + method: 'client.Conversations.VisitorIdentification.GenerateToken', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tidentificationTokenResponse, err := client.Conversations.VisitorIdentification.GenerateToken(context.TODO(), conversations.VisitorIdentificationGenerateTokenParams{\n\t\tIdentificationTokenGenerationRequest: conversations.IdentificationTokenGenerationRequestParam{\n\t\t\tEmail: "email",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", identificationTokenResponse.Token)\n}\n', + }, + ruby: { + method: 'conversations.visitor_identification.generate_token', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nidentification_token_response = hubspot.conversations.visitor_identification.generate_token(email: "email")\n\nputs(identification_token_response)', + }, + php: { + method: 'conversations->visitorIdentification->generateToken', + example: + "conversations\n ->visitorIdentification\n ->generateToken(email: 'email', firstName: 'firstName', lastName: 'lastName');\n\nvar_dump($identificationTokenResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/visitor-identification/2026-03/tokens/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email"\n }\'', + }, + }, + }, + { + name: 'uninstall', + endpoint: '/appinstalls/2026-03/external-install', + httpMethod: 'delete', + summary: 'Uninstall app', + description: + "Use this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account.", + stainlessPath: '(resource) crm.app_uninstalls > (method) uninstall', + qualified: 'client.crm.appUninstalls.uninstall', + markdown: + "## uninstall\n\n`client.crm.appUninstalls.uninstall(): void`\n\n**delete** `/appinstalls/2026-03/external-install`\n\nUse this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.appUninstalls.uninstall()\n```", + perLanguage: { + typescript: { + method: 'client.crm.appUninstalls.uninstall', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.appUninstalls.uninstall();", + }, + python: { + method: 'crm.app_uninstalls.uninstall', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.app_uninstalls.uninstall()', + }, + java: { + method: 'crm().appUninstalls().uninstall', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.appuninstalls.AppUninstallUninstallParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().appUninstalls().uninstall();\n }\n}', + }, + go: { + method: 'client.Crm.AppUninstalls.Uninstall', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AppUninstalls.Uninstall(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.app_uninstalls.uninstall', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.app_uninstalls.uninstall\n\nputs(result)', + }, + php: { + method: 'crm->appUninstalls->uninstall', + example: + "crm->appUninstalls->uninstall();\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/appinstalls/2026-03/external-install \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: + '/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}', + httpMethod: 'put', + summary: 'Associate records (default)', + description: 'Create the default (most generic) association type between two object types', + stainlessPath: '(resource) crm.associations > (method) create', + qualified: 'client.crm.associations.create', + params: [ + 'fromObjectType: string;', + 'fromObjectId: string;', + 'toObjectType: string;', + 'toObjectId: string;', + ], + response: + "{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.associations.create(fromObjectType: string, fromObjectId: string, toObjectType: string, toObjectId: string): { completedAt: string; results: public_default_association[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**put** `/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}`\n\nCreate the default (most generic) association type between two object types\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `fromObjectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n### Returns\n\n- `{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n The response returned after performing a batch operation on associations.\n\n - `completedAt: string`\n - `results: { associationSpec: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }; from: { id: string; }; to: { id: string; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.create('toObjectId', {\n fromObjectType: 'fromObjectType',\n fromObjectId: 'fromObjectId',\n toObjectType: 'toObjectType',\n});\n\nconsole.log(batchResponsePublicDefaultAssociation);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.create('toObjectId', {\n fromObjectType: 'fromObjectType',\n fromObjectId: 'fromObjectId',\n toObjectType: 'toObjectType',\n});\n\nconsole.log(batchResponsePublicDefaultAssociation.completedAt);", + }, + python: { + method: 'crm.associations.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_default_association = client.crm.associations.create(\n to_object_id="toObjectId",\n from_object_type="fromObjectType",\n from_object_id="fromObjectId",\n to_object_type="toObjectType",\n)\nprint(batch_response_public_default_association.completed_at)', + }, + java: { + method: 'crm().associations().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicDefaultAssociation;\nimport com.hubspot.sdk.models.crm.associations.AssociationCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationCreateParams params = AssociationCreateParams.builder()\n .fromObjectType("fromObjectType")\n .fromObjectId("fromObjectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .build();\n BatchResponsePublicDefaultAssociation batchResponsePublicDefaultAssociation = client.crm().associations().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicDefaultAssociation, err := client.Crm.Associations.New(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tFromObjectID: "fromObjectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicDefaultAssociation.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_default_association = hubspot.crm.associations.create(\n "toObjectId",\n from_object_type: "fromObjectType",\n from_object_id: "fromObjectId",\n to_object_type: "toObjectType"\n)\n\nputs(batch_response_public_default_association)', + }, + php: { + method: 'crm->associations->create', + example: + "crm->associations->create(\n 'toObjectId',\n fromObjectType: 'fromObjectType',\n fromObjectID: 'fromObjectId',\n toObjectType: 'toObjectType',\n);\n\nvar_dump($batchResponsePublicDefaultAssociation);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$FROM_OBJECT_TYPE/$FROM_OBJECT_ID/associations/default/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', + httpMethod: 'delete', + summary: 'Delete associations between two records', + description: 'deletes all associations between two records.', + stainlessPath: '(resource) crm.associations > (method) delete', + qualified: 'client.crm.associations.delete', + params: ['objectType: string;', 'objectId: string;', 'toObjectType: string;', 'toObjectId: string;'], + markdown: + "## delete\n\n`client.crm.associations.delete(objectType: string, objectId: string, toObjectType: string, toObjectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`\n\ndeletes all associations between two records.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.delete('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n})\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.delete('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n});", + }, + python: { + method: 'crm.associations.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.delete(\n to_object_id="toObjectId",\n object_type="objectType",\n object_id="objectId",\n to_object_type="toObjectType",\n)', + }, + java: { + method: 'crm().associations().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associations.AssociationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationDeleteParams params = AssociationDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .build();\n client.crm().associations().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Delete(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.delete(\n "toObjectId",\n object_type: "objectType",\n object_id_: "objectId",\n to_object_type: "toObjectType"\n)\n\nputs(result)', + }, + php: { + method: 'crm->associations->delete', + example: + "crm->associations->delete(\n 'toObjectId',\n objectType: 'objectType',\n objectID: 'objectId',\n toObjectType: 'toObjectType',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}', + httpMethod: 'get', + summary: 'Retrieve all associations by object type', + description: + 'Retrieve all associations between a specific record and an object type. Limit 500 per call.', + stainlessPath: '(resource) crm.associations > (method) list', + qualified: 'client.crm.associations.list', + params: [ + 'objectType: string;', + 'objectId: string;', + 'toObjectType: string;', + 'after?: string;', + 'limit?: number;', + ], + response: + "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", + markdown: + "## list\n\n`client.crm.associations.list(objectType: string, objectId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}`\n\nRetrieve all associations between a specific record and an object type. Limit 500 per call.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.associations.list('toObjectType', { objectType: 'objectType', objectId: 'objectId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.associations.list('toObjectType', {\n objectType: 'objectType',\n objectId: 'objectId',\n})) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", + }, + python: { + method: 'crm.associations.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.associations.list(\n to_object_type="toObjectType",\n object_type="objectType",\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.association_types)', + }, + java: { + method: 'crm().associations().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associations.AssociationListPage;\nimport com.hubspot.sdk.models.crm.associations.AssociationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationListParams params = AssociationListParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .build();\n AssociationListPage page = client.crm().associations().list(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Associations.List(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationListParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.associations.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.associations.list("toObjectType", object_type: "objectType", object_id_: "objectId")\n\nputs(page)', + }, + php: { + method: 'crm->associations->list', + example: + "crm->associations->list(\n 'toObjectType',\n objectType: 'objectType',\n objectID: 'objectId',\n after: 'after',\n limit: 0,\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'request_high_usage_report', + endpoint: '/crm/associations/2026-03/usage/high-usage-report/{userId}', + httpMethod: 'post', + summary: 'Report high usage', + description: 'Requests a report of all objects in the portal which have a high usage of associations', + stainlessPath: '(resource) crm.associations > (method) request_high_usage_report', + qualified: 'client.crm.associations.requestHighUsageReport', + params: ['userId: number;'], + response: + '{ enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }; userEmail: string; userId: number; }', + markdown: + "## request_high_usage_report\n\n`client.crm.associations.requestHighUsageReport(userId: number): { enqueueTime: date_time; userEmail: string; userId: number; }`\n\n**post** `/crm/associations/2026-03/usage/high-usage-report/{userId}`\n\nRequests a report of all objects in the portal which have a high usage of associations\n\n### Parameters\n\n- `userId: number`\n\n### Returns\n\n- `{ enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }; userEmail: string; userId: number; }`\n\n - `enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }`\n - `userEmail: string`\n - `userId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst reportCreationResponse = await client.crm.associations.requestHighUsageReport(0);\n\nconsole.log(reportCreationResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.requestHighUsageReport', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst reportCreationResponse = await client.crm.associations.requestHighUsageReport(0);\n\nconsole.log(reportCreationResponse.enqueueTime);", + }, + python: { + method: 'crm.associations.request_high_usage_report', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nreport_creation_response = client.crm.associations.request_high_usage_report(\n 0,\n)\nprint(report_creation_response.enqueue_time)', + }, + java: { + method: 'crm().associations().requestHighUsageReport', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.ReportCreationResponse;\nimport com.hubspot.sdk.models.crm.associations.AssociationRequestHighUsageReportParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ReportCreationResponse reportCreationResponse = client.crm().associations().requestHighUsageReport(0);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.RequestHighUsageReport', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\treportCreationResponse, err := client.Crm.Associations.RequestHighUsageReport(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", reportCreationResponse.EnqueueTime)\n}\n', + }, + ruby: { + method: 'crm.associations.request_high_usage_report', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nreport_creation_response = hubspot.crm.associations.request_high_usage_report(0)\n\nputs(report_creation_response)', + }, + php: { + method: 'crm->associations->requestHighUsageReport', + example: + "crm->associations->requestHighUsageReport(0);\n\nvar_dump($reportCreationResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/usage/high-usage-report/$USER_ID \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/{objectType}/search', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.associations > (method) search', + qualified: 'client.crm.associations.search', + params: [ + 'objectType: string;', + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.associations.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.associations.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.associations.search(\n 'objectType',\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.associations.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.associations.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().associations().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.associations.AssociationSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationSearchParams params = AssociationSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().associations().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Associations.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.AssociationSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.associations.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.associations.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->associations->search', + example: + "crm\n ->associations\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update_labels', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', + httpMethod: 'put', + summary: 'Associate records (labelled)', + description: 'Set association labels between two records.', + stainlessPath: '(resource) crm.associations > (method) update_labels', + qualified: 'client.crm.associations.updateLabels', + params: [ + 'objectType: string;', + 'objectId: string;', + 'toObjectType: string;', + 'toObjectId: string;', + "body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[];", + ], + response: + '{ fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }', + markdown: + "## update_labels\n\n`client.crm.associations.updateLabels(objectType: string, objectId: string, toObjectType: string, toObjectId: string, body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]): { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }`\n\n**put** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`\n\nSet association labels between two records.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n- `body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]`\n\n### Returns\n\n- `{ fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }`\n The relationship descriptors applicable between two object types.\n\n - `fromObjectId: string`\n - `fromObjectTypeId: string`\n - `labels: string[]`\n - `toObjectId: string`\n - `toObjectTypeId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst labelsBetweenObjectPair = await client.crm.associations.updateLabels('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n body: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n});\n\nconsole.log(labelsBetweenObjectPair);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.updateLabels', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst labelsBetweenObjectPair = await client.crm.associations.updateLabels('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n body: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n});\n\nconsole.log(labelsBetweenObjectPair.fromObjectId);", + }, + python: { + method: 'crm.associations.update_labels', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlabels_between_object_pair = client.crm.associations.update_labels(\n to_object_id="toObjectId",\n object_type="objectType",\n object_id="objectId",\n to_object_type="toObjectType",\n body=[{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n)\nprint(labels_between_object_pair.from_object_id)', + }, + java: { + method: 'crm().associations().updateLabels', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.crm.LabelsBetweenObjectPair;\nimport com.hubspot.sdk.models.crm.associations.AssociationUpdateLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationUpdateLabelsParams params = AssociationUpdateLabelsParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .addBody(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build();\n LabelsBetweenObjectPair labelsBetweenObjectPair = client.crm().associations().updateLabels(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.UpdateLabels', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlabelsBetweenObjectPair, err := client.Crm.Associations.UpdateLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationUpdateLabelsParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t\tBody: []shared.AssociationSpecParam{{\n\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t}},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", labelsBetweenObjectPair.FromObjectID)\n}\n', + }, + ruby: { + method: 'crm.associations.update_labels', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlabels_between_object_pair = hubspot.crm.associations.update_labels(\n "toObjectId",\n object_type: "objectType",\n object_id_: "objectId",\n to_object_type: "toObjectType",\n body: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]\n)\n\nputs(labels_between_object_pair)', + }, + php: { + method: 'crm->associations->updateLabels', + example: + "crm->associations->updateLabels(\n 'toObjectId',\n objectType: 'objectType',\n objectID: 'objectId',\n toObjectType: 'toObjectType',\n body: [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n);\n\nvar_dump($labelsBetweenObjectPair);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create', + httpMethod: 'post', + summary: 'Associate records (labelled)', + description: 'Batch create associations for objects', + stainlessPath: '(resource) crm.associations.batch > (method) create', + qualified: 'client.crm.associations.batch.create', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + "inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + ], + response: + "{ completedAt: string; results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.associations.batch.create(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; types: association_spec[]; }[]): { completedAt: string; results: labels_between_object_pair[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create`\n\nBatch create associations for objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseLabelsBetweenObjectPair = await client.crm.associations.batch.create('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}] });\n\nconsole.log(batchResponseLabelsBetweenObjectPair);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseLabelsBetweenObjectPair = await client.crm.associations.batch.create(\n 'toObjectType',\n {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n },\n);\n\nconsole.log(batchResponseLabelsBetweenObjectPair.completedAt);", + }, + python: { + method: 'crm.associations.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_labels_between_object_pair = client.crm.associations.batch.create(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n)\nprint(batch_response_labels_between_object_pair.completed_at)', + }, + java: { + method: 'crm().associations().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.BatchResponseLabelsBetweenObjectPair;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiPost(BatchInputPublicAssociationMultiPost.builder()\n .addInput(PublicAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .build())\n .build();\n BatchResponseLabelsBetweenObjectPair batchResponseLabelsBetweenObjectPair = client.crm().associations().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseLabelsBetweenObjectPair, err := client.Crm.Associations.Batch.New(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiPost: crm.BatchInputPublicAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseLabelsBetweenObjectPair.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_labels_between_object_pair = hubspot.crm.associations.batch.create(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}]\n)\n\nputs(batch_response_labels_between_object_pair)', + }, + php: { + method: 'crm->associations->batch->create', + example: + "crm\n ->associations\n ->batch\n ->create(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n [\n 'from' => ['id' => 'id'],\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n);\n\nvar_dump($batchResponseLabelsBetweenObjectPair);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_default', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default', + httpMethod: 'post', + summary: 'Associate records (default)', + description: 'Create the default (most generic) association type between two object types', + stainlessPath: '(resource) crm.associations.batch > (method) create_default', + qualified: 'client.crm.associations.batch.createDefault', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'inputs: { from: { id: string; }; to: { id: string; }; }[];', + ], + response: + "{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create_default\n\n`client.crm.associations.batch.createDefault(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; }[]): { completedAt: string; results: public_default_association[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default`\n\nCreate the default (most generic) association type between two object types\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n The response returned after performing a batch operation on associations.\n\n - `completedAt: string`\n - `results: { associationSpec: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }; from: { id: string; }; to: { id: string; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.batch.createDefault('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n}] });\n\nconsole.log(batchResponsePublicDefaultAssociation);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.batch.createDefault', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.batch.createDefault(\n 'toObjectType',\n {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n },\n ],\n },\n);\n\nconsole.log(batchResponsePublicDefaultAssociation.completedAt);", + }, + python: { + method: 'crm.associations.batch.create_default', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_default_association = client.crm.associations.batch.create_default(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n }],\n)\nprint(batch_response_public_default_association.completed_at)', + }, + java: { + method: 'crm().associations().batch().createDefault', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicDefaultAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicDefaultAssociation;\nimport com.hubspot.sdk.models.crm.PublicDefaultAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchCreateDefaultParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateDefaultParams params = BatchCreateDefaultParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicDefaultAssociationMultiPost(BatchInputPublicDefaultAssociationMultiPost.builder()\n .addInput(PublicDefaultAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .build())\n .build())\n .build();\n BatchResponsePublicDefaultAssociation batchResponsePublicDefaultAssociation = client.crm().associations().batch().createDefault(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Batch.NewDefault', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicDefaultAssociation, err := client.Crm.Associations.Batch.NewDefault(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchNewDefaultParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicDefaultAssociationMultiPost: crm.BatchInputPublicDefaultAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicDefaultAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicDefaultAssociation.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations.batch.create_default', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_default_association = hubspot.crm.associations.batch.create_default(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}}]\n)\n\nputs(batch_response_public_default_association)', + }, + php: { + method: 'crm->associations->batch->createDefault', + example: + "crm\n ->associations\n ->batch\n ->createDefault(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['from' => ['id' => 'id'], 'to' => ['id' => 'id']]],\n);\n\nvar_dump($batchResponsePublicDefaultAssociation);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/associate/default \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive', + httpMethod: 'post', + summary: 'Remove associations', + description: 'Batch delete associations for objects', + stainlessPath: '(resource) crm.associations.batch > (method) delete', + qualified: 'client.crm.associations.batch.delete', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'inputs: { from: { id: string; }; to: { id: string; }[]; }[];', + ], + markdown: + "## delete\n\n`client.crm.associations.batch.delete(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id[]; }[]): void`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive`\n\nBatch delete associations for objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.batch.delete('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: [{ id: 'id' }],\n}] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.batch.delete('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: [{ id: 'id' }],\n },\n ],\n});", + }, + python: { + method: 'crm.associations.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.batch.delete(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": [{\n "id": "id"\n }],\n }],\n)', + }, + java: { + method: 'crm().associations().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiArchive;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiArchive;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiArchive(BatchInputPublicAssociationMultiArchive.builder()\n .addInput(PublicAssociationMultiArchive.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .addTo(PublicObjectId.builder()\n .id("id")\n .build())\n .build())\n .build())\n .build();\n client.crm().associations().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchDeleteParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiArchive: crm.BatchInputPublicAssociationMultiArchiveParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiArchiveParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: []shared.PublicObjectIDParam{{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.batch.delete(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: [{id: "id"}]}]\n)\n\nputs(result)', + }, + php: { + method: 'crm->associations->batch->delete', + example: + "crm->associations->batch->delete(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['from' => ['id' => 'id'], 'to' => [['id' => 'id']]]],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": [\n {\n "id": "id"\n }\n ]\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_labels', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive', + httpMethod: 'post', + summary: 'Delete specific labels', + description: + 'Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects', + stainlessPath: '(resource) crm.associations.batch > (method) delete_labels', + qualified: 'client.crm.associations.batch.deleteLabels', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + "inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + ], + markdown: + "## delete_labels\n\n`client.crm.associations.batch.deleteLabels(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; types: association_spec[]; }[]): void`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive`\n\nBatch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.batch.deleteLabels('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.batch.deleteLabels', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.batch.deleteLabels('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n});", + }, + python: { + method: 'crm.associations.batch.delete_labels', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.batch.delete_labels(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n)', + }, + java: { + method: 'crm().associations().batch().deleteLabels', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchDeleteLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteLabelsParams params = BatchDeleteLabelsParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiPost(BatchInputPublicAssociationMultiPost.builder()\n .addInput(PublicAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .build())\n .build();\n client.crm().associations().batch().deleteLabels(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Batch.DeleteLabels', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Batch.DeleteLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchDeleteLabelsParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiPost: crm.BatchInputPublicAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations.batch.delete_labels', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.batch.delete_labels(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}]\n)\n\nputs(result)', + }, + php: { + method: 'crm->associations->batch->deleteLabels', + example: + "crm->associations->batch->deleteLabels(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n [\n 'from' => ['id' => 'id'],\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/labels/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read', + httpMethod: 'post', + summary: 'Retrieve associations', + description: + "Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.", + stainlessPath: '(resource) crm.associations.batch > (method) get', + qualified: 'client.crm.associations.batch.get', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'inputs: { id: string; after?: string; }[];', + ], + response: + "{ completedAt: string; results: { from: public_object_id; to: multi_associated_object_with_label[]; paging?: paging; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.associations.batch.get(fromObjectType: string, toObjectType: string, inputs: { id: string; after?: string; }[]): { completedAt: string; results: public_association_multi_with_label[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read`\n\nBatch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { id: string; after?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { from: public_object_id; to: multi_associated_object_with_label[]; paging?: paging; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { from: { id: string; }; to: { associationTypes: association_spec_with_label[]; toObjectId: string; }[]; paging?: { next?: next_page; prev?: previous_page; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationMultiWithLabel = await client.crm.associations.batch.get('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponsePublicAssociationMultiWithLabel);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associations.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationMultiWithLabel = await client.crm.associations.batch.get(\n 'toObjectType',\n { fromObjectType: 'fromObjectType', inputs: [{ id: 'id' }] },\n);\n\nconsole.log(batchResponsePublicAssociationMultiWithLabel.completedAt);", + }, + python: { + method: 'crm.associations.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_multi_with_label = client.crm.associations.batch.get(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_public_association_multi_with_label.completed_at)', + }, + java: { + method: 'crm().associations().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.BatchInputPublicFetchAssociationsBatchRequest;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicAssociationMultiWithLabel;\nimport com.hubspot.sdk.models.crm.PublicFetchAssociationsBatchRequest;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicFetchAssociationsBatchRequest(BatchInputPublicFetchAssociationsBatchRequest.builder()\n .addInput(PublicFetchAssociationsBatchRequest.builder()\n .id("id")\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationMultiWithLabel batchResponsePublicAssociationMultiWithLabel = client.crm().associations().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Associations.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationMultiWithLabel, err := client.Crm.Associations.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchGetParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicFetchAssociationsBatchRequest: crm.BatchInputPublicFetchAssociationsBatchRequestParam{\n\t\t\t\tInputs: []crm.PublicFetchAssociationsBatchRequestParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationMultiWithLabel.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_multi_with_label = hubspot.crm.associations.batch.get(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{id: "id"}]\n)\n\nputs(batch_response_public_association_multi_with_label)', + }, + php: { + method: 'crm->associations->batch->get', + example: + "crm\n ->associations\n ->batch\n ->get(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['id' => 'id', 'after' => 'after']],\n);\n\nvar_dump($batchResponsePublicAssociationMultiWithLabel);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'batch_create', + endpoint: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create', + httpMethod: 'post', + summary: 'Configure association limits', + description: 'Batch configure association limits between two object types.', + stainlessPath: '(resource) crm.associations_schema.labels > (method) batch_create', + qualified: 'client.crm.associationsSchema.labels.batchCreate', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + "inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[];", + ], + response: + "{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## batch_create\n\n`client.crm.associationsSchema.labels.batchCreate(fromObjectType: string, toObjectType: string, inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]): { completedAt: string; results: public_association_definition_user_configuration[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create`\n\nBatch configure association limits between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationDefinitionUserConfiguration = await client.crm.associationsSchema.labels.batchCreate('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n}] });\n\nconsole.log(batchResponsePublicAssociationDefinitionUserConfiguration);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.labels.batchCreate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationDefinitionUserConfiguration =\n await client.crm.associationsSchema.labels.batchCreate('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicAssociationDefinitionUserConfiguration.completedAt);", + }, + python: { + method: 'crm.associations_schema.labels.batch_create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_definition_user_configuration = client.crm.associations_schema.labels.batch_create(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "HUBSPOT_DEFINED",\n "max_to_object_ids": 0,\n "type_id": 0,\n }],\n)\nprint(batch_response_public_association_definition_user_configuration.completed_at)', + }, + java: { + method: 'crm().associationsSchema().labels().batchCreate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationDefinitionConfigurationCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchResponsePublicAssociationDefinitionUserConfiguration;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionConfigurationCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelBatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelBatchCreateParams params = LabelBatchCreateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationDefinitionConfigurationCreateRequest(BatchInputPublicAssociationDefinitionConfigurationCreateRequest.builder()\n .addInput(PublicAssociationDefinitionConfigurationCreateRequest.builder()\n .category(PublicAssociationDefinitionConfigurationCreateRequest.Category.HUBSPOT_DEFINED)\n .maxToObjectIds(0)\n .typeId(0)\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationDefinitionUserConfiguration batchResponsePublicAssociationDefinitionUserConfiguration = client.crm().associationsSchema().labels().batchCreate(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Labels.BatchNew', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationDefinitionUserConfiguration, err := client.Crm.AssociationsSchema.Labels.BatchNew(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelBatchNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationDefinitionConfigurationCreateRequest: crm.BatchInputPublicAssociationDefinitionConfigurationCreateRequestParam{\n\t\t\t\tInputs: []crm.PublicAssociationDefinitionConfigurationCreateRequestParam{{\n\t\t\t\t\tCategory: crm.PublicAssociationDefinitionConfigurationCreateRequestCategoryHubSpotDefined,\n\t\t\t\t\tMaxToObjectIDs: 0,\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationDefinitionUserConfiguration.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.labels.batch_create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_definition_user_configuration = hubspot.crm.associations_schema.labels.batch_create(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: :HUBSPOT_DEFINED, maxToObjectIds: 0, typeId: 0}]\n)\n\nputs(batch_response_public_association_definition_user_configuration)', + }, + php: { + method: 'crm->associationsSchema->labels->batchCreate', + example: + "crm\n ->associationsSchema\n ->labels\n ->batchCreate(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n ['category' => 'HUBSPOT_DEFINED', 'maxToObjectIDs' => 0, 'typeID' => 0]\n ],\n);\n\nvar_dump($batchResponsePublicAssociationDefinitionUserConfiguration);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "HUBSPOT_DEFINED",\n "maxToObjectIds": 0,\n "typeId": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_label', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + httpMethod: 'post', + summary: 'Create association label', + description: + 'Create a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively.', + stainlessPath: '(resource) crm.associations_schema.labels > (method) create_label', + qualified: 'client.crm.associationsSchema.labels.createLabel', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'label: string;', + 'name: string;', + 'inverseLabel?: string;', + ], + response: + "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }", + markdown: + "## create_label\n\n`client.crm.associationsSchema.labels.createLabel(fromObjectType: string, toObjectType: string, label: string, name: string, inverseLabel?: string): { results: association_spec_with_label[]; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nCreate a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `label: string`\n A descriptor that provides context about the relationship between two associated CRM objects.\n\n- `name: string`\n The unique identifier for the association definition.\n\n- `inverseLabel?: string`\n An optional descriptor that clarifies the reverse relationship in the association.\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationSpecWithLabelNoPaging = await client.crm.associationsSchema.labels.createLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n});\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.labels.createLabel', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationSpecWithLabelNoPaging =\n await client.crm.associationsSchema.labels.createLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging.results);", + }, + python: { + method: 'crm.associations_schema.labels.create_label', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_spec_with_label_no_paging = client.crm.associations_schema.labels.create_label(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n label="label",\n name="name",\n)\nprint(collection_response_association_spec_with_label_no_paging.results)', + }, + java: { + method: 'crm().associationsSchema().labels().createLabel', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponseAssociationSpecWithLabelNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelCreateLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelCreateLabelParams params = LabelCreateLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .publicAssociationDefinitionCreateRequest(PublicAssociationDefinitionCreateRequest.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n CollectionResponseAssociationSpecWithLabelNoPaging collectionResponseAssociationSpecWithLabelNoPaging = client.crm().associationsSchema().labels().createLabel(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Labels.NewLabel', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationSpecWithLabelNoPaging, err := client.Crm.AssociationsSchema.Labels.NewLabel(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelNewLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tPublicAssociationDefinitionCreateRequest: crm.PublicAssociationDefinitionCreateRequestParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationSpecWithLabelNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.labels.create_label', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_spec_with_label_no_paging = hubspot.crm.associations_schema.labels.create_label(\n "toObjectType",\n from_object_type: "fromObjectType",\n label: "label",\n name: "name"\n)\n\nputs(collection_response_association_spec_with_label_no_paging)', + }, + php: { + method: 'crm->associationsSchema->labels->createLabel', + example: + "crm\n ->associationsSchema\n ->labels\n ->createLabel(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n inverseLabel: 'inverseLabel',\n);\n\nvar_dump($collectionResponseAssociationSpecWithLabelNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'delete_label', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}', + httpMethod: 'delete', + summary: 'Delete association label', + description: 'Remove a specific label from the association between two CRM object types.', + stainlessPath: '(resource) crm.associations_schema.labels > (method) delete_label', + qualified: 'client.crm.associationsSchema.labels.deleteLabel', + params: ['fromObjectType: string;', 'toObjectType: string;', 'associationTypeId: number;'], + markdown: + "## delete_label\n\n`client.crm.associationsSchema.labels.deleteLabel(fromObjectType: string, toObjectType: string, associationTypeId: number): void`\n\n**delete** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}`\n\nRemove a specific label from the association between two CRM object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `associationTypeId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.labels.deleteLabel(0, { fromObjectType: 'fromObjectType', toObjectType: 'toObjectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.labels.deleteLabel', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.labels.deleteLabel(0, {\n fromObjectType: 'fromObjectType',\n toObjectType: 'toObjectType',\n});", + }, + python: { + method: 'crm.associations_schema.labels.delete_label', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.labels.delete_label(\n association_type_id=0,\n from_object_type="fromObjectType",\n to_object_type="toObjectType",\n)', + }, + java: { + method: 'crm().associationsSchema().labels().deleteLabel', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelDeleteLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelDeleteLabelParams params = LabelDeleteLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .associationTypeId(0)\n .build();\n client.crm().associationsSchema().labels().deleteLabel(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Labels.DeleteLabel', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Labels.DeleteLabel(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.AssociationsSchemaLabelDeleteLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations_schema.labels.delete_label', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.labels.delete_label(\n 0,\n from_object_type: "fromObjectType",\n to_object_type: "toObjectType"\n)\n\nputs(result)', + }, + php: { + method: 'crm->associationsSchema->labels->deleteLabel', + example: + "crm->associationsSchema->labels->deleteLabel(\n 0, fromObjectType: 'fromObjectType', toObjectType: 'toObjectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels/$ASSOCIATION_TYPE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_labels', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + httpMethod: 'get', + summary: 'Retrieve association labels', + description: + 'Retrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations.', + stainlessPath: '(resource) crm.associations_schema.labels > (method) list_labels', + qualified: 'client.crm.associationsSchema.labels.listLabels', + params: ['fromObjectType: string;', 'toObjectType: string;'], + response: + "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }", + markdown: + "## list_labels\n\n`client.crm.associationsSchema.labels.listLabels(fromObjectType: string, toObjectType: string): { results: association_spec_with_label[]; }`\n\n**get** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nRetrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationSpecWithLabelNoPaging = await client.crm.associationsSchema.labels.listLabels('toObjectType', { fromObjectType: 'fromObjectType' });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.labels.listLabels', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationSpecWithLabelNoPaging =\n await client.crm.associationsSchema.labels.listLabels('toObjectType', {\n fromObjectType: 'fromObjectType',\n });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging.results);", + }, + python: { + method: 'crm.associations_schema.labels.list_labels', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_spec_with_label_no_paging = client.crm.associations_schema.labels.list_labels(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n)\nprint(collection_response_association_spec_with_label_no_paging.results)', + }, + java: { + method: 'crm().associationsSchema().labels().listLabels', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponseAssociationSpecWithLabelNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelListLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelListLabelsParams params = LabelListLabelsParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .build();\n CollectionResponseAssociationSpecWithLabelNoPaging collectionResponseAssociationSpecWithLabelNoPaging = client.crm().associationsSchema().labels().listLabels(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Labels.ListLabels', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationSpecWithLabelNoPaging, err := client.Crm.AssociationsSchema.Labels.ListLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelListLabelsParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationSpecWithLabelNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.labels.list_labels', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_spec_with_label_no_paging = hubspot.crm.associations_schema.labels.list_labels("toObjectType", from_object_type: "fromObjectType")\n\nputs(collection_response_association_spec_with_label_no_paging)', + }, + php: { + method: 'crm->associationsSchema->labels->listLabels', + example: + "crm\n ->associationsSchema\n ->labels\n ->listLabels('toObjectType', fromObjectType: 'fromObjectType');\n\nvar_dump($collectionResponseAssociationSpecWithLabelNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_label', + endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + httpMethod: 'put', + summary: 'Update association label', + description: + 'Update an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship.', + stainlessPath: '(resource) crm.associations_schema.labels > (method) update_label', + qualified: 'client.crm.associationsSchema.labels.updateLabel', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'associationTypeId: number;', + 'label: string;', + 'inverseLabel?: string;', + ], + markdown: + "## update_label\n\n`client.crm.associationsSchema.labels.updateLabel(fromObjectType: string, toObjectType: string, associationTypeId: number, label: string, inverseLabel?: string): void`\n\n**put** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nUpdate an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `associationTypeId: number`\n The unique identifier for the association type.\n\n- `label: string`\n A descriptor that provides context about the relationship between associated records.\n\n- `inverseLabel?: string`\n An optional descriptor for the inverse relationship between associated records.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.labels.updateLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n associationTypeId: 0,\n label: 'label',\n})\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.labels.updateLabel', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.labels.updateLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n associationTypeId: 0,\n label: 'label',\n});", + }, + python: { + method: 'crm.associations_schema.labels.update_label', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.labels.update_label(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n association_type_id=0,\n label="label",\n)', + }, + java: { + method: 'crm().associationsSchema().labels().updateLabel', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelUpdateLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelUpdateLabelParams params = LabelUpdateLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .publicAssociationDefinitionUpdateRequest(PublicAssociationDefinitionUpdateRequest.builder()\n .associationTypeId(0)\n .label("label")\n .build())\n .build();\n client.crm().associationsSchema().labels().updateLabel(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Labels.UpdateLabel', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Labels.UpdateLabel(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelUpdateLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tPublicAssociationDefinitionUpdateRequest: crm.PublicAssociationDefinitionUpdateRequestParam{\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t\tLabel: "label",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations_schema.labels.update_label', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.labels.update_label(\n "toObjectType",\n from_object_type: "fromObjectType",\n association_type_id: 0,\n label: "label"\n)\n\nputs(result)', + }, + php: { + method: 'crm->associationsSchema->labels->updateLabel', + example: + "crm->associationsSchema->labels->updateLabel(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n associationTypeID: 0,\n label: 'label',\n inverseLabel: 'inverseLabel',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associationTypeId": 0,\n "label": "label"\n }\'', + }, + }, + }, + { + name: 'batch_delete', + endpoint: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge', + httpMethod: 'post', + summary: 'Remove association limits', + description: 'Batch delete limits that have been defined for association types between two object types.', + stainlessPath: '(resource) crm.associations_schema.limits > (method) batch_delete', + qualified: 'client.crm.associationsSchema.limits.batchDelete', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + 'inputs: { category: string; typeId: number; }[];', + ], + markdown: + "## batch_delete\n\n`client.crm.associationsSchema.limits.batchDelete(fromObjectType: string, toObjectType: string, inputs: { category: string; typeId: number; }[]): void`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge`\n\nBatch delete limits that have been defined for association types between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: string; typeId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.limits.batchDelete('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{ category: 'category', typeId: 0 }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.limits.batchDelete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.limits.batchDelete('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [{ category: 'category', typeId: 0 }],\n});", + }, + python: { + method: 'crm.associations_schema.limits.batch_delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.limits.batch_delete(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "category",\n "type_id": 0,\n }],\n)', + }, + java: { + method: 'crm().associationsSchema().limits().batchDelete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationSpec;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationSpec;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitBatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitBatchDeleteParams params = LimitBatchDeleteParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationSpec(BatchInputPublicAssociationSpec.builder()\n .addInput(PublicAssociationSpec.builder()\n .category("category")\n .typeId(0)\n .build())\n .build())\n .build();\n client.crm().associationsSchema().limits().batchDelete(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Limits.BatchDelete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Limits.BatchDelete(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitBatchDeleteParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationSpec: crm.BatchInputPublicAssociationSpecParam{\n\t\t\t\tInputs: []crm.PublicAssociationSpecParam{{\n\t\t\t\t\tCategory: "category",\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.associations_schema.limits.batch_delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.limits.batch_delete(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: "category", typeId: 0}]\n)\n\nputs(result)', + }, + php: { + method: 'crm->associationsSchema->limits->batchDelete', + example: + "crm->associationsSchema->limits->batchDelete(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['category' => 'category', 'typeID' => 0]],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/purge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "category",\n "typeId": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'batch_update', + endpoint: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update', + httpMethod: 'post', + summary: 'Update association limits', + description: 'Batch update association limits that have been configured between two object types.', + stainlessPath: '(resource) crm.associations_schema.limits > (method) batch_update', + qualified: 'client.crm.associationsSchema.limits.batchUpdate', + params: [ + 'fromObjectType: string;', + 'toObjectType: string;', + "inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[];", + ], + response: + "{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## batch_update\n\n`client.crm.associationsSchema.limits.batchUpdate(fromObjectType: string, toObjectType: string, inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]): { completedAt: string; results: public_association_definition_configuration_update_result[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update`\n\nBatch update association limits that have been configured between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationDefinitionConfigurationUpdateResult = await client.crm.associationsSchema.limits.batchUpdate('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n}] });\n\nconsole.log(batchResponsePublicAssociationDefinitionConfigurationUpdateResult);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.limits.batchUpdate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationDefinitionConfigurationUpdateResult =\n await client.crm.associationsSchema.limits.batchUpdate('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicAssociationDefinitionConfigurationUpdateResult.completedAt);", + }, + python: { + method: 'crm.associations_schema.limits.batch_update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_definition_configuration_update_result = client.crm.associations_schema.limits.batch_update(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "HUBSPOT_DEFINED",\n "max_to_object_ids": 0,\n "type_id": 0,\n }],\n)\nprint(batch_response_public_association_definition_configuration_update_result.completed_at)', + }, + java: { + method: 'crm().associationsSchema().limits().batchUpdate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationDefinitionConfigurationUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchResponsePublicAssociationDefinitionConfigurationUpdateResult;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionConfigurationUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitBatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitBatchUpdateParams params = LimitBatchUpdateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationDefinitionConfigurationUpdateRequest(BatchInputPublicAssociationDefinitionConfigurationUpdateRequest.builder()\n .addInput(PublicAssociationDefinitionConfigurationUpdateRequest.builder()\n .category(PublicAssociationDefinitionConfigurationUpdateRequest.Category.HUBSPOT_DEFINED)\n .maxToObjectIds(0)\n .typeId(0)\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationDefinitionConfigurationUpdateResult batchResponsePublicAssociationDefinitionConfigurationUpdateResult = client.crm().associationsSchema().limits().batchUpdate(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Limits.BatchUpdate', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationDefinitionConfigurationUpdateResult, err := client.Crm.AssociationsSchema.Limits.BatchUpdate(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitBatchUpdateParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationDefinitionConfigurationUpdateRequest: crm.BatchInputPublicAssociationDefinitionConfigurationUpdateRequestParam{\n\t\t\t\tInputs: []crm.PublicAssociationDefinitionConfigurationUpdateRequestParam{{\n\t\t\t\t\tCategory: crm.PublicAssociationDefinitionConfigurationUpdateRequestCategoryHubSpotDefined,\n\t\t\t\t\tMaxToObjectIDs: 0,\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationDefinitionConfigurationUpdateResult.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.limits.batch_update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_definition_configuration_update_result = hubspot.crm.associations_schema.limits.batch_update(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: :HUBSPOT_DEFINED, maxToObjectIds: 0, typeId: 0}]\n)\n\nputs(batch_response_public_association_definition_configuration_update_result)', + }, + php: { + method: 'crm->associationsSchema->limits->batchUpdate', + example: + "crm\n ->associationsSchema\n ->limits\n ->batchUpdate(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n ['category' => 'HUBSPOT_DEFINED', 'maxToObjectIDs' => 0, 'typeID' => 0]\n ],\n);\n\nvar_dump($batchResponsePublicAssociationDefinitionConfigurationUpdateResult);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "HUBSPOT_DEFINED",\n "maxToObjectIds": 0,\n "typeId": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get_by_object_types', + endpoint: '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}', + httpMethod: 'get', + summary: 'Retrieve association limits', + description: + 'Retrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types.', + stainlessPath: '(resource) crm.associations_schema.limits > (method) get_by_object_types', + qualified: 'client.crm.associationsSchema.limits.getByObjectTypes', + params: ['fromObjectType: string;', 'toObjectType: string;'], + response: + "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }", + markdown: + "## get_by_object_types\n\n`client.crm.associationsSchema.limits.getByObjectTypes(fromObjectType: string, toObjectType: string): { results: public_association_definition_user_configuration[]; }`\n\n**get** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}`\n\nRetrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = await client.crm.associationsSchema.limits.getByObjectTypes('toObjectType', { fromObjectType: 'fromObjectType' });\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.limits.getByObjectTypes', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging =\n await client.crm.associationsSchema.limits.getByObjectTypes('toObjectType', {\n fromObjectType: 'fromObjectType',\n });\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.results);", + }, + python: { + method: 'crm.associations_schema.limits.get_by_object_types', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_association_definition_user_configuration_no_paging = client.crm.associations_schema.limits.get_by_object_types(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n)\nprint(collection_response_public_association_definition_user_configuration_no_paging.results)', + }, + java: { + method: 'crm().associationsSchema().limits().getByObjectTypes', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitGetByObjectTypesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitGetByObjectTypesParams params = LimitGetByObjectTypesParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .build();\n CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = client.crm().associationsSchema().limits().getByObjectTypes(params);\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Limits.GetByObjectTypes', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging, err := client.Crm.AssociationsSchema.Limits.GetByObjectTypes(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitGetByObjectTypesParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.limits.get_by_object_types', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_association_definition_user_configuration_no_paging = hubspot.crm.associations_schema.limits.get_by_object_types(\n "toObjectType",\n from_object_type: "fromObjectType"\n)\n\nputs(collection_response_public_association_definition_user_configuration_no_paging)', + }, + php: { + method: 'crm->associationsSchema->limits->getByObjectTypes', + example: + "crm\n ->associationsSchema\n ->limits\n ->getByObjectTypes('toObjectType', fromObjectType: 'fromObjectType');\n\nvar_dump(\n $collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging\n);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/associations/2026-03/definitions/configurations/all', + httpMethod: 'get', + summary: 'Retrieve all association limits', + description: + 'Retrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other.', + stainlessPath: '(resource) crm.associations_schema.limits > (method) list', + qualified: 'client.crm.associationsSchema.limits.list', + response: + "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }", + markdown: + "## list\n\n`client.crm.associationsSchema.limits.list(): { results: public_association_definition_user_configuration[]; }`\n\n**get** `/crm/associations/2026-03/definitions/configurations/all`\n\nRetrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other.\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = await client.crm.associationsSchema.limits.list();\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.associationsSchema.limits.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging =\n await client.crm.associationsSchema.limits.list();\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.results);", + }, + python: { + method: 'crm.associations_schema.limits.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_association_definition_user_configuration_no_paging = client.crm.associations_schema.limits.list()\nprint(collection_response_public_association_definition_user_configuration_no_paging.results)', + }, + java: { + method: 'crm().associationsSchema().limits().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = client.crm().associationsSchema().limits().list();\n }\n}', + }, + go: { + method: 'client.Crm.AssociationsSchema.Limits.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging, err := client.Crm.AssociationsSchema.Limits.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.associations_schema.limits.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_association_definition_user_configuration_no_paging = hubspot.crm.associations_schema.limits.list\n\nputs(collection_response_public_association_definition_user_configuration_no_paging)', + }, + php: { + method: 'crm->associationsSchema->limits->list', + example: + "crm\n ->associationsSchema\n ->limits\n ->list();\n\nvar_dump(\n $collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging\n);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'read', + endpoint: '/deal-splits/2026-03/batch/read', + httpMethod: 'post', + summary: 'Read a batch of deal split objects by their associated deal object internal ID', + description: 'Read a batch of deal split objects by their associated deal object internal ID', + stainlessPath: '(resource) crm.deal_splits.batch > (method) read', + qualified: 'client.crm.dealSplits.batch.read', + params: ['inputs: { id: string; }[];'], + response: + "{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## read\n\n`client.crm.dealSplits.batch.read(inputs: { id: string; }[]): { completedAt: string; results: deal_to_deal_splits[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/deal-splits/2026-03/batch/read`\n\nRead a batch of deal split objects by their associated deal object internal ID\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; splits: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.read({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseDealToDealSplits);\n```", + perLanguage: { + typescript: { + method: 'client.crm.dealSplits.batch.read', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.read({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseDealToDealSplits.completedAt);", + }, + python: { + method: 'crm.deal_splits.batch.read', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_deal_to_deal_splits = client.crm.deal_splits.batch.read(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_deal_to_deal_splits.completed_at)', + }, + java: { + method: 'crm().dealSplits().batch().read', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPublicObjectId;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.dealsplits.BatchResponseDealToDealSplits;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicObjectId params = BatchInputPublicObjectId.builder()\n .addInput(PublicObjectId.builder()\n .id("id")\n .build())\n .build();\n BatchResponseDealToDealSplits batchResponseDealToDealSplits = client.crm().dealSplits().batch().read(params);\n }\n}', + }, + go: { + method: 'client.Crm.DealSplits.Batch.Read', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseDealToDealSplits, err := client.Crm.DealSplits.Batch.Read(context.TODO(), crm.DealSplitBatchReadParams{\n\t\tBatchInputPublicObjectID: shared.BatchInputPublicObjectIDParam{\n\t\t\tInputs: []shared.PublicObjectIDParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseDealToDealSplits.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.deal_splits.batch.read', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_deal_to_deal_splits = hubspot.crm.deal_splits.batch.read(inputs: [{id: "id"}])\n\nputs(batch_response_deal_to_deal_splits)', + }, + php: { + method: 'crm->dealSplits->batch->read', + example: + "crm->dealSplits->batch->read(\n inputs: [['id' => 'id']]\n);\n\nvar_dump($batchResponseDealToDealSplits);", + }, + http: { + example: + 'curl https://api.hubapi.com/deal-splits/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/deal-splits/2026-03/batch/upsert', + httpMethod: 'post', + summary: + 'Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places', + description: + 'Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places', + stainlessPath: '(resource) crm.deal_splits.batch > (method) upsert', + qualified: 'client.crm.dealSplits.batch.upsert', + params: ['inputs: { id: number; splits: { ownerId: number; percentage: number; }[]; }[];'], + response: + "{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.dealSplits.batch.upsert(inputs: { id: number; splits: public_deal_split_input[]; }[]): { completedAt: string; results: deal_to_deal_splits[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/deal-splits/2026-03/batch/upsert`\n\nCreate or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places\n\n### Parameters\n\n- `inputs: { id: number; splits: { ownerId: number; percentage: number; }[]; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; splits: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.upsert({ inputs: [{ id: 0, splits: [{ ownerId: 0, percentage: 0 }] }] });\n\nconsole.log(batchResponseDealToDealSplits);\n```", + perLanguage: { + typescript: { + method: 'client.crm.dealSplits.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.upsert({\n inputs: [{ id: 0, splits: [{ ownerId: 0, percentage: 0 }] }],\n});\n\nconsole.log(batchResponseDealToDealSplits.completedAt);", + }, + python: { + method: 'crm.deal_splits.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_deal_to_deal_splits = client.crm.deal_splits.batch.upsert(\n inputs=[{\n "id": 0,\n "splits": [{\n "owner_id": 0,\n "percentage": 0,\n }],\n }],\n)\nprint(batch_response_deal_to_deal_splits.completed_at)', + }, + java: { + method: 'crm().dealSplits().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.dealsplits.BatchResponseDealToDealSplits;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitInput;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitsBatchCreateRequest;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitsCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicDealSplitsBatchCreateRequest params = PublicDealSplitsBatchCreateRequest.builder()\n .addInput(PublicDealSplitsCreateRequest.builder()\n .id(0L)\n .addSplit(PublicDealSplitInput.builder()\n .ownerId(0)\n .percentage(0.0)\n .build())\n .build())\n .build();\n BatchResponseDealToDealSplits batchResponseDealToDealSplits = client.crm().dealSplits().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.DealSplits.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseDealToDealSplits, err := client.Crm.DealSplits.Batch.Upsert(context.TODO(), crm.DealSplitBatchUpsertParams{\n\t\tPublicDealSplitsBatchCreateRequest: crm.PublicDealSplitsBatchCreateRequestParam{\n\t\t\tInputs: []crm.PublicDealSplitsCreateRequestParam{{\n\t\t\t\tID: 0,\n\t\t\t\tSplits: []crm.PublicDealSplitInputParam{{\n\t\t\t\t\tOwnerID: 0,\n\t\t\t\t\tPercentage: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseDealToDealSplits.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.deal_splits.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_deal_to_deal_splits = hubspot.crm.deal_splits.batch.upsert(inputs: [{id: 0, splits: [{ownerId: 0, percentage: 0}]}])\n\nputs(batch_response_deal_to_deal_splits)', + }, + php: { + method: 'crm->dealSplits->batch->upsert', + example: + "crm->dealSplits->batch->upsert(\n inputs: [['id' => 0, 'splits' => [['ownerID' => 0, 'percentage' => 0]]]]\n);\n\nvar_dump($batchResponseDealToDealSplits);", + }, + http: { + example: + 'curl https://api.hubapi.com/deal-splits/2026-03/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": 0,\n "splits": [\n {\n "ownerId": 0,\n "percentage": 0\n }\n ]\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_async', + endpoint: '/crm/exports/2026-03/export/async', + httpMethod: 'post', + summary: 'Start an export', + description: 'Begins exporting CRM data for the portal as specified in the request body', + stainlessPath: '(resource) crm.exports > (method) create_async', + qualified: 'client.crm.exports.createAsync', + params: [ + "public_export_request: { associatedObjectType: string[]; exportInternalValuesOptions: 'NAMES' | 'VALUES'[]; exportName: string; exportType: 'VIEW'; format: 'XLS' | 'XLSX' | 'CSV'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: string; objectProperties: string[]; objectType: string; overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; publicCrmSearchRequest?: object; } | { associatedObjectType: string[]; exportInternalValuesOptions: 'NAMES' | 'VALUES'[]; exportName: string; exportType: 'LIST'; format: 'XLS' | 'XLSX' | 'CSV'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: string; listId: string; objectProperties: string[]; objectType: string; overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; };", + ], + response: '{ id: string; links?: object; }', + perLanguage: { + typescript: { + method: 'client.crm.exports.createAsync', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst taskLocator = await client.crm.exports.createAsync();\n\nconsole.log(taskLocator.id);", + }, + python: { + method: 'crm.exports.create_async', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntask_locator = client.crm.exports.create_async()\nprint(task_locator.id)', + }, + java: { + method: 'crm().exports().createAsync', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.TaskLocator;\nimport com.hubspot.sdk.models.crm.exports.PublicExportListRequest;\nimport com.hubspot.sdk.models.crm.exports.PublicExportViewRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicExportViewRequest params = PublicExportViewRequest.builder()\n .addAssociatedObjectType("string")\n .addExportInternalValuesOption(PublicExportViewRequest.ExportInternalValuesOption.NAMES)\n .exportName("exportName")\n .exportType(PublicExportViewRequest.ExportType.VIEW)\n .format(PublicExportViewRequest.Format.XLS)\n .includeLabeledAssociations(true)\n .includePrimaryDisplayPropertyForAssociatedObjects(true)\n .language(PublicExportViewRequest.Language.EN)\n .addObjectProperty("string")\n .objectType("objectType")\n .overrideAssociatedObjectsPerDefinitionPerRowLimit(true)\n .build();\n TaskLocator taskLocator = client.crm().exports().createAsync(params);\n }\n}', + }, + go: { + method: 'client.Crm.Exports.NewAsync', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttaskLocator, err := client.Crm.Exports.NewAsync(context.TODO(), crm.ExportNewAsyncParams{\n\t\tPublicExportRequest: crm.PublicExportRequestUnionParam{\n\t\t\tOfPublicExportViewRequest: &crm.PublicExportViewRequestParam{\n\t\t\t\tAssociatedObjectType: []string{"string"},\n\t\t\t\tExportInternalValuesOptions: []string{"NAMES"},\n\t\t\t\tExportName: "exportName",\n\t\t\t\tExportType: crm.PublicExportViewRequestExportTypeView,\n\t\t\t\tFormat: crm.PublicExportViewRequestFormatXls,\n\t\t\t\tIncludeLabeledAssociations: true,\n\t\t\t\tIncludePrimaryDisplayPropertyForAssociatedObjects: true,\n\t\t\t\tLanguage: crm.PublicExportViewRequestLanguageEn,\n\t\t\t\tObjectProperties: []string{"string"},\n\t\t\t\tObjectType: "objectType",\n\t\t\t\tOverrideAssociatedObjectsPerDefinitionPerRowLimit: true,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", taskLocator.ID)\n}\n', + }, + ruby: { + method: 'crm.exports.create_async', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntask_locator = hubspot.crm.exports.create_async(\n public_export_request: {\n associatedObjectType: ["string"],\n exportInternalValuesOptions: [:NAMES],\n exportName: "exportName",\n exportType: :VIEW,\n format: :XLS,\n includeLabeledAssociations: true,\n includePrimaryDisplayPropertyForAssociatedObjects: true,\n language: :EN,\n objectProperties: ["string"],\n objectType: "objectType",\n overrideAssociatedObjectsPerDefinitionPerRowLimit: true\n }\n)\n\nputs(task_locator)', + }, + php: { + method: 'crm->exports->createAsync', + example: + "crm->exports->createAsync();\n\nvar_dump($taskLocator);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/exports/2026-03/export/async \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'get', + endpoint: '/crm/exports/2026-03/export/{exportId}', + httpMethod: 'get', + summary: 'Retrieve details of a specific export by its unique ID.', + description: + 'Retrieve detailed information about a specific CRM export, including its current state and properties.', + stainlessPath: '(resource) crm.exports > (method) get', + qualified: 'client.crm.exports.get', + params: ['exportId: number;'], + response: + "{ id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }", + markdown: + "## get\n\n`client.crm.exports.get(exportId: number): { id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }`\n\n**get** `/crm/exports/2026-03/export/{exportId}`\n\nRetrieve detailed information about a specific CRM export, including its current state and properties.\n\n### Parameters\n\n- `exportId: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }`\n\n - `id: string`\n - `createdAt: string`\n - `exportState: string`\n - `exportType: 'LIST' | 'VIEW'`\n - `objectProperties: string[]`\n - `objectType: string`\n - `updatedAt: string`\n - `exportName?: string`\n - `recordCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicExportResponse = await client.crm.exports.get(0);\n\nconsole.log(publicExportResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.exports.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicExportResponse = await client.crm.exports.get(0);\n\nconsole.log(publicExportResponse.id);", + }, + python: { + method: 'crm.exports.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_export_response = client.crm.exports.get(\n 0,\n)\nprint(public_export_response.id)', + }, + java: { + method: 'crm().exports().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.exports.ExportGetParams;\nimport com.hubspot.sdk.models.crm.exports.PublicExportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicExportResponse publicExportResponse = client.crm().exports().get(0L);\n }\n}', + }, + go: { + method: 'client.Crm.Exports.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicExportResponse, err := client.Crm.Exports.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicExportResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.exports.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_export_response = hubspot.crm.exports.get(0)\n\nputs(public_export_response)', + }, + php: { + method: 'crm->exports->get', + example: + "crm->exports->get(0);\n\nvar_dump($publicExportResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/exports/2026-03/export/$EXPORT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_status', + endpoint: '/crm/exports/2026-03/export/async/tasks/{taskId}/status', + httpMethod: 'get', + summary: 'Get the status of the export including the URL to download the file', + description: + 'Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE', + stainlessPath: '(resource) crm.exports > (method) get_status', + qualified: 'client.crm.exports.getStatus', + params: ['taskId: number;'], + response: + "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }", + markdown: + "## get_status\n\n`client.crm.exports.getStatus(taskId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }`\n\n**get** `/crm/exports/2026-03/export/async/tasks/{taskId}/status`\n\nReturns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE\n\n### Parameters\n\n- `taskId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithSingleResultUri = await client.crm.exports.getStatus(0);\n\nconsole.log(actionResponseWithSingleResultUri);\n```", + perLanguage: { + typescript: { + method: 'client.crm.exports.getStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithSingleResultUri = await client.crm.exports.getStatus(0);\n\nconsole.log(actionResponseWithSingleResultUri.completedAt);", + }, + python: { + method: 'crm.exports.get_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_single_result_uri = client.crm.exports.get_status(\n 0,\n)\nprint(action_response_with_single_result_uri.completed_at)', + }, + java: { + method: 'crm().exports().getStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.exports.ActionResponseWithSingleResultUri;\nimport com.hubspot.sdk.models.crm.exports.ExportGetStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponseWithSingleResultUri actionResponseWithSingleResultUri = client.crm().exports().getStatus(0L);\n }\n}', + }, + go: { + method: 'client.Crm.Exports.GetStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithSingleResultUri, err := client.Crm.Exports.GetStatus(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithSingleResultUri.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.exports.get_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_single_result_uri = hubspot.crm.exports.get_status(0)\n\nputs(action_response_with_single_result_uri)', + }, + php: { + method: 'crm->exports->getStatus', + example: + "crm->exports->getStatus(0);\n\nvar_dump($actionResponseWithSingleResultUri);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/exports/2026-03/export/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create_channel_connection_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + httpMethod: 'post', + summary: 'Create new channel connection settings for a specific app.', + description: 'Establish new channel connection settings for the specified app.', + stainlessPath: '(resource) crm.extensions.calling > (method) create_channel_connection_settings', + qualified: 'client.crm.extensions.calling.createChannelConnectionSettings', + params: ['appId: number;', 'isReady: boolean;', 'url: string;'], + response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', + markdown: + "## create_channel_connection_settings\n\n`client.crm.extensions.calling.createChannelConnectionSettings(appId: number, isReady: boolean, url: string): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nEstablish new channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `isReady: boolean`\n Indicates whether the channel connection settings are ready.\n\n- `url: string`\n The URL associated with the channel connection settings.\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.createChannelConnectionSettings(0, { isReady: true, url: 'url' });\n\nconsole.log(channelConnectionSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.createChannelConnectionSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.createChannelConnectionSettings(0, {\n isReady: true,\n url: 'url',\n });\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", + }, + python: { + method: 'crm.extensions.calling.create_channel_connection_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.create_channel_connection_settings(\n app_id=0,\n is_ready=True,\n url="url",\n)\nprint(channel_connection_settings_response.created_at)', + }, + java: { + method: 'crm().extensions().calling().createChannelConnectionSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateChannelConnectionSettingsParams params = CallingCreateChannelConnectionSettingsParams.builder()\n .appId(0)\n .channelConnectionSettingsRequest(ChannelConnectionSettingsRequest.builder()\n .isReady(true)\n .url("url")\n .build())\n .build();\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().createChannelConnectionSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.NewChannelConnectionSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.NewChannelConnectionSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewChannelConnectionSettingsParams{\n\t\t\tChannelConnectionSettingsRequest: crm.ChannelConnectionSettingsRequestParam{\n\t\t\t\tIsReady: true,\n\t\t\t\tURL: "url",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.create_channel_connection_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.create_channel_connection_settings(0, is_ready: true, url: "url")\n\nputs(channel_connection_settings_response)', + }, + php: { + method: 'crm->extensions->calling->createChannelConnectionSettings', + example: + "crm\n ->extensions\n ->calling\n ->createChannelConnectionSettings(0, isReady: true, url: 'url');\n\nvar_dump($channelConnectionSettingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "isReady": true,\n "url": "url"\n }\'', + }, + }, + }, + { + name: 'create_inbound_call', + endpoint: '/crm/extensions/calling/2026-03/inbound-call', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.extensions.calling > (method) create_inbound_call', + qualified: 'client.crm.extensions.calling.createInboundCall', + params: [ + 'createEngagement: boolean;', + 'engagementProperties: object;', + 'externalCallId: string;', + 'finalCallStatus: string;', + 'fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', + 'potentialRecipientUserIds: number[];', + 'toNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', + 'callStartedTimestamp?: string;', + 'durationSeconds?: number;', + 'userId?: number;', + ], + response: + "{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }", + markdown: + "## create_inbound_call\n\n`client.crm.extensions.calling.createInboundCall(createEngagement: boolean, engagementProperties: object, externalCallId: string, finalCallStatus: string, fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, potentialRecipientUserIds: number[], toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, callStartedTimestamp?: string, durationSeconds?: number, userId?: number): { callerIdMatches: contact_caller_id | company_caller_id[]; }`\n\n**post** `/crm/extensions/calling/2026-03/inbound-call`\n\n### Parameters\n\n- `createEngagement: boolean`\n Indicates whether an engagement should be created for the call.\n\n- `engagementProperties: object`\n Contains additional properties related to the engagement.\n\n- `externalCallId: string`\n The unique identifier for the call from an external system.\n\n- `finalCallStatus: string`\n The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.\n\n- `fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `potentialRecipientUserIds: number[]`\n\n- `toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `callStartedTimestamp?: string`\n The timestamp indicating when the call started, formatted as a date-time string.\n\n- `durationSeconds?: number`\n The duration of the call in seconds.\n\n- `userId?: number`\n The ID of the user associated with the call.\n\n### Returns\n\n- `{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }`\n\n - `callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; name?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.createInboundCall', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse.callerIdMatches);", + }, + python: { + method: 'crm.extensions.calling.create_inbound_call', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompleted_third_party_call_response = client.crm.extensions.calling.create_inbound_call(\n create_engagement=True,\n engagement_properties={\n "foo": "string"\n },\n external_call_id="externalCallId",\n final_call_status="BUSY",\n from_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n potential_recipient_user_ids=[0],\n to_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n)\nprint(completed_third_party_call_response.caller_id_matches)', + }, + java: { + method: 'crm().extensions().calling().createInboundCall', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.FormattedPhoneNumber;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompletedThirdPartyCallRequest params = CompletedThirdPartyCallRequest.builder()\n .createEngagement(true)\n .engagementProperties(CompletedThirdPartyCallRequest.EngagementProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .externalCallId("externalCallId")\n .finalCallStatus(CompletedThirdPartyCallRequest.FinalCallStatus.BUSY)\n .fromNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .addPotentialRecipientUserId(0)\n .toNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .build();\n CompletedThirdPartyCallResponse completedThirdPartyCallResponse = client.crm().extensions().calling().createInboundCall(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.NewInboundCall', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompletedThirdPartyCallResponse, err := client.Crm.Extensions.Calling.NewInboundCall(context.TODO(), crm.ExtensionCallingNewInboundCallParams{\n\t\tCompletedThirdPartyCallRequest: crm.CompletedThirdPartyCallRequestParam{\n\t\t\tCreateEngagement: true,\n\t\t\tEngagementProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tExternalCallID: "externalCallId",\n\t\t\tFinalCallStatus: crm.CompletedThirdPartyCallRequestFinalCallStatusBusy,\n\t\t\tFromNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t\tPotentialRecipientUserIDs: []int64{0},\n\t\t\tToNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", completedThirdPartyCallResponse.CallerIDMatches)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.create_inbound_call', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompleted_third_party_call_response = hubspot.crm.extensions.calling.create_inbound_call(\n create_engagement: true,\n engagement_properties: {foo: "string"},\n external_call_id: "externalCallId",\n final_call_status: :BUSY,\n from_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE},\n potential_recipient_user_ids: [0],\n to_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE}\n)\n\nputs(completed_third_party_call_response)', + }, + php: { + method: 'crm->extensions->calling->createInboundCall', + example: + "crm\n ->extensions\n ->calling\n ->createInboundCall(\n createEngagement: true,\n engagementProperties: ['foo' => 'string'],\n externalCallID: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n potentialRecipientUserIDs: [0],\n toNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n callStartedTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n durationSeconds: 0,\n userID: 0,\n);\n\nvar_dump($completedThirdPartyCallResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/inbound-call \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createEngagement": true,\n "engagementProperties": {\n "foo": "string"\n },\n "externalCallId": "externalCallId",\n "finalCallStatus": "BUSY",\n "fromNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n },\n "potentialRecipientUserIds": [\n 0\n ],\n "toNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n }\n }\'', + }, + }, + }, + { + name: 'create_recording_ready', + endpoint: '/crm/extensions/calling/2026-03/recordings/ready', + httpMethod: 'post', + summary: 'Mark a call recording as ready for retrieval.', + description: + 'This endpoint is used to mark a call recording as ready. It requires the engagementId to identify the specific recording.', + stainlessPath: '(resource) crm.extensions.calling > (method) create_recording_ready', + qualified: 'client.crm.extensions.calling.createRecordingReady', + params: ['engagementId: number;'], + markdown: + "## create_recording_ready\n\n`client.crm.extensions.calling.createRecordingReady(engagementId: number): void`\n\n**post** `/crm/extensions/calling/2026-03/recordings/ready`\n\nThis endpoint is used to mark a call recording as ready. It requires the engagementId to identify the specific recording.\n\n### Parameters\n\n- `engagementId: number`\n The unique identifier for the engagement associated with the call recording.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.createRecordingReady({ engagementId: 0 })\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.createRecordingReady', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.createRecordingReady({ engagementId: 0 });", + }, + python: { + method: 'crm.extensions.calling.create_recording_ready', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.create_recording_ready(\n engagement_id=0,\n)', + }, + java: { + method: 'crm().extensions().calling().createRecordingReady', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.MarkRecordingAsReadyRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarkRecordingAsReadyRequest params = MarkRecordingAsReadyRequest.builder()\n .engagementId(0L)\n .build();\n client.crm().extensions().calling().createRecordingReady(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.NewRecordingReady', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.NewRecordingReady(context.TODO(), crm.ExtensionCallingNewRecordingReadyParams{\n\t\tMarkRecordingAsReadyRequest: crm.MarkRecordingAsReadyRequestParam{\n\t\t\tEngagementID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.create_recording_ready', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.create_recording_ready(engagement_id: 0)\n\nputs(result)', + }, + php: { + method: 'crm->extensions->calling->createRecordingReady', + example: + "crm->extensions->calling->createRecordingReady(\n engagementID: 0\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/recordings/ready \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "engagementId": 0\n }\'', + }, + }, + }, + { + name: 'create_recording_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + httpMethod: 'post', + summary: 'Create recording settings for an app.', + description: 'Create new recording settings for a specific app using the provided app ID.', + stainlessPath: '(resource) crm.extensions.calling > (method) create_recording_settings', + qualified: 'client.crm.extensions.calling.createRecordingSettings', + params: ['appId: number;', 'urlToRetrieveAuthedRecording: string;'], + response: '{ urlToRetrieveAuthedRecording: string; }', + markdown: + "## create_recording_settings\n\n`client.crm.extensions.calling.createRecordingSettings(appId: number, urlToRetrieveAuthedRecording: string): { urlToRetrieveAuthedRecording: string; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nCreate new recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `urlToRetrieveAuthedRecording: string`\n The URL used to access authenticated call recordings.\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.createRecordingSettings(0, { urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording' });\n\nconsole.log(recordingSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.createRecordingSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.createRecordingSettings(0, {\n urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording',\n});\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", + }, + python: { + method: 'crm.extensions.calling.create_recording_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.create_recording_settings(\n app_id=0,\n url_to_retrieve_authed_recording="urlToRetrieveAuthedRecording",\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', + }, + java: { + method: 'crm().extensions().calling().createRecordingSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateRecordingSettingsParams params = CallingCreateRecordingSettingsParams.builder()\n .appId(0)\n .recordingSettingsRequest(RecordingSettingsRequest.builder()\n .urlToRetrieveAuthedRecording("urlToRetrieveAuthedRecording")\n .build())\n .build();\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().createRecordingSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.NewRecordingSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.NewRecordingSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewRecordingSettingsParams{\n\t\t\tRecordingSettingsRequest: crm.RecordingSettingsRequestParam{\n\t\t\t\tURLToRetrieveAuthedRecording: "urlToRetrieveAuthedRecording",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.create_recording_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.create_recording_settings(\n 0,\n url_to_retrieve_authed_recording: "urlToRetrieveAuthedRecording"\n)\n\nputs(recording_settings_response)', + }, + php: { + method: 'crm->extensions->calling->createRecordingSettings', + example: + "crm\n ->extensions\n ->calling\n ->createRecordingSettings(\n 0, urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording'\n);\n\nvar_dump($recordingSettingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "urlToRetrieveAuthedRecording": "urlToRetrieveAuthedRecording"\n }\'', + }, + }, + }, + { + name: 'create_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', + httpMethod: 'post', + summary: 'Create new calling extension settings for a specific app.', + description: 'Create new settings for the calling extension associated with the specified appId.', + stainlessPath: '(resource) crm.extensions.calling > (method) create_settings', + qualified: 'client.crm.extensions.calling.createSettings', + params: [ + 'appId: number;', + 'height: number;', + 'isReady: boolean;', + 'name: string;', + 'supportsCustomObjects: boolean;', + 'supportsInboundCalling: boolean;', + 'url: string;', + 'usesCallingWindow: boolean;', + 'usesRemote: boolean;', + 'width: number;', + ], + response: + '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', + markdown: + "## create_settings\n\n`client.crm.extensions.calling.createSettings(appId: number, height: number, isReady: boolean, name: string, supportsCustomObjects: boolean, supportsInboundCalling: boolean, url: string, usesCallingWindow: boolean, usesRemote: boolean, width: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nCreate new settings for the calling extension associated with the specified appId.\n\n### Parameters\n\n- `appId: number`\n\n- `height: number`\n Specifies the height of the calling extension interface.\n\n- `isReady: boolean`\n Indicates if the calling extension is ready for use.\n\n- `name: string`\n The name of the calling extension.\n\n- `supportsCustomObjects: boolean`\n Indicates if the calling extension supports custom objects.\n\n- `supportsInboundCalling: boolean`\n Indicates if the calling extension supports inbound calling.\n\n- `url: string`\n The URL associated with the calling extension.\n\n- `usesCallingWindow: boolean`\n Indicates if the calling extension uses a separate calling window.\n\n- `usesRemote: boolean`\n Indicates if the calling extension uses remote services.\n\n- `width: number`\n Specifies the width of the calling extension interface.\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.createSettings(0, {\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n});\n\nconsole.log(settingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.createSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.createSettings(0, {\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n});\n\nconsole.log(settingsResponse.width);", + }, + python: { + method: 'crm.extensions.calling.create_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.create_settings(\n app_id=0,\n height=0,\n is_ready=True,\n name="name",\n supports_custom_objects=True,\n supports_inbound_calling=True,\n url="url",\n uses_calling_window=True,\n uses_remote=True,\n width=0,\n)\nprint(settings_response.width)', + }, + java: { + method: 'crm().extensions().calling().createSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateSettingsParams params = CallingCreateSettingsParams.builder()\n .appId(0)\n .settingsRequest(SettingsRequest.builder()\n .height(0)\n .isReady(true)\n .name("name")\n .supportsCustomObjects(true)\n .supportsInboundCalling(true)\n .url("url")\n .usesCallingWindow(true)\n .usesRemote(true)\n .width(0)\n .build())\n .build();\n SettingsResponse settingsResponse = client.crm().extensions().calling().createSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.NewSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.NewSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewSettingsParams{\n\t\t\tSettingsRequest: crm.SettingsRequestParam{\n\t\t\t\tHeight: 0,\n\t\t\t\tIsReady: true,\n\t\t\t\tName: "name",\n\t\t\t\tSupportsCustomObjects: true,\n\t\t\t\tSupportsInboundCalling: true,\n\t\t\t\tURL: "url",\n\t\t\t\tUsesCallingWindow: true,\n\t\t\t\tUsesRemote: true,\n\t\t\t\tWidth: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.create_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.create_settings(\n 0,\n height: 0,\n is_ready: true,\n name: "name",\n supports_custom_objects: true,\n supports_inbound_calling: true,\n url: "url",\n uses_calling_window: true,\n uses_remote: true,\n width: 0\n)\n\nputs(settings_response)', + }, + php: { + method: 'crm->extensions->calling->createSettings', + example: + "crm->extensions->calling->createSettings(\n 0,\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n);\n\nvar_dump($settingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "height": 0,\n "isReady": true,\n "name": "name",\n "supportsCustomObjects": true,\n "supportsInboundCalling": true,\n "url": "url",\n "usesCallingWindow": true,\n "usesRemote": true,\n "width": 0\n }\'', + }, + }, + }, + { + name: 'delete_channel_connection_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + httpMethod: 'delete', + summary: 'Remove the channel connection settings for a specific app.', + description: 'Delete the channel connection settings associated with the specified app.', + stainlessPath: '(resource) crm.extensions.calling > (method) delete_channel_connection_settings', + qualified: 'client.crm.extensions.calling.deleteChannelConnectionSettings', + params: ['appId: number;'], + markdown: + "## delete_channel_connection_settings\n\n`client.crm.extensions.calling.deleteChannelConnectionSettings(appId: number): void`\n\n**delete** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nDelete the channel connection settings associated with the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.deleteChannelConnectionSettings(0)\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.deleteChannelConnectionSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.deleteChannelConnectionSettings(0);", + }, + python: { + method: 'crm.extensions.calling.delete_channel_connection_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.delete_channel_connection_settings(\n 0,\n)', + }, + java: { + method: 'crm().extensions().calling().deleteChannelConnectionSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingDeleteChannelConnectionSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().deleteChannelConnectionSettings(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.DeleteChannelConnectionSettings', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.DeleteChannelConnectionSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.delete_channel_connection_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.delete_channel_connection_settings(0)\n\nputs(result)', + }, + php: { + method: 'crm->extensions->calling->deleteChannelConnectionSettings', + example: + "crm->extensions->calling->deleteChannelConnectionSettings(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', + httpMethod: 'delete', + summary: 'Delete the calling extension settings for a specific app.', + description: + 'Remove the calling extension settings associated with the specified appId. This action cannot be undone.', + stainlessPath: '(resource) crm.extensions.calling > (method) delete_settings', + qualified: 'client.crm.extensions.calling.deleteSettings', + params: ['appId: number;'], + markdown: + "## delete_settings\n\n`client.crm.extensions.calling.deleteSettings(appId: number): void`\n\n**delete** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nRemove the calling extension settings associated with the specified appId. This action cannot be undone.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.deleteSettings(0)\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.deleteSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.deleteSettings(0);", + }, + python: { + method: 'crm.extensions.calling.delete_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.delete_settings(\n 0,\n)', + }, + java: { + method: 'crm().extensions().calling().deleteSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingDeleteSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().deleteSettings(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.DeleteSettings', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.DeleteSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.delete_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.delete_settings(0)\n\nputs(result)', + }, + php: { + method: 'crm->extensions->calling->deleteSettings', + example: + "crm->extensions->calling->deleteSettings(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_channel_connection_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + httpMethod: 'get', + summary: 'Retrieve the channel connection settings for a specific app.', + description: 'Access the current channel connection settings for the specified app.', + stainlessPath: '(resource) crm.extensions.calling > (method) get_channel_connection_settings', + qualified: 'client.crm.extensions.calling.getChannelConnectionSettings', + params: ['appId: number;'], + response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', + markdown: + "## get_channel_connection_settings\n\n`client.crm.extensions.calling.getChannelConnectionSettings(appId: number): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nAccess the current channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.getChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.getChannelConnectionSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.getChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", + }, + python: { + method: 'crm.extensions.calling.get_channel_connection_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.get_channel_connection_settings(\n 0,\n)\nprint(channel_connection_settings_response.created_at)', + }, + java: { + method: 'crm().extensions().calling().getChannelConnectionSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().getChannelConnectionSettings(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.GetChannelConnectionSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.GetChannelConnectionSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.get_channel_connection_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.get_channel_connection_settings(0)\n\nputs(channel_connection_settings_response)', + }, + php: { + method: 'crm->extensions->calling->getChannelConnectionSettings', + example: + "crm\n ->extensions\n ->calling\n ->getChannelConnectionSettings(0);\n\nvar_dump($channelConnectionSettingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_recording_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + httpMethod: 'get', + summary: 'Retrieve recording settings for an app.', + description: 'Retrieve the current recording settings for a specific app using the provided app ID.', + stainlessPath: '(resource) crm.extensions.calling > (method) get_recording_settings', + qualified: 'client.crm.extensions.calling.getRecordingSettings', + params: ['appId: number;'], + response: '{ urlToRetrieveAuthedRecording: string; }', + markdown: + "## get_recording_settings\n\n`client.crm.extensions.calling.getRecordingSettings(appId: number): { urlToRetrieveAuthedRecording: string; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nRetrieve the current recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.getRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.getRecordingSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.getRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", + }, + python: { + method: 'crm.extensions.calling.get_recording_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.get_recording_settings(\n 0,\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', + }, + java: { + method: 'crm().extensions().calling().getRecordingSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().getRecordingSettings(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.GetRecordingSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.GetRecordingSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.get_recording_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.get_recording_settings(0)\n\nputs(recording_settings_response)', + }, + php: { + method: 'crm->extensions->calling->getRecordingSettings', + example: + "crm\n ->extensions\n ->calling\n ->getRecordingSettings(0);\n\nvar_dump($recordingSettingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', + httpMethod: 'get', + summary: 'Retrieve the calling extension settings for a specific app.', + description: 'Retrieve the current settings of the calling extension for the specified appId. ', + stainlessPath: '(resource) crm.extensions.calling > (method) get_settings', + qualified: 'client.crm.extensions.calling.getSettings', + params: ['appId: number;'], + response: + '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', + markdown: + "## get_settings\n\n`client.crm.extensions.calling.getSettings(appId: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nRetrieve the current settings of the calling extension for the specified appId. \n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.getSettings(0);\n\nconsole.log(settingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.getSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.getSettings(0);\n\nconsole.log(settingsResponse.width);", + }, + python: { + method: 'crm.extensions.calling.get_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.get_settings(\n 0,\n)\nprint(settings_response.width)', + }, + java: { + method: 'crm().extensions().calling().getSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingsResponse settingsResponse = client.crm().extensions().calling().getSettings(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.GetSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.GetSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.get_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.get_settings(0)\n\nputs(settings_response)', + }, + php: { + method: 'crm->extensions->calling->getSettings', + example: + "crm->extensions->calling->getSettings(0);\n\nvar_dump($settingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_channel_connection_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + httpMethod: 'patch', + summary: 'Update the channel connection settings for a specific app.', + description: 'Modify the existing channel connection settings for the specified app.', + stainlessPath: '(resource) crm.extensions.calling > (method) update_channel_connection_settings', + qualified: 'client.crm.extensions.calling.updateChannelConnectionSettings', + params: ['appId: number;', 'isReady?: boolean;', 'url?: string;'], + response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', + markdown: + "## update_channel_connection_settings\n\n`client.crm.extensions.calling.updateChannelConnectionSettings(appId: number, isReady?: boolean, url?: string): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nModify the existing channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `isReady?: boolean`\n Indicates whether the channel connection settings are ready.\n\n- `url?: string`\n The URL for the channel connection settings.\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.updateChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.updateChannelConnectionSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.updateChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", + }, + python: { + method: 'crm.extensions.calling.update_channel_connection_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.update_channel_connection_settings(\n app_id=0,\n)\nprint(channel_connection_settings_response.created_at)', + }, + java: { + method: 'crm().extensions().calling().updateChannelConnectionSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateChannelConnectionSettingsParams params = CallingUpdateChannelConnectionSettingsParams.builder()\n .appId(0)\n .channelConnectionSettingsPatchRequest(ChannelConnectionSettingsPatchRequest.builder().build())\n .build();\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().updateChannelConnectionSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.UpdateChannelConnectionSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.UpdateChannelConnectionSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateChannelConnectionSettingsParams{\n\t\t\tChannelConnectionSettingsPatchRequest: crm.ChannelConnectionSettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.update_channel_connection_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.update_channel_connection_settings(0)\n\nputs(channel_connection_settings_response)', + }, + php: { + method: 'crm->extensions->calling->updateChannelConnectionSettings', + example: + "crm\n ->extensions\n ->calling\n ->updateChannelConnectionSettings(0, isReady: true, url: 'url');\n\nvar_dump($channelConnectionSettingsResponse);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_recording_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + httpMethod: 'patch', + summary: 'Update recording settings for an app.', + description: 'Update the recording settings for a specific app using the provided app ID.', + stainlessPath: '(resource) crm.extensions.calling > (method) update_recording_settings', + qualified: 'client.crm.extensions.calling.updateRecordingSettings', + params: ['appId: number;', 'urlToRetrieveAuthedRecording?: string;'], + response: '{ urlToRetrieveAuthedRecording: string; }', + markdown: + "## update_recording_settings\n\n`client.crm.extensions.calling.updateRecordingSettings(appId: number, urlToRetrieveAuthedRecording?: string): { urlToRetrieveAuthedRecording: string; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nUpdate the recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `urlToRetrieveAuthedRecording?: string`\n The URL used to access authenticated call recordings.\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.updateRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.updateRecordingSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.updateRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", + }, + python: { + method: 'crm.extensions.calling.update_recording_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.update_recording_settings(\n app_id=0,\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', + }, + java: { + method: 'crm().extensions().calling().updateRecordingSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateRecordingSettingsParams params = CallingUpdateRecordingSettingsParams.builder()\n .appId(0)\n .recordingSettingsPatchRequest(RecordingSettingsPatchRequest.builder().build())\n .build();\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().updateRecordingSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.UpdateRecordingSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.UpdateRecordingSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateRecordingSettingsParams{\n\t\t\tRecordingSettingsPatchRequest: crm.RecordingSettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.update_recording_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.update_recording_settings(0)\n\nputs(recording_settings_response)', + }, + php: { + method: 'crm->extensions->calling->updateRecordingSettings', + example: + "crm\n ->extensions\n ->calling\n ->updateRecordingSettings(\n 0, urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording'\n);\n\nvar_dump($recordingSettingsResponse);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_settings', + endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', + httpMethod: 'patch', + summary: 'Update the calling extension settings for a specific app.', + description: + 'Modify existing calling extension settings for the specified appId. Only the fields provided in the request will be updated.', + stainlessPath: '(resource) crm.extensions.calling > (method) update_settings', + qualified: 'client.crm.extensions.calling.updateSettings', + params: [ + 'appId: number;', + 'height?: number;', + 'isReady?: boolean;', + 'name?: string;', + 'supportsCustomObjects?: boolean;', + 'supportsInboundCalling?: boolean;', + 'url?: string;', + 'usesCallingWindow?: boolean;', + 'usesRemote?: boolean;', + 'width?: number;', + ], + response: + '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', + markdown: + "## update_settings\n\n`client.crm.extensions.calling.updateSettings(appId: number, height?: number, isReady?: boolean, name?: string, supportsCustomObjects?: boolean, supportsInboundCalling?: boolean, url?: string, usesCallingWindow?: boolean, usesRemote?: boolean, width?: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nModify existing calling extension settings for the specified appId. Only the fields provided in the request will be updated.\n\n### Parameters\n\n- `appId: number`\n\n- `height?: number`\n The height setting for the calling extension interface.\n\n- `isReady?: boolean`\n Specifies whether the calling extension is ready for use.\n\n- `name?: string`\n The name of the calling extension.\n\n- `supportsCustomObjects?: boolean`\n Indicates if the calling extension supports custom objects.\n\n- `supportsInboundCalling?: boolean`\n Indicates if the calling extension supports inbound calling.\n\n- `url?: string`\n The URL associated with the calling extension settings.\n\n- `usesCallingWindow?: boolean`\n Indicates if the calling extension uses a calling window.\n\n- `usesRemote?: boolean`\n Indicates if the calling extension uses a remote connection.\n\n- `width?: number`\n The width setting for the calling extension interface.\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.updateSettings(0);\n\nconsole.log(settingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.updateSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.updateSettings(0);\n\nconsole.log(settingsResponse.width);", + }, + python: { + method: 'crm.extensions.calling.update_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.update_settings(\n app_id=0,\n)\nprint(settings_response.width)', + }, + java: { + method: 'crm().extensions().calling().updateSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateSettingsParams params = CallingUpdateSettingsParams.builder()\n .appId(0)\n .settingsPatchRequest(SettingsPatchRequest.builder().build())\n .build();\n SettingsResponse settingsResponse = client.crm().extensions().calling().updateSettings(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.UpdateSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateSettingsParams{\n\t\t\tSettingsPatchRequest: crm.SettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.update_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.update_settings(0)\n\nputs(settings_response)', + }, + php: { + method: 'crm->extensions->calling->updateSettings', + example: + "crm->extensions->calling->updateSettings(\n 0,\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n);\n\nvar_dump($settingsResponse);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create', + endpoint: '/crm/extensions/calling/2026-03/transcripts', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) create', + qualified: 'client.crm.extensions.calling.transcripts.create', + params: [ + 'engagementId: number;', + 'transcriptCreateUtterances: { endTimeMillis: number; speaker: { id: string; name: string; email?: string; }; startTimeMillis: number; text: string; languageCode?: string; }[];', + ], + response: '{ id: string; }', + markdown: + "## create\n\n`client.crm.extensions.calling.transcripts.create(engagementId: number, transcriptCreateUtterances: { endTimeMillis: number; speaker: speaker; startTimeMillis: number; text: string; languageCode?: string; }[]): { id: string; }`\n\n**post** `/crm/extensions/calling/2026-03/transcripts`\n\n### Parameters\n\n- `engagementId: number`\n\n- `transcriptCreateUtterances: { endTimeMillis: number; speaker: { id: string; name: string; email?: string; }; startTimeMillis: number; text: string; languageCode?: string; }[]`\n\n### Returns\n\n- `{ id: string; }`\n\n - `id: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst transcriptCreateResponse = await client.crm.extensions.calling.transcripts.create({ engagementId: 0, transcriptCreateUtterances: [{\n endTimeMillis: 0,\n speaker: { id: 'id', name: 'name' },\n startTimeMillis: 0,\n text: 'text',\n}] });\n\nconsole.log(transcriptCreateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.transcripts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst transcriptCreateResponse = await client.crm.extensions.calling.transcripts.create({\n engagementId: 0,\n transcriptCreateUtterances: [\n {\n endTimeMillis: 0,\n speaker: { id: 'id', name: 'name' },\n startTimeMillis: 0,\n text: 'text',\n },\n ],\n});\n\nconsole.log(transcriptCreateResponse.id);", + }, + python: { + method: 'crm.extensions.calling.transcripts.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntranscript_create_response = client.crm.extensions.calling.transcripts.create(\n engagement_id=0,\n transcript_create_utterances=[{\n "end_time_millis": 0,\n "speaker": {\n "id": "id",\n "name": "name",\n },\n "start_time_millis": 0,\n "text": "text",\n }],\n)\nprint(transcript_create_response.id)', + }, + java: { + method: 'crm().extensions().calling().transcripts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.Speaker;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateUtterance;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TranscriptCreateRequest params = TranscriptCreateRequest.builder()\n .engagementId(0L)\n .addTranscriptCreateUtterance(TranscriptCreateUtterance.builder()\n .endTimeMillis(0L)\n .speaker(Speaker.builder()\n .id("id")\n .name("name")\n .build())\n .startTimeMillis(0L)\n .text("text")\n .build())\n .build();\n TranscriptCreateResponse transcriptCreateResponse = client.crm().extensions().calling().transcripts().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.Transcripts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttranscriptCreateResponse, err := client.Crm.Extensions.Calling.Transcripts.New(context.TODO(), crm.ExtensionCallingTranscriptNewParams{\n\t\tTranscriptCreateRequest: crm.TranscriptCreateRequestParam{\n\t\t\tEngagementID: 0,\n\t\t\tTranscriptCreateUtterances: []crm.TranscriptCreateUtteranceParam{{\n\t\t\t\tEndTimeMillis: 0,\n\t\t\t\tSpeaker: crm.SpeakerParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tName: "name",\n\t\t\t\t},\n\t\t\t\tStartTimeMillis: 0,\n\t\t\t\tText: "text",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", transcriptCreateResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.transcripts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntranscript_create_response = hubspot.crm.extensions.calling.transcripts.create(\n engagement_id: 0,\n transcript_create_utterances: [{endTimeMillis: 0, speaker: {id: "id", name: "name"}, startTimeMillis: 0, text: "text"}]\n)\n\nputs(transcript_create_response)', + }, + php: { + method: 'crm->extensions->calling->transcripts->create', + example: + "crm\n ->extensions\n ->calling\n ->transcripts\n ->create(\n engagementID: 0,\n transcriptCreateUtterances: [\n [\n 'endTimeMillis' => 0,\n 'speaker' => ['id' => 'id', 'name' => 'name', 'email' => 'email'],\n 'startTimeMillis' => 0,\n 'text' => 'text',\n 'languageCode' => 'languageCode',\n ],\n ],\n);\n\nvar_dump($transcriptCreateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "engagementId": 0,\n "transcriptCreateUtterances": [\n {\n "endTimeMillis": 0,\n "speaker": {\n "id": "id",\n "name": "name"\n },\n "startTimeMillis": 0,\n "text": "text"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_inbound_call', + endpoint: '/crm/extensions/calling/2026-03/inbound-call', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) create_inbound_call', + qualified: 'client.crm.extensions.calling.transcripts.createInboundCall', + params: [ + 'createEngagement: boolean;', + 'engagementProperties: object;', + 'externalCallId: string;', + 'finalCallStatus: string;', + 'fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', + 'potentialRecipientUserIds: number[];', + 'toNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', + 'callStartedTimestamp?: string;', + 'durationSeconds?: number;', + 'userId?: number;', + ], + response: + "{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }", + markdown: + "## create_inbound_call\n\n`client.crm.extensions.calling.transcripts.createInboundCall(createEngagement: boolean, engagementProperties: object, externalCallId: string, finalCallStatus: string, fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, potentialRecipientUserIds: number[], toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, callStartedTimestamp?: string, durationSeconds?: number, userId?: number): { callerIdMatches: contact_caller_id | company_caller_id[]; }`\n\n**post** `/crm/extensions/calling/2026-03/inbound-call`\n\n### Parameters\n\n- `createEngagement: boolean`\n Indicates whether an engagement should be created for the call.\n\n- `engagementProperties: object`\n Contains additional properties related to the engagement.\n\n- `externalCallId: string`\n The unique identifier for the call from an external system.\n\n- `finalCallStatus: string`\n The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.\n\n- `fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `potentialRecipientUserIds: number[]`\n\n- `toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `callStartedTimestamp?: string`\n The timestamp indicating when the call started, formatted as a date-time string.\n\n- `durationSeconds?: number`\n The duration of the call in seconds.\n\n- `userId?: number`\n The ID of the user associated with the call.\n\n### Returns\n\n- `{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }`\n\n - `callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; name?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.transcripts.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.transcripts.createInboundCall', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst completedThirdPartyCallResponse =\n await client.crm.extensions.calling.transcripts.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n });\n\nconsole.log(completedThirdPartyCallResponse.callerIdMatches);", + }, + python: { + method: 'crm.extensions.calling.transcripts.create_inbound_call', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompleted_third_party_call_response = client.crm.extensions.calling.transcripts.create_inbound_call(\n create_engagement=True,\n engagement_properties={\n "foo": "string"\n },\n external_call_id="externalCallId",\n final_call_status="BUSY",\n from_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n potential_recipient_user_ids=[0],\n to_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n)\nprint(completed_third_party_call_response.caller_id_matches)', + }, + java: { + method: 'crm().extensions().calling().transcripts().createInboundCall', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.FormattedPhoneNumber;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompletedThirdPartyCallRequest params = CompletedThirdPartyCallRequest.builder()\n .createEngagement(true)\n .engagementProperties(CompletedThirdPartyCallRequest.EngagementProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .externalCallId("externalCallId")\n .finalCallStatus(CompletedThirdPartyCallRequest.FinalCallStatus.BUSY)\n .fromNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .addPotentialRecipientUserId(0)\n .toNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .build();\n CompletedThirdPartyCallResponse completedThirdPartyCallResponse = client.crm().extensions().calling().transcripts().createInboundCall(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.Transcripts.NewInboundCall', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompletedThirdPartyCallResponse, err := client.Crm.Extensions.Calling.Transcripts.NewInboundCall(context.TODO(), crm.ExtensionCallingTranscriptNewInboundCallParams{\n\t\tCompletedThirdPartyCallRequest: crm.CompletedThirdPartyCallRequestParam{\n\t\t\tCreateEngagement: true,\n\t\t\tEngagementProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tExternalCallID: "externalCallId",\n\t\t\tFinalCallStatus: crm.CompletedThirdPartyCallRequestFinalCallStatusBusy,\n\t\t\tFromNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t\tPotentialRecipientUserIDs: []int64{0},\n\t\t\tToNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", completedThirdPartyCallResponse.CallerIDMatches)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.transcripts.create_inbound_call', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompleted_third_party_call_response = hubspot.crm.extensions.calling.transcripts.create_inbound_call(\n create_engagement: true,\n engagement_properties: {foo: "string"},\n external_call_id: "externalCallId",\n final_call_status: :BUSY,\n from_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE},\n potential_recipient_user_ids: [0],\n to_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE}\n)\n\nputs(completed_third_party_call_response)', + }, + php: { + method: 'crm->extensions->calling->transcripts->createInboundCall', + example: + "crm\n ->extensions\n ->calling\n ->transcripts\n ->createInboundCall(\n createEngagement: true,\n engagementProperties: ['foo' => 'string'],\n externalCallID: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n potentialRecipientUserIDs: [0],\n toNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n callStartedTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n durationSeconds: 0,\n userID: 0,\n);\n\nvar_dump($completedThirdPartyCallResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/inbound-call \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createEngagement": true,\n "engagementProperties": {\n "foo": "string"\n },\n "externalCallId": "externalCallId",\n "finalCallStatus": "BUSY",\n "fromNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n },\n "potentialRecipientUserIds": [\n 0\n ],\n "toNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', + httpMethod: 'delete', + summary: '', + description: '', + stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) delete', + qualified: 'client.crm.extensions.calling.transcripts.delete', + params: ['transcriptId: string;'], + markdown: + "## delete\n\n`client.crm.extensions.calling.transcripts.delete(transcriptId: string): void`\n\n**delete** `/crm/extensions/calling/2026-03/transcripts/{transcriptId}`\n\n### Parameters\n\n- `transcriptId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.transcripts.delete('transcriptId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.transcripts.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.transcripts.delete('transcriptId');", + }, + python: { + method: 'crm.extensions.calling.transcripts.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.transcripts.delete(\n "transcriptId",\n)', + }, + java: { + method: 'crm().extensions().calling().transcripts().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().transcripts().delete("transcriptId");\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.Transcripts.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.Transcripts.Delete(context.TODO(), "transcriptId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.transcripts.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.transcripts.delete("transcriptId")\n\nputs(result)', + }, + php: { + method: 'crm->extensions->calling->transcripts->delete', + example: + "crm->extensions->calling->transcripts->delete(\n 'transcriptId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts/$TRANSCRIPT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) get', + qualified: 'client.crm.extensions.calling.transcripts.get', + params: ['transcriptId: string;'], + response: + "{ id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: speaker; }[]; updatedAt: string; }", + markdown: + "## get\n\n`client.crm.extensions.calling.transcripts.get(transcriptId: string): { id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: transcript_utterance[]; updatedAt: string; }`\n\n**get** `/crm/extensions/calling/2026-03/transcripts/{transcriptId}`\n\n### Parameters\n\n- `transcriptId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: speaker; }[]; updatedAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `engagementId: number`\n - `transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'`\n - `transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: { id: string; name: string; email?: string; }; }[]`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst transcriptResponse = await client.crm.extensions.calling.transcripts.get('transcriptId');\n\nconsole.log(transcriptResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.calling.transcripts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst transcriptResponse = await client.crm.extensions.calling.transcripts.get('transcriptId');\n\nconsole.log(transcriptResponse.id);", + }, + python: { + method: 'crm.extensions.calling.transcripts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntranscript_response = client.crm.extensions.calling.transcripts.get(\n "transcriptId",\n)\nprint(transcript_response.id)', + }, + java: { + method: 'crm().extensions().calling().transcripts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptGetParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TranscriptResponse transcriptResponse = client.crm().extensions().calling().transcripts().get("transcriptId");\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.Calling.Transcripts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttranscriptResponse, err := client.Crm.Extensions.Calling.Transcripts.Get(context.TODO(), "transcriptId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", transcriptResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.extensions.calling.transcripts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntranscript_response = hubspot.crm.extensions.calling.transcripts.get("transcriptId")\n\nputs(transcript_response)', + }, + php: { + method: 'crm->extensions->calling->transcripts->get', + example: + "crm->extensions->calling->transcripts->get(\n 'transcriptId'\n);\n\nvar_dump($transcriptResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts/$TRANSCRIPT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}', + httpMethod: 'post', + summary: 'Create a new card', + description: 'Defines a new card that will become active on an account when this app is installed.', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) create', + qualified: 'client.crm.extensions.cardsDev.create', + params: [ + 'appId: number;', + 'actions: { baseUrls: string[]; };', + "display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; };", + "fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; serverlessFunction?: string; };", + 'title: string;', + ], + response: + "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", + markdown: + "## create\n\n`client.crm.extensions.cardsDev.create(appId: number, actions: { baseUrls: string[]; }, display: { properties: card_display_property[]; }, fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: card_object_type_body[]; targetUrl: string; serverlessFunction?: string; }, title: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**post** `/crm/extensions/cards-dev/2026-03/{appId}`\n\nDefines a new card that will become active on an account when this app is installed.\n\n### Parameters\n\n- `appId: number`\n\n- `actions: { baseUrls: string[]; }`\n - `baseUrls: string[]`\n A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.\n\n- `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: { label: string; name: string; type: 'DANGER' | 'DEFAULT' | 'INFO' | 'SUCCESS' | 'WARNING'; }[]; }[]`\n Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.\n\n- `fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; serverlessFunction?: string; }`\n - `cardType: 'EXTERNAL' | 'SERVERLESS'`\n A deprecated field to determine the type of card returned.\n - `objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]`\n An array of CRM object types where this card should be displayed. HubSpot will call your data fetch URL whenever a user visits a record page of the types defined here.\n - `targetUrl: string`\n URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.\n - `serverlessFunction?: string`\n A deprecated field to specify serverless functionality with the card\n\n- `title: string`\n The top-level title for this card. Displayed to users in the CRM UI.\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.create(0, {\n actions: { baseUrls: ['string'] },\n display: { properties: [{\n dataType: 'BOOLEAN',\n label: 'label',\n name: 'name',\n options: [{\n label: 'label',\n name: 'name',\n type: 'DANGER',\n}],\n}] },\n fetch: {\n cardType: 'EXTERNAL',\n objectTypes: [{ name: 'companies', propertiesToSend: ['string'] }],\n targetUrl: 'targetUrl',\n},\n title: 'title',\n});\n\nconsole.log(publicCardResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.create(0, {\n actions: { baseUrls: ['string'] },\n display: {\n properties: [\n {\n dataType: 'BOOLEAN',\n label: 'label',\n name: 'name',\n options: [\n {\n label: 'label',\n name: 'name',\n type: 'DANGER',\n },\n ],\n },\n ],\n },\n fetch: {\n cardType: 'EXTERNAL',\n objectTypes: [{ name: 'companies', propertiesToSend: ['string'] }],\n targetUrl: 'targetUrl',\n },\n title: 'title',\n});\n\nconsole.log(publicCardResponse.id);", + }, + python: { + method: 'crm.extensions.cards_dev.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.create(\n app_id=0,\n actions={\n "base_urls": ["string"]\n },\n display={\n "properties": [{\n "data_type": "BOOLEAN",\n "label": "label",\n "name": "name",\n "options": [{\n "label": "label",\n "name": "name",\n "type": "DANGER",\n }],\n }]\n },\n fetch={\n "card_type": "EXTERNAL",\n "object_types": [{\n "name": "companies",\n "properties_to_send": ["string"],\n }],\n "target_url": "targetUrl",\n },\n title="title",\n)\nprint(public_card_response.id)', + }, + java: { + method: 'crm().extensions().cardsDev().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardActions;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardCreateRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardDisplayBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardDisplayProperty;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardFetchBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardObjectTypeBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevCreateParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.DisplayOption;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevCreateParams params = CardsDevCreateParams.builder()\n .appId(0)\n .cardCreateRequest(CardCreateRequest.builder()\n .actions(CardActions.builder()\n .addBaseUrl("string")\n .build())\n .display(CardDisplayBody.builder()\n .addProperty(CardDisplayProperty.builder()\n .dataType(CardDisplayProperty.DataType.BOOLEAN)\n .label("label")\n .name("name")\n .addOption(DisplayOption.builder()\n .label("label")\n .name("name")\n .type(DisplayOption.Type.DANGER)\n .build())\n .build())\n .build())\n .fetch(CardFetchBody.builder()\n .cardType(CardFetchBody.CardType.EXTERNAL)\n .addObjectType(CardObjectTypeBody.builder()\n .name(CardObjectTypeBody.Name.COMPANIES)\n .addPropertiesToSend("string")\n .build())\n .targetUrl("targetUrl")\n .build())\n .title("title")\n .build())\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCardsDevNewParams{\n\t\t\tCardCreateRequest: crm.CardCreateRequestParam{\n\t\t\t\tActions: crm.CardActionsParam{\n\t\t\t\t\tBaseURLs: []string{"string"},\n\t\t\t\t},\n\t\t\t\tDisplay: crm.CardDisplayBodyParam{\n\t\t\t\t\tProperties: []crm.CardDisplayPropertyParam{{\n\t\t\t\t\t\tDataType: crm.CardDisplayPropertyDataTypeBoolean,\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOptions: []crm.DisplayOptionParam{{\n\t\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\t\tType: crm.DisplayOptionTypeDanger,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t},\n\t\t\t\tFetch: crm.CardFetchBodyParam{\n\t\t\t\t\tCardType: crm.CardFetchBodyCardTypeExternal,\n\t\t\t\t\tObjectTypes: []crm.CardObjectTypeBodyParam{{\n\t\t\t\t\t\tName: crm.CardObjectTypeBodyNameCompanies,\n\t\t\t\t\t\tPropertiesToSend: []string{"string"},\n\t\t\t\t\t}},\n\t\t\t\t\tTargetURL: "targetUrl",\n\t\t\t\t},\n\t\t\t\tTitle: "title",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.create(\n 0,\n actions: {baseUrls: ["string"]},\n display_: {\n properties: [\n {dataType: :BOOLEAN, label: "label", name: "name", options: [{label: "label", name: "name", type: :DANGER}]}\n ]\n },\n fetch: {cardType: :EXTERNAL, objectTypes: [{name: :companies, propertiesToSend: ["string"]}], targetUrl: "targetUrl"},\n title: "title"\n)\n\nputs(public_card_response)', + }, + php: { + method: 'crm->extensions->cardsDev->create', + example: + "crm->extensions->cardsDev->create(\n 0,\n actions: ['baseURLs' => ['string']],\n display: [\n 'properties' => [\n [\n 'dataType' => 'BOOLEAN',\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n ['label' => 'label', 'name' => 'name', 'type' => 'DANGER']\n ],\n ],\n ],\n ],\n fetch: [\n 'cardType' => 'EXTERNAL',\n 'objectTypes' => [\n ['name' => 'companies', 'propertiesToSend' => ['string']]\n ],\n 'targetURL' => 'targetUrl',\n 'serverlessFunction' => 'serverlessFunction',\n ],\n title: 'title',\n);\n\nvar_dump($publicCardResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "actions": {\n "baseUrls": [\n "string"\n ]\n },\n "display": {\n "properties": [\n {\n "dataType": "BOOLEAN",\n "label": "label",\n "name": "name",\n "options": [\n {\n "label": "label",\n "name": "name",\n "type": "DANGER"\n }\n ]\n }\n ]\n },\n "fetch": {\n "cardType": "EXTERNAL",\n "objectTypes": [\n {\n "name": "companies",\n "propertiesToSend": [\n "string"\n ]\n }\n ],\n "targetUrl": "targetUrl"\n },\n "title": "title"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + httpMethod: 'delete', + summary: 'Delete a card', + description: + "Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.", + stainlessPath: '(resource) crm.extensions.cards_dev > (method) delete', + qualified: 'client.crm.extensions.cardsDev.delete', + params: ['appId: number;', 'cardId: string;'], + markdown: + "## delete\n\n`client.crm.extensions.cardsDev.delete(appId: number, cardId: string): void`\n\n**delete** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nPermanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.cardsDev.delete('cardId', { appId: 0 })\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.cardsDev.delete('cardId', { appId: 0 });", + }, + python: { + method: 'crm.extensions.cards_dev.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.cards_dev.delete(\n card_id="cardId",\n app_id=0,\n)', + }, + java: { + method: 'crm().extensions().cardsDev().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevDeleteParams params = CardsDevDeleteParams.builder()\n .appId(0)\n .cardId("cardId")\n .build();\n client.crm().extensions().cardsDev().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.CardsDev.Delete(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.cards_dev.delete("cardId", app_id: 0)\n\nputs(result)', + }, + php: { + method: 'crm->extensions->cardsDev->delete', + example: + "crm->extensions->cardsDev->delete('cardId', appID: 0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}', + httpMethod: 'get', + summary: 'Get all cards', + description: 'Returns a list of cards for a given app.', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) get', + qualified: 'client.crm.extensions.cardsDev.get', + params: ['appId: number;'], + response: + '{ results: { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }[]; }', + markdown: + "## get\n\n`client.crm.extensions.cardsDev.get(appId: number): { results: public_card_response[]; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/{appId}`\n\nReturns a list of cards for a given app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ results: { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }[]; }`\n\n - `results: { id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardListResponse = await client.crm.extensions.cardsDev.get(0);\n\nconsole.log(publicCardListResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardListResponse = await client.crm.extensions.cardsDev.get(0);\n\nconsole.log(publicCardListResponse.results);", + }, + python: { + method: 'crm.extensions.cards_dev.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_list_response = client.crm.extensions.cards_dev.get(\n 0,\n)\nprint(public_card_list_response.results)', + }, + java: { + method: 'crm().extensions().cardsDev().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardListResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCardListResponse publicCardListResponse = client.crm().extensions().cardsDev().get(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardListResponse, err := client.Crm.Extensions.CardsDev.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardListResponse.Results)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_list_response = hubspot.crm.extensions.cards_dev.get(0)\n\nputs(public_card_list_response)', + }, + php: { + method: 'crm->extensions->cardsDev->get', + example: + "crm->extensions->cardsDev->get(0);\n\nvar_dump($publicCardListResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_id', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + httpMethod: 'get', + summary: 'Get a card.', + description: 'Returns the definition for a card with the given ID.', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) get_by_id', + qualified: 'client.crm.extensions.cardsDev.getByID', + params: ['appId: number;', 'cardId: string;'], + response: + "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", + markdown: + "## get_by_id\n\n`client.crm.extensions.cardsDev.getByID(appId: number, cardId: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nReturns the definition for a card with the given ID.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.getByID('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.getByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.getByID('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse.id);", + }, + python: { + method: 'crm.extensions.cards_dev.get_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.get_by_id(\n card_id="cardId",\n app_id=0,\n)\nprint(public_card_response.id)', + }, + java: { + method: 'crm().extensions().cardsDev().getById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetByIdParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevGetByIdParams params = CardsDevGetByIdParams.builder()\n .appId(0)\n .cardId("cardId")\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().getById(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.GetByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.GetByID(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevGetByIDParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.get_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.get_by_id("cardId", app_id: 0)\n\nputs(public_card_response)', + }, + php: { + method: 'crm->extensions->cardsDev->getByID', + example: + "crm->extensions->cardsDev->getByID(\n 'cardId', appID: 0\n);\n\nvar_dump($publicCardResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_sample_response', + endpoint: '/crm/extensions/cards-dev/2026-03/sample-response', + httpMethod: 'get', + summary: 'Get sample card detail response', + description: + 'Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) get_sample_response', + qualified: 'client.crm.extensions.cardsDev.getSampleResponse', + response: + "{ responseVersion: 'v1' | 'v3'; sections: { id: string; actions: action_hook_action_body | i_frame_action_body[]; title: string; tokens: object_token[]; linkUrl?: string; }[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: { secondary: action_hook_action_body | i_frame_action_body[]; primary?: action_hook_action_body | i_frame_action_body; settings?: i_frame_action_body; }; }", + markdown: + "## get_sample_response\n\n`client.crm.extensions.cardsDev.getSampleResponse(): { responseVersion: 'v1' | 'v3'; sections: integrator_object_result[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: top_level_actions; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/sample-response`\n\nReturns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.\n\n### Returns\n\n- `{ responseVersion: 'v1' | 'v3'; sections: { id: string; actions: action_hook_action_body | i_frame_action_body[]; title: string; tokens: object_token[]; linkUrl?: string; }[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: { secondary: action_hook_action_body | i_frame_action_body[]; primary?: action_hook_action_body | i_frame_action_body; settings?: i_frame_action_body; }; }`\n\n - `responseVersion: 'v1' | 'v3'`\n - `sections: { id: string; actions: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }[]; title: string; tokens: { value: string; dataType?: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label?: string; name?: string; }[]; linkUrl?: string; }[]`\n - `totalCount: number`\n - `allItemsLinkUrl?: string`\n - `cardLabel?: string`\n - `topLevelActions?: { secondary: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }[]; primary?: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }; settings?: { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorCardPayloadResponse = await client.crm.extensions.cardsDev.getSampleResponse();\n\nconsole.log(integratorCardPayloadResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.getSampleResponse', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorCardPayloadResponse = await client.crm.extensions.cardsDev.getSampleResponse();\n\nconsole.log(integratorCardPayloadResponse.responseVersion);", + }, + python: { + method: 'crm.extensions.cards_dev.get_sample_response', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_card_payload_response = client.crm.extensions.cards_dev.get_sample_response()\nprint(integrator_card_payload_response.response_version)', + }, + java: { + method: 'crm().extensions().cardsDev().getSampleResponse', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetSampleResponseParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.IntegratorCardPayloadResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IntegratorCardPayloadResponse integratorCardPayloadResponse = client.crm().extensions().cardsDev().getSampleResponse();\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.GetSampleResponse', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorCardPayloadResponse, err := client.Crm.Extensions.CardsDev.GetSampleResponse(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorCardPayloadResponse.ResponseVersion)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.get_sample_response', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_card_payload_response = hubspot.crm.extensions.cards_dev.get_sample_response\n\nputs(integrator_card_payload_response)', + }, + php: { + method: 'crm->extensions->cardsDev->getSampleResponse', + example: + "crm\n ->extensions\n ->cardsDev\n ->getSampleResponse();\n\nvar_dump($integratorCardPayloadResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/sample-response \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'migrate_views', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/views/migrate', + httpMethod: 'post', + summary: 'Migrate Card Views', + description: + 'Swaps a Legacy CRM Card with an App Card in views. Reference the "Migrate a legacy CRM card to an app card" docs for more information', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) migrate_views', + qualified: 'client.crm.extensions.cardsDev.migrateViews', + params: [ + 'appId: number;', + 'allowDuplicateAppCardIds: boolean;', + 'appCardId: number;', + 'legacyCrmCardId: number;', + 'helpdeskAppCardId?: number;', + ], + response: + '{ message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }', + markdown: + '## migrate_views\n\n`client.crm.extensions.cardsDev.migrateViews(appId: number, allowDuplicateAppCardIds: boolean, appCardId: number, legacyCrmCardId: number, helpdeskAppCardId?: number): { message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }`\n\n**post** `/crm/extensions/cards-dev/2026-03/{appId}/views/migrate`\n\nSwaps a Legacy CRM Card with an App Card in views. Reference the "Migrate a legacy CRM card to an app card" docs for more information\n\n### Parameters\n\n- `appId: number`\n\n- `allowDuplicateAppCardIds: boolean`\n\n- `appCardId: number`\n\n- `legacyCrmCardId: number`\n\n- `helpdeskAppCardId?: number`\n\n### Returns\n\n- `{ message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }`\n\n - `message: string`\n - `endedAt?: number`\n - `remainingPortalCount?: number`\n - `startedAt?: number`\n - `totalPortalCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from \'@hubspot/sdk\';\n\nconst client = new HubSpot();\n\nconst cardMigrateViewsResponse = await client.crm.extensions.cardsDev.migrateViews(0, {\n allowDuplicateAppCardIds: true,\n appCardId: 0,\n legacyCrmCardId: 0,\n});\n\nconsole.log(cardMigrateViewsResponse);\n```', + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.migrateViews', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst cardMigrateViewsResponse = await client.crm.extensions.cardsDev.migrateViews(0, {\n allowDuplicateAppCardIds: true,\n appCardId: 0,\n legacyCrmCardId: 0,\n});\n\nconsole.log(cardMigrateViewsResponse.message);", + }, + python: { + method: 'crm.extensions.cards_dev.migrate_views', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncard_migrate_views_response = client.crm.extensions.cards_dev.migrate_views(\n app_id=0,\n allow_duplicate_app_card_ids=True,\n app_card_id=0,\n legacy_crm_card_id=0,\n)\nprint(card_migrate_views_response.message)', + }, + java: { + method: 'crm().extensions().cardsDev().migrateViews', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardMigrateViewsRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardMigrateViewsResponse;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevMigrateViewsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevMigrateViewsParams params = CardsDevMigrateViewsParams.builder()\n .appId(0)\n .cardMigrateViewsRequest(CardMigrateViewsRequest.builder()\n .allowDuplicateAppCardIds(true)\n .appCardId(0L)\n .legacyCrmCardId(0L)\n .build())\n .build();\n CardMigrateViewsResponse cardMigrateViewsResponse = client.crm().extensions().cardsDev().migrateViews(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.MigrateViews', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcardMigrateViewsResponse, err := client.Crm.Extensions.CardsDev.MigrateViews(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCardsDevMigrateViewsParams{\n\t\t\tCardMigrateViewsRequest: crm.CardMigrateViewsRequestParam{\n\t\t\t\tAllowDuplicateAppCardIDs: true,\n\t\t\t\tAppCardID: 0,\n\t\t\t\tLegacyCrmCardID: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", cardMigrateViewsResponse.Message)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.migrate_views', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncard_migrate_views_response = hubspot.crm.extensions.cards_dev.migrate_views(\n 0,\n allow_duplicate_app_card_ids: true,\n app_card_id: 0,\n legacy_crm_card_id: 0\n)\n\nputs(card_migrate_views_response)', + }, + php: { + method: 'crm->extensions->cardsDev->migrateViews', + example: + "crm->extensions->cardsDev->migrateViews(\n 0,\n allowDuplicateAppCardIDs: true,\n appCardID: 0,\n legacyCrmCardID: 0,\n helpdeskAppCardID: 0,\n);\n\nvar_dump($cardMigrateViewsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/views/migrate \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowDuplicateAppCardIds": true,\n "appCardId": 0,\n "legacyCrmCardId": 0\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + httpMethod: 'patch', + summary: 'Update a card', + description: 'Update a card definition with new details.', + stainlessPath: '(resource) crm.extensions.cards_dev > (method) update', + qualified: 'client.crm.extensions.cardsDev.update', + params: [ + 'appId: number;', + 'cardId: string;', + 'actions?: { baseUrls: string[]; };', + "display?: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; };", + "fetch?: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; };", + 'title?: string;', + ], + response: + "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", + markdown: + "## update\n\n`client.crm.extensions.cardsDev.update(appId: number, cardId: string, actions?: { baseUrls: string[]; }, display?: { properties: card_display_property[]; }, fetch?: { objectTypes: card_object_type_body[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; }, title?: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**patch** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nUpdate a card definition with new details.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n- `actions?: { baseUrls: string[]; }`\n - `baseUrls: string[]`\n A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.\n\n- `display?: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: { label: string; name: string; type: 'DANGER' | 'DEFAULT' | 'INFO' | 'SUCCESS' | 'WARNING'; }[]; }[]`\n Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.\n\n- `fetch?: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; }`\n - `objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]`\n An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.\n - `cardType?: 'EXTERNAL' | 'SERVERLESS'`\n A deprecated field to determine the type of card returned.\n - `serverlessFunction?: string`\n A deprecated field to specify serverless functionality with the card\n - `targetUrl?: string`\n URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.\n\n- `title?: string`\n The top-level title for this card. Displayed to users in the CRM UI.\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.update('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.cardsDev.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.update('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse.id);", + }, + python: { + method: 'crm.extensions.cards_dev.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.update(\n card_id="cardId",\n app_id=0,\n)\nprint(public_card_response.id)', + }, + java: { + method: 'crm().extensions().cardsDev().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevUpdateParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevUpdateParams params = CardsDevUpdateParams.builder()\n .appId(0)\n .cardId("cardId")\n .cardPatchRequest(CardPatchRequest.builder().build())\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.CardsDev.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.Update(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tCardPatchRequest: crm.CardPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.extensions.cards_dev.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.update("cardId", app_id: 0)\n\nputs(public_card_response)', + }, + php: { + method: 'crm->extensions->cardsDev->update', + example: + "crm->extensions->cardsDev->update(\n 'cardId',\n appID: 0,\n actions: ['baseURLs' => ['string']],\n display: [\n 'properties' => [\n [\n 'dataType' => 'BOOLEAN',\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n ['label' => 'label', 'name' => 'name', 'type' => 'DANGER']\n ],\n ],\n ],\n ],\n fetch: [\n 'objectTypes' => [\n ['name' => 'companies', 'propertiesToSend' => ['string']]\n ],\n 'cardType' => 'EXTERNAL',\n 'serverlessFunction' => 'serverlessFunction',\n 'targetURL' => 'targetUrl',\n ],\n title: 'title',\n);\n\nvar_dump($publicCardResponse);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + httpMethod: 'delete', + summary: 'Delete settings', + description: 'Delete video conference extension settings for your app', + stainlessPath: '(resource) crm.extensions.video_conferencing > (method) delete', + qualified: 'client.crm.extensions.videoConferencing.delete', + params: ['appId: number;'], + markdown: + "## delete\n\n`client.crm.extensions.videoConferencing.delete(appId: number): void`\n\n**delete** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nDelete video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.videoConferencing.delete(0)\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.videoConferencing.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.videoConferencing.delete(0);", + }, + python: { + method: 'crm.extensions.video_conferencing.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.video_conferencing.delete(\n 0,\n)', + }, + java: { + method: 'crm().extensions().videoConferencing().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().videoConferencing().delete(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.VideoConferencing.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.VideoConferencing.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.extensions.video_conferencing.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.video_conferencing.delete(0)\n\nputs(result)', + }, + php: { + method: 'crm->extensions->videoConferencing->delete', + example: + "crm->extensions->videoConferencing->delete(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + httpMethod: 'get', + summary: 'Get settings', + description: 'Fetch video conference extension settings for your app', + stainlessPath: '(resource) crm.extensions.video_conferencing > (method) get', + qualified: 'client.crm.extensions.videoConferencing.get', + params: ['appId: number;'], + response: + '{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }', + markdown: + "## get\n\n`client.crm.extensions.videoConferencing.get(appId: number): { createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n**get** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nFetch video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n - `createMeetingUrl: string`\n - `deleteMeetingUrl?: string`\n - `fetchAccountsUri?: string`\n - `updateMeetingUrl?: string`\n - `userVerifyUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalSettings = await client.crm.extensions.videoConferencing.get(0);\n\nconsole.log(externalSettings);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.videoConferencing.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalSettings = await client.crm.extensions.videoConferencing.get(0);\n\nconsole.log(externalSettings.createMeetingUrl);", + }, + python: { + method: 'crm.extensions.video_conferencing.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_settings = client.crm.extensions.video_conferencing.get(\n 0,\n)\nprint(external_settings.create_meeting_url)', + }, + java: { + method: 'crm().extensions().videoConferencing().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.ExternalSettings;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalSettings externalSettings = client.crm().extensions().videoConferencing().get(0);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.VideoConferencing.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalSettings, err := client.Crm.Extensions.VideoConferencing.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalSettings.CreateMeetingURL)\n}\n', + }, + ruby: { + method: 'crm.extensions.video_conferencing.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_settings = hubspot.crm.extensions.video_conferencing.get(0)\n\nputs(external_settings)', + }, + php: { + method: 'crm->extensions->videoConferencing->get', + example: + "crm->extensions->videoConferencing->get(0);\n\nvar_dump($externalSettings);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + httpMethod: 'put', + summary: 'Create or update settings', + description: 'Create or update video conference extension settings for your app', + stainlessPath: '(resource) crm.extensions.video_conferencing > (method) update', + qualified: 'client.crm.extensions.videoConferencing.update', + params: [ + 'appId: number;', + 'createMeetingUrl: string;', + 'deleteMeetingUrl?: string;', + 'fetchAccountsUri?: string;', + 'updateMeetingUrl?: string;', + 'userVerifyUrl?: string;', + ], + response: + '{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }', + markdown: + "## update\n\n`client.crm.extensions.videoConferencing.update(appId: number, createMeetingUrl: string, deleteMeetingUrl?: string, fetchAccountsUri?: string, updateMeetingUrl?: string, userVerifyUrl?: string): { createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n**put** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nCreate or update video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n- `createMeetingUrl: string`\n\n- `deleteMeetingUrl?: string`\n\n- `fetchAccountsUri?: string`\n\n- `updateMeetingUrl?: string`\n\n- `userVerifyUrl?: string`\n\n### Returns\n\n- `{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n - `createMeetingUrl: string`\n - `deleteMeetingUrl?: string`\n - `fetchAccountsUri?: string`\n - `updateMeetingUrl?: string`\n - `userVerifyUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalSettings = await client.crm.extensions.videoConferencing.update(0, { createMeetingUrl: 'createMeetingUrl' });\n\nconsole.log(externalSettings);\n```", + perLanguage: { + typescript: { + method: 'client.crm.extensions.videoConferencing.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalSettings = await client.crm.extensions.videoConferencing.update(0, {\n createMeetingUrl: 'createMeetingUrl',\n});\n\nconsole.log(externalSettings.createMeetingUrl);", + }, + python: { + method: 'crm.extensions.video_conferencing.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_settings = client.crm.extensions.video_conferencing.update(\n app_id=0,\n create_meeting_url="createMeetingUrl",\n)\nprint(external_settings.create_meeting_url)', + }, + java: { + method: 'crm().extensions().videoConferencing().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.ExternalSettings;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n VideoConferencingUpdateParams params = VideoConferencingUpdateParams.builder()\n .appId(0)\n .externalSettings(ExternalSettings.builder()\n .createMeetingUrl("createMeetingUrl")\n .build())\n .build();\n ExternalSettings externalSettings = client.crm().extensions().videoConferencing().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Extensions.VideoConferencing.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalSettings, err := client.Crm.Extensions.VideoConferencing.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionVideoConferencingUpdateParams{\n\t\t\tExternalSettings: crm.ExternalSettingsParam{\n\t\t\t\tCreateMeetingURL: "createMeetingUrl",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalSettings.CreateMeetingURL)\n}\n', + }, + ruby: { + method: 'crm.extensions.video_conferencing.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_settings = hubspot.crm.extensions.video_conferencing.update(0, create_meeting_url: "createMeetingUrl")\n\nputs(external_settings)', + }, + php: { + method: 'crm->extensions->videoConferencing->update', + example: + "crm->extensions->videoConferencing->update(\n 0,\n createMeetingURL: 'createMeetingUrl',\n deleteMeetingURL: 'deleteMeetingUrl',\n fetchAccountsUri: 'fetchAccountsUri',\n updateMeetingURL: 'updateMeetingUrl',\n userVerifyURL: 'userVerifyUrl',\n);\n\nvar_dump($externalSettings);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createMeetingUrl": "createMeetingUrl"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', + httpMethod: 'delete', + summary: "Delete an app's feature flag", + description: + 'Delete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated.', + stainlessPath: '(resource) crm.feature_flags > (method) delete', + qualified: 'client.crm.featureFlags.delete', + params: ['appId: number;', 'flagName: string;'], + response: + "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", + markdown: + "## delete\n\n`client.crm.featureFlags.delete(appId: number, flagName: string): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**delete** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nDelete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.delete('flagName', { appId: 0 });\n\nconsole.log(flagResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.delete('flagName', { appId: 0 });\n\nconsole.log(flagResponse.overrideState);", + }, + python: { + method: 'crm.feature_flags.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.delete(\n flag_name="flagName",\n app_id=0,\n)\nprint(flag_response.override_state)', + }, + java: { + method: 'crm().featureFlags().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagDeleteParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagDeleteParams params = FeatureFlagDeleteParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Delete(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.delete("flagName", app_id: 0)\n\nputs(flag_response)', + }, + php: { + method: 'crm->featureFlags->delete', + example: + "crm->featureFlags->delete('flagName', appID: 0);\n\nvar_dump($flagResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_portal_state', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + httpMethod: 'delete', + summary: 'Delete an account flag state', + description: + 'Delete an account-level flag state for a specific HubSpot account. No request body is included.', + stainlessPath: '(resource) crm.feature_flags > (method) delete_portal_state', + qualified: 'client.crm.featureFlags.deletePortalState', + params: ['appId: number;', 'flagName: string;', 'portalId: number;'], + response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", + markdown: + "## delete_portal_state\n\n`client.crm.featureFlags.deletePortalState(appId: number, flagName: string, portalId: number): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**delete** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nDelete an account-level flag state for a specific HubSpot account. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.deletePortalState(0, { appId: 0, flagName: 'flagName' });\n\nconsole.log(portalFlagStateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.deletePortalState', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.deletePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n});\n\nconsole.log(portalFlagStateResponse.appId);", + }, + python: { + method: 'crm.feature_flags.delete_portal_state', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.delete_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n)\nprint(portal_flag_state_response.app_id)', + }, + java: { + method: 'crm().featureFlags().deletePortalState', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagDeletePortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagDeletePortalStateParams params = FeatureFlagDeletePortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().deletePortalState(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.DeletePortalState', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.DeletePortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagDeletePortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.delete_portal_state', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.delete_portal_state(0, app_id: 0, flag_name: "flagName")\n\nputs(portal_flag_state_response)', + }, + php: { + method: 'crm->featureFlags->deletePortalState', + example: + "crm->featureFlags->deletePortalState(\n 0, appID: 0, flagName: 'flagName'\n);\n\nvar_dump($portalFlagStateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', + httpMethod: 'get', + summary: "Retrieve an app's feature flags", + description: "Retrieve the current status of the app's feature flags. No request body is included.", + stainlessPath: '(resource) crm.feature_flags > (method) get', + qualified: 'client.crm.featureFlags.get', + params: ['appId: number;', 'flagName: string;'], + response: + "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", + markdown: + "## get\n\n`client.crm.featureFlags.get(appId: number, flagName: string): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nRetrieve the current status of the app's feature flags. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.get('flagName', { appId: 0 });\n\nconsole.log(flagResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.get('flagName', { appId: 0 });\n\nconsole.log(flagResponse.overrideState);", + }, + python: { + method: 'crm.feature_flags.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.get(\n flag_name="flagName",\n app_id=0,\n)\nprint(flag_response.override_state)', + }, + java: { + method: 'crm().featureFlags().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagGetParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagGetParams params = FeatureFlagGetParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Get(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagGetParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.get("flagName", app_id: 0)\n\nputs(flag_response)', + }, + php: { + method: 'crm->featureFlags->get', + example: + "crm->featureFlags->get('flagName', appID: 0);\n\nvar_dump($flagResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_portal_state', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + httpMethod: 'get', + summary: 'Retrieve account flag state', + description: 'Retrieve the account-level flag state of a specific HubSpot account.', + stainlessPath: '(resource) crm.feature_flags > (method) get_portal_state', + qualified: 'client.crm.featureFlags.getPortalState', + params: ['appId: number;', 'flagName: string;', 'portalId: number;'], + response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", + markdown: + "## get_portal_state\n\n`client.crm.featureFlags.getPortalState(appId: number, flagName: string, portalId: number): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nRetrieve the account-level flag state of a specific HubSpot account.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.getPortalState(0, { appId: 0, flagName: 'flagName' });\n\nconsole.log(portalFlagStateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.getPortalState', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.getPortalState(0, {\n appId: 0,\n flagName: 'flagName',\n});\n\nconsole.log(portalFlagStateResponse.appId);", + }, + python: { + method: 'crm.feature_flags.get_portal_state', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.get_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n)\nprint(portal_flag_state_response.app_id)', + }, + java: { + method: 'crm().featureFlags().getPortalState', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagGetPortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagGetPortalStateParams params = FeatureFlagGetPortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().getPortalState(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.GetPortalState', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.GetPortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagGetPortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.get_portal_state', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.get_portal_state(0, app_id: 0, flag_name: "flagName")\n\nputs(portal_flag_state_response)', + }, + php: { + method: 'crm->featureFlags->getPortalState', + example: + "crm->featureFlags->getPortalState(\n 0, appID: 0, flagName: 'flagName'\n);\n\nvar_dump($portalFlagStateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_all', + endpoint: '/feature-flags/2026-03/{appId}/flags/all', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.feature_flags > (method) list_all', + qualified: 'client.crm.featureFlags.listAll', + params: ['appId: number;'], + response: '{ flagsForApp: string[]; }', + markdown: + "## list_all\n\n`client.crm.featureFlags.listAll(appId: number): { flagsForApp: string[]; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/all`\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ flagsForApp: string[]; }`\n\n - `flagsForApp: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagsForAppResponse = await client.crm.featureFlags.listAll(0);\n\nconsole.log(flagsForAppResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.listAll', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagsForAppResponse = await client.crm.featureFlags.listAll(0);\n\nconsole.log(flagsForAppResponse.flagsForApp);", + }, + python: { + method: 'crm.feature_flags.list_all', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflags_for_app_response = client.crm.feature_flags.list_all(\n 0,\n)\nprint(flags_for_app_response.flags_for_app)', + }, + java: { + method: 'crm().featureFlags().listAll', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagListAllParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagsForAppResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FlagsForAppResponse flagsForAppResponse = client.crm().featureFlags().listAll(0);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.ListAll', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagsForAppResponse, err := client.Crm.FeatureFlags.ListAll(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagsForAppResponse.FlagsForApp)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.list_all', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflags_for_app_response = hubspot.crm.feature_flags.list_all(0)\n\nputs(flags_for_app_response)', + }, + php: { + method: 'crm->featureFlags->listAll', + example: + "crm->featureFlags->listAll(0);\n\nvar_dump($flagsForAppResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_portals', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals', + httpMethod: 'get', + summary: 'Retrieve accounts with a set flag state', + description: + 'Retrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included.', + stainlessPath: '(resource) crm.feature_flags > (method) list_portals', + qualified: 'client.crm.featureFlags.listPortals', + params: ['appId: number;', 'flagName: string;', 'limit?: number;', 'startPortalId?: number;'], + response: + "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", + markdown: + "## list_portals\n\n`client.crm.featureFlags.listPortals(appId: number, flagName: string, limit?: number, startPortalId?: number): { portalFlagStates: portal_flag_state_response[]; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals`\n\nRetrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `startPortalId?: number`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.listPortals('flagName', { appId: 0 });\n\nconsole.log(portalFlagStateBatchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.listPortals', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.listPortals('flagName', {\n appId: 0,\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", + }, + python: { + method: 'crm.feature_flags.list_portals', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.list_portals(\n flag_name="flagName",\n app_id=0,\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', + }, + java: { + method: 'crm().featureFlags().listPortals', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagListPortalsParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagListPortalsParams params = FeatureFlagListPortalsParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().listPortals(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.ListPortals', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.ListPortals(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagListPortalsParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.list_portals', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.list_portals("flagName", app_id: 0)\n\nputs(portal_flag_state_batch_response)', + }, + php: { + method: 'crm->featureFlags->listPortals', + example: + "crm->featureFlags->listPortals(\n 'flagName', appID: 0, limit: 0, startPortalID: 0\n);\n\nvar_dump($portalFlagStateBatchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', + httpMethod: 'put', + summary: "Set an app's feature flag", + description: + "Set a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs.", + stainlessPath: '(resource) crm.feature_flags > (method) update', + qualified: 'client.crm.featureFlags.update', + params: [ + 'appId: number;', + 'flagName: string;', + "defaultState: 'ABSENT' | 'OFF' | 'ON';", + "overrideState?: 'ABSENT' | 'OFF' | 'ON';", + ], + response: + "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", + markdown: + "## update\n\n`client.crm.featureFlags.update(appId: number, flagName: string, defaultState: 'ABSENT' | 'OFF' | 'ON', overrideState?: 'ABSENT' | 'OFF' | 'ON'): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**put** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nSet a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n The state that the flag should have if there are no overrides for a particular portal\n\n- `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n A flag value that supercedes all other overrides, including portal-level values. Mostly used for things like emergency overrides\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.update('flagName', { appId: 0, defaultState: 'ABSENT' });\n\nconsole.log(flagResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.update('flagName', {\n appId: 0,\n defaultState: 'ABSENT',\n});\n\nconsole.log(flagResponse.overrideState);", + }, + python: { + method: 'crm.feature_flags.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.update(\n flag_name="flagName",\n app_id=0,\n default_state="ABSENT",\n)\nprint(flag_response.override_state)', + }, + java: { + method: 'crm().featureFlags().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagUpdateParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagPutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagUpdateParams params = FeatureFlagUpdateParams.builder()\n .appId(0)\n .flagName("flagName")\n .flagPutRequest(FlagPutRequest.builder()\n .defaultState(FlagPutRequest.DefaultState.ABSENT)\n .build())\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Update(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagPutRequest: crm.FlagPutRequestParam{\n\t\t\t\tDefaultState: crm.FlagPutRequestDefaultStateAbsent,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.update("flagName", app_id: 0, default_state: :ABSENT)\n\nputs(flag_response)', + }, + php: { + method: 'crm->featureFlags->update', + example: + "crm->featureFlags->update(\n 'flagName', appID: 0, defaultState: 'ABSENT', overrideState: 'ABSENT'\n);\n\nvar_dump($flagResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "defaultState": "ABSENT"\n }\'', + }, + }, + }, + { + name: 'update_portal_state', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + httpMethod: 'put', + summary: 'Set an account flag state', + description: 'Specify an account-level flag state for a specific HubSpot account.', + stainlessPath: '(resource) crm.feature_flags > (method) update_portal_state', + qualified: 'client.crm.featureFlags.updatePortalState', + params: [ + 'appId: number;', + 'flagName: string;', + 'portalId: number;', + "flagState: 'ABSENT' | 'OFF' | 'ON';", + ], + response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", + markdown: + "## update_portal_state\n\n`client.crm.featureFlags.updatePortalState(appId: number, flagName: string, portalId: number, flagState: 'ABSENT' | 'OFF' | 'ON'): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**put** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nSpecify an account-level flag state for a specific HubSpot account.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n- `flagState: 'ABSENT' | 'OFF' | 'ON'`\n The state that the given flag should be in for this portal\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.updatePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n flagState: 'ABSENT',\n});\n\nconsole.log(portalFlagStateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.updatePortalState', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.updatePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n flagState: 'ABSENT',\n});\n\nconsole.log(portalFlagStateResponse.appId);", + }, + python: { + method: 'crm.feature_flags.update_portal_state', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.update_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n flag_state="ABSENT",\n)\nprint(portal_flag_state_response.app_id)', + }, + java: { + method: 'crm().featureFlags().updatePortalState', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagUpdatePortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStatePutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagUpdatePortalStateParams params = FeatureFlagUpdatePortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .portalFlagStatePutRequest(PortalFlagStatePutRequest.builder()\n .flagState(PortalFlagStatePutRequest.FlagState.ABSENT)\n .build())\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().updatePortalState(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.UpdatePortalState', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.UpdatePortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagUpdatePortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t\tPortalFlagStatePutRequest: crm.PortalFlagStatePutRequestParam{\n\t\t\t\tFlagState: crm.PortalFlagStatePutRequestFlagStateAbsent,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.update_portal_state', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.update_portal_state(0, app_id: 0, flag_name: "flagName", flag_state: :ABSENT)\n\nputs(portal_flag_state_response)', + }, + php: { + method: 'crm->featureFlags->updatePortalState', + example: + "crm->featureFlags->updatePortalState(\n 0, appID: 0, flagName: 'flagName', flagState: 'ABSENT'\n);\n\nvar_dump($portalFlagStateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "flagState": "ABSENT"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete', + httpMethod: 'post', + summary: 'Batch delete account flag state', + description: + 'Delete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.', + stainlessPath: '(resource) crm.feature_flags.batch > (method) delete', + qualified: 'client.crm.featureFlags.batch.delete', + params: ['appId: number;', 'flagName: string;', 'portalIds: number[];'], + response: + "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", + markdown: + "## delete\n\n`client.crm.featureFlags.batch.delete(appId: number, flagName: string, portalIds: number[]): { portalFlagStates: portal_flag_state_response[]; }`\n\n**post** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete`\n\nDelete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalIds: number[]`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.delete('flagName', { appId: 0, portalIds: [0] });\n\nconsole.log(portalFlagStateBatchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.delete('flagName', {\n appId: 0,\n portalIds: [0],\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", + }, + python: { + method: 'crm.feature_flags.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.batch.delete(\n flag_name="flagName",\n app_id=0,\n portal_ids=[0],\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', + }, + java: { + method: 'crm().featureFlags().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchDeleteRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\nimport com.hubspot.sdk.models.crm.featureflags.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalFlagStateBatchDeleteRequest(PortalFlagStateBatchDeleteRequest.builder()\n .addPortalId(0)\n .build())\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagBatchDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tPortalFlagStateBatchDeleteRequest: crm.PortalFlagStateBatchDeleteRequestParam{\n\t\t\t\tPortalIDs: []int64{0},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.batch.delete("flagName", app_id: 0, portal_ids: [0])\n\nputs(portal_flag_state_batch_response)', + }, + php: { + method: 'crm->featureFlags->batch->delete', + example: + "crm->featureFlags->batch->delete(\n 'flagName', appID: 0, portalIDs: [0]\n);\n\nvar_dump($portalFlagStateBatchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/batch/delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "portalIds": [\n 0\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert', + httpMethod: 'post', + summary: 'Batch set account flag state', + description: + 'Set the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.', + stainlessPath: '(resource) crm.feature_flags.batch > (method) upsert', + qualified: 'client.crm.featureFlags.batch.upsert', + params: [ + 'appId: number;', + 'flagName: string;', + "portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[];", + ], + response: + "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", + markdown: + "## upsert\n\n`client.crm.featureFlags.batch.upsert(appId: number, flagName: string, portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]): { portalFlagStates: portal_flag_state_response[]; }`\n\n**post** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert`\n\nSet the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.upsert('flagName', { appId: 0, portalStates: [{ flagState: 'ABSENT', portalId: 0 }] });\n\nconsole.log(portalFlagStateBatchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.featureFlags.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.upsert('flagName', {\n appId: 0,\n portalStates: [{ flagState: 'ABSENT', portalId: 0 }],\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", + }, + python: { + method: 'crm.feature_flags.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.batch.upsert(\n flag_name="flagName",\n app_id=0,\n portal_states=[{\n "flag_state": "ABSENT",\n "portal_id": 0,\n }],\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', + }, + java: { + method: 'crm().featureFlags().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.BatchPortalEntry;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchPutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\nimport com.hubspot.sdk.models.crm.featureflags.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalFlagStateBatchPutRequest(PortalFlagStateBatchPutRequest.builder()\n .addPortalState(BatchPortalEntry.builder()\n .flagState(BatchPortalEntry.FlagState.ABSENT)\n .portalId(0)\n .build())\n .build())\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.FeatureFlags.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagBatchUpsertParams{\n\t\t\tAppID: 0,\n\t\t\tPortalFlagStateBatchPutRequest: crm.PortalFlagStateBatchPutRequestParam{\n\t\t\t\tPortalStates: []crm.BatchPortalEntryParam{{\n\t\t\t\t\tFlagState: crm.BatchPortalEntryFlagStateAbsent,\n\t\t\t\t\tPortalID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', + }, + ruby: { + method: 'crm.feature_flags.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.batch.upsert(\n "flagName",\n app_id: 0,\n portal_states: [{flagState: :ABSENT, portalId: 0}]\n)\n\nputs(portal_flag_state_batch_response)', + }, + php: { + method: 'crm->featureFlags->batch->upsert', + example: + "crm->featureFlags->batch->upsert(\n 'flagName',\n appID: 0,\n portalStates: [['flagState' => 'ABSENT', 'portalID' => 0]],\n);\n\nvar_dump($portalFlagStateBatchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "portalStates": [\n {\n "flagState": "ABSENT",\n "portalId": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'cancel', + endpoint: '/crm/imports/2026-03/{importId}/cancel', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.imports > (method) cancel', + qualified: 'client.crm.imports.cancel', + params: ['importId: number;'], + response: + "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## cancel\n\n`client.crm.imports.cancel(importId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/imports/2026-03/{importId}/cancel`\n\n### Parameters\n\n- `importId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponse = await client.crm.imports.cancel(0);\n\nconsole.log(actionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.imports.cancel', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponse = await client.crm.imports.cancel(0);\n\nconsole.log(actionResponse.completedAt);", + }, + python: { + method: 'crm.imports.cancel', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response = client.crm.imports.cancel(\n 0,\n)\nprint(action_response.completed_at)', + }, + java: { + method: 'crm().imports().cancel', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ActionResponse;\nimport com.hubspot.sdk.models.crm.imports.ImportCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponse actionResponse = client.crm().imports().cancel(0L);\n }\n}', + }, + go: { + method: 'client.Crm.Imports.Cancel', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponse, err := client.Crm.Imports.Cancel(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.imports.cancel', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response = hubspot.crm.imports.cancel(0)\n\nputs(action_response)', + }, + php: { + method: 'crm->imports->cancel', + example: + "crm->imports->cancel(0);\n\nvar_dump($actionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID/cancel \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/imports/2026-03', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.imports > (method) create', + qualified: 'client.crm.imports.create', + params: ['files?: string;', 'importRequest?: string;'], + response: + "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", + markdown: + "## create\n\n`client.crm.imports.create(files?: string, importRequest?: string): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**post** `/crm/imports/2026-03`\n\n### Parameters\n\n- `files?: string`\n\n- `importRequest?: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicImportResponse = await client.crm.imports.create();\n\nconsole.log(publicImportResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.imports.create', + example: + "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicImportResponse = await client.crm.imports.create();\n\nconsole.log(publicImportResponse.id);", + }, + python: { + method: 'crm.imports.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_import_response = client.crm.imports.create()\nprint(public_import_response.id)', + }, + java: { + method: 'crm().imports().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportCreateParams;\nimport com.hubspot.sdk.models.crm.imports.PublicImportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicImportResponse publicImportResponse = client.crm().imports().create();\n }\n}', + }, + go: { + method: 'client.Crm.Imports.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicImportResponse, err := client.Crm.Imports.New(context.TODO(), crm.ImportNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicImportResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.imports.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_import_response = hubspot.crm.imports.create\n\nputs(public_import_response)', + }, + php: { + method: 'crm->imports->create', + example: + "crm->imports->create(\n files: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n importRequest: 'importRequest',\n);\n\nvar_dump($publicImportResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/imports/2026-03 \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/imports/2026-03/{importId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.imports > (method) get', + qualified: 'client.crm.imports.get', + params: ['importId: number;'], + response: + "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", + markdown: + "## get\n\n`client.crm.imports.get(importId: number): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**get** `/crm/imports/2026-03/{importId}`\n\n### Parameters\n\n- `importId: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicImportResponse = await client.crm.imports.get(0);\n\nconsole.log(publicImportResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.imports.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicImportResponse = await client.crm.imports.get(0);\n\nconsole.log(publicImportResponse.id);", + }, + python: { + method: 'crm.imports.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_import_response = client.crm.imports.get(\n 0,\n)\nprint(public_import_response.id)', + }, + java: { + method: 'crm().imports().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportGetParams;\nimport com.hubspot.sdk.models.crm.imports.PublicImportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicImportResponse publicImportResponse = client.crm().imports().get(0L);\n }\n}', + }, + go: { + method: 'client.Crm.Imports.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicImportResponse, err := client.Crm.Imports.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicImportResponse.ID)\n}\n', + }, + ruby: { + method: 'crm.imports.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_import_response = hubspot.crm.imports.get(0)\n\nputs(public_import_response)', + }, + php: { + method: 'crm->imports->get', + example: + "crm->imports->get(0);\n\nvar_dump($publicImportResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/imports/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.imports > (method) list', + qualified: 'client.crm.imports.list', + params: ['after?: string;', 'limit?: number;'], + response: + "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", + markdown: + "## list\n\n`client.crm.imports.list(after?: string, limit?: number): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**get** `/crm/imports/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportResponse of client.crm.imports.list()) {\n console.log(publicImportResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.imports.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportResponse of client.crm.imports.list()) {\n console.log(publicImportResponse.id);\n}", + }, + python: { + method: 'crm.imports.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.imports.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().imports().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportListPage;\nimport com.hubspot.sdk.models.crm.imports.ImportListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportListPage page = client.crm().imports().list();\n }\n}', + }, + go: { + method: 'client.Crm.Imports.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Imports.List(context.TODO(), crm.ImportListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.imports.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.imports.list\n\nputs(page)', + }, + php: { + method: 'crm->imports->list', + example: + "crm->imports->list(after: 'after', limit: 0);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/imports/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_errors', + endpoint: '/crm/imports/2026-03/{importId}/errors', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.imports > (method) list_errors', + qualified: 'client.crm.imports.listErrors', + params: [ + 'importId: number;', + 'after?: string;', + 'includeErrorMessage?: boolean;', + 'includeRowData?: boolean;', + 'limit?: number;', + ], + response: + "{ id: string; createdAt: number; errorType: string; sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }; errorMessage?: string; extraContext?: string; invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }", + markdown: + "## list_errors\n\n`client.crm.imports.listErrors(importId: number, after?: string, includeErrorMessage?: boolean, includeRowData?: boolean, limit?: number): { id: string; createdAt: number; errorType: string; sourceData: import_row_core; errorMessage?: string; extraContext?: string; invalidPropertyValue?: property_value; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }`\n\n**get** `/crm/imports/2026-03/{importId}/errors`\n\n### Parameters\n\n- `importId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `includeErrorMessage?: boolean`\n\n- `includeRowData?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: number; errorType: string; sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }; errorMessage?: string; extraContext?: string; invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }`\n\n - `id: string`\n - `createdAt: number`\n - `errorType: string`\n - `sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }`\n - `errorMessage?: string`\n - `extraContext?: string`\n - `invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }`\n - `invalidValue?: string`\n - `invalidValueToDisplay?: string`\n - `knownColumnNumber?: number`\n - `objectType?: string`\n - `objectTypeId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportError of client.crm.imports.listErrors(0)) {\n console.log(publicImportError);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.imports.listErrors', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportError of client.crm.imports.listErrors(0)) {\n console.log(publicImportError.id);\n}", + }, + python: { + method: 'crm.imports.list_errors', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.imports.list_errors(\n import_id=0,\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().imports().listErrors', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportListErrorsPage;\nimport com.hubspot.sdk.models.crm.imports.ImportListErrorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportListErrorsPage page = client.crm().imports().listErrors(0L);\n }\n}', + }, + go: { + method: 'client.Crm.Imports.ListErrors', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Imports.ListErrors(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ImportListErrorsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.imports.list_errors', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.imports.list_errors(0)\n\nputs(page)', + }, + php: { + method: 'crm->imports->listErrors', + example: + "crm->imports->listErrors(\n 0, after: 'after', includeErrorMessage: true, includeRowData: true, limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID/errors \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_association_label_limits', + endpoint: '/crm/limits/2026-03/associations/labels', + httpMethod: 'get', + summary: 'Read association label limits', + description: 'Returns limits and usage for custom association labels', + stainlessPath: '(resource) crm.limits > (method) get_association_label_limits', + qualified: 'client.crm.limits.getAssociationLabelLimits', + params: ['fromObjectTypeId?: string;', 'toObjectTypeId?: string;'], + response: + '{ results: { allLabels: string[]; fromObjectType: limits_object_type_definition; limit: number; percentage: number; toObjectType: limits_object_type_definition; usage: number; }[]; }', + markdown: + "## get_association_label_limits\n\n`client.crm.limits.getAssociationLabelLimits(fromObjectTypeId?: string, toObjectTypeId?: string): { results: association_label_limit_response[]; }`\n\n**get** `/crm/limits/2026-03/associations/labels`\n\nReturns limits and usage for custom association labels\n\n### Parameters\n\n- `fromObjectTypeId?: string`\n\n- `toObjectTypeId?: string`\n\n### Returns\n\n- `{ results: { allLabels: string[]; fromObjectType: limits_object_type_definition; limit: number; percentage: number; toObjectType: limits_object_type_definition; usage: number; }[]; }`\n\n - `results: { allLabels: string[]; fromObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; }; limit: number; percentage: number; toObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; }; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationLabelLimitResponseNoPaging = await client.crm.limits.getAssociationLabelLimits();\n\nconsole.log(collectionResponseAssociationLabelLimitResponseNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getAssociationLabelLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationLabelLimitResponseNoPaging =\n await client.crm.limits.getAssociationLabelLimits();\n\nconsole.log(collectionResponseAssociationLabelLimitResponseNoPaging.results);", + }, + python: { + method: 'crm.limits.get_association_label_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_label_limit_response_no_paging = client.crm.limits.get_association_label_limits()\nprint(collection_response_association_label_limit_response_no_paging.results)', + }, + java: { + method: 'crm().limits().getAssociationLabelLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseAssociationLabelLimitResponseNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationLabelLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseAssociationLabelLimitResponseNoPaging collectionResponseAssociationLabelLimitResponseNoPaging = client.crm().limits().getAssociationLabelLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetAssociationLabelLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationLabelLimitResponseNoPaging, err := client.Crm.Limits.GetAssociationLabelLimits(context.TODO(), crm.LimitGetAssociationLabelLimitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationLabelLimitResponseNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.limits.get_association_label_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_label_limit_response_no_paging = hubspot.crm.limits.get_association_label_limits\n\nputs(collection_response_association_label_limit_response_no_paging)', + }, + php: { + method: 'crm->limits->getAssociationLabelLimits', + example: + "crm\n ->limits\n ->getAssociationLabelLimits(\n fromObjectTypeID: 'fromObjectTypeId', toObjectTypeID: 'toObjectTypeId'\n);\n\nvar_dump($collectionResponseAssociationLabelLimitResponseNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/associations/labels \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_association_records_limits_by_object_type', + endpoint: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}', + httpMethod: 'get', + summary: 'Read record association limits between two objects', + description: 'Returns records approaching or at association limits between two objects', + stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_by_object_type', + qualified: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', + params: ['fromObjectTypeId: string;', 'toObjectTypeId: string;'], + response: + '{ atLimitFromRecordSamples: { label: string; objectId: number; }[]; limit: number; nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }', + markdown: + "## get_association_records_limits_by_object_type\n\n`client.crm.limits.getAssociationRecordsLimitsByObjectType(fromObjectTypeId: string, toObjectTypeId: string): { atLimitFromRecordSamples: at_limit_record_sample[]; limit: number; nearLimitFromRecordSamples: near_limit_record_sample[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }`\n\n**get** `/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}`\n\nReturns records approaching or at association limits between two objects\n\n### Parameters\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n### Returns\n\n- `{ atLimitFromRecordSamples: { label: string; objectId: number; }[]; limit: number; nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }`\n\n - `atLimitFromRecordSamples: { label: string; objectId: number; }[]`\n - `limit: number`\n - `nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]`\n - `totalRecordsAtLimit: number`\n - `totalRecordsNearLimit: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationRecordLimitResponse = await client.crm.limits.getAssociationRecordsLimitsByObjectType('toObjectTypeId', { fromObjectTypeId: 'fromObjectTypeId' });\n\nconsole.log(associationRecordLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationRecordLimitResponse =\n await client.crm.limits.getAssociationRecordsLimitsByObjectType('toObjectTypeId', {\n fromObjectTypeId: 'fromObjectTypeId',\n });\n\nconsole.log(associationRecordLimitResponse.atLimitFromRecordSamples);", + }, + python: { + method: 'crm.limits.get_association_records_limits_by_object_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_record_limit_response = client.crm.limits.get_association_records_limits_by_object_type(\n to_object_type_id="toObjectTypeId",\n from_object_type_id="fromObjectTypeId",\n)\nprint(association_record_limit_response.at_limit_from_record_samples)', + }, + java: { + method: 'crm().limits().getAssociationRecordsLimitsByObjectType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.AssociationRecordLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsByObjectTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitGetAssociationRecordsLimitsByObjectTypeParams params = LimitGetAssociationRecordsLimitsByObjectTypeParams.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build();\n AssociationRecordLimitResponse associationRecordLimitResponse = client.crm().limits().getAssociationRecordsLimitsByObjectType(params);\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetAssociationRecordsLimitsByObjectType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationRecordLimitResponse, err := client.Crm.Limits.GetAssociationRecordsLimitsByObjectType(\n\t\tcontext.TODO(),\n\t\t"toObjectTypeId",\n\t\tcrm.LimitGetAssociationRecordsLimitsByObjectTypeParams{\n\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationRecordLimitResponse.AtLimitFromRecordSamples)\n}\n', + }, + ruby: { + method: 'crm.limits.get_association_records_limits_by_object_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_record_limit_response = hubspot.crm.limits.get_association_records_limits_by_object_type(\n "toObjectTypeId",\n from_object_type_id: "fromObjectTypeId"\n)\n\nputs(association_record_limit_response)', + }, + php: { + method: 'crm->limits->getAssociationRecordsLimitsByObjectType', + example: + "crm\n ->limits\n ->getAssociationRecordsLimitsByObjectType(\n 'toObjectTypeId', fromObjectTypeID: 'fromObjectTypeId'\n);\n\nvar_dump($associationRecordLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/$FROM_OBJECT_TYPE_ID/$TO_OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_association_records_limits_from_objects', + endpoint: '/crm/limits/2026-03/associations/records/from', + httpMethod: 'get', + summary: 'Read record association limits', + description: 'Returns objects with records approaching or at association limits', + stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_from_objects', + qualified: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', + response: + '{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }', + markdown: + "## get_association_records_limits_from_objects\n\n`client.crm.limits.getAssociationRecordsLimitsFromObjects(): { results: object_type_near_or_at_association_limit[]; }`\n\n**get** `/crm/limits/2026-03/associations/records/from`\n\nReturns objects with records approaching or at association limits\n\n### Returns\n\n- `{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }`\n\n - `results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = await client.crm.limits.getAssociationRecordsLimitsFromObjects();\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging =\n await client.crm.limits.getAssociationRecordsLimitsFromObjects();\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.results);", + }, + python: { + method: 'crm.limits.get_association_records_limits_from_objects', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_type_near_or_at_association_limit_no_paging = client.crm.limits.get_association_records_limits_from_objects()\nprint(collection_response_object_type_near_or_at_association_limit_no_paging.results)', + }, + java: { + method: 'crm().limits().getAssociationRecordsLimitsFromObjects', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsFromObjectsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = client.crm().limits().getAssociationRecordsLimitsFromObjects();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetAssociationRecordsLimitsFromObjects', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging, err := client.Crm.Limits.GetAssociationRecordsLimitsFromObjects(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.limits.get_association_records_limits_from_objects', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_type_near_or_at_association_limit_no_paging = hubspot.crm.limits.get_association_records_limits_from_objects\n\nputs(collection_response_object_type_near_or_at_association_limit_no_paging)', + }, + php: { + method: 'crm->limits->getAssociationRecordsLimitsFromObjects', + example: + "crm\n ->limits\n ->getAssociationRecordsLimitsFromObjects();\n\nvar_dump($collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/from \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_association_records_limits_to_objects', + endpoint: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to', + httpMethod: 'get', + summary: 'Read record association limits from an object', + description: 'Returns objects for which the from object has records approaching or at association limits', + stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_to_objects', + qualified: 'client.crm.limits.getAssociationRecordsLimitsToObjects', + params: ['fromObjectTypeId: string;'], + response: + '{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }', + markdown: + "## get_association_records_limits_to_objects\n\n`client.crm.limits.getAssociationRecordsLimitsToObjects(fromObjectTypeId: string): { results: object_type_near_or_at_association_limit[]; }`\n\n**get** `/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to`\n\nReturns objects for which the from object has records approaching or at association limits\n\n### Parameters\n\n- `fromObjectTypeId: string`\n\n### Returns\n\n- `{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }`\n\n - `results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = await client.crm.limits.getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getAssociationRecordsLimitsToObjects', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging =\n await client.crm.limits.getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.results);", + }, + python: { + method: 'crm.limits.get_association_records_limits_to_objects', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_type_near_or_at_association_limit_no_paging = client.crm.limits.get_association_records_limits_to_objects(\n "fromObjectTypeId",\n)\nprint(collection_response_object_type_near_or_at_association_limit_no_paging.results)', + }, + java: { + method: 'crm().limits().getAssociationRecordsLimitsToObjects', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsToObjectsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = client.crm().limits().getAssociationRecordsLimitsToObjects("fromObjectTypeId");\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetAssociationRecordsLimitsToObjects', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging, err := client.Crm.Limits.GetAssociationRecordsLimitsToObjects(context.TODO(), "fromObjectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.limits.get_association_records_limits_to_objects', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_type_near_or_at_association_limit_no_paging = hubspot.crm.limits.get_association_records_limits_to_objects("fromObjectTypeId")\n\nputs(collection_response_object_type_near_or_at_association_limit_no_paging)', + }, + php: { + method: 'crm->limits->getAssociationRecordsLimitsToObjects', + example: + "crm\n ->limits\n ->getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nvar_dump($collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/$FROM_OBJECT_TYPE_ID/to \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_calculated_property_limits', + endpoint: '/crm/limits/2026-03/calculated-properties', + httpMethod: 'get', + summary: 'Read calculation property limits', + description: 'Returns overall limit and per object usage for calculated properties', + stainlessPath: '(resource) crm.limits > (method) get_calculated_property_limits', + qualified: 'client.crm.limits.getCalculatedPropertyLimits', + response: + '{ byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }', + markdown: + "## get_calculated_property_limits\n\n`client.crm.limits.getCalculatedPropertyLimits(): { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n**get** `/crm/limits/2026-03/calculated-properties`\n\nReturns overall limit and per object usage for calculated properties\n\n### Returns\n\n- `{ byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n - `byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]`\n - `overallLimit: number`\n - `overallPercentage: number`\n - `overallUsage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst calculatedPropertyLimitResponse = await client.crm.limits.getCalculatedPropertyLimits();\n\nconsole.log(calculatedPropertyLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getCalculatedPropertyLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst calculatedPropertyLimitResponse = await client.crm.limits.getCalculatedPropertyLimits();\n\nconsole.log(calculatedPropertyLimitResponse.byObjectType);", + }, + python: { + method: 'crm.limits.get_calculated_property_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncalculated_property_limit_response = client.crm.limits.get_calculated_property_limits()\nprint(calculated_property_limit_response.by_object_type)', + }, + java: { + method: 'crm().limits().getCalculatedPropertyLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CalculatedPropertyLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCalculatedPropertyLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CalculatedPropertyLimitResponse calculatedPropertyLimitResponse = client.crm().limits().getCalculatedPropertyLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetCalculatedPropertyLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcalculatedPropertyLimitResponse, err := client.Crm.Limits.GetCalculatedPropertyLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", calculatedPropertyLimitResponse.ByObjectType)\n}\n', + }, + ruby: { + method: 'crm.limits.get_calculated_property_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncalculated_property_limit_response = hubspot.crm.limits.get_calculated_property_limits\n\nputs(calculated_property_limit_response)', + }, + php: { + method: 'crm->limits->getCalculatedPropertyLimits', + example: + "crm\n ->limits\n ->getCalculatedPropertyLimits();\n\nvar_dump($calculatedPropertyLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/calculated-properties \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_custom_object_type_limits', + endpoint: '/crm/limits/2026-03/custom-object-types', + httpMethod: 'get', + summary: 'Read custom object limits', + description: 'Returns limits and usage for custom object schemas', + stainlessPath: '(resource) crm.limits > (method) get_custom_object_type_limits', + qualified: 'client.crm.limits.getCustomObjectTypeLimits', + response: '{ limit: number; percentage: number; usage: number; }', + markdown: + "## get_custom_object_type_limits\n\n`client.crm.limits.getCustomObjectTypeLimits(): { limit: number; percentage: number; usage: number; }`\n\n**get** `/crm/limits/2026-03/custom-object-types`\n\nReturns limits and usage for custom object schemas\n\n### Returns\n\n- `{ limit: number; percentage: number; usage: number; }`\n\n - `limit: number`\n - `percentage: number`\n - `usage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst customObjectLimitResponse = await client.crm.limits.getCustomObjectTypeLimits();\n\nconsole.log(customObjectLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getCustomObjectTypeLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst customObjectLimitResponse = await client.crm.limits.getCustomObjectTypeLimits();\n\nconsole.log(customObjectLimitResponse.limit);", + }, + python: { + method: 'crm.limits.get_custom_object_type_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncustom_object_limit_response = client.crm.limits.get_custom_object_type_limits()\nprint(custom_object_limit_response.limit)', + }, + java: { + method: 'crm().limits().getCustomObjectTypeLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CustomObjectLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCustomObjectTypeLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomObjectLimitResponse customObjectLimitResponse = client.crm().limits().getCustomObjectTypeLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetCustomObjectTypeLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcustomObjectLimitResponse, err := client.Crm.Limits.GetCustomObjectTypeLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customObjectLimitResponse.Limit)\n}\n', + }, + ruby: { + method: 'crm.limits.get_custom_object_type_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncustom_object_limit_response = hubspot.crm.limits.get_custom_object_type_limits\n\nputs(custom_object_limit_response)', + }, + php: { + method: 'crm->limits->getCustomObjectTypeLimits', + example: + "crm->limits->getCustomObjectTypeLimits();\n\nvar_dump($customObjectLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/custom-object-types \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_custom_property_limits', + endpoint: '/crm/limits/2026-03/custom-properties', + httpMethod: 'get', + summary: 'Read custom property limits', + description: 'Returns limits and usage per object for custom properties', + stainlessPath: '(resource) crm.limits > (method) get_custom_property_limits', + qualified: 'client.crm.limits.getCustomPropertyLimits', + response: + '{ byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }', + markdown: + "## get_custom_property_limits\n\n`client.crm.limits.getCustomPropertyLimits(): { byObjectType: limit_and_usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n**get** `/crm/limits/2026-03/custom-properties`\n\nReturns limits and usage per object for custom properties\n\n### Returns\n\n- `{ byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n - `byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n - `overallLimit: number`\n - `overallPercentage: number`\n - `overallUsage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst customPropertyLimitResponse = await client.crm.limits.getCustomPropertyLimits();\n\nconsole.log(customPropertyLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getCustomPropertyLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst customPropertyLimitResponse = await client.crm.limits.getCustomPropertyLimits();\n\nconsole.log(customPropertyLimitResponse.byObjectType);", + }, + python: { + method: 'crm.limits.get_custom_property_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncustom_property_limit_response = client.crm.limits.get_custom_property_limits()\nprint(custom_property_limit_response.by_object_type)', + }, + java: { + method: 'crm().limits().getCustomPropertyLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CustomPropertyLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCustomPropertyLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomPropertyLimitResponse customPropertyLimitResponse = client.crm().limits().getCustomPropertyLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetCustomPropertyLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcustomPropertyLimitResponse, err := client.Crm.Limits.GetCustomPropertyLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customPropertyLimitResponse.ByObjectType)\n}\n', + }, + ruby: { + method: 'crm.limits.get_custom_property_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncustom_property_limit_response = hubspot.crm.limits.get_custom_property_limits\n\nputs(custom_property_limit_response)', + }, + php: { + method: 'crm->limits->getCustomPropertyLimits', + example: + "crm->limits->getCustomPropertyLimits();\n\nvar_dump($customPropertyLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/custom-properties \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_pipeline_limits', + endpoint: '/crm/limits/2026-03/pipelines', + httpMethod: 'get', + summary: 'Read pipeline limits', + description: 'Returns limits and usage per object for pipelines', + stainlessPath: '(resource) crm.limits > (method) get_pipeline_limits', + qualified: 'client.crm.limits.getPipelineLimits', + response: + '{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }', + markdown: + "## get_pipeline_limits\n\n`client.crm.limits.getPipelineLimits(): { customObjectTypes: custom_object_record_limit_response; hubspotDefinedObjectTypes: limit_and_usage_for_object_type[]; }`\n\n**get** `/crm/limits/2026-03/pipelines`\n\nReturns limits and usage per object for pipelines\n\n### Returns\n\n- `{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }`\n\n - `customObjectTypes: { byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n - `hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineLimitResponse = await client.crm.limits.getPipelineLimits();\n\nconsole.log(pipelineLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getPipelineLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineLimitResponse = await client.crm.limits.getPipelineLimits();\n\nconsole.log(pipelineLimitResponse.customObjectTypes);", + }, + python: { + method: 'crm.limits.get_pipeline_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_limit_response = client.crm.limits.get_pipeline_limits()\nprint(pipeline_limit_response.custom_object_types)', + }, + java: { + method: 'crm().limits().getPipelineLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.LimitGetPipelineLimitsParams;\nimport com.hubspot.sdk.models.crm.limits.PipelineLimitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineLimitResponse pipelineLimitResponse = client.crm().limits().getPipelineLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetPipelineLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineLimitResponse, err := client.Crm.Limits.GetPipelineLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineLimitResponse.CustomObjectTypes)\n}\n', + }, + ruby: { + method: 'crm.limits.get_pipeline_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_limit_response = hubspot.crm.limits.get_pipeline_limits\n\nputs(pipeline_limit_response)', + }, + php: { + method: 'crm->limits->getPipelineLimits', + example: + "crm->limits->getPipelineLimits();\n\nvar_dump($pipelineLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/pipelines \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_record_limits', + endpoint: '/crm/limits/2026-03/records', + httpMethod: 'get', + summary: 'Read record limits', + description: 'Returns limits and usage per object for records', + stainlessPath: '(resource) crm.limits > (method) get_record_limits', + qualified: 'client.crm.limits.getRecordLimits', + response: + '{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }', + markdown: + "## get_record_limits\n\n`client.crm.limits.getRecordLimits(): { customObjectTypes: custom_object_record_limit_response; hubspotDefinedObjectTypes: limit_and_usage_for_object_type[]; }`\n\n**get** `/crm/limits/2026-03/records`\n\nReturns limits and usage per object for records\n\n### Returns\n\n- `{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }`\n\n - `customObjectTypes: { byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n - `hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordLimitResponse = await client.crm.limits.getRecordLimits();\n\nconsole.log(recordLimitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.limits.getRecordLimits', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordLimitResponse = await client.crm.limits.getRecordLimits();\n\nconsole.log(recordLimitResponse.customObjectTypes);", + }, + python: { + method: 'crm.limits.get_record_limits', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecord_limit_response = client.crm.limits.get_record_limits()\nprint(record_limit_response.custom_object_types)', + }, + java: { + method: 'crm().limits().getRecordLimits', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.LimitGetRecordLimitsParams;\nimport com.hubspot.sdk.models.crm.limits.RecordLimitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RecordLimitResponse recordLimitResponse = client.crm().limits().getRecordLimits();\n }\n}', + }, + go: { + method: 'client.Crm.Limits.GetRecordLimits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordLimitResponse, err := client.Crm.Limits.GetRecordLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordLimitResponse.CustomObjectTypes)\n}\n', + }, + ruby: { + method: 'crm.limits.get_record_limits', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecord_limit_response = hubspot.crm.limits.get_record_limits\n\nputs(record_limit_response)', + }, + php: { + method: 'crm->limits->getRecordLimits', + example: + "crm->limits->getRecordLimits();\n\nvar_dump($recordLimitResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/limits/2026-03/records \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'add_and_remove_memberships', + endpoint: '/crm/lists/2026-03/{listId}/memberships/add-and-remove', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) add_and_remove_memberships', + qualified: 'client.crm.lists.addAndRemoveMemberships', + params: ['listId: string;', 'recordIdsToAdd: string[];', 'recordIdsToRemove: string[];'], + response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', + markdown: + "## add_and_remove_memberships\n\n`client.crm.lists.addAndRemoveMemberships(listId: string, recordIdsToAdd: string[], recordIdsToRemove: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add-and-remove`\n\n### Parameters\n\n- `listId: string`\n\n- `recordIdsToAdd: string[]`\n\n- `recordIdsToRemove: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.addAndRemoveMemberships('listId', { recordIdsToAdd: ['string'], recordIdsToRemove: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.addAndRemoveMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.addAndRemoveMemberships('listId', {\n recordIdsToAdd: ['string'],\n recordIdsToRemove: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", + }, + python: { + method: 'crm.lists.add_and_remove_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.add_and_remove_memberships(\n list_id="listId",\n record_ids_to_add=["string"],\n record_ids_to_remove=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', + }, + java: { + method: 'crm().lists().addAndRemoveMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddAndRemoveMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipChangeRequest;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddAndRemoveMembershipsParams params = ListAddAndRemoveMembershipsParams.builder()\n .listId("listId")\n .membershipChangeRequest(MembershipChangeRequest.builder()\n .addRecordIdsToAdd("string")\n .addRecordIdsToRemove("string")\n .build())\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().addAndRemoveMemberships(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.AddAndRemoveMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.AddAndRemoveMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListAddAndRemoveMembershipsParams{\n\t\t\tMembershipChangeRequest: crm.MembershipChangeRequestParam{\n\t\t\t\tRecordIDsToAdd: []string{"string"},\n\t\t\t\tRecordIDsToRemove: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', + }, + ruby: { + method: 'crm.lists.add_and_remove_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.add_and_remove_memberships(\n "listId",\n record_ids_to_add: ["string"],\n record_ids_to_remove: ["string"]\n)\n\nputs(memberships_update_response)', + }, + php: { + method: 'crm->lists->addAndRemoveMemberships', + example: + "crm->lists->addAndRemoveMemberships(\n 'listId', recordIDsToAdd: ['string'], recordIDsToRemove: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add-and-remove \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "recordIdsToAdd": [\n "string"\n ],\n "recordIdsToRemove": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'add_memberships', + endpoint: '/crm/lists/2026-03/{listId}/memberships/add', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) add_memberships', + qualified: 'client.crm.lists.addMemberships', + params: ['listId: string;', 'body: string[];'], + response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', + markdown: + "## add_memberships\n\n`client.crm.lists.addMemberships(listId: string, body: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add`\n\n### Parameters\n\n- `listId: string`\n\n- `body: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.addMemberships('listId', { body: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.addMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.addMemberships('listId', {\n body: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", + }, + python: { + method: 'crm.lists.add_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.add_memberships(\n list_id="listId",\n body=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', + }, + java: { + method: 'crm().lists().addMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddMembershipsParams params = ListAddMembershipsParams.builder()\n .listId("listId")\n .addBody("string")\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().addMemberships(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.AddMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.AddMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListAddMembershipsParams{\n\t\t\tBody: []string{"string"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', + }, + ruby: { + method: 'crm.lists.add_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.add_memberships("listId", body: ["string"])\n\nputs(memberships_update_response)', + }, + php: { + method: 'crm->lists->addMemberships', + example: + "crm->lists->addMemberships(\n 'listId', body: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', + }, + }, + }, + { + name: 'add_memberships_from', + endpoint: '/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) add_memberships_from', + qualified: 'client.crm.lists.addMembershipsFrom', + params: ['listId: string;', 'sourceListId: string;'], + markdown: + "## add_memberships_from\n\n`client.crm.lists.addMembershipsFrom(listId: string, sourceListId: string): void`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}`\n\n### Parameters\n\n- `listId: string`\n\n- `sourceListId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.addMembershipsFrom('sourceListId', { listId: 'listId' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.addMembershipsFrom', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.addMembershipsFrom('sourceListId', { listId: 'listId' });", + }, + python: { + method: 'crm.lists.add_memberships_from', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.add_memberships_from(\n source_list_id="sourceListId",\n list_id="listId",\n)', + }, + java: { + method: 'crm().lists().addMembershipsFrom', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddMembershipsFromParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddMembershipsFromParams params = ListAddMembershipsFromParams.builder()\n .listId("listId")\n .sourceListId("sourceListId")\n .build();\n client.crm().lists().addMembershipsFrom(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.AddMembershipsFrom', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.AddMembershipsFrom(\n\t\tcontext.TODO(),\n\t\t"sourceListId",\n\t\tcrm.ListAddMembershipsFromParams{\n\t\t\tListID: "listId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.add_memberships_from', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.add_memberships_from("sourceListId", list_id: "listId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->addMembershipsFrom', + example: + "crm->lists->addMembershipsFrom(\n 'sourceListId', listID: 'listId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add-from/$SOURCE_LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'batch_read_memberships', + endpoint: '/crm/lists/2026-03/records/memberships/batch/read', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) batch_read_memberships', + qualified: 'client.crm.lists.batchReadMemberships', + params: ['inputs: { objectTypeId: string; recordId: string; }[];'], + response: + "{ completedAt: string; results: { objectTypeId: string; recordId: string; recordListMemberships: record_list_membership[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## batch_read_memberships\n\n`client.crm.lists.batchReadMemberships(inputs: { objectTypeId: string; recordId: string; }[]): { completedAt: string; results: record_id_with_memberships[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/lists/2026-03/records/memberships/batch/read`\n\n### Parameters\n\n- `inputs: { objectTypeId: string; recordId: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { objectTypeId: string; recordId: string; recordListMemberships: record_list_membership[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { objectTypeId: string; recordId: string; recordListMemberships: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseRecordIDWithMemberships = await client.crm.lists.batchReadMemberships({ inputs: [{ objectTypeId: 'objectTypeId', recordId: 'recordId' }] });\n\nconsole.log(batchResponseRecordIDWithMemberships);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.batchReadMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseRecordIDWithMemberships = await client.crm.lists.batchReadMemberships({\n inputs: [{ objectTypeId: 'objectTypeId', recordId: 'recordId' }],\n});\n\nconsole.log(batchResponseRecordIDWithMemberships.completedAt);", + }, + python: { + method: 'crm.lists.batch_read_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_record_id_with_memberships = client.crm.lists.batch_read_memberships(\n inputs=[{\n "object_type_id": "objectTypeId",\n "record_id": "recordId",\n }],\n)\nprint(batch_response_record_id_with_memberships.completed_at)', + }, + java: { + method: 'crm().lists().batchReadMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.BatchInputRecordIdInput;\nimport com.hubspot.sdk.models.crm.lists.BatchResponseRecordIdWithMemberships;\nimport com.hubspot.sdk.models.crm.lists.RecordIdInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputRecordIdInput params = BatchInputRecordIdInput.builder()\n .addInput(RecordIdInput.builder()\n .objectTypeId("objectTypeId")\n .recordId("recordId")\n .build())\n .build();\n BatchResponseRecordIdWithMemberships batchResponseRecordIdWithMemberships = client.crm().lists().batchReadMemberships(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.BatchReadMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseRecordIDWithMemberships, err := client.Crm.Lists.BatchReadMemberships(context.TODO(), crm.ListBatchReadMembershipsParams{\n\t\tBatchInputRecordIDInput: crm.BatchInputRecordIDInputParam{\n\t\t\tInputs: []crm.RecordIDInputParam{{\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tRecordID: "recordId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseRecordIDWithMemberships.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.lists.batch_read_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_record_id_with_memberships = hubspot.crm.lists.batch_read_memberships(inputs: [{objectTypeId: "objectTypeId", recordId: "recordId"}])\n\nputs(batch_response_record_id_with_memberships)', + }, + php: { + method: 'crm->lists->batchReadMemberships', + example: + "crm\n ->lists\n ->batchReadMemberships(\n inputs: [['objectTypeID' => 'objectTypeId', 'recordID' => 'recordId']]\n);\n\nvar_dump($batchResponseRecordIDWithMemberships);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/records/memberships/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "objectTypeId": "objectTypeId",\n "recordId": "recordId"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/lists/2026-03', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) create', + qualified: 'client.crm.lists.create', + params: [ + 'name: string;', + 'objectTypeId: string;', + 'processingType: string;', + 'customProperties?: object;', + "filterBranch?: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; };", + 'listFolderId?: number;', + 'listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; };', + 'membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; };', + ], + response: + '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', + markdown: + "## create\n\n`client.crm.lists.create(name: string, objectTypeId: string, processingType: string, customProperties?: object, filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }, listFolderId?: number, listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }, membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }): { list: public_object_list; }`\n\n**post** `/crm/lists/2026-03`\n\n### Parameters\n\n- `name: string`\n The name of the list, which must be globally unique across all public lists in the portal.\n\n- `objectTypeId: string`\n The object type ID of the type of objects that the list will store.\n\n- `processingType: string`\n The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.\n\n- `customProperties?: object`\n The list of custom properties to tie to the list. Custom property name is the key, the value is the value.\n\n- `filterBranch?: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; }`\n Filter branch object containing filtering criteria for the list\n\n- `listFolderId?: number`\n The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.\n\n- `listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }`\n - `teamsWithEditAccess: number[]`\n - `usersWithEditAccess: number[]`\n\n- `membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }`\n - `includeUnassigned?: boolean`\n Indicates whether unassigned memberships should be included.\n - `membershipTeamId?: number`\n The ID of the team associated with the membership.\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listCreateResponse = await client.crm.lists.create({\n name: 'name',\n objectTypeId: 'objectTypeId',\n processingType: 'processingType',\n});\n\nconsole.log(listCreateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listCreateResponse = await client.crm.lists.create({\n name: 'name',\n objectTypeId: 'objectTypeId',\n processingType: 'processingType',\n});\n\nconsole.log(listCreateResponse.list);", + }, + python: { + method: 'crm.lists.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_create_response = client.crm.lists.create(\n name="name",\n object_type_id="objectTypeId",\n processing_type="processingType",\n)\nprint(list_create_response.list)', + }, + java: { + method: 'crm().lists().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListCreateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListCreateRequest params = ListCreateRequest.builder()\n .name("name")\n .objectTypeId("objectTypeId")\n .processingType("processingType")\n .build();\n ListCreateResponse listCreateResponse = client.crm().lists().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistCreateResponse, err := client.Crm.Lists.New(context.TODO(), crm.ListNewParams{\n\t\tListCreateRequest: crm.ListCreateRequestParam{\n\t\t\tName: "name",\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tProcessingType: "processingType",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listCreateResponse.List)\n}\n', + }, + ruby: { + method: 'crm.lists.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_create_response = hubspot.crm.lists.create(name: "name", object_type_id: "objectTypeId", processing_type: "processingType")\n\nputs(list_create_response)', + }, + php: { + method: 'crm->lists->create', + example: + "crm->lists->create(\n name: 'name',\n objectTypeID: 'objectTypeId',\n processingType: 'processingType',\n customProperties: ['foo' => 'string'],\n filterBranch: [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'eventTypeID' => 'eventTypeId',\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'associationCategory' => 'associationCategory',\n 'associationTypeID' => 0,\n 'filterBranches' => [\n [\n 'filterBranches' => [],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'PROPERTY_ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n 'propertyWithObjectID' => 'propertyWithObjectId',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'UNIFIED_EVENTS',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'operator' => 'HAS_COMPLETED',\n 'coalescingRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n 'pruningRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'RESTRICTED',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ANY',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ALL',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'AND',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n listFolderID: 0,\n listPermissions: ['teamsWithEditAccess' => [0], 'usersWithEditAccess' => [0]],\n membershipSettings: ['includeUnassigned' => true, 'membershipTeamID' => 0],\n);\n\nvar_dump($listCreateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name",\n "objectTypeId": "objectTypeId",\n "processingType": "processingType"\n }\'', + }, + }, + }, + { + name: 'create_folder', + endpoint: '/crm/lists/2026-03/folders', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) create_folder', + qualified: 'client.crm.lists.createFolder', + params: ['name: string;', 'parentFolderId?: string;'], + response: + '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', + markdown: + "## create_folder\n\n`client.crm.lists.createFolder(name: string, parentFolderId?: string): { folder: public_list_folder; }`\n\n**post** `/crm/lists/2026-03/folders`\n\n### Parameters\n\n- `name: string`\n The name of the folder to be created.\n\n- `parentFolderId?: string`\n The folder this should be created in, if not specified will be created in the root folder 0.\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderCreateResponse = await client.crm.lists.createFolder({ name: 'name' });\n\nconsole.log(listFolderCreateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.createFolder', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderCreateResponse = await client.crm.lists.createFolder({ name: 'name' });\n\nconsole.log(listFolderCreateResponse.folder);", + }, + python: { + method: 'crm.lists.create_folder', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_create_response = client.crm.lists.create_folder(\n name="name",\n)\nprint(list_folder_create_response.folder)', + }, + java: { + method: 'crm().lists().createFolder', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderCreateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListFolderCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderCreateRequest params = ListFolderCreateRequest.builder()\n .name("name")\n .build();\n ListFolderCreateResponse listFolderCreateResponse = client.crm().lists().createFolder(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.NewFolder', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderCreateResponse, err := client.Crm.Lists.NewFolder(context.TODO(), crm.ListNewFolderParams{\n\t\tListFolderCreateRequest: crm.ListFolderCreateRequestParam{\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderCreateResponse.Folder)\n}\n', + }, + ruby: { + method: 'crm.lists.create_folder', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_create_response = hubspot.crm.lists.create_folder(name: "name")\n\nputs(list_folder_create_response)', + }, + php: { + method: 'crm->lists->createFolder', + example: + "crm->lists->createFolder(\n name: 'name', parentFolderID: 'parentFolderId'\n);\n\nvar_dump($listFolderCreateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'create_id_mapping', + endpoint: '/crm/lists/2026-03/idmapping', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) create_id_mapping', + qualified: 'client.crm.lists.createIDMapping', + params: ['body: string[];'], + response: + '{ legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]; missingLegacyListIds: string[]; }', + markdown: + "## create_id_mapping\n\n`client.crm.lists.createIDMapping(body: string[]): { legacyListIdsToIdsMapping: public_migration_mapping[]; missingLegacyListIds: string[]; }`\n\n**post** `/crm/lists/2026-03/idmapping`\n\n### Parameters\n\n- `body: string[]`\n\n### Returns\n\n- `{ legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]; missingLegacyListIds: string[]; }`\n\n - `legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]`\n - `missingLegacyListIds: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBatchMigrationMapping = await client.crm.lists.createIDMapping({ body: ['string'] });\n\nconsole.log(publicBatchMigrationMapping);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.createIDMapping', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBatchMigrationMapping = await client.crm.lists.createIDMapping({ body: ['string'] });\n\nconsole.log(publicBatchMigrationMapping.legacyListIdsToIdsMapping);", + }, + python: { + method: 'crm.lists.create_id_mapping', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_batch_migration_mapping = client.crm.lists.create_id_mapping(\n body=["string"],\n)\nprint(public_batch_migration_mapping.legacy_list_ids_to_ids_mapping)', + }, + java: { + method: 'crm().lists().createIdMapping', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.PublicBatchMigrationMapping;\nimport java.util.List;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List params = List.of("string");\n PublicBatchMigrationMapping publicBatchMigrationMapping = client.crm().lists().createIdMapping(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.NewIDMapping', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBatchMigrationMapping, err := client.Crm.Lists.NewIDMapping(context.TODO(), crm.ListNewIDMappingParams{\n\t\tBody: []string{"string"},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBatchMigrationMapping.LegacyListIDsToIDsMapping)\n}\n', + }, + ruby: { + method: 'crm.lists.create_id_mapping', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_batch_migration_mapping = hubspot.crm.lists.create_id_mapping(body: ["string"])\n\nputs(public_batch_migration_mapping)', + }, + php: { + method: 'crm->lists->createIDMapping', + example: + "crm->lists->createIDMapping(\n body: ['string']\n);\n\nvar_dump($publicBatchMigrationMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/idmapping \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/lists/2026-03/{listId}', + httpMethod: 'delete', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) delete', + qualified: 'client.crm.lists.delete', + params: ['listId: string;'], + markdown: + "## delete\n\n`client.crm.lists.delete(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.delete('listId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.delete('listId');", + }, + python: { + method: 'crm.lists.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete(\n "listId",\n)', + }, + java: { + method: 'crm().lists().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().delete("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.Delete(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete("listId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->delete', + example: + "crm->lists->delete('listId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_folder', + endpoint: '/crm/lists/2026-03/folders/{folderId}', + httpMethod: 'delete', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) delete_folder', + qualified: 'client.crm.lists.deleteFolder', + params: ['folderId: string;'], + markdown: + "## delete_folder\n\n`client.crm.lists.deleteFolder(folderId: string): void`\n\n**delete** `/crm/lists/2026-03/folders/{folderId}`\n\n### Parameters\n\n- `folderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.deleteFolder('folderId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.deleteFolder', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.deleteFolder('folderId');", + }, + python: { + method: 'crm.lists.delete_folder', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete_folder(\n "folderId",\n)', + }, + java: { + method: 'crm().lists().deleteFolder', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().deleteFolder("folderId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.DeleteFolder', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.DeleteFolder(context.TODO(), "folderId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.delete_folder', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete_folder("folderId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->deleteFolder', + example: + "crm->lists->deleteFolder('folderId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_memberships', + endpoint: '/crm/lists/2026-03/{listId}/memberships', + httpMethod: 'delete', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) delete_memberships', + qualified: 'client.crm.lists.deleteMemberships', + params: ['listId: string;'], + markdown: + "## delete_memberships\n\n`client.crm.lists.deleteMemberships(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}/memberships`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.deleteMemberships('listId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.deleteMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.deleteMemberships('listId');", + }, + python: { + method: 'crm.lists.delete_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete_memberships(\n "listId",\n)', + }, + java: { + method: 'crm().lists().deleteMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().deleteMemberships("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.DeleteMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.DeleteMemberships(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.delete_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete_memberships("listId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->deleteMemberships', + example: + "crm->lists->deleteMemberships('listId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/lists/2026-03/{listId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get', + qualified: 'client.crm.lists.get', + params: ['listId: string;', 'includeFilters?: boolean;'], + response: + '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', + markdown: + "## get\n\n`client.crm.lists.get(listId: string, includeFilters?: boolean): { list: public_object_list; }`\n\n**get** `/crm/lists/2026-03/{listId}`\n\n### Parameters\n\n- `listId: string`\n\n- `includeFilters?: boolean`\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFetchResponse = await client.crm.lists.get('listId');\n\nconsole.log(listFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFetchResponse = await client.crm.lists.get('listId');\n\nconsole.log(listFetchResponse.list);", + }, + python: { + method: 'crm.lists.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_fetch_response = client.crm.lists.get(\n list_id="listId",\n)\nprint(list_fetch_response.list)', + }, + java: { + method: 'crm().lists().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFetchResponse listFetchResponse = client.crm().lists().get("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFetchResponse, err := client.Crm.Lists.Get(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFetchResponse.List)\n}\n', + }, + ruby: { + method: 'crm.lists.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_fetch_response = hubspot.crm.lists.get("listId")\n\nputs(list_fetch_response)', + }, + php: { + method: 'crm->lists->get', + example: + "crm->lists->get('listId', includeFilters: true);\n\nvar_dump($listFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_object_type_and_name', + endpoint: '/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_by_object_type_and_name', + qualified: 'client.crm.lists.getByObjectTypeAndName', + params: ['objectTypeId: string;', 'listName: string;', 'includeFilters?: boolean;'], + response: + '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', + markdown: + "## get_by_object_type_and_name\n\n`client.crm.lists.getByObjectTypeAndName(objectTypeId: string, listName: string, includeFilters?: boolean): { list: public_object_list; }`\n\n**get** `/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}`\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `listName: string`\n\n- `includeFilters?: boolean`\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFetchResponse = await client.crm.lists.getByObjectTypeAndName('listName', { objectTypeId: 'objectTypeId' });\n\nconsole.log(listFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getByObjectTypeAndName', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFetchResponse = await client.crm.lists.getByObjectTypeAndName('listName', {\n objectTypeId: 'objectTypeId',\n});\n\nconsole.log(listFetchResponse.list);", + }, + python: { + method: 'crm.lists.get_by_object_type_and_name', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_fetch_response = client.crm.lists.get_by_object_type_and_name(\n list_name="listName",\n object_type_id="objectTypeId",\n)\nprint(list_fetch_response.list)', + }, + java: { + method: 'crm().lists().getByObjectTypeAndName', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListGetByObjectTypeAndNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetByObjectTypeAndNameParams params = ListGetByObjectTypeAndNameParams.builder()\n .objectTypeId("objectTypeId")\n .listName("listName")\n .build();\n ListFetchResponse listFetchResponse = client.crm().lists().getByObjectTypeAndName(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetByObjectTypeAndName', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFetchResponse, err := client.Crm.Lists.GetByObjectTypeAndName(\n\t\tcontext.TODO(),\n\t\t"listName",\n\t\tcrm.ListGetByObjectTypeAndNameParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFetchResponse.List)\n}\n', + }, + ruby: { + method: 'crm.lists.get_by_object_type_and_name', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_fetch_response = hubspot.crm.lists.get_by_object_type_and_name("listName", object_type_id: "objectTypeId")\n\nputs(list_fetch_response)', + }, + php: { + method: 'crm->lists->getByObjectTypeAndName', + example: + "crm->lists->getByObjectTypeAndName(\n 'listName', objectTypeID: 'objectTypeId', includeFilters: true\n);\n\nvar_dump($listFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/object-type-id/$OBJECT_TYPE_ID/name/$LIST_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_id_mapping', + endpoint: '/crm/lists/2026-03/idmapping', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_id_mapping', + qualified: 'client.crm.lists.getIDMapping', + params: ['legacyListId?: string;'], + response: '{ legacyListId: string; listId: string; }', + markdown: + "## get_id_mapping\n\n`client.crm.lists.getIDMapping(legacyListId?: string): { legacyListId: string; listId: string; }`\n\n**get** `/crm/lists/2026-03/idmapping`\n\n### Parameters\n\n- `legacyListId?: string`\n\n### Returns\n\n- `{ legacyListId: string; listId: string; }`\n\n - `legacyListId: string`\n - `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicMigrationMapping = await client.crm.lists.getIDMapping();\n\nconsole.log(publicMigrationMapping);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getIDMapping', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicMigrationMapping = await client.crm.lists.getIDMapping();\n\nconsole.log(publicMigrationMapping.legacyListId);", + }, + python: { + method: 'crm.lists.get_id_mapping', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_migration_mapping = client.crm.lists.get_id_mapping()\nprint(public_migration_mapping.legacy_list_id)', + }, + java: { + method: 'crm().lists().getIdMapping', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetIdMappingParams;\nimport com.hubspot.sdk.models.crm.lists.PublicMigrationMapping;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMigrationMapping publicMigrationMapping = client.crm().lists().getIdMapping();\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetIDMapping', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicMigrationMapping, err := client.Crm.Lists.GetIDMapping(context.TODO(), crm.ListGetIDMappingParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicMigrationMapping.LegacyListID)\n}\n', + }, + ruby: { + method: 'crm.lists.get_id_mapping', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_migration_mapping = hubspot.crm.lists.get_id_mapping\n\nputs(public_migration_mapping)', + }, + php: { + method: 'crm->lists->getIDMapping', + example: + "crm->lists->getIDMapping(\n legacyListID: 'legacyListId'\n);\n\nvar_dump($publicMigrationMapping);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/idmapping \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_memberships_join_order', + endpoint: '/crm/lists/2026-03/{listId}/memberships/join-order', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_memberships_join_order', + qualified: 'client.crm.lists.getMembershipsJoinOrder', + params: ['listId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: '{ membershipTimestamp: string; recordId: string; }', + markdown: + "## get_memberships_join_order\n\n`client.crm.lists.getMembershipsJoinOrder(listId: string, after?: string, before?: string, limit?: number): { membershipTimestamp: string; recordId: string; }`\n\n**get** `/crm/lists/2026-03/{listId}/memberships/join-order`\n\n### Parameters\n\n- `listId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ membershipTimestamp: string; recordId: string; }`\n\n - `membershipTimestamp: string`\n - `recordId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.getMembershipsJoinOrder('listId')) {\n console.log(joinTimeAndRecordID);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getMembershipsJoinOrder', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.getMembershipsJoinOrder('listId')) {\n console.log(joinTimeAndRecordID.membershipTimestamp);\n}", + }, + python: { + method: 'crm.lists.get_memberships_join_order', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.lists.get_memberships_join_order(\n list_id="listId",\n)\npage = page.results[0]\nprint(page.membership_timestamp)', + }, + java: { + method: 'crm().lists().getMembershipsJoinOrder', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetMembershipsJoinOrderPage;\nimport com.hubspot.sdk.models.crm.lists.ListGetMembershipsJoinOrderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetMembershipsJoinOrderPage page = client.crm().lists().getMembershipsJoinOrder("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetMembershipsJoinOrder', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Lists.GetMembershipsJoinOrder(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetMembershipsJoinOrderParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.lists.get_memberships_join_order', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.lists.get_memberships_join_order("listId")\n\nputs(page)', + }, + php: { + method: 'crm->lists->getMembershipsJoinOrder', + example: + "crm->lists->getMembershipsJoinOrder(\n 'listId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/join-order \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_record_memberships', + endpoint: '/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_record_memberships', + qualified: 'client.crm.lists.getRecordMemberships', + params: ['objectTypeId: string;', 'recordId: string;'], + response: + '{ results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; paging?: { next?: next_page; prev?: previous_page; }; total?: number; }', + markdown: + "## get_record_memberships\n\n`client.crm.lists.getRecordMemberships(objectTypeId: string, recordId: string): { results: record_list_membership[]; paging?: paging; total?: number; }`\n\n**get** `/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships`\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `recordId: string`\n\n### Returns\n\n- `{ results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; paging?: { next?: next_page; prev?: previous_page; }; total?: number; }`\n\n - `results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n - `total?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst apiCollectionResponseRecordListMembership = await client.crm.lists.getRecordMemberships('recordId', { objectTypeId: 'objectTypeId' });\n\nconsole.log(apiCollectionResponseRecordListMembership);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getRecordMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst apiCollectionResponseRecordListMembership = await client.crm.lists.getRecordMemberships(\n 'recordId',\n { objectTypeId: 'objectTypeId' },\n);\n\nconsole.log(apiCollectionResponseRecordListMembership.results);", + }, + python: { + method: 'crm.lists.get_record_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\napi_collection_response_record_list_membership = client.crm.lists.get_record_memberships(\n record_id="recordId",\n object_type_id="objectTypeId",\n)\nprint(api_collection_response_record_list_membership.results)', + }, + java: { + method: 'crm().lists().getRecordMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ApiCollectionResponseRecordListMembership;\nimport com.hubspot.sdk.models.crm.lists.ListGetRecordMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetRecordMembershipsParams params = ListGetRecordMembershipsParams.builder()\n .objectTypeId("objectTypeId")\n .recordId("recordId")\n .build();\n ApiCollectionResponseRecordListMembership apiCollectionResponseRecordListMembership = client.crm().lists().getRecordMemberships(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetRecordMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tapiCollectionResponseRecordListMembership, err := client.Crm.Lists.GetRecordMemberships(\n\t\tcontext.TODO(),\n\t\t"recordId",\n\t\tcrm.ListGetRecordMembershipsParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", apiCollectionResponseRecordListMembership.Results)\n}\n', + }, + ruby: { + method: 'crm.lists.get_record_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\napi_collection_response_record_list_membership = hubspot.crm.lists.get_record_memberships("recordId", object_type_id: "objectTypeId")\n\nputs(api_collection_response_record_list_membership)', + }, + php: { + method: 'crm->lists->getRecordMemberships', + example: + "crm\n ->lists\n ->getRecordMemberships('recordId', objectTypeID: 'objectTypeId');\n\nvar_dump($apiCollectionResponseRecordListMembership);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/records/$OBJECT_TYPE_ID/$RECORD_ID/memberships \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_schedule_conversion', + endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_schedule_conversion', + qualified: 'client.crm.lists.getScheduleConversion', + params: ['listId: string;'], + response: + "{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }", + markdown: + "## get_schedule_conversion\n\n`client.crm.lists.getScheduleConversion(listId: string): { listId: string; convertedAt?: string; requestedConversionTime?: public_list_conversion_date | public_list_conversion_inactivity; }`\n\n**get** `/crm/lists/2026-03/{listId}/schedule-conversion`\n\n### Parameters\n\n- `listId: string`\n\n### Returns\n\n- `{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }`\n\n - `listId: string`\n - `convertedAt?: string`\n - `requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicListConversionResponse = await client.crm.lists.getScheduleConversion('listId');\n\nconsole.log(publicListConversionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getScheduleConversion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicListConversionResponse = await client.crm.lists.getScheduleConversion('listId');\n\nconsole.log(publicListConversionResponse.listId);", + }, + python: { + method: 'crm.lists.get_schedule_conversion', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_list_conversion_response = client.crm.lists.get_schedule_conversion(\n "listId",\n)\nprint(public_list_conversion_response.list_id)', + }, + java: { + method: 'crm().lists().getScheduleConversion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetScheduleConversionParams;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicListConversionResponse publicListConversionResponse = client.crm().lists().getScheduleConversion("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetScheduleConversion', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicListConversionResponse, err := client.Crm.Lists.GetScheduleConversion(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicListConversionResponse.ListID)\n}\n', + }, + ruby: { + method: 'crm.lists.get_schedule_conversion', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_list_conversion_response = hubspot.crm.lists.get_schedule_conversion("listId")\n\nputs(public_list_conversion_response)', + }, + php: { + method: 'crm->lists->getScheduleConversion', + example: + "crm->lists->getScheduleConversion(\n 'listId'\n);\n\nvar_dump($publicListConversionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_size_and_edits_history_between', + endpoint: '/crm/lists/2026-03/{listId}/size-and-edits-history/between', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) get_size_and_edits_history_between', + qualified: 'client.crm.lists.getSizeAndEditsHistoryBetween', + params: ['listId: string;', 'endDate?: string;', 'startDate?: string;'], + response: '{ editHistory: string[]; sizeHistory: { size: number; timestamp: string; }[]; }', + markdown: + "## get_size_and_edits_history_between\n\n`client.crm.lists.getSizeAndEditsHistoryBetween(listId: string, endDate?: string, startDate?: string): { editHistory: string[]; sizeHistory: list_size_data_point[]; }`\n\n**get** `/crm/lists/2026-03/{listId}/size-and-edits-history/between`\n\n### Parameters\n\n- `listId: string`\n\n- `endDate?: string`\n\n- `startDate?: string`\n\n### Returns\n\n- `{ editHistory: string[]; sizeHistory: { size: number; timestamp: string; }[]; }`\n\n - `editHistory: string[]`\n - `sizeHistory: { size: number; timestamp: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listSizeAndEditHistoryResponse = await client.crm.lists.getSizeAndEditsHistoryBetween('listId');\n\nconsole.log(listSizeAndEditHistoryResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.getSizeAndEditsHistoryBetween', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listSizeAndEditHistoryResponse = await client.crm.lists.getSizeAndEditsHistoryBetween(\n 'listId',\n);\n\nconsole.log(listSizeAndEditHistoryResponse.editHistory);", + }, + python: { + method: 'crm.lists.get_size_and_edits_history_between', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_size_and_edit_history_response = client.crm.lists.get_size_and_edits_history_between(\n list_id="listId",\n)\nprint(list_size_and_edit_history_response.edit_history)', + }, + java: { + method: 'crm().lists().getSizeAndEditsHistoryBetween', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetSizeAndEditsHistoryBetweenParams;\nimport com.hubspot.sdk.models.crm.lists.ListSizeAndEditHistoryResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListSizeAndEditHistoryResponse listSizeAndEditHistoryResponse = client.crm().lists().getSizeAndEditsHistoryBetween("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.GetSizeAndEditsHistoryBetween', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistSizeAndEditHistoryResponse, err := client.Crm.Lists.GetSizeAndEditsHistoryBetween(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetSizeAndEditsHistoryBetweenParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listSizeAndEditHistoryResponse.EditHistory)\n}\n', + }, + ruby: { + method: 'crm.lists.get_size_and_edits_history_between', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_size_and_edit_history_response = hubspot.crm.lists.get_size_and_edits_history_between("listId")\n\nputs(list_size_and_edit_history_response)', + }, + php: { + method: 'crm->lists->getSizeAndEditsHistoryBetween', + example: + "crm\n ->lists\n ->getSizeAndEditsHistoryBetween(\n 'listId',\n endDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n startDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($listSizeAndEditHistoryResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/size-and-edits-history/between \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/lists/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) list', + qualified: 'client.crm.lists.list', + params: ['includeFilters?: boolean;', 'listIds?: string[];'], + response: + '{ lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }[]; }', + markdown: + "## list\n\n`client.crm.lists.list(includeFilters?: boolean, listIds?: string[]): { lists: public_object_list[]; }`\n\n**get** `/crm/lists/2026-03`\n\n### Parameters\n\n- `includeFilters?: boolean`\n\n- `listIds?: string[]`\n\n### Returns\n\n- `{ lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }[]; }`\n\n - `lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listsByIDResponse = await client.crm.lists.list();\n\nconsole.log(listsByIDResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listsByIDResponse = await client.crm.lists.list();\n\nconsole.log(listsByIDResponse.lists);", + }, + python: { + method: 'crm.lists.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlists_by_id_response = client.crm.lists.list()\nprint(lists_by_id_response.lists)', + }, + java: { + method: 'crm().lists().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListListParams;\nimport com.hubspot.sdk.models.crm.lists.ListsByIdResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListsByIdResponse listsByIdResponse = client.crm().lists().list();\n }\n}', + }, + go: { + method: 'client.Crm.Lists.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistsByIDResponse, err := client.Crm.Lists.List(context.TODO(), crm.ListListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listsByIDResponse.Lists)\n}\n', + }, + ruby: { + method: 'crm.lists.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlists_by_id_response = hubspot.crm.lists.list\n\nputs(lists_by_id_response)', + }, + php: { + method: 'crm->lists->list', + example: + "crm->lists->list(\n includeFilters: true, listIDs: ['string']\n);\n\nvar_dump($listsByIDResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_by_search', + endpoint: '/crm/lists/2026-03/search', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) list_by_search', + qualified: 'client.crm.lists.listBySearch', + params: [ + 'listIds: string[];', + 'offset: number;', + 'processingTypes: string[];', + 'additional_filter_properties?: string[];', + 'count?: number;', + 'objectTypeId?: string;', + 'query?: string;', + 'sort?: string;', + ], + response: + '{ hasMore: boolean; lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]; offset: number; total: number; }', + markdown: + "## list_by_search\n\n`client.crm.lists.listBySearch(listIds: string[], offset: number, processingTypes: string[], additional_filter_properties?: string[], count?: number, objectTypeId?: string, query?: string, sort?: string): { hasMore: boolean; lists: public_object_list_search_result[]; offset: number; total: number; }`\n\n**post** `/crm/lists/2026-03/search`\n\n### Parameters\n\n- `listIds: string[]`\n ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included\n\n- `offset: number`\n Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.\n\n- `processingTypes: string[]`\n List processing types to be included in search results. If not specified, all lists with all processing types will be included.\n\n- `additional_filter_properties?: string[]`\n The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.\n\nBy default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.\n\n- `count?: number`\n The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.\n\n- `objectTypeId?: string`\n\n- `query?: string`\n The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.\n\n- `sort?: string`\n Sort field and order\n\n### Returns\n\n- `{ hasMore: boolean; lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]; offset: number; total: number; }`\n\n - `hasMore: boolean`\n - `lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]`\n - `offset: number`\n - `total: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listSearchResponse = await client.crm.lists.listBySearch({\n listIds: ['string'],\n offset: 0,\n processingTypes: ['string'],\n});\n\nconsole.log(listSearchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.listBySearch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listSearchResponse = await client.crm.lists.listBySearch({\n listIds: ['string'],\n offset: 0,\n processingTypes: ['string'],\n});\n\nconsole.log(listSearchResponse.hasMore);", + }, + python: { + method: 'crm.lists.list_by_search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_search_response = client.crm.lists.list_by_search(\n list_ids=["string"],\n offset=0,\n processing_types=["string"],\n)\nprint(list_search_response.has_more)', + }, + java: { + method: 'crm().lists().listBySearch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListSearchRequest;\nimport com.hubspot.sdk.models.crm.lists.ListSearchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListSearchRequest params = ListSearchRequest.builder()\n .addListId("string")\n .offset(0)\n .addProcessingType("string")\n .build();\n ListSearchResponse listSearchResponse = client.crm().lists().listBySearch(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.ListBySearch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistSearchResponse, err := client.Crm.Lists.ListBySearch(context.TODO(), crm.ListListBySearchParams{\n\t\tListSearchRequest: crm.ListSearchRequestParam{\n\t\t\tListIDs: []string{"string"},\n\t\t\tOffset: 0,\n\t\t\tProcessingTypes: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listSearchResponse.HasMore)\n}\n', + }, + ruby: { + method: 'crm.lists.list_by_search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_search_response = hubspot.crm.lists.list_by_search(list_ids: ["string"], offset: 0, processing_types: ["string"])\n\nputs(list_search_response)', + }, + php: { + method: 'crm->lists->listBySearch', + example: + "crm->lists->listBySearch(\n listIDs: ['string'],\n offset: 0,\n processingTypes: ['string'],\n additionalFilterProperties: ['string'],\n count: 0,\n objectTypeID: 'objectTypeId',\n query: 'query',\n sort: 'sort',\n);\n\nvar_dump($listSearchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "listIds": [\n "string"\n ],\n "offset": 0,\n "processingTypes": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'list_folders', + endpoint: '/crm/lists/2026-03/folders', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) list_folders', + qualified: 'client.crm.lists.listFolders', + params: ['folderId?: string;'], + response: + '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', + markdown: + "## list_folders\n\n`client.crm.lists.listFolders(folderId?: string): { folder: public_list_folder; }`\n\n**get** `/crm/lists/2026-03/folders`\n\n### Parameters\n\n- `folderId?: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.listFolders();\n\nconsole.log(listFolderFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.listFolders', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.listFolders();\n\nconsole.log(listFolderFetchResponse.folder);", + }, + python: { + method: 'crm.lists.list_folders', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.list_folders()\nprint(list_folder_fetch_response.folder)', + }, + java: { + method: 'crm().lists().listFolders', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListListFoldersParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().listFolders();\n }\n}', + }, + go: { + method: 'client.Crm.Lists.ListFolders', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.ListFolders(context.TODO(), crm.ListListFoldersParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', + }, + ruby: { + method: 'crm.lists.list_folders', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.list_folders\n\nputs(list_folder_fetch_response)', + }, + php: { + method: 'crm->lists->listFolders', + example: + "crm->lists->listFolders(\n folderID: 'folderId'\n);\n\nvar_dump($listFolderFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_memberships', + endpoint: '/crm/lists/2026-03/{listId}/memberships', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) list_memberships', + qualified: 'client.crm.lists.listMemberships', + params: ['listId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: '{ membershipTimestamp: string; recordId: string; }', + markdown: + "## list_memberships\n\n`client.crm.lists.listMemberships(listId: string, after?: string, before?: string, limit?: number): { membershipTimestamp: string; recordId: string; }`\n\n**get** `/crm/lists/2026-03/{listId}/memberships`\n\n### Parameters\n\n- `listId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ membershipTimestamp: string; recordId: string; }`\n\n - `membershipTimestamp: string`\n - `recordId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.listMemberships('listId')) {\n console.log(joinTimeAndRecordID);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.listMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.listMemberships('listId')) {\n console.log(joinTimeAndRecordID.membershipTimestamp);\n}", + }, + python: { + method: 'crm.lists.list_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.lists.list_memberships(\n list_id="listId",\n)\npage = page.results[0]\nprint(page.membership_timestamp)', + }, + java: { + method: 'crm().lists().listMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListListMembershipsPage;\nimport com.hubspot.sdk.models.crm.lists.ListListMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListListMembershipsPage page = client.crm().lists().listMemberships("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.ListMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Lists.ListMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListListMembershipsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.lists.list_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.lists.list_memberships("listId")\n\nputs(page)', + }, + php: { + method: 'crm->lists->listMemberships', + example: + "crm->lists->listMemberships(\n 'listId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'move_folder', + endpoint: '/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) move_folder', + qualified: 'client.crm.lists.moveFolder', + params: ['folderId: string;', 'newParentFolderId: string;'], + response: + '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', + markdown: + "## move_folder\n\n`client.crm.lists.moveFolder(folderId: string, newParentFolderId: string): { folder: public_list_folder; }`\n\n**put** `/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}`\n\n### Parameters\n\n- `folderId: string`\n\n- `newParentFolderId: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.moveFolder('newParentFolderId', { folderId: 'folderId' });\n\nconsole.log(listFolderFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.moveFolder', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.moveFolder('newParentFolderId', {\n folderId: 'folderId',\n});\n\nconsole.log(listFolderFetchResponse.folder);", + }, + python: { + method: 'crm.lists.move_folder', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.move_folder(\n new_parent_folder_id="newParentFolderId",\n folder_id="folderId",\n)\nprint(list_folder_fetch_response.folder)', + }, + java: { + method: 'crm().lists().moveFolder', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListMoveFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListMoveFolderParams params = ListMoveFolderParams.builder()\n .folderId("folderId")\n .newParentFolderId("newParentFolderId")\n .build();\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().moveFolder(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.MoveFolder', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.MoveFolder(\n\t\tcontext.TODO(),\n\t\t"newParentFolderId",\n\t\tcrm.ListMoveFolderParams{\n\t\t\tFolderID: "folderId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', + }, + ruby: { + method: 'crm.lists.move_folder', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.move_folder("newParentFolderId", folder_id: "folderId")\n\nputs(list_folder_fetch_response)', + }, + php: { + method: 'crm->lists->moveFolder', + example: + "crm->lists->moveFolder(\n 'newParentFolderId', folderID: 'folderId'\n);\n\nvar_dump($listFolderFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID/move/$NEW_PARENT_FOLDER_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'move_list', + endpoint: '/crm/lists/2026-03/folders/move-list', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) move_list', + qualified: 'client.crm.lists.moveList', + params: ['listId: string;', 'newFolderId: string;'], + markdown: + "## move_list\n\n`client.crm.lists.moveList(listId: string, newFolderId: string): void`\n\n**put** `/crm/lists/2026-03/folders/move-list`\n\n### Parameters\n\n- `listId: string`\n The Id of the list to move.\n\n- `newFolderId: string`\n The Id of folder to move the list to, the root folder is Id 0.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.moveList({ listId: 'listId', newFolderId: 'newFolderId' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.moveList', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.moveList({ listId: 'listId', newFolderId: 'newFolderId' });", + }, + python: { + method: 'crm.lists.move_list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.move_list(\n list_id="listId",\n new_folder_id="newFolderId",\n)', + }, + java: { + method: 'crm().lists().moveList', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListMoveRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListMoveRequest params = ListMoveRequest.builder()\n .listId("listId")\n .newFolderId("newFolderId")\n .build();\n client.crm().lists().moveList(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.MoveList', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.MoveList(context.TODO(), crm.ListMoveListParams{\n\t\tListMoveRequest: crm.ListMoveRequestParam{\n\t\t\tListID: "listId",\n\t\t\tNewFolderID: "newFolderId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.move_list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.move_list(list_id: "listId", new_folder_id: "newFolderId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->moveList', + example: + "crm->lists->moveList(\n listID: 'listId', newFolderID: 'newFolderId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders/move-list \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "listId": "listId",\n "newFolderId": "newFolderId"\n }\'', + }, + }, + }, + { + name: 'remove_memberships', + endpoint: '/crm/lists/2026-03/{listId}/memberships/remove', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) remove_memberships', + qualified: 'client.crm.lists.removeMemberships', + params: ['listId: string;', 'body: string[];'], + response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', + markdown: + "## remove_memberships\n\n`client.crm.lists.removeMemberships(listId: string, body: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/remove`\n\n### Parameters\n\n- `listId: string`\n\n- `body: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.removeMemberships('listId', { body: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.removeMemberships', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.removeMemberships('listId', {\n body: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", + }, + python: { + method: 'crm.lists.remove_memberships', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.remove_memberships(\n list_id="listId",\n body=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', + }, + java: { + method: 'crm().lists().removeMemberships', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListRemoveMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListRemoveMembershipsParams params = ListRemoveMembershipsParams.builder()\n .listId("listId")\n .addBody("string")\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().removeMemberships(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.RemoveMemberships', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.RemoveMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListRemoveMembershipsParams{\n\t\t\tBody: []string{"string"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', + }, + ruby: { + method: 'crm.lists.remove_memberships', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.remove_memberships("listId", body: ["string"])\n\nputs(memberships_update_response)', + }, + php: { + method: 'crm->lists->removeMemberships', + example: + "crm->lists->removeMemberships(\n 'listId', body: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/remove \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', + }, + }, + }, + { + name: 'rename_folder', + endpoint: '/crm/lists/2026-03/folders/{folderId}/rename', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) rename_folder', + qualified: 'client.crm.lists.renameFolder', + params: ['folderId: string;', 'newFolderName?: string;'], + response: + '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', + markdown: + "## rename_folder\n\n`client.crm.lists.renameFolder(folderId: string, newFolderName?: string): { folder: public_list_folder; }`\n\n**put** `/crm/lists/2026-03/folders/{folderId}/rename`\n\n### Parameters\n\n- `folderId: string`\n\n- `newFolderName?: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.renameFolder('folderId');\n\nconsole.log(listFolderFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.renameFolder', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.renameFolder('folderId');\n\nconsole.log(listFolderFetchResponse.folder);", + }, + python: { + method: 'crm.lists.rename_folder', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.rename_folder(\n folder_id="folderId",\n)\nprint(list_folder_fetch_response.folder)', + }, + java: { + method: 'crm().lists().renameFolder', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListRenameFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().renameFolder("folderId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.RenameFolder', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.RenameFolder(\n\t\tcontext.TODO(),\n\t\t"folderId",\n\t\tcrm.ListRenameFolderParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', + }, + ruby: { + method: 'crm.lists.rename_folder', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.rename_folder("folderId")\n\nputs(list_folder_fetch_response)', + }, + php: { + method: 'crm->lists->renameFolder', + example: + "crm->lists->renameFolder(\n 'folderId', newFolderName: 'newFolderName'\n);\n\nvar_dump($listFolderFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID/rename \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore', + endpoint: '/crm/lists/2026-03/{listId}/restore', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) restore', + qualified: 'client.crm.lists.restore', + params: ['listId: string;'], + markdown: + "## restore\n\n`client.crm.lists.restore(listId: string): void`\n\n**put** `/crm/lists/2026-03/{listId}/restore`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.restore('listId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.restore', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.restore('listId');", + }, + python: { + method: 'crm.lists.restore', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.restore(\n "listId",\n)', + }, + java: { + method: 'crm().lists().restore', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListRestoreParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().restore("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.Restore', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.Restore(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.restore', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.restore("listId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->restore', + example: + "crm->lists->restore('listId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/restore \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'schedule_conversion', + endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', + httpMethod: 'delete', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) schedule_conversion', + qualified: 'client.crm.lists.scheduleConversion', + params: ['listId: string;'], + markdown: + "## schedule_conversion\n\n`client.crm.lists.scheduleConversion(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}/schedule-conversion`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.scheduleConversion('listId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.scheduleConversion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.scheduleConversion('listId');", + }, + python: { + method: 'crm.lists.schedule_conversion', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.schedule_conversion(\n "listId",\n)', + }, + java: { + method: 'crm().lists().scheduleConversion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListScheduleConversionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().scheduleConversion("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.ScheduleConversion', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.ScheduleConversion(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.lists.schedule_conversion', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.schedule_conversion("listId")\n\nputs(result)', + }, + php: { + method: 'crm->lists->scheduleConversion', + example: + "crm->lists->scheduleConversion('listId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_list_filters', + endpoint: '/crm/lists/2026-03/{listId}/update-list-filters', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) update_list_filters', + qualified: 'client.crm.lists.updateListFilters', + params: [ + 'listId: string;', + "filterBranch: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; };", + 'enrollObjectsInWorkflows?: boolean;', + ], + response: + '{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', + markdown: + "## update_list_filters\n\n`client.crm.lists.updateListFilters(listId: string, filterBranch: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }, enrollObjectsInWorkflows?: boolean): { updatedList?: public_object_list; }`\n\n**put** `/crm/lists/2026-03/{listId}/update-list-filters`\n\n### Parameters\n\n- `listId: string`\n\n- `filterBranch: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; }`\n Updated filtering criteria for the list\n\n- `enrollObjectsInWorkflows?: boolean`\n\n### Returns\n\n- `{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listUpdateResponse = await client.crm.lists.updateListFilters('listId', { filterBranch: {\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n eventTypeId: 'eventTypeId',\n filterBranches: [{\n filterBranches: [{\n associationCategory: 'associationCategory',\n associationTypeId: 0,\n filterBranches: [{\n filterBranches: [],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'ASSOCIATION',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'PROPERTY_ASSOCIATION',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n propertyWithObjectId: 'propertyWithObjectId',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'UNIFIED_EVENTS',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n operator: 'HAS_COMPLETED',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'RESTRICTED',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ANY',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ALL',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'AND',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n} });\n\nconsole.log(listUpdateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.updateListFilters', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listUpdateResponse = await client.crm.lists.updateListFilters('listId', {\n filterBranch: {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n eventTypeId: 'eventTypeId',\n filterBranches: [\n {\n filterBranches: [\n {\n associationCategory: 'associationCategory',\n associationTypeId: 0,\n filterBranches: [\n {\n filterBranches: [],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'ASSOCIATION',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'PROPERTY_ASSOCIATION',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n propertyWithObjectId: 'propertyWithObjectId',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'UNIFIED_EVENTS',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n operator: 'HAS_COMPLETED',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'RESTRICTED',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ANY',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ALL',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'AND',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n});\n\nconsole.log(listUpdateResponse.updatedList);", + }, + python: { + method: 'crm.lists.update_list_filters', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_update_response = client.crm.lists.update_list_filters(\n list_id="listId",\n filter_branch={\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "event_type_id": "eventTypeId",\n "filter_branches": [{\n "filter_branches": [{\n "association_category": "associationCategory",\n "association_type_id": 0,\n "filter_branches": [{\n "filter_branches": [],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "OR",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "ASSOCIATION",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "object_type_id": "objectTypeId",\n "operator": "operator",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "PROPERTY_ASSOCIATION",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "object_type_id": "objectTypeId",\n "operator": "operator",\n "property_with_object_id": "propertyWithObjectId",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "UNIFIED_EVENTS",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "operator": "HAS_COMPLETED",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "RESTRICTED",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "NOT_ANY",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "NOT_ALL",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "AND",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "OR",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n },\n)\nprint(list_update_response.updated_list)', + }, + java: { + method: 'crm().lists().updateListFilters', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFilterUpdateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateListFiltersParams;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateResponse;\nimport com.hubspot.sdk.models.crm.lists.PublicAndFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicAssociationFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicBoolPropertyOperation;\nimport com.hubspot.sdk.models.crm.lists.PublicNotAllFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicNotAnyFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicOrFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicPropertyAssociationFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicPropertyFilter;\nimport com.hubspot.sdk.models.crm.lists.PublicRestrictedFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicUnifiedEventsFilterBranch;\nimport java.util.List;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateListFiltersParams params = ListUpdateListFiltersParams.builder()\n .listId("listId")\n .listFilterUpdateRequest(ListFilterUpdateRequest.builder()\n .filterBranch(PublicOrFilterBranch.builder()\n .addFilterBranch(PublicAndFilterBranch.builder()\n .addFilterBranch(PublicNotAllFilterBranch.builder()\n .addFilterBranch(PublicNotAnyFilterBranch.builder()\n .addFilterBranch(PublicRestrictedFilterBranch.builder()\n .addFilterBranch(PublicUnifiedEventsFilterBranch.builder()\n .eventTypeId("eventTypeId")\n .addFilterBranch(PublicPropertyAssociationFilterBranch.builder()\n .addFilterBranch(PublicAssociationFilterBranch.builder()\n .associationCategory("associationCategory")\n .associationTypeId(0)\n .addFilterBranch(PublicOrFilterBranch.builder()\n .filterBranches(List.of())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicOrFilterBranch.FilterBranchType.OR)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicAssociationFilterBranch.FilterBranchType.ASSOCIATION)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .objectTypeId("objectTypeId")\n .operator("operator")\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicPropertyAssociationFilterBranch.FilterBranchType.PROPERTY_ASSOCIATION)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .objectTypeId("objectTypeId")\n .operator("operator")\n .propertyWithObjectId("propertyWithObjectId")\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicUnifiedEventsFilterBranch.FilterBranchType.UNIFIED_EVENTS)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .operator(PublicUnifiedEventsFilterBranch.Operator.HAS_COMPLETED)\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicRestrictedFilterBranch.FilterBranchType.RESTRICTED)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicNotAnyFilterBranch.FilterBranchType.NOT_ANY)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicNotAllFilterBranch.FilterBranchType.NOT_ALL)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicAndFilterBranch.FilterBranchType.AND)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicOrFilterBranch.FilterBranchType.OR)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .build())\n .build();\n ListUpdateResponse listUpdateResponse = client.crm().lists().updateListFilters(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.UpdateListFilters', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistUpdateResponse, err := client.Crm.Lists.UpdateListFilters(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateListFiltersParams{\n\t\t\tListFilterUpdateRequest: crm.ListFilterUpdateRequestParam{\n\t\t\t\tFilterBranch: crm.ListFilterUpdateRequestFilterBranchUnionParam{\n\t\t\t\t\tOfOr: &crm.PublicOrFilterBranchParam{\n\t\t\t\t\t\tFilterBranches: []crm.PublicOrFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\tOfAnd: &crm.PublicAndFilterBranchParam{\n\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicAndFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\tOfNotAll: &crm.PublicNotAllFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicNotAllFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\tOfNotAny: &crm.PublicNotAnyFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicNotAnyFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfRestricted: &crm.PublicRestrictedFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicRestrictedFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfUnifiedEvents: &crm.PublicUnifiedEventsFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tEventTypeID: "eventTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicUnifiedEventsFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfPropertyAssociation: &crm.PublicPropertyAssociationFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicPropertyAssociationFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfAssociation: &crm.PublicAssociationFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tAssociationCategory: "associationCategory",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicAssociationFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfOr: &crm.PublicOrFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicOrFilterBranchFilterBranchUnionParam{},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicOrFilterBranchFilterBranchTypeOr,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicOrFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicAssociationFilterBranchFilterBranchTypeAssociation,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicAssociationFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicPropertyAssociationFilterBranchFilterBranchTypePropertyAssociation,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicPropertyAssociationFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tPropertyWithObjectID: "propertyWithObjectId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicUnifiedEventsFilterBranchFilterBranchTypeUnifiedEvents,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicUnifiedEventsFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: crm.PublicUnifiedEventsFilterBranchOperatorHasCompleted,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicRestrictedFilterBranchFilterBranchTypeRestricted,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicRestrictedFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicNotAnyFilterBranchFilterBranchTypeNotAny,\n\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicNotAnyFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicNotAllFilterBranchFilterBranchTypeNotAll,\n\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicNotAllFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicAndFilterBranchFilterBranchTypeAnd,\n\t\t\t\t\t\t\t\tFilters: []crm.PublicAndFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\tFilterBranchType: crm.PublicOrFilterBranchFilterBranchTypeOr,\n\t\t\t\t\t\tFilters: []crm.PublicOrFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listUpdateResponse.UpdatedList)\n}\n', + }, + ruby: { + method: 'crm.lists.update_list_filters', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_update_response = hubspot.crm.lists.update_list_filters(\n "listId",\n filter_branch: {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n eventTypeId: "eventTypeId",\n filterBranches: [\n {\n filterBranches: [\n {\n associationCategory: "associationCategory",\n associationTypeId: 0,\n filterBranches: [\n {\n filterBranches: [],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :OR,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :ASSOCIATION,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n objectTypeId: "objectTypeId",\n operator: "operator"\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :PROPERTY_ASSOCIATION,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n objectTypeId: "objectTypeId",\n operator: "operator",\n propertyWithObjectId: "propertyWithObjectId"\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :UNIFIED_EVENTS,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n operator: :HAS_COMPLETED\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :RESTRICTED,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :NOT_ANY,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :NOT_ALL,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :AND,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :OR,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n)\n\nputs(list_update_response)', + }, + php: { + method: 'crm->lists->updateListFilters', + example: + "crm->lists->updateListFilters(\n 'listId',\n filterBranch: [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'eventTypeID' => 'eventTypeId',\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'associationCategory' => 'associationCategory',\n 'associationTypeID' => 0,\n 'filterBranches' => [\n [\n 'filterBranches' => [],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'PROPERTY_ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n 'propertyWithObjectID' => 'propertyWithObjectId',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'UNIFIED_EVENTS',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'operator' => 'HAS_COMPLETED',\n 'coalescingRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n 'pruningRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'RESTRICTED',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ANY',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ALL',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'AND',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n enrollObjectsInWorkflows: true,\n);\n\nvar_dump($listUpdateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/update-list-filters \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "filterBranch": {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "eventTypeId": "eventTypeId",\n "filterBranches": [\n {\n "filterBranches": [\n {\n "associationCategory": "associationCategory",\n "associationTypeId": 0,\n "filterBranches": [\n {\n "filterBranches": [],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "OR",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "ASSOCIATION",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "objectTypeId": "objectTypeId",\n "operator": "operator"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "PROPERTY_ASSOCIATION",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "objectTypeId": "objectTypeId",\n "operator": "operator",\n "propertyWithObjectId": "propertyWithObjectId"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "UNIFIED_EVENTS",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "operator": "HAS_COMPLETED"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "RESTRICTED",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "NOT_ANY",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "NOT_ALL",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "AND",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "OR",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n }\'', + }, + }, + }, + { + name: 'update_list_name', + endpoint: '/crm/lists/2026-03/{listId}/update-list-name', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) update_list_name', + qualified: 'client.crm.lists.updateListName', + params: ['listId: string;', 'includeFilters?: boolean;', 'listName?: string;'], + response: + '{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', + markdown: + "## update_list_name\n\n`client.crm.lists.updateListName(listId: string, includeFilters?: boolean, listName?: string): { updatedList?: public_object_list; }`\n\n**put** `/crm/lists/2026-03/{listId}/update-list-name`\n\n### Parameters\n\n- `listId: string`\n\n- `includeFilters?: boolean`\n\n- `listName?: string`\n\n### Returns\n\n- `{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listUpdateResponse = await client.crm.lists.updateListName('listId');\n\nconsole.log(listUpdateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.lists.updateListName', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listUpdateResponse = await client.crm.lists.updateListName('listId');\n\nconsole.log(listUpdateResponse.updatedList);", + }, + python: { + method: 'crm.lists.update_list_name', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_update_response = client.crm.lists.update_list_name(\n list_id="listId",\n)\nprint(list_update_response.updated_list)', + }, + java: { + method: 'crm().lists().updateListName', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateListNameParams;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateResponse listUpdateResponse = client.crm().lists().updateListName("listId");\n }\n}', + }, + go: { + method: 'client.Crm.Lists.UpdateListName', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistUpdateResponse, err := client.Crm.Lists.UpdateListName(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateListNameParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listUpdateResponse.UpdatedList)\n}\n', + }, + ruby: { + method: 'crm.lists.update_list_name', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_update_response = hubspot.crm.lists.update_list_name("listId")\n\nputs(list_update_response)', + }, + php: { + method: 'crm->lists->updateListName', + example: + "crm->lists->updateListName(\n 'listId', includeFilters: true, listName: 'listName'\n);\n\nvar_dump($listUpdateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/update-list-name \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_schedule_conversion', + endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', + httpMethod: 'put', + summary: '', + description: '', + stainlessPath: '(resource) crm.lists > (method) update_schedule_conversion', + qualified: 'client.crm.lists.updateScheduleConversion', + params: [ + 'listId: string;', + "public_list_conversion_time: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; };", + ], + response: + "{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }", + perLanguage: { + typescript: { + method: 'client.crm.lists.updateScheduleConversion', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicListConversionResponse = await client.crm.lists.updateScheduleConversion('listId', {\n conversionType: 'CONVERSION_DATE',\n day: 0,\n month: 0,\n year: 0,\n});\n\nconsole.log(publicListConversionResponse.listId);", + }, + python: { + method: 'crm.lists.update_schedule_conversion', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_list_conversion_response = client.crm.lists.update_schedule_conversion(\n list_id="listId",\n conversion_type="CONVERSION_DATE",\n day=0,\n month=0,\n year=0,\n)\nprint(public_list_conversion_response.list_id)', + }, + java: { + method: 'crm().lists().updateScheduleConversion', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateScheduleConversionParams;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionDate;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateScheduleConversionParams params = ListUpdateScheduleConversionParams.builder()\n .listId("listId")\n .publicListConversionTime(PublicListConversionDate.builder()\n .conversionType(PublicListConversionDate.ConversionType.CONVERSION_DATE)\n .day(0)\n .month(0)\n .year(0)\n .build())\n .build();\n PublicListConversionResponse publicListConversionResponse = client.crm().lists().updateScheduleConversion(params);\n }\n}', + }, + go: { + method: 'client.Crm.Lists.UpdateScheduleConversion', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicListConversionResponse, err := client.Crm.Lists.UpdateScheduleConversion(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateScheduleConversionParams{\n\t\t\tPublicListConversionTime: crm.PublicListConversionTimeUnionParam{\n\t\t\t\tOfConversionDate: &crm.PublicListConversionDateParam{\n\t\t\t\t\tConversionType: crm.PublicListConversionDateConversionTypeConversionDate,\n\t\t\t\t\tDay: 0,\n\t\t\t\t\tMonth: 0,\n\t\t\t\t\tYear: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicListConversionResponse.ListID)\n}\n', + }, + ruby: { + method: 'crm.lists.update_schedule_conversion', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_list_conversion_response = hubspot.crm.lists.update_schedule_conversion(\n "listId",\n public_list_conversion_time: {conversionType: :CONVERSION_DATE, day: 0, month: 0, year: 0}\n)\n\nputs(public_list_conversion_response)', + }, + php: { + method: 'crm->lists->updateScheduleConversion', + example: + "crm->lists->updateScheduleConversion(\n 'listId',\n conversionType: 'INACTIVITY',\n day: 0,\n month: 0,\n year: 0,\n offset: 0,\n timeUnit: 'DAY',\n);\n\nvar_dump($publicListConversionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionType": "CONVERSION_DATE",\n "day": 0,\n "month": 0,\n "year": 0\n }\'', + }, + }, + }, + { + name: 'get_all', + endpoint: '/crm/object-library/2026-03/enablement', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.object_library.enablement > (method) get_all', + qualified: 'client.crm.objectLibrary.enablement.getAll', + response: '{ enablementByObjectTypeId: object; }', + markdown: + "## get_all\n\n`client.crm.objectLibrary.enablement.getAll(): { enablementByObjectTypeId: object; }`\n\n**get** `/crm/object-library/2026-03/enablement`\n\n### Returns\n\n- `{ enablementByObjectTypeId: object; }`\n\n - `enablementByObjectTypeId: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalObjectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getAll();\n\nconsole.log(portalObjectTypeEnablementPublicResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectLibrary.enablement.getAll', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalObjectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getAll();\n\nconsole.log(portalObjectTypeEnablementPublicResponse.enablementByObjectTypeId);", + }, + python: { + method: 'crm.object_library.enablement.get_all', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_object_type_enablement_public_response = client.crm.object_library.enablement.get_all()\nprint(portal_object_type_enablement_public_response.enablement_by_object_type_id)', + }, + java: { + method: 'crm().objectLibrary().enablement().getAll', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.EnablementGetAllParams;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.PortalObjectTypeEnablementPublicResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PortalObjectTypeEnablementPublicResponse portalObjectTypeEnablementPublicResponse = client.crm().objectLibrary().enablement().getAll();\n }\n}', + }, + go: { + method: 'client.Crm.ObjectLibrary.Enablement.GetAll', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalObjectTypeEnablementPublicResponse, err := client.Crm.ObjectLibrary.Enablement.GetAll(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalObjectTypeEnablementPublicResponse.EnablementByObjectTypeID)\n}\n', + }, + ruby: { + method: 'crm.object_library.enablement.get_all', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_object_type_enablement_public_response = hubspot.crm.object_library.enablement.get_all\n\nputs(portal_object_type_enablement_public_response)', + }, + php: { + method: 'crm->objectLibrary->enablement->getAll', + example: + "crm\n ->objectLibrary\n ->enablement\n ->getAll();\n\nvar_dump($portalObjectTypeEnablementPublicResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/object-library/2026-03/enablement \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_object_type_id', + endpoint: '/crm/object-library/2026-03/enablement/{objectTypeId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.object_library.enablement > (method) get_by_object_type_id', + qualified: 'client.crm.objectLibrary.enablement.getByObjectTypeID', + params: ['objectTypeId: string;'], + response: '{ enablement: boolean; }', + markdown: + "## get_by_object_type_id\n\n`client.crm.objectLibrary.enablement.getByObjectTypeID(objectTypeId: string): { enablement: boolean; }`\n\n**get** `/crm/object-library/2026-03/enablement/{objectTypeId}`\n\n### Parameters\n\n- `objectTypeId: string`\n\n### Returns\n\n- `{ enablement: boolean; }`\n\n - `enablement: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getByObjectTypeID('objectTypeId');\n\nconsole.log(objectTypeEnablementPublicResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectLibrary.enablement.getByObjectTypeID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeEnablementPublicResponse =\n await client.crm.objectLibrary.enablement.getByObjectTypeID('objectTypeId');\n\nconsole.log(objectTypeEnablementPublicResponse.enablement);", + }, + python: { + method: 'crm.object_library.enablement.get_by_object_type_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_enablement_public_response = client.crm.object_library.enablement.get_by_object_type_id(\n "objectTypeId",\n)\nprint(object_type_enablement_public_response.enablement)', + }, + java: { + method: 'crm().objectLibrary().enablement().getByObjectTypeId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.EnablementGetByObjectTypeIdParams;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.ObjectTypeEnablementPublicResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectTypeEnablementPublicResponse objectTypeEnablementPublicResponse = client.crm().objectLibrary().enablement().getByObjectTypeId("objectTypeId");\n }\n}', + }, + go: { + method: 'client.Crm.ObjectLibrary.Enablement.GetByObjectTypeID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeEnablementPublicResponse, err := client.Crm.ObjectLibrary.Enablement.GetByObjectTypeID(context.TODO(), "objectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeEnablementPublicResponse.Enablement)\n}\n', + }, + ruby: { + method: 'crm.object_library.enablement.get_by_object_type_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_enablement_public_response = hubspot.crm.object_library.enablement.get_by_object_type_id("objectTypeId")\n\nputs(object_type_enablement_public_response)', + }, + php: { + method: 'crm->objectLibrary->enablement->getByObjectTypeID', + example: + "crm\n ->objectLibrary\n ->enablement\n ->getByObjectTypeID('objectTypeId');\n\nvar_dump($objectTypeEnablementPublicResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/object-library/2026-03/enablement/$OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/crm-object-schemas/2026-03/schemas', + httpMethod: 'post', + summary: 'Create a new custom object schema.', + description: 'Create a new custom object schema by defining its properties and associations.', + stainlessPath: '(resource) crm.object_schemas > (method) create', + qualified: 'client.crm.objectSchemas.create', + params: [ + 'allowsSensitiveProperties: boolean;', + 'associatedObjects: string[];', + 'labels: { plural?: string; singular?: string; };', + 'name: string;', + "properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[];", + 'requiredProperties: string[];', + 'searchableProperties: string[];', + 'secondaryDisplayProperties: string[];', + 'description?: string;', + 'primaryDisplayProperty?: string;', + ], + response: + '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', + markdown: + "## create\n\n`client.crm.objectSchemas.create(allowsSensitiveProperties: boolean, associatedObjects: string[], labels: { plural?: string; singular?: string; }, name: string, properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[], requiredProperties: string[], searchableProperties: string[], secondaryDisplayProperties: string[], description?: string, primaryDisplayProperty?: string): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**post** `/crm-object-schemas/2026-03/schemas`\n\nCreate a new custom object schema by defining its properties and associations.\n\n### Parameters\n\n- `allowsSensitiveProperties: boolean`\n Determines if the object type can include properties that are marked as sensitive.\n\n- `associatedObjects: string[]`\n Associations defined for this object type.\n\n- `labels: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `name: string`\n A unique name for this object. For internal use only.\n\n- `properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[]`\n Properties defined for this object type.\n\n- `requiredProperties: string[]`\n The names of properties that should be **required** when creating an object of this type.\n\n- `searchableProperties: string[]`\n Names of properties that will be indexed for this object type in by HubSpot's product search.\n\n- `secondaryDisplayProperties: string[]`\n The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.\n\n- `description?: string`\n A brief explanation of the object type.\n\n- `primaryDisplayProperty?: string`\n The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.crm.objectSchemas.create({\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: {},\n name: 'name',\n properties: [{\n fieldType: 'fieldType',\n label: 'label',\n name: 'name',\n type: 'bool',\n}],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n});\n\nconsole.log(objectSchema);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.crm.objectSchemas.create({\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: {},\n name: 'name',\n properties: [\n {\n fieldType: 'fieldType',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n});\n\nconsole.log(objectSchema.id);", + }, + python: { + method: 'crm.object_schemas.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.crm.object_schemas.create(\n allows_sensitive_properties=True,\n associated_objects=["string"],\n labels={},\n name="name",\n properties=[{\n "field_type": "fieldType",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n required_properties=["string"],\n searchable_properties=["string"],\n secondary_display_properties=["string"],\n)\nprint(object_schema.id)', + }, + java: { + method: 'crm().objectSchemas().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionLabels;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchema;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaEgg;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectTypePropertyCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaEgg params = ObjectSchemaEgg.builder()\n .allowsSensitiveProperties(true)\n .addAssociatedObject("string")\n .labels(ObjectTypeDefinitionLabels.builder().build())\n .name("name")\n .addProperty(ObjectTypePropertyCreate.builder()\n .fieldType("fieldType")\n .label("label")\n .name("name")\n .type(ObjectTypePropertyCreate.Type.BOOL)\n .build())\n .addRequiredProperty("string")\n .addSearchableProperty("string")\n .addSecondaryDisplayProperty("string")\n .build();\n ObjectSchema objectSchema = client.crm().objectSchemas().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Crm.ObjectSchemas.New(context.TODO(), crm.ObjectSchemaNewParams{\n\t\tObjectSchemaEgg: crm.ObjectSchemaEggParam{\n\t\t\tAllowsSensitiveProperties: true,\n\t\t\tAssociatedObjects: []string{"string"},\n\t\t\tLabels: shared.ObjectTypeDefinitionLabelsParam{},\n\t\t\tName: "name",\n\t\t\tProperties: []crm.ObjectTypePropertyCreateParam{{\n\t\t\t\tFieldType: "fieldType",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: crm.ObjectTypePropertyCreateTypeBool,\n\t\t\t}},\n\t\t\tRequiredProperties: []string{"string"},\n\t\t\tSearchableProperties: []string{"string"},\n\t\t\tSecondaryDisplayProperties: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.crm.object_schemas.create(\n allows_sensitive_properties: true,\n associated_objects: ["string"],\n labels: {},\n name: "name",\n properties: [{fieldType: "fieldType", label: "label", name: "name", type: :bool}],\n required_properties: ["string"],\n searchable_properties: ["string"],\n secondary_display_properties: ["string"]\n)\n\nputs(object_schema)', + }, + php: { + method: 'crm->objectSchemas->create', + example: + "crm->objectSchemas->create(\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n name: 'name',\n properties: [\n [\n 'fieldType' => 'fieldType',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'formField' => true,\n 'groupName' => 'groupName',\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'optionSortStrategy' => 'ALPHABETICAL',\n 'referencedObjectType' => 'referencedObjectType',\n 'searchableInGlobalSearch' => true,\n 'showCurrencySymbol' => true,\n 'textDisplayHint' => 'domain_name',\n ],\n ],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n description: 'description',\n primaryDisplayProperty: 'primaryDisplayProperty',\n);\n\nvar_dump($objectSchema);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowsSensitiveProperties": true,\n "associatedObjects": [\n "string"\n ],\n "labels": {},\n "name": "name",\n "properties": [\n {\n "fieldType": "fieldType",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ],\n "requiredProperties": [\n "string"\n ],\n "searchableProperties": [\n "string"\n ],\n "secondaryDisplayProperties": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create_association', + endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}/associations', + httpMethod: 'post', + summary: 'Create an association for a specified object type.', + description: + 'Create a new association between the specified object type and another object type. This operation requires the definition of the association attributes, such as the primary and target object type IDs.', + stainlessPath: '(resource) crm.object_schemas > (method) create_association', + qualified: 'client.crm.objectSchemas.createAssociation', + params: ['objectType: string;', 'fromObjectTypeId: string;', 'toObjectTypeId: string;', 'name?: string;'], + response: + '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', + markdown: + "## create_association\n\n`client.crm.objectSchemas.createAssociation(objectType: string, fromObjectTypeId: string, toObjectTypeId: string, name?: string): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/crm-object-schemas/2026-03/schemas/{objectType}/associations`\n\nCreate a new association between the specified object type and another object type. This operation requires the definition of the association attributes, such as the primary and target object type IDs.\n\n### Parameters\n\n- `objectType: string`\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.crm.objectSchemas.createAssociation('objectType', { fromObjectTypeId: 'fromObjectTypeId', toObjectTypeId: 'toObjectTypeId' });\n\nconsole.log(associationDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.createAssociation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.crm.objectSchemas.createAssociation('objectType', {\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition.id);", + }, + python: { + method: 'crm.object_schemas.create_association', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.crm.object_schemas.create_association(\n object_type="objectType",\n from_object_type_id="fromObjectTypeId",\n to_object_type_id="toObjectTypeId",\n)\nprint(association_definition.id)', + }, + java: { + method: 'crm().objectSchemas().createAssociation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.AssociationDefinitionEgg;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaCreateAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaCreateAssociationParams params = ObjectSchemaCreateAssociationParams.builder()\n .objectType("objectType")\n .associationDefinitionEgg(AssociationDefinitionEgg.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build())\n .build();\n AssociationDefinition associationDefinition = client.crm().objectSchemas().createAssociation(params);\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.NewAssociation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Crm.ObjectSchemas.NewAssociation(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaNewAssociationParams{\n\t\t\tAssociationDefinitionEgg: shared.AssociationDefinitionEggParam{\n\t\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t\t\tToObjectTypeID: "toObjectTypeId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.create_association', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.crm.object_schemas.create_association(\n "objectType",\n from_object_type_id: "fromObjectTypeId",\n to_object_type_id: "toObjectTypeId"\n)\n\nputs(association_definition)', + }, + php: { + method: 'crm->objectSchemas->createAssociation', + example: + "crm->objectSchemas->createAssociation(\n 'objectType',\n fromObjectTypeID: 'fromObjectTypeId',\n toObjectTypeID: 'toObjectTypeId',\n name: 'name',\n);\n\nvar_dump($associationDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE/associations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromObjectTypeId": "fromObjectTypeId",\n "toObjectTypeId": "toObjectTypeId"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', + httpMethod: 'delete', + summary: 'Delete the schema of a specified custom object.', + description: + 'Remove a custom object schema from the account using its object type ID or fully qualified name.', + stainlessPath: '(resource) crm.object_schemas > (method) delete', + qualified: 'client.crm.objectSchemas.delete', + params: ['objectType: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.crm.objectSchemas.delete(objectType: string, archived?: boolean): void`\n\n**delete** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nRemove a custom object schema from the account using its object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objectSchemas.delete('objectType')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objectSchemas.delete('objectType');", + }, + python: { + method: 'crm.object_schemas.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.object_schemas.delete(\n object_type="objectType",\n)', + }, + java: { + method: 'crm().objectSchemas().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objectSchemas().delete("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.ObjectSchemas.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.object_schemas.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.object_schemas.delete("objectType")\n\nputs(result)', + }, + php: { + method: 'crm->objectSchemas->delete', + example: + "crm->objectSchemas->delete('objectType', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_association', + endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}', + httpMethod: 'delete', + summary: 'Delete an existing association for a specified object type.', + description: + 'Remove an association between two object types identified by the association identifier and object type. This operation is irreversible and will permanently delete the specified association.', + stainlessPath: '(resource) crm.object_schemas > (method) delete_association', + qualified: 'client.crm.objectSchemas.deleteAssociation', + params: ['objectType: string;', 'associationIdentifier: string;'], + markdown: + "## delete_association\n\n`client.crm.objectSchemas.deleteAssociation(objectType: string, associationIdentifier: string): void`\n\n**delete** `/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}`\n\nRemove an association between two object types identified by the association identifier and object type. This operation is irreversible and will permanently delete the specified association.\n\n### Parameters\n\n- `objectType: string`\n\n- `associationIdentifier: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objectSchemas.deleteAssociation('associationIdentifier', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.deleteAssociation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objectSchemas.deleteAssociation('associationIdentifier', {\n objectType: 'objectType',\n});", + }, + python: { + method: 'crm.object_schemas.delete_association', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.object_schemas.delete_association(\n association_identifier="associationIdentifier",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().objectSchemas().deleteAssociation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaDeleteAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaDeleteAssociationParams params = ObjectSchemaDeleteAssociationParams.builder()\n .objectType("objectType")\n .associationIdentifier("associationIdentifier")\n .build();\n client.crm().objectSchemas().deleteAssociation(params);\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.DeleteAssociation', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.ObjectSchemas.DeleteAssociation(\n\t\tcontext.TODO(),\n\t\t"associationIdentifier",\n\t\tcrm.ObjectSchemaDeleteAssociationParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.object_schemas.delete_association', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.object_schemas.delete_association("associationIdentifier", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->objectSchemas->deleteAssociation', + example: + "crm->objectSchemas->deleteAssociation(\n 'associationIdentifier', objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE/associations/$ASSOCIATION_IDENTIFIER \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', + httpMethod: 'get', + summary: 'Retrieve the schema of a specified custom object.', + description: + 'Retrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name.', + stainlessPath: '(resource) crm.object_schemas > (method) get', + qualified: 'client.crm.objectSchemas.get', + params: [ + 'objectType: string;', + 'includeAssociationDefinitions?: boolean;', + 'includeAuditMetadata?: boolean;', + 'includePropertyDefinitions?: boolean;', + ], + response: + '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', + markdown: + "## get\n\n`client.crm.objectSchemas.get(objectType: string, includeAssociationDefinitions?: boolean, includeAuditMetadata?: boolean, includePropertyDefinitions?: boolean): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**get** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nRetrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `includeAssociationDefinitions?: boolean`\n\n- `includeAuditMetadata?: boolean`\n\n- `includePropertyDefinitions?: boolean`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.crm.objectSchemas.get('objectType');\n\nconsole.log(objectSchema);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.crm.objectSchemas.get('objectType');\n\nconsole.log(objectSchema.id);", + }, + python: { + method: 'crm.object_schemas.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.crm.object_schemas.get(\n object_type="objectType",\n)\nprint(object_schema.id)', + }, + java: { + method: 'crm().objectSchemas().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchema;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchema objectSchema = client.crm().objectSchemas().get("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Crm.ObjectSchemas.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.crm.object_schemas.get("objectType")\n\nputs(object_schema)', + }, + php: { + method: 'crm->objectSchemas->get', + example: + "crm->objectSchemas->get(\n 'objectType',\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n);\n\nvar_dump($objectSchema);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm-object-schemas/2026-03/schemas', + httpMethod: 'get', + summary: 'Retrieve all custom object schemas.', + description: + 'Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.', + stainlessPath: '(resource) crm.object_schemas > (method) list', + qualified: 'client.crm.objectSchemas.list', + params: [ + 'archived?: boolean;', + 'includeAssociationDefinitions?: boolean;', + 'includeAuditMetadata?: boolean;', + 'includePropertyDefinitions?: boolean;', + ], + response: + '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', + markdown: + "## list\n\n`client.crm.objectSchemas.list(archived?: boolean, includeAssociationDefinitions?: boolean, includeAuditMetadata?: boolean, includePropertyDefinitions?: boolean): { results: object_schema[]; }`\n\n**get** `/crm-object-schemas/2026-03/schemas`\n\nRetrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.\n\n### Parameters\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeAssociationDefinitions?: boolean`\n\n- `includeAuditMetadata?: boolean`\n\n- `includePropertyDefinitions?: boolean`\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.list();\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.list();\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", + }, + python: { + method: 'crm.object_schemas.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.crm.object_schemas.list()\nprint(collection_response_object_schema_no_paging.results)', + }, + java: { + method: 'crm().objectSchemas().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.crm().objectSchemas().list();\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Crm.ObjectSchemas.List(context.TODO(), crm.ObjectSchemaListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.crm.object_schemas.list\n\nputs(collection_response_object_schema_no_paging)', + }, + php: { + method: 'crm->objectSchemas->list', + example: + "crm->objectSchemas->list(\n archived: true,\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', + httpMethod: 'patch', + summary: 'Update the schema of a specified custom object.', + description: + 'Update attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name.', + stainlessPath: '(resource) crm.object_schemas > (method) update', + qualified: 'client.crm.objectSchemas.update', + params: [ + 'objectType: string;', + 'clearDescription: boolean;', + 'allowsSensitiveProperties?: boolean;', + 'description?: string;', + 'labels?: { plural?: string; singular?: string; };', + 'primaryDisplayProperty?: string;', + 'requiredProperties?: string[];', + 'restorable?: boolean;', + 'searchableProperties?: string[];', + 'secondaryDisplayProperties?: string[];', + ], + response: + '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }', + markdown: + "## update\n\n`client.crm.objectSchemas.update(objectType: string, clearDescription: boolean, allowsSensitiveProperties?: boolean, description?: string, labels?: { plural?: string; singular?: string; }, primaryDisplayProperty?: string, requiredProperties?: string[], restorable?: boolean, searchableProperties?: string[], secondaryDisplayProperties?: string[]): { id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n**patch** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nUpdate attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `clearDescription: boolean`\n\n- `allowsSensitiveProperties?: boolean`\n\n- `description?: string`\n\n- `labels?: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `primaryDisplayProperty?: string`\n\n- `requiredProperties?: string[]`\n\n- `restorable?: boolean`\n\n- `searchableProperties?: string[]`\n\n- `secondaryDisplayProperties?: string[]`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `description?: string`\n - `portalId?: number`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeDefinition = await client.crm.objectSchemas.update('objectType', { clearDescription: true });\n\nconsole.log(objectTypeDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeDefinition = await client.crm.objectSchemas.update('objectType', {\n clearDescription: true,\n});\n\nconsole.log(objectTypeDefinition.id);", + }, + python: { + method: 'crm.object_schemas.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_definition = client.crm.object_schemas.update(\n object_type="objectType",\n clear_description=True,\n)\nprint(object_type_definition.id)', + }, + java: { + method: 'crm().objectSchemas().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinition;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionPatch;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaUpdateParams params = ObjectSchemaUpdateParams.builder()\n .objectType("objectType")\n .objectTypeDefinitionPatch(ObjectTypeDefinitionPatch.builder()\n .clearDescription(true)\n .build())\n .build();\n ObjectTypeDefinition objectTypeDefinition = client.crm().objectSchemas().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeDefinition, err := client.Crm.ObjectSchemas.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaUpdateParams{\n\t\t\tObjectTypeDefinitionPatch: shared.ObjectTypeDefinitionPatchParam{\n\t\t\t\tClearDescription: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeDefinition.ID)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_definition = hubspot.crm.object_schemas.update("objectType", clear_description: true)\n\nputs(object_type_definition)', + }, + php: { + method: 'crm->objectSchemas->update', + example: + "crm->objectSchemas->update(\n 'objectType',\n clearDescription: true,\n allowsSensitiveProperties: true,\n description: 'description',\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n primaryDisplayProperty: 'primaryDisplayProperty',\n requiredProperties: ['string'],\n restorable: true,\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n);\n\nvar_dump($objectTypeDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearDescription": true\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm-object-schemas/2026-03/schemas/batch/read', + httpMethod: 'post', + summary: 'Retrieve multiple custom object schemas in a batch request.', + description: + 'Retrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call.', + stainlessPath: '(resource) crm.object_schemas.batch > (method) get', + qualified: 'client.crm.objectSchemas.batch.get', + params: [ + 'includeAssociationDefinitions: boolean;', + 'includeAuditMetadata: boolean;', + 'includePropertyDefinitions: boolean;', + 'inputs: string[];', + ], + response: + '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', + markdown: + "## get\n\n`client.crm.objectSchemas.batch.get(includeAssociationDefinitions: boolean, includeAuditMetadata: boolean, includePropertyDefinitions: boolean, inputs: string[]): { results: object_schema[]; }`\n\n**post** `/crm-object-schemas/2026-03/schemas/batch/read`\n\nRetrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call.\n\n### Parameters\n\n- `includeAssociationDefinitions: boolean`\n Indicates whether to include association definitions in the response.\n\n- `includeAuditMetadata: boolean`\n Indicates whether to include audit metadata in the response.\n\n- `includePropertyDefinitions: boolean`\n Indicates whether to include property definitions in the response.\n\n- `inputs: string[]`\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.batch.get({\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n});\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objectSchemas.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.batch.get({\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n});\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", + }, + python: { + method: 'crm.object_schemas.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.crm.object_schemas.batch.get(\n include_association_definitions=True,\n include_audit_metadata=True,\n include_property_definitions=True,\n inputs=["string"],\n)\nprint(collection_response_object_schema_no_paging.results)', + }, + java: { + method: 'crm().objectSchemas().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaBatchReadRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaBatchReadRequest params = ObjectSchemaBatchReadRequest.builder()\n .includeAssociationDefinitions(true)\n .includeAuditMetadata(true)\n .includePropertyDefinitions(true)\n .addInput("string")\n .build();\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.crm().objectSchemas().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.ObjectSchemas.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Crm.ObjectSchemas.Batch.Get(context.TODO(), crm.ObjectSchemaBatchGetParams{\n\t\tObjectSchemaBatchReadRequest: crm.ObjectSchemaBatchReadRequestParam{\n\t\t\tIncludeAssociationDefinitions: true,\n\t\t\tIncludeAuditMetadata: true,\n\t\t\tIncludePropertyDefinitions: true,\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.object_schemas.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.crm.object_schemas.batch.get(\n include_association_definitions: true,\n include_audit_metadata: true,\n include_property_definitions: true,\n inputs: ["string"]\n)\n\nputs(collection_response_object_schema_no_paging)', + }, + php: { + method: 'crm->objectSchemas->batch->get', + example: + "crm\n ->objectSchemas\n ->batch\n ->get(\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "includeAssociationDefinitions": true,\n "includeAuditMetadata": true,\n "includePropertyDefinitions": true,\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/calls', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.', + stainlessPath: '(resource) crm.objects.calls > (method) create', + qualified: 'client.crm.objects.calls.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.calls.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/calls`\n\nCreate a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.calls.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.calls.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.calls.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.calls.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().calls().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().calls().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Calls.New(context.TODO(), crm.ObjectCallNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.calls.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->calls->create', + example: + "crm->objects->calls->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/calls/{callId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{callId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.calls > (method) delete', + qualified: 'client.crm.objects.calls.delete', + params: ['callId: string;'], + markdown: + "## delete\n\n`client.crm.objects.calls.delete(callId: string): void`\n\n**delete** `/crm/objects/2026-03/calls/{callId}`\n\nMove an Object identified by `{callId}` to the recycling bin.\n\n### Parameters\n\n- `callId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.calls.delete('callId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.calls.delete('callId');", + }, + python: { + method: 'crm.objects.calls.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.calls.delete(\n "callId",\n)', + }, + java: { + method: 'crm().objects().calls().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.calls.CallDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().calls().delete("callId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Calls.Delete(context.TODO(), "callId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.calls.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.calls.delete("callId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->calls->delete', + example: + "crm->objects->calls->delete('callId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/calls/{callId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.calls > (method) get', + qualified: 'client.crm.objects.calls.get', + params: [ + 'callId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.calls.get(callId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/calls/{callId}`\n\nRead an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `callId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.calls.get('callId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.calls.get('callId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.calls.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.calls.get(\n call_id="callId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().calls().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.calls.CallGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().calls().get("callId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Calls.Get(\n\t\tcontext.TODO(),\n\t\t"callId",\n\t\tcrm.ObjectCallGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.calls.get("callId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->calls->get', + example: + "crm->objects->calls->get(\n 'callId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/calls', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of calls. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.calls > (method) list', + qualified: 'client.crm.objects.calls.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.calls.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/calls`\n\nRead a page of calls. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.calls.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.calls.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.calls.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.calls.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().calls().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.calls.CallListPage;\nimport com.hubspot.sdk.models.crm.objects.calls.CallListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallListPage page = client.crm().objects().calls().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Calls.List(context.TODO(), crm.ObjectCallListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.calls.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->calls->list', + example: + "crm->objects->calls->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/calls/search', + httpMethod: 'post', + summary: 'Search for calls', + description: + 'Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.calls > (method) search', + qualified: 'client.crm.objects.calls.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.calls.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/calls/search`\n\nSearch for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.calls.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.calls.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.calls.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.calls.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().calls().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().calls().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Calls.Search(context.TODO(), crm.ObjectCallSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.calls.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->calls->search', + example: + "crm\n ->objects\n ->calls\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/calls/{callId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.calls > (method) update', + qualified: 'client.crm.objects.calls.update', + params: ['callId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.calls.update(callId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/calls/{callId}`\n\nPerform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `callId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.calls.update('callId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.calls.update('callId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.calls.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.calls.update(\n call_id="callId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().calls().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.calls.CallUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallUpdateParams params = CallUpdateParams.builder()\n .callId("callId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().calls().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Calls.Update(\n\t\tcontext.TODO(),\n\t\t"callId",\n\t\tcrm.ObjectCallUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.calls.update("callId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->calls->update', + example: + "crm->objects->calls->update(\n 'callId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/calls/batch/create', + httpMethod: 'post', + summary: 'Create a batch of calls', + description: + 'Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', + stainlessPath: '(resource) crm.objects.calls.batch > (method) create', + qualified: 'client.crm.objects.calls.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.calls.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/create`\n\nCreate a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.calls.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().calls().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.New(context.TODO(), crm.ObjectCallBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->calls->batch->create', + example: + "crm->objects->calls->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/calls/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of calls by ID', + description: + 'Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).', + stainlessPath: '(resource) crm.objects.calls.batch > (method) delete', + qualified: 'client.crm.objects.calls.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.calls.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/calls/batch/archive`\n\nArchive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.calls.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.calls.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.calls.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.calls.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().calls().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().calls().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Calls.Batch.Delete(context.TODO(), crm.ObjectCallBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.calls.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.calls.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->calls->batch->delete', + example: + "crm->objects->calls->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/calls/batch/read', + httpMethod: 'post', + summary: 'Read a batch of calls by internal ID, or unique property values', + description: 'Retrieve a batch of calls by ID.', + stainlessPath: '(resource) crm.objects.calls.batch > (method) get', + qualified: 'client.crm.objects.calls.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.calls.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/read`\n\nRetrieve a batch of calls by ID.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.calls.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().calls().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.Get(context.TODO(), crm.ObjectCallBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->calls->batch->get', + example: + "crm->objects->calls->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/calls/batch/update', + httpMethod: 'post', + summary: 'Update a batch of calls by internal ID, or unique property values', + description: 'Update a batch of calls by ID.', + stainlessPath: '(resource) crm.objects.calls.batch > (method) update', + qualified: 'client.crm.objects.calls.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.calls.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/update`\n\nUpdate a batch of calls by ID.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.calls.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().calls().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.Update(context.TODO(), crm.ObjectCallBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->calls->batch->update', + example: + "crm->objects->calls->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/calls/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of calls by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.calls.batch > (method) upsert', + qualified: 'client.crm.objects.calls.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.calls.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.calls.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.calls.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.calls.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.calls.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.calls.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().calls().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().calls().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Calls.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Calls.Batch.Upsert(context.TODO(), crm.ObjectCallBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.calls.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.calls.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->calls->batch->upsert', + example: + "crm\n ->objects\n ->calls\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/carts', + httpMethod: 'post', + summary: 'Create a cart', + description: + 'Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.', + stainlessPath: '(resource) crm.objects.carts > (method) create', + qualified: 'client.crm.objects.carts.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.carts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/carts`\n\nCreate a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.carts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.carts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.carts.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.carts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().carts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().carts().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Carts.New(context.TODO(), crm.ObjectCartNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.carts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->carts->create', + example: + "crm->objects->carts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/carts/{cartId}', + httpMethod: 'delete', + summary: 'Delete a cart', + description: 'Delete a cart by its ID, moving it to the recycling bin.', + stainlessPath: '(resource) crm.objects.carts > (method) delete', + qualified: 'client.crm.objects.carts.delete', + params: ['cartId: string;'], + markdown: + "## delete\n\n`client.crm.objects.carts.delete(cartId: string): void`\n\n**delete** `/crm/objects/2026-03/carts/{cartId}`\n\nDelete a cart by its ID, moving it to the recycling bin.\n\n### Parameters\n\n- `cartId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.carts.delete('cartId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.carts.delete('cartId');", + }, + python: { + method: 'crm.objects.carts.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.carts.delete(\n "cartId",\n)', + }, + java: { + method: 'crm().objects().carts().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.carts.CartDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().carts().delete("cartId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Carts.Delete(context.TODO(), "cartId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.carts.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.carts.delete("cartId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->carts->delete', + example: + "crm->objects->carts->delete('cartId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/carts/{cartId}', + httpMethod: 'get', + summary: 'Retrieve a cart', + description: + 'Retrieve a cart by its ID. You can control what is returned via the `properties` query parameter.', + stainlessPath: '(resource) crm.objects.carts > (method) get', + qualified: 'client.crm.objects.carts.get', + params: [ + 'cartId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.carts.get(cartId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/carts/{cartId}`\n\nRetrieve a cart by its ID. You can control what is returned via the `properties` query parameter.\n\n### Parameters\n\n- `cartId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.carts.get('cartId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.carts.get('cartId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.carts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.carts.get(\n cart_id="cartId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().carts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.carts.CartGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().carts().get("cartId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Carts.Get(\n\t\tcontext.TODO(),\n\t\t"cartId",\n\t\tcrm.ObjectCartGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.carts.get("cartId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->carts->get', + example: + "crm->objects->carts->get(\n 'cartId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/carts', + httpMethod: 'get', + summary: 'Retrieve carts', + description: 'Retrieve all carts. You can control what is returned via the `properties` query parameter.', + stainlessPath: '(resource) crm.objects.carts > (method) list', + qualified: 'client.crm.objects.carts.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.carts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/carts`\n\nRetrieve all carts. You can control what is returned via the `properties` query parameter.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.carts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.carts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.carts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.carts.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().carts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.carts.CartListPage;\nimport com.hubspot.sdk.models.crm.objects.carts.CartListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CartListPage page = client.crm().objects().carts().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Carts.List(context.TODO(), crm.ObjectCartListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.carts.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->carts->list', + example: + "crm->objects->carts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/carts/search', + httpMethod: 'post', + summary: 'Search for carts', + description: + 'Search for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results.', + stainlessPath: '(resource) crm.objects.carts > (method) search', + qualified: 'client.crm.objects.carts.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.carts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/carts/search`\n\nSearch for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.carts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.carts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.carts.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.carts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().carts().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().carts().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Carts.Search(context.TODO(), crm.ObjectCartSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.carts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->carts->search', + example: + "crm\n ->objects\n ->carts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/carts/{cartId}', + httpMethod: 'patch', + summary: 'Update a cart', + description: + 'Perform a partial update of a cart, specified by its ID. Alternatively, you can specify a cart by a unique property value using the `idProperty` query parameter. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.carts > (method) update', + qualified: 'client.crm.objects.carts.update', + params: ['cartId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.carts.update(cartId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/carts/{cartId}`\n\nPerform a partial update of a cart, specified by its ID. Alternatively, you can specify a cart by a unique property value using the `idProperty` query parameter. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `cartId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.carts.update('cartId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.carts.update('cartId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.carts.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.carts.update(\n cart_id="cartId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().carts().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.carts.CartUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CartUpdateParams params = CartUpdateParams.builder()\n .cartId("cartId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().carts().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Carts.Update(\n\t\tcontext.TODO(),\n\t\t"cartId",\n\t\tcrm.ObjectCartUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.carts.update("cartId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->carts->update', + example: + "crm->objects->carts->update(\n 'cartId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/carts/batch/create', + httpMethod: 'post', + summary: 'Create a batch of carts', + description: 'Create a batch of carts with specified properties and associations.', + stainlessPath: '(resource) crm.objects.carts.batch > (method) create', + qualified: 'client.crm.objects.carts.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.carts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/create`\n\nCreate a batch of carts with specified properties and associations.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.carts.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().carts().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.New(context.TODO(), crm.ObjectCartBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->carts->batch->create', + example: + "crm->objects->carts->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/carts/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of carts', + description: 'Archive a batch of carts identified by their IDs.', + stainlessPath: '(resource) crm.objects.carts.batch > (method) delete', + qualified: 'client.crm.objects.carts.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.carts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/carts/batch/archive`\n\nArchive a batch of carts identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.carts.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.carts.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.carts.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.carts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().carts().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().carts().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Carts.Batch.Delete(context.TODO(), crm.ObjectCartBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.carts.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.carts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->carts->batch->delete', + example: + "crm->objects->carts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/carts/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of carts', + description: + 'Retrieve carts by ID, or include the `idProperty` parameter to retrieve carts by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.carts.batch > (method) get', + qualified: 'client.crm.objects.carts.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.carts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/read`\n\nRetrieve carts by ID, or include the `idProperty` parameter to retrieve carts by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.carts.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().carts().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.Get(context.TODO(), crm.ObjectCartBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->carts->batch->get', + example: + "crm->objects->carts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/carts/batch/update', + httpMethod: 'post', + summary: 'Update a batch of carts', + description: 'Update a batch of carts using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.carts.batch > (method) update', + qualified: 'client.crm.objects.carts.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.carts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/update`\n\nUpdate a batch of carts using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.carts.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().carts().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.Update(context.TODO(), crm.ObjectCartBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->carts->batch->update', + example: + "crm->objects->carts->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/carts/batch/upsert', + httpMethod: 'post', + summary: 'Upsert a batch of carts', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query parameter.', + stainlessPath: '(resource) crm.objects.carts.batch > (method) upsert', + qualified: 'client.crm.objects.carts.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.carts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query parameter.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.carts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.carts.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.carts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.carts.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.carts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().carts().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().carts().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Carts.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Carts.Batch.Upsert(context.TODO(), crm.ObjectCartBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.carts.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.carts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->carts->batch->upsert', + example: + "crm\n ->objects\n ->carts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/commerce_payments', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) create', + qualified: 'client.crm.objects.commercePayments.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.commercePayments.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments`\n\nCreate a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.commercePayments.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.commercePayments.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.commerce_payments.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.commerce_payments.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().commercePayments().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().commercePayments().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.CommercePayments.New(context.TODO(), crm.ObjectCommercePaymentNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.commerce_payments.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->create', + example: + "crm->objects->commercePayments->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{commercePaymentId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) delete', + qualified: 'client.crm.objects.commercePayments.delete', + params: ['commercePaymentId: string;'], + markdown: + "## delete\n\n`client.crm.objects.commercePayments.delete(commercePaymentId: string): void`\n\n**delete** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nMove an Object identified by `{commercePaymentId}` to the recycling bin.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.commercePayments.delete('commercePaymentId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.commercePayments.delete('commercePaymentId');", + }, + python: { + method: 'crm.objects.commerce_payments.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.commerce_payments.delete(\n "commercePaymentId",\n)', + }, + java: { + method: 'crm().objects().commercePayments().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().commercePayments().delete("commercePaymentId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.CommercePayments.Delete(context.TODO(), "commercePaymentId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.commerce_payments.delete("commercePaymentId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->commercePayments->delete', + example: + "crm->objects->commercePayments->delete('commercePaymentId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) get', + qualified: 'client.crm.objects.commercePayments.get', + params: [ + 'commercePaymentId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.commercePayments.get(commercePaymentId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nRead an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.commercePayments.get('commercePaymentId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.commercePayments.get(\n 'commercePaymentId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.commerce_payments.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.commerce_payments.get(\n commerce_payment_id="commercePaymentId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().commercePayments().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().commercePayments().get("commercePaymentId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.CommercePayments.Get(\n\t\tcontext.TODO(),\n\t\t"commercePaymentId",\n\t\tcrm.ObjectCommercePaymentGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.commerce_payments.get("commercePaymentId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->commercePayments->get', + example: + "crm\n ->objects\n ->commercePayments\n ->get(\n 'commercePaymentId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/commerce_payments', + httpMethod: 'get', + summary: 'List', + description: + 'Read a page of commerce payments. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) list', + qualified: 'client.crm.objects.commercePayments.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.commercePayments.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/commerce_payments`\n\nRead a page of commerce payments. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.commercePayments.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.commercePayments.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.commerce_payments.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.commerce_payments.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().commercePayments().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentListPage;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommercePaymentListPage page = client.crm().objects().commercePayments().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.CommercePayments.List(context.TODO(), crm.ObjectCommercePaymentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.commerce_payments.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->commercePayments->list', + example: + "crm->objects->commercePayments->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/commerce_payments/search', + httpMethod: 'post', + summary: 'Search for commerce payments using specified criteria.', + description: + 'Execute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) search', + qualified: 'client.crm.objects.commercePayments.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.commercePayments.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/search`\n\nExecute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.commercePayments.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.commercePayments.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.commerce_payments.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.commerce_payments.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().commercePayments().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().commercePayments().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.CommercePayments.Search(context.TODO(), crm.ObjectCommercePaymentSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.commerce_payments.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->search', + example: + "crm\n ->objects\n ->commercePayments\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.commerce_payments > (method) update', + qualified: 'client.crm.objects.commercePayments.update', + params: ['commercePaymentId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.commercePayments.update(commercePaymentId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nPerform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.commercePayments.update('commercePaymentId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.commercePayments.update('commercePaymentId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.commerce_payments.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.commerce_payments.update(\n commerce_payment_id="commercePaymentId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().commercePayments().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommercePaymentUpdateParams params = CommercePaymentUpdateParams.builder()\n .commercePaymentId("commercePaymentId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().commercePayments().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.CommercePayments.Update(\n\t\tcontext.TODO(),\n\t\t"commercePaymentId",\n\t\tcrm.ObjectCommercePaymentUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.commerce_payments.update("commercePaymentId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->update', + example: + "crm->objects->commercePayments->update(\n 'commercePaymentId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/commerce_payments/batch/create', + httpMethod: 'post', + summary: 'Create a batch of commerce payments', + description: + 'Create multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs.', + stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) create', + qualified: 'client.crm.objects.commercePayments.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.commercePayments.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/create`\n\nCreate multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.commerce_payments.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().commercePayments().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.New(context.TODO(), crm.ObjectCommercePaymentBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->batch->create', + example: + "crm\n ->objects\n ->commercePayments\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/commerce_payments/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of commerce payments by ID', + description: + 'Archive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system.', + stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) delete', + qualified: 'client.crm.objects.commercePayments.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.commercePayments.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/archive`\n\nArchive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.commercePayments.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.commercePayments.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.commerce_payments.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.commerce_payments.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().commercePayments().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().commercePayments().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.CommercePayments.Batch.Delete(context.TODO(), crm.ObjectCommercePaymentBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.commerce_payments.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->commercePayments->batch->delete', + example: + "crm->objects->commercePayments->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/commerce_payments/batch/read', + httpMethod: 'post', + summary: 'Read a batch of commerce payments by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) get', + qualified: 'client.crm.objects.commercePayments.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.commercePayments.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.commerce_payments.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().commercePayments().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.Get(context.TODO(), crm.ObjectCommercePaymentBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->batch->get', + example: + "crm\n ->objects\n ->commercePayments\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/commerce_payments/batch/update', + httpMethod: 'post', + summary: 'Update a batch of commerce payments by internal ID, or unique property values', + description: + 'Update multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values.', + stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) update', + qualified: 'client.crm.objects.commercePayments.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.commercePayments.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/update`\n\nUpdate multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.commerce_payments.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().commercePayments().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.Update(context.TODO(), crm.ObjectCommercePaymentBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->commercePayments->batch->update', + example: + "crm\n ->objects\n ->commercePayments\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/commerce_payments/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of commerce payments by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) upsert', + qualified: 'client.crm.objects.commercePayments.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.commercePayments.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.commercePayments.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.commercePayments.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject =\n await client.crm.objects.commercePayments.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n });\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.commerce_payments.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.commerce_payments.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().commercePayments().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().commercePayments().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.CommercePayments.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.CommercePayments.Batch.Upsert(context.TODO(), crm.ObjectCommercePaymentBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.commerce_payments.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.commerce_payments.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->commercePayments->batch->upsert', + example: + "crm\n ->objects\n ->commercePayments\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/communications', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.', + stainlessPath: '(resource) crm.objects.communications > (method) create', + qualified: 'client.crm.objects.communications.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.communications.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/communications`\n\nCreate a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.communications.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.communications.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.communications.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.communications.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().communications().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().communications().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Communications.New(context.TODO(), crm.ObjectCommunicationNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.communications.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->communications->create', + example: + "crm->objects->communications->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/communications/{communicationId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{communicationId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.communications > (method) delete', + qualified: 'client.crm.objects.communications.delete', + params: ['communicationId: string;'], + markdown: + "## delete\n\n`client.crm.objects.communications.delete(communicationId: string): void`\n\n**delete** `/crm/objects/2026-03/communications/{communicationId}`\n\nMove an Object identified by `{communicationId}` to the recycling bin.\n\n### Parameters\n\n- `communicationId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.communications.delete('communicationId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.communications.delete('communicationId');", + }, + python: { + method: 'crm.objects.communications.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.communications.delete(\n "communicationId",\n)', + }, + java: { + method: 'crm().objects().communications().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().communications().delete("communicationId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Communications.Delete(context.TODO(), "communicationId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.communications.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.communications.delete("communicationId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->communications->delete', + example: + "crm->objects->communications->delete('communicationId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/communications/{communicationId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.communications > (method) get', + qualified: 'client.crm.objects.communications.get', + params: [ + 'communicationId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.communications.get(communicationId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/communications/{communicationId}`\n\nRead an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `communicationId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.communications.get('communicationId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.communications.get(\n 'communicationId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.communications.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.communications.get(\n communication_id="communicationId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().communications().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().communications().get("communicationId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Communications.Get(\n\t\tcontext.TODO(),\n\t\t"communicationId",\n\t\tcrm.ObjectCommunicationGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.communications.get("communicationId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->communications->get', + example: + "crm\n ->objects\n ->communications\n ->get(\n 'communicationId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/communications', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of communications. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.communications > (method) list', + qualified: 'client.crm.objects.communications.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.communications.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/communications`\n\nRead a page of communications. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.communications.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.communications.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.communications.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.communications.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().communications().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationListPage;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationListPage page = client.crm().objects().communications().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Communications.List(context.TODO(), crm.ObjectCommunicationListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.communications.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->communications->list', + example: + "crm->objects->communications->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/communications/search', + httpMethod: 'post', + summary: 'Search for messages', + description: + 'Search for messages by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.communications > (method) search', + qualified: 'client.crm.objects.communications.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.communications.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/communications/search`\n\nSearch for messages by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.communications.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.communications.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.communications.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.communications.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().communications().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().communications().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Communications.Search(context.TODO(), crm.ObjectCommunicationSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.communications.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->communications->search', + example: + "crm\n ->objects\n ->communications\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/communications/{communicationId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.communications > (method) update', + qualified: 'client.crm.objects.communications.update', + params: ['communicationId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.communications.update(communicationId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/communications/{communicationId}`\n\nPerform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `communicationId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.communications.update('communicationId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.communications.update('communicationId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.communications.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.communications.update(\n communication_id="communicationId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().communications().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationUpdateParams params = CommunicationUpdateParams.builder()\n .communicationId("communicationId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().communications().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Communications.Update(\n\t\tcontext.TODO(),\n\t\t"communicationId",\n\t\tcrm.ObjectCommunicationUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.communications.update("communicationId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->communications->update', + example: + "crm->objects->communications->update(\n 'communicationId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/communications/batch/create', + httpMethod: 'post', + summary: 'Create a batch of communications', + description: + 'Create a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', + stainlessPath: '(resource) crm.objects.communications.batch > (method) create', + qualified: 'client.crm.objects.communications.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.communications.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/create`\n\nCreate a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.communications.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().communications().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.New(context.TODO(), crm.ObjectCommunicationBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->communications->batch->create', + example: + "crm\n ->objects\n ->communications\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/communications/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of communications by ID', + description: + 'Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).', + stainlessPath: '(resource) crm.objects.communications.batch > (method) delete', + qualified: 'client.crm.objects.communications.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.communications.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/communications/batch/archive`\n\nDelete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.communications.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.communications.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.communications.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.communications.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().communications().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().communications().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Communications.Batch.Delete(context.TODO(), crm.ObjectCommunicationBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.communications.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.communications.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->communications->batch->delete', + example: + "crm->objects->communications->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/communications/batch/read', + httpMethod: 'post', + summary: 'Read a batch of communications by internal ID, or unique property values', + description: + 'Retrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). ', + stainlessPath: '(resource) crm.objects.communications.batch > (method) get', + qualified: 'client.crm.objects.communications.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.communications.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/read`\n\nRetrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.communications.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().communications().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.Get(context.TODO(), crm.ObjectCommunicationBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->communications->batch->get', + example: + "crm\n ->objects\n ->communications\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/communications/batch/update', + httpMethod: 'post', + summary: 'Update a batch of communications by internal ID, or unique property values', + description: + 'Update a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.communications.batch > (method) update', + qualified: 'client.crm.objects.communications.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.communications.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/update`\n\nUpdate a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.communications.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().communications().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.Update(context.TODO(), crm.ObjectCommunicationBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->communications->batch->update', + example: + "crm\n ->objects\n ->communications\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/communications/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of communications by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.communications.batch > (method) upsert', + qualified: 'client.crm.objects.communications.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.communications.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.communications.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.communications.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.communications.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.communications.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.communications.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().communications().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().communications().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Communications.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Communications.Batch.Upsert(context.TODO(), crm.ObjectCommunicationBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.communications.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.communications.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->communications->batch->upsert', + example: + "crm\n ->objects\n ->communications\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/companies', + httpMethod: 'post', + summary: 'Create a company', + description: + 'Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', + stainlessPath: '(resource) crm.objects.companies > (method) create', + qualified: 'client.crm.objects.companies.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.companies.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/companies`\n\nCreate a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.companies.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().companies().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.New(context.TODO(), crm.ObjectCompanyNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->companies->create', + example: + "crm->objects->companies->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/companies/{companyId}', + httpMethod: 'delete', + summary: 'Archive a company', + description: + 'Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', + stainlessPath: '(resource) crm.objects.companies > (method) delete', + qualified: 'client.crm.objects.companies.delete', + params: ['companyId: string;'], + markdown: + "## delete\n\n`client.crm.objects.companies.delete(companyId: string): void`\n\n**delete** `/crm/objects/2026-03/companies/{companyId}`\n\nDelete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `companyId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.companies.delete('companyId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.companies.delete('companyId');", + }, + python: { + method: 'crm.objects.companies.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.companies.delete(\n "companyId",\n)', + }, + java: { + method: 'crm().objects().companies().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().companies().delete("companyId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Companies.Delete(context.TODO(), "companyId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.companies.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.companies.delete("companyId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->companies->delete', + example: + "crm->objects->companies->delete('companyId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/companies/{companyId}', + httpMethod: 'get', + summary: 'Retrieve a company', + description: + 'Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.', + stainlessPath: '(resource) crm.objects.companies > (method) get', + qualified: 'client.crm.objects.companies.get', + params: [ + 'companyId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.companies.get(companyId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/companies/{companyId}`\n\nRetrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `companyId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.companies.get('companyId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.companies.get('companyId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.companies.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.companies.get(\n company_id="companyId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().companies().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().companies().get("companyId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Companies.Get(\n\t\tcontext.TODO(),\n\t\t"companyId",\n\t\tcrm.ObjectCompanyGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.companies.get("companyId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->companies->get', + example: + "crm->objects->companies->get(\n 'companyId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/companies', + httpMethod: 'get', + summary: 'Retrieve companies', + description: + 'Retrieve all companies, using query parameters to control the information that gets returned.', + stainlessPath: '(resource) crm.objects.companies > (method) list', + qualified: 'client.crm.objects.companies.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.companies.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/companies`\n\nRetrieve all companies, using query parameters to control the information that gets returned.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.companies.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.companies.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.companies.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.companies.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().companies().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyListPage;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyListPage page = client.crm().objects().companies().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Companies.List(context.TODO(), crm.ObjectCompanyListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.companies.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->companies->list', + example: + "crm->objects->companies->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/companies/merge', + httpMethod: 'post', + summary: 'Merge two companies', + description: + 'Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).', + stainlessPath: '(resource) crm.objects.companies > (method) merge', + qualified: 'client.crm.objects.companies.merge', + params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.companies.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/companies/merge`\n\nMerge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.companies.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().companies().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.Merge(context.TODO(), crm.ObjectCompanyMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->companies->merge', + example: + "crm->objects->companies->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/companies/search', + httpMethod: 'post', + summary: 'Search for companies', + description: + 'Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.companies > (method) search', + qualified: 'client.crm.objects.companies.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.companies.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/companies/search`\n\nSearch for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.companies.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.companies.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.companies.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.companies.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().companies().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().companies().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Companies.Search(context.TODO(), crm.ObjectCompanySearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.companies.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->companies->search', + example: + "crm\n ->objects\n ->companies\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/companies/{companyId}', + httpMethod: 'patch', + summary: 'Update a company', + description: + 'Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.companies > (method) update', + qualified: 'client.crm.objects.companies.update', + params: ['companyId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.companies.update(companyId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/companies/{companyId}`\n\nUpdate a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `companyId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.update('companyId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.update('companyId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.companies.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.update(\n company_id="companyId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().companies().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyUpdateParams params = CompanyUpdateParams.builder()\n .companyId("companyId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.Update(\n\t\tcontext.TODO(),\n\t\t"companyId",\n\t\tcrm.ObjectCompanyUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.update("companyId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->companies->update', + example: + "crm->objects->companies->update(\n 'companyId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/companies/batch/create', + httpMethod: 'post', + summary: 'Create a batch of companies', + description: + 'Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', + stainlessPath: '(resource) crm.objects.companies.batch > (method) create', + qualified: 'client.crm.objects.companies.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.companies.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/create`\n\nCreate a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.companies.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().companies().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.New(context.TODO(), crm.ObjectCompanyBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->companies->batch->create', + example: + "crm\n ->objects\n ->companies\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/companies/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of companies', + description: + 'Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', + stainlessPath: '(resource) crm.objects.companies.batch > (method) delete', + qualified: 'client.crm.objects.companies.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.companies.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/companies/batch/archive`\n\nDelete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.companies.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.companies.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.companies.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.companies.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().companies().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().companies().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Companies.Batch.Delete(context.TODO(), crm.ObjectCompanyBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.companies.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.companies.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->companies->batch->delete', + example: + "crm->objects->companies->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/companies/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of companies', + description: + 'Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.', + stainlessPath: '(resource) crm.objects.companies.batch > (method) get', + qualified: 'client.crm.objects.companies.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.companies.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/read`\n\nRetrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.companies.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().companies().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.Get(context.TODO(), crm.ObjectCompanyBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->companies->batch->get', + example: + "crm->objects->companies->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/companies/batch/update', + httpMethod: 'post', + summary: 'Update a batch of companies', + description: 'Update a batch of companies by ID.', + stainlessPath: '(resource) crm.objects.companies.batch > (method) update', + qualified: 'client.crm.objects.companies.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.companies.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/update`\n\nUpdate a batch of companies by ID.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.companies.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().companies().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.Update(context.TODO(), crm.ObjectCompanyBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->companies->batch->update', + example: + "crm\n ->objects\n ->companies\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/companies/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of companies by unique property values', + description: + 'Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.companies.batch > (method) upsert', + qualified: 'client.crm.objects.companies.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.companies.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/upsert`\n\nCreate or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.companies.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.companies.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.companies.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.companies.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.companies.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().companies().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().companies().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Companies.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Companies.Batch.Upsert(context.TODO(), crm.ObjectCompanyBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.companies.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.companies.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->companies->batch->upsert', + example: + "crm\n ->objects\n ->companies\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/contacts', + httpMethod: 'post', + summary: 'Create a contact', + description: 'Create a contact', + stainlessPath: '(resource) crm.objects.contacts > (method) create', + qualified: 'client.crm.objects.contacts.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.contacts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/contacts`\n\nCreate a contact\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.contacts.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().contacts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.New(context.TODO(), crm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->create', + example: + "crm->objects->contacts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/contacts/{contactId}', + httpMethod: 'delete', + summary: '', + description: + 'Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).', + stainlessPath: '(resource) crm.objects.contacts > (method) delete', + qualified: 'client.crm.objects.contacts.delete', + params: ['contactId: string;'], + markdown: + "## delete\n\n`client.crm.objects.contacts.delete(contactId: string): void`\n\n**delete** `/crm/objects/2026-03/contacts/{contactId}`\n\nDelete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `contactId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.delete('contactId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.delete('contactId');", + }, + python: { + method: 'crm.objects.contacts.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.delete(\n "contactId",\n)', + }, + java: { + method: 'crm().objects().contacts().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().contacts().delete("contactId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.Delete(context.TODO(), "contactId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.delete("contactId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->contacts->delete', + example: + "crm->objects->contacts->delete('contactId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'gdpr_delete', + endpoint: '/crm/objects/2026-03/contacts/gdpr-delete', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts > (method) gdpr_delete', + qualified: 'client.crm.objects.contacts.gdprDelete', + params: ['objectId: string;', 'idProperty?: string;'], + markdown: + "## gdpr_delete\n\n`client.crm.objects.contacts.gdprDelete(objectId: string, idProperty?: string): void`\n\n**post** `/crm/objects/2026-03/contacts/gdpr-delete`\n\n### Parameters\n\n- `objectId: string`\n The ID of the contact to permanently delete.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object. An alternative to identifying a contact by ID.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.gdprDelete({ objectId: 'objectId' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.gdprDelete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.gdprDelete({ objectId: 'objectId' });", + }, + python: { + method: 'crm.objects.contacts.gdpr_delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.gdpr_delete(\n object_id="objectId",\n)', + }, + java: { + method: 'crm().objects().contacts().gdprDelete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.PublicGdprDeleteInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicGdprDeleteInput params = PublicGdprDeleteInput.builder()\n .objectId("objectId")\n .build();\n client.crm().objects().contacts().gdprDelete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.GdprDelete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.GdprDelete(context.TODO(), crm.ObjectContactGdprDeleteParams{\n\t\tPublicGdprDeleteInput: crm.PublicGdprDeleteInputParam{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.gdpr_delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.gdpr_delete(object_id_: "objectId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->contacts->gdprDelete', + example: + "crm->objects->contacts->gdprDelete(\n objectID: 'objectId', idProperty: 'idProperty'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/gdpr-delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectId": "objectId"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/contacts/{contactId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts > (method) get', + qualified: 'client.crm.objects.contacts.get', + params: [ + 'contactId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.contacts.get(contactId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contacts/{contactId}`\n\n### Parameters\n\n- `contactId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.contacts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.contacts.get(\n contact_id="contactId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().contacts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().contacts().get("contactId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Contacts.Get(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contacts.get("contactId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->contacts->get', + example: + "crm->objects->contacts->get(\n 'contactId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/contacts', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts > (method) list', + qualified: 'client.crm.objects.contacts.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.contacts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contacts`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.contacts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.contacts.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().contacts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContactListPage page = client.crm().objects().contacts().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Contacts.List(context.TODO(), crm.ObjectContactListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.contacts.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->contacts->list', + example: + "crm->objects->contacts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/contacts/merge', + httpMethod: 'post', + summary: 'Merge two contacts', + description: 'Merge two contacts', + stainlessPath: '(resource) crm.objects.contacts > (method) merge', + qualified: 'client.crm.objects.contacts.merge', + params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.contacts.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/merge`\n\nMerge two contacts\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.contacts.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().contacts().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.Merge(context.TODO(), crm.ObjectContactMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->merge', + example: + "crm->objects->contacts->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/contacts/search', + httpMethod: 'post', + summary: 'Search for contacts', + description: + 'Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.contacts > (method) search', + qualified: 'client.crm.objects.contacts.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.contacts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/contacts/search`\n\nSearch for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.contacts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.contacts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.contacts.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.contacts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().contacts().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().contacts().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Contacts.Search(context.TODO(), crm.ObjectContactSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.contacts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->search', + example: + "crm\n ->objects\n ->contacts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/contacts/{contactId}', + httpMethod: 'patch', + summary: '', + description: + 'Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.contacts > (method) update', + qualified: 'client.crm.objects.contacts.update', + params: ['contactId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.contacts.update(contactId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/contacts/{contactId}`\n\nUpdate an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `contactId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.update('contactId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.update('contactId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.contacts.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.update(\n contact_id="contactId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().contacts().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContactUpdateParams params = ContactUpdateParams.builder()\n .contactId("contactId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.Update(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.update("contactId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->update', + example: + "crm->objects->contacts->update(\n 'contactId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/contacts/batch/create', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts.batch > (method) create', + qualified: 'client.crm.objects.contacts.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.contacts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/create`\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.contacts.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().contacts().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.New(context.TODO(), crm.ObjectContactBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->batch->create', + example: + "crm\n ->objects\n ->contacts\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/contacts/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of contacts', + description: 'Archive a batch of contacts', + stainlessPath: '(resource) crm.objects.contacts.batch > (method) delete', + qualified: 'client.crm.objects.contacts.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.contacts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/contacts/batch/archive`\n\nArchive a batch of contacts\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.contacts.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().contacts().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().contacts().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.Batch.Delete(context.TODO(), crm.ObjectContactBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->contacts->batch->delete', + example: + "crm->objects->contacts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/contacts/batch/read', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts.batch > (method) get', + qualified: 'client.crm.objects.contacts.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.contacts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/read`\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.contacts.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().contacts().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.Get(context.TODO(), crm.ObjectContactBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->batch->get', + example: + "crm->objects->contacts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/contacts/batch/update', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts.batch > (method) update', + qualified: 'client.crm.objects.contacts.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.contacts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/update`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.contacts.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().contacts().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.Update(context.TODO(), crm.ObjectContactBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->contacts->batch->update', + example: + "crm\n ->objects\n ->contacts\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/contacts/batch/upsert', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.contacts.batch > (method) upsert', + qualified: 'client.crm.objects.contacts.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.contacts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/upsert`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.contacts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contacts.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.contacts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.contacts.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.contacts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().contacts().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().contacts().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contacts.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Contacts.Batch.Upsert(context.TODO(), crm.ObjectContactBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.contacts.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.contacts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->contacts->batch->upsert', + example: + "crm\n ->objects\n ->contacts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/contracts/{contractId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{contractId}`. `{contractId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.contracts > (method) get', + qualified: 'client.crm.objects.contracts.get', + params: [ + 'contractId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.contracts.get(contractId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contracts/{contractId}`\n\nRead an Object identified by `{contractId}`. `{contractId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `contractId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contracts.get('contractId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contracts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contracts.get('contractId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.contracts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.contracts.get(\n contract_id="contractId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().contracts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().contracts().get("contractId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contracts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Contracts.Get(\n\t\tcontext.TODO(),\n\t\t"contractId",\n\t\tcrm.ObjectContractGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.contracts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contracts.get("contractId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->contracts->get', + example: + "crm->objects->contracts->get(\n 'contractId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contracts/$CONTRACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/contracts', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of contracts. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.contracts > (method) list', + qualified: 'client.crm.objects.contracts.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.contracts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contracts`\n\nRead a page of contracts. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contracts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contracts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contracts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.contracts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.contracts.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().contracts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractListPage;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContractListPage page = client.crm().objects().contracts().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contracts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Contracts.List(context.TODO(), crm.ObjectContractListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.contracts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.contracts.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->contracts->list', + example: + "crm->objects->contracts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contracts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/contracts/batch/read', + httpMethod: 'post', + summary: 'Read a batch of contracts by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.contracts.batch > (method) get', + qualified: 'client.crm.objects.contracts.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.contracts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contracts/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contracts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.contracts.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contracts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.contracts.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contracts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().contracts().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contracts().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Contracts.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contracts.Batch.Get(context.TODO(), crm.ObjectContractBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.contracts.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contracts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->contracts->batch->get', + example: + "crm->objects->contracts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/contracts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-410', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided.', + stainlessPath: '(resource) crm.objects.courses > (method) create', + qualified: 'client.crm.objects.courses.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.courses.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-410`\n\nCreate a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.courses.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.courses.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.courses.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.courses.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().courses().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().courses().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Courses.New(context.TODO(), crm.ObjectCourseNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.courses.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->courses->create', + example: + "crm->objects->courses->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-410/{courseId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{courseId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.courses > (method) delete', + qualified: 'client.crm.objects.courses.delete', + params: ['courseId: string;'], + markdown: + "## delete\n\n`client.crm.objects.courses.delete(courseId: string): void`\n\n**delete** `/crm/objects/2026-03/0-410/{courseId}`\n\nMove an Object identified by `{courseId}` to the recycling bin.\n\n### Parameters\n\n- `courseId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.courses.delete('courseId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.courses.delete('courseId');", + }, + python: { + method: 'crm.objects.courses.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.courses.delete(\n "courseId",\n)', + }, + java: { + method: 'crm().objects().courses().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().courses().delete("courseId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Courses.Delete(context.TODO(), "courseId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.courses.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.courses.delete("courseId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->courses->delete', + example: + "crm->objects->courses->delete('courseId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-410/{courseId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.courses > (method) get', + qualified: 'client.crm.objects.courses.get', + params: [ + 'courseId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.courses.get(courseId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-410/{courseId}`\n\nRead an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `courseId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.courses.get('courseId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.courses.get('courseId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.courses.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.courses.get(\n course_id="courseId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().courses().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().courses().get("courseId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Courses.Get(\n\t\tcontext.TODO(),\n\t\t"courseId",\n\t\tcrm.ObjectCourseGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.courses.get("courseId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->courses->get', + example: + "crm->objects->courses->get(\n 'courseId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/0-410', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of courses. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.courses > (method) list', + qualified: 'client.crm.objects.courses.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.courses.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-410`\n\nRead a page of courses. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.courses.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.courses.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.courses.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.courses.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().courses().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseListPage;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CourseListPage page = client.crm().objects().courses().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Courses.List(context.TODO(), crm.ObjectCourseListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.courses.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->courses->list', + example: + "crm->objects->courses->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/0-410/search', + httpMethod: 'post', + summary: 'Search for objects', + description: 'Fetch objects using a search query', + stainlessPath: '(resource) crm.objects.courses > (method) search', + qualified: 'client.crm.objects.courses.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.courses.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-410/search`\n\nFetch objects using a search query\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.courses.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.courses.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.courses.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.courses.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().courses().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().courses().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Courses.Search(context.TODO(), crm.ObjectCourseSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.courses.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->courses->search', + example: + "crm\n ->objects\n ->courses\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-410/{courseId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.courses > (method) update', + qualified: 'client.crm.objects.courses.update', + params: ['courseId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.courses.update(courseId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-410/{courseId}`\n\nPerform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `courseId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.courses.update('courseId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.courses.update('courseId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.courses.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.courses.update(\n course_id="courseId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().courses().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CourseUpdateParams params = CourseUpdateParams.builder()\n .courseId("courseId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().courses().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Courses.Update(\n\t\tcontext.TODO(),\n\t\t"courseId",\n\t\tcrm.ObjectCourseUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.courses.update("courseId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->courses->update', + example: + "crm->objects->courses->update(\n 'courseId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-410/batch/create', + httpMethod: 'post', + summary: 'Create a batch of courses', + description: 'Create a batch of objects', + stainlessPath: '(resource) crm.objects.courses.batch > (method) create', + qualified: 'client.crm.objects.courses.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.courses.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.courses.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().courses().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.New(context.TODO(), crm.ObjectCourseBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->courses->batch->create', + example: + "crm\n ->objects\n ->courses\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-410/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of courses by ID', + description: 'Archive a batch of objects', + stainlessPath: '(resource) crm.objects.courses.batch > (method) delete', + qualified: 'client.crm.objects.courses.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.courses.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-410/batch/archive`\n\nArchive a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.courses.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.courses.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.courses.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.courses.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().courses().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().courses().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Courses.Batch.Delete(context.TODO(), crm.ObjectCourseBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.courses.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.courses.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->courses->batch->delete', + example: + "crm->objects->courses->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-410/batch/read', + httpMethod: 'post', + summary: 'Read a batch of courses by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.courses.batch > (method) get', + qualified: 'client.crm.objects.courses.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.courses.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.courses.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().courses().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.Get(context.TODO(), crm.ObjectCourseBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->courses->batch->get', + example: + "crm->objects->courses->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-410/batch/update', + httpMethod: 'post', + summary: 'Update a batch of courses by internal ID, or unique property values', + description: 'Update a batch of objects', + stainlessPath: '(resource) crm.objects.courses.batch > (method) update', + qualified: 'client.crm.objects.courses.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.courses.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/update`\n\nUpdate a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.courses.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().courses().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.Update(context.TODO(), crm.ObjectCourseBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->courses->batch->update', + example: + "crm\n ->objects\n ->courses\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/0-410/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of courses by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.courses.batch > (method) upsert', + qualified: 'client.crm.objects.courses.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.courses.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.courses.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.courses.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.courses.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.courses.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.courses.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().courses().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().courses().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Courses.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Courses.Batch.Upsert(context.TODO(), crm.ObjectCourseBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.courses.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.courses.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->courses->batch->upsert', + example: + "crm\n ->objects\n ->courses\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/{objectType}', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.', + stainlessPath: '(resource) crm.objects.custom > (method) create', + qualified: 'client.crm.objects.custom.create', + params: [ + 'objectType: string;', + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.custom.create(objectType: string, associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}`\n\nCreate a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.\n\n### Parameters\n\n- `objectType: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.create('objectType', {\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.create('objectType', {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.custom.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.create(\n object_type="objectType",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().custom().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomCreateParams params = CustomCreateParams.builder()\n .objectType("objectType")\n .simplePublicObjectInputForCreate(SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomNewParams{\n\t\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.create(\n "objectType",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->custom->create', + example: + "crm->objects->custom->create(\n 'objectType',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{objectId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.custom > (method) delete', + qualified: 'client.crm.objects.custom.delete', + params: ['objectType: string;', 'objectId: string;'], + markdown: + "## delete\n\n`client.crm.objects.custom.delete(objectType: string, objectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nMove an Object identified by `{objectId}` to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.custom.delete('objectId', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.custom.delete('objectId', { objectType: 'objectType' });", + }, + python: { + method: 'crm.objects.custom.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.custom.delete(\n object_id="objectId",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().objects().custom().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomDeleteParams params = CustomDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n client.crm().objects().custom().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Custom.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.custom.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.custom.delete("objectId", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->objects->custom->delete', + example: + "crm->objects->custom->delete(\n 'objectId', objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.custom > (method) get', + qualified: 'client.crm.objects.custom.get', + params: [ + 'objectType: string;', + 'objectId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.custom.get(objectType: string, objectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nRead an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.custom.get('objectId', { objectType: 'objectType' });\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.custom.get('objectId', {\n objectType: 'objectType',\n});\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.custom.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.custom.get(\n object_id="objectId",\n object_type="objectType",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().custom().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomGetParams params = CustomGetParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().custom().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Custom.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.custom.get("objectId", object_type: "objectType")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->custom->get', + example: + "crm->objects->custom->get(\n 'objectId',\n objectType: 'objectType',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/{objectType}', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of objects. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.custom > (method) list', + qualified: 'client.crm.objects.custom.list', + params: [ + 'objectType: string;', + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.custom.list(objectType: string, after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}`\n\nRead a page of objects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.custom.list('objectType')) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.custom.list(\n 'objectType',\n)) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.custom.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.custom.list(\n object_type="objectType",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().custom().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomListPage;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomListPage page = client.crm().objects().custom().list("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Custom.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.custom.list("objectType")\n\nputs(page)', + }, + php: { + method: 'crm->objects->custom->list', + example: + "crm->objects->custom->list(\n 'objectType',\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/{objectType}/merge', + httpMethod: 'post', + summary: 'Merge two objects with same type', + description: + 'Merge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it.', + stainlessPath: '(resource) crm.objects.custom > (method) merge', + qualified: 'client.crm.objects.custom.merge', + params: ['objectType: string;', 'objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.custom.merge(objectType: string, objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/merge`\n\nMerge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.merge('objectType', { objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.merge('objectType', {\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.custom.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.merge(\n object_type="objectType",\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().custom().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomMergeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomMergeParams params = CustomMergeParams.builder()\n .objectType("objectType")\n .publicMergeInput(PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.Merge(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomMergeParams{\n\t\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.merge(\n "objectType",\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->custom->merge', + example: + "crm->objects->custom->merge(\n 'objectType',\n objectIDToMerge: 'objectIdToMerge',\n primaryObjectID: 'primaryObjectId',\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/{objectType}/search', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.custom > (method) search', + qualified: 'client.crm.objects.custom.search', + params: [ + 'objectType: string;', + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.custom.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.custom.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.custom.search(\n 'objectType',\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.custom.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.custom.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().custom().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomSearchParams params = CustomSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().custom().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Custom.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.custom.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->custom->search', + example: + "crm\n ->objects\n ->custom\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.custom > (method) update', + qualified: 'client.crm.objects.custom.update', + params: ['objectType: string;', 'objectId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.custom.update(objectType: string, objectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nPerform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.custom.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.update(\n object_id="objectId",\n object_type="objectType",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().custom().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomUpdateParams params = CustomUpdateParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.update("objectId", object_type: "objectType", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->custom->update', + example: + "crm->objects->custom->update(\n 'objectId',\n objectType: 'objectType',\n properties: ['foo' => 'string'],\n idProperty: 'idProperty',\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/{objectType}/batch/create', + httpMethod: 'post', + summary: 'Create a batch of objects', + description: 'Create a batch of objects', + stainlessPath: '(resource) crm.objects.custom.batch > (method) create', + qualified: 'client.crm.objects.custom.batch.create', + params: [ + 'objectType: string;', + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.custom.batch.create(objectType: string, inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.create('objectType', { inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.create('objectType', {\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.custom.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.create(\n object_type="objectType",\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().custom().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputForCreate(BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchNewParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.create(\n "objectType",\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->custom->batch->create', + example: + "crm->objects->custom->batch->create(\n 'objectType',\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/{objectType}/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of objects by ID', + description: 'Archive a batch of objects by ID', + stainlessPath: '(resource) crm.objects.custom.batch > (method) delete', + qualified: 'client.crm.objects.custom.batch.delete', + params: ['objectType: string;', 'inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.custom.batch.delete(objectType: string, inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/archive`\n\nArchive a batch of objects by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.custom.batch.delete('objectType', { inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.custom.batch.delete('objectType', { inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.custom.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.custom.batch.delete(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().custom().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectId(BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build())\n .build();\n client.crm().objects().custom().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Custom.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchDeleteParams{\n\t\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.custom.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.custom.batch.delete("objectType", inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->custom->batch->delete', + example: + "crm->objects->custom->batch->delete(\n 'objectType', inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/{objectType}/batch/read', + httpMethod: 'post', + summary: 'Read a batch of objects by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.custom.batch > (method) get', + qualified: 'client.crm.objects.custom.batch.get', + params: [ + 'objectType: string;', + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.custom.batch.get(objectType: string, inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.custom.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.get(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().custom().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputSimplePublicObjectId(BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchGetParams{\n\t\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.get(\n "objectType",\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->custom->batch->get', + example: + "crm->objects->custom->batch->get(\n 'objectType',\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/{objectType}/batch/update', + httpMethod: 'post', + summary: 'Update a batch of objects by internal ID, or unique property values', + description: 'Update a batch of objects by internal ID, or unique property values', + stainlessPath: '(resource) crm.objects.custom.batch > (method) update', + qualified: 'client.crm.objects.custom.batch.update', + params: [ + 'objectType: string;', + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.custom.batch.update(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/update`\n\nUpdate a batch of objects by internal ID, or unique property values\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.update('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.update('objectType', {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.custom.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.update(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().custom().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpdateParams params = BatchUpdateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInput(BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchUpdateParams{\n\t\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.update("objectType", inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->custom->batch->update', + example: + "crm->objects->custom->batch->update(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/{objectType}/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of objects by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.custom.batch > (method) upsert', + qualified: 'client.crm.objects.custom.batch.upsert', + params: [ + 'objectType: string;', + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.custom.batch.upsert(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.custom.batch.upsert('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.custom.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.custom.batch.upsert(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.custom.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.custom.batch.upsert(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().custom().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputUpsert(BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().custom().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Custom.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Custom.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchUpsertParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.custom.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.custom.batch.upsert("objectType", inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->custom->batch->upsert', + example: + "crm\n ->objects\n ->custom\n ->batch\n ->upsert(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-3', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.', + stainlessPath: '(resource) crm.objects.deals > (method) create', + qualified: 'client.crm.objects.deals.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.deals.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-3`\n\nCreate a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.deals.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().deals().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.New(context.TODO(), crm.ObjectDealNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->deals->create', + example: + "crm->objects->deals->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-3/{dealId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{dealId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.deals > (method) delete', + qualified: 'client.crm.objects.deals.delete', + params: ['dealId: string;'], + markdown: + "## delete\n\n`client.crm.objects.deals.delete(dealId: string): void`\n\n**delete** `/crm/objects/2026-03/0-3/{dealId}`\n\nMove an Object identified by `{dealId}` to the recycling bin.\n\n### Parameters\n\n- `dealId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.deals.delete('dealId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.deals.delete('dealId');", + }, + python: { + method: 'crm.objects.deals.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.deals.delete(\n "dealId",\n)', + }, + java: { + method: 'crm().objects().deals().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.deals.DealDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().deals().delete("dealId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Deals.Delete(context.TODO(), "dealId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.deals.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.deals.delete("dealId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->deals->delete', + example: + "crm->objects->deals->delete('dealId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-3/{dealId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.deals > (method) get', + qualified: 'client.crm.objects.deals.get', + params: [ + 'dealId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.deals.get(dealId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-3/{dealId}`\n\nRead an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `dealId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.deals.get('dealId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.deals.get('dealId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.deals.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.deals.get(\n deal_id="dealId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().deals().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.deals.DealGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().deals().get("dealId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Deals.Get(\n\t\tcontext.TODO(),\n\t\t"dealId",\n\t\tcrm.ObjectDealGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.deals.get("dealId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->deals->get', + example: + "crm->objects->deals->get(\n 'dealId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/0-3', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of deals. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.deals > (method) list', + qualified: 'client.crm.objects.deals.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.deals.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-3`\n\nRead a page of deals. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.deals.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.deals.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.deals.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.deals.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().deals().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.deals.DealListPage;\nimport com.hubspot.sdk.models.crm.objects.deals.DealListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DealListPage page = client.crm().objects().deals().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Deals.List(context.TODO(), crm.ObjectDealListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.deals.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->deals->list', + example: + "crm->objects->deals->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/0-3/merge', + httpMethod: 'post', + summary: 'Merge two deals with same type', + description: 'Combine two deals of the same type into a single deal.', + stainlessPath: '(resource) crm.objects.deals > (method) merge', + qualified: 'client.crm.objects.deals.merge', + params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.deals.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/merge`\n\nCombine two deals of the same type into a single deal.\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.deals.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().deals().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.Merge(context.TODO(), crm.ObjectDealMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->deals->merge', + example: + "crm->objects->deals->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/0-3/search', + httpMethod: 'post', + summary: 'Search for deals using various filters and criteria to retrieve specific records.', + description: 'Search for deals using specified criteria and filters.', + stainlessPath: '(resource) crm.objects.deals > (method) search', + qualified: 'client.crm.objects.deals.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.deals.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-3/search`\n\nSearch for deals using specified criteria and filters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.deals.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.deals.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.deals.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.deals.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().deals().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().deals().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Deals.Search(context.TODO(), crm.ObjectDealSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.deals.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->deals->search', + example: + "crm\n ->objects\n ->deals\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-3/{dealId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.deals > (method) update', + qualified: 'client.crm.objects.deals.update', + params: ['dealId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.deals.update(dealId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-3/{dealId}`\n\nPerform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `dealId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.update('dealId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.update('dealId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.deals.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.update(\n deal_id="dealId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().deals().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.deals.DealUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DealUpdateParams params = DealUpdateParams.builder()\n .dealId("dealId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.Update(\n\t\tcontext.TODO(),\n\t\t"dealId",\n\t\tcrm.ObjectDealUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.update("dealId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->deals->update', + example: + "crm->objects->deals->update(\n 'dealId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-3/batch/create', + httpMethod: 'post', + summary: 'Create a batch of deals', + description: 'Create multiple deals in a single request.', + stainlessPath: '(resource) crm.objects.deals.batch > (method) create', + qualified: 'client.crm.objects.deals.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.deals.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/create`\n\nCreate multiple deals in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.deals.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().deals().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.New(context.TODO(), crm.ObjectDealBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->deals->batch->create', + example: + "crm->objects->deals->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-3/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of deals by ID', + description: 'Archive multiple deals using their IDs.', + stainlessPath: '(resource) crm.objects.deals.batch > (method) delete', + qualified: 'client.crm.objects.deals.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.deals.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-3/batch/archive`\n\nArchive multiple deals using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.deals.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.deals.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.deals.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.deals.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().deals().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().deals().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Deals.Batch.Delete(context.TODO(), crm.ObjectDealBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.deals.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.deals.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->deals->batch->delete', + example: + "crm->objects->deals->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-3/batch/read', + httpMethod: 'post', + summary: 'Read a batch of deals by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.deals.batch > (method) get', + qualified: 'client.crm.objects.deals.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.deals.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.deals.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().deals().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.Get(context.TODO(), crm.ObjectDealBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->deals->batch->get', + example: + "crm->objects->deals->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-3/batch/update', + httpMethod: 'post', + summary: 'Update a batch of deals by internal ID, or unique property values', + description: 'Update multiple deals using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.deals.batch > (method) update', + qualified: 'client.crm.objects.deals.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.deals.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/update`\n\nUpdate multiple deals using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.deals.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().deals().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.Update(context.TODO(), crm.ObjectDealBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->deals->batch->update', + example: + "crm->objects->deals->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/0-3/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of deals by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.deals.batch > (method) upsert', + qualified: 'client.crm.objects.deals.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.deals.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.deals.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.deals.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.deals.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.deals.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.deals.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().deals().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().deals().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Deals.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Deals.Batch.Upsert(context.TODO(), crm.ObjectDealBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.deals.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.deals.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->deals->batch->upsert', + example: + "crm\n ->objects\n ->deals\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/discounts', + httpMethod: 'post', + summary: '', + description: + 'Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.', + stainlessPath: '(resource) crm.objects.discounts > (method) create', + qualified: 'client.crm.objects.discounts.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.discounts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/discounts`\n\nCreate a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.discounts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.discounts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.discounts.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.discounts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().discounts().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().discounts().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Discounts.New(context.TODO(), crm.ObjectDiscountNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.discounts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->create', + example: + "crm->objects->discounts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/discounts/{discountId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Archive', + stainlessPath: '(resource) crm.objects.discounts > (method) delete', + qualified: 'client.crm.objects.discounts.delete', + params: ['discountId: string;'], + markdown: + "## delete\n\n`client.crm.objects.discounts.delete(discountId: string): void`\n\n**delete** `/crm/objects/2026-03/discounts/{discountId}`\n\nArchive\n\n### Parameters\n\n- `discountId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.discounts.delete('discountId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.discounts.delete('discountId');", + }, + python: { + method: 'crm.objects.discounts.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.discounts.delete(\n "discountId",\n)', + }, + java: { + method: 'crm().objects().discounts().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().discounts().delete("discountId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Discounts.Delete(context.TODO(), "discountId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.discounts.delete("discountId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->discounts->delete', + example: + "crm->objects->discounts->delete('discountId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/discounts/{discountId}', + httpMethod: 'get', + summary: '', + description: + 'Read an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.discounts > (method) get', + qualified: 'client.crm.objects.discounts.get', + params: [ + 'discountId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.discounts.get(discountId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/discounts/{discountId}`\n\nRead an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `discountId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.discounts.get('discountId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.discounts.get('discountId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.discounts.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.discounts.get(\n discount_id="discountId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().discounts().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().discounts().get("discountId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Discounts.Get(\n\t\tcontext.TODO(),\n\t\t"discountId",\n\t\tcrm.ObjectDiscountGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.discounts.get("discountId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->discounts->get', + example: + "crm->objects->discounts->get(\n 'discountId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/discounts', + httpMethod: 'get', + summary: 'List', + description: 'List', + stainlessPath: '(resource) crm.objects.discounts > (method) list', + qualified: 'client.crm.objects.discounts.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.discounts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/discounts`\n\nList\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.discounts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.discounts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.discounts.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.discounts.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().discounts().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountListPage;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DiscountListPage page = client.crm().objects().discounts().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Discounts.List(context.TODO(), crm.ObjectDiscountListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.discounts.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->discounts->list', + example: + "crm->objects->discounts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/discounts/search', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.discounts > (method) search', + qualified: 'client.crm.objects.discounts.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.discounts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/discounts/search`\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.discounts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.discounts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.discounts.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.discounts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().discounts().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().discounts().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Discounts.Search(context.TODO(), crm.ObjectDiscountSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.discounts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->search', + example: + "crm\n ->objects\n ->discounts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/discounts/{discountId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.discounts > (method) update', + qualified: 'client.crm.objects.discounts.update', + params: ['discountId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.discounts.update(discountId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/discounts/{discountId}`\n\nPerform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `discountId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.discounts.update('discountId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.discounts.update('discountId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.discounts.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.discounts.update(\n discount_id="discountId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().discounts().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DiscountUpdateParams params = DiscountUpdateParams.builder()\n .discountId("discountId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().discounts().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Discounts.Update(\n\t\tcontext.TODO(),\n\t\t"discountId",\n\t\tcrm.ObjectDiscountUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.discounts.update("discountId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->update', + example: + "crm->objects->discounts->update(\n 'discountId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/discounts/batch/create', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.discounts.batch > (method) create', + qualified: 'client.crm.objects.discounts.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.discounts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/create`\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.discounts.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().discounts().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.New(context.TODO(), crm.ObjectDiscountBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->batch->create', + example: + "crm\n ->objects\n ->discounts\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/discounts/batch/archive', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.discounts.batch > (method) delete', + qualified: 'client.crm.objects.discounts.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.discounts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/discounts/batch/archive`\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.discounts.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.discounts.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.discounts.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.discounts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().discounts().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().discounts().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Discounts.Batch.Delete(context.TODO(), crm.ObjectDiscountBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.discounts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->discounts->batch->delete', + example: + "crm->objects->discounts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/discounts/batch/read', + httpMethod: 'post', + summary: '', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.discounts.batch > (method) get', + qualified: 'client.crm.objects.discounts.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.discounts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.discounts.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().discounts().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.Get(context.TODO(), crm.ObjectDiscountBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->batch->get', + example: + "crm->objects->discounts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/discounts/batch/update', + httpMethod: 'post', + summary: 'Update a batch of discounts by internal ID, or unique property values', + description: 'Update a batch of discounts by internal ID, or unique property values', + stainlessPath: '(resource) crm.objects.discounts.batch > (method) update', + qualified: 'client.crm.objects.discounts.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.discounts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/update`\n\nUpdate a batch of discounts by internal ID, or unique property values\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.discounts.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().discounts().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.Update(context.TODO(), crm.ObjectDiscountBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->discounts->batch->update', + example: + "crm\n ->objects\n ->discounts\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/discounts/batch/upsert', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.discounts.batch > (method) upsert', + qualified: 'client.crm.objects.discounts.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.discounts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/upsert`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.discounts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.discounts.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.discounts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.discounts.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.discounts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().discounts().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().discounts().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Discounts.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Discounts.Batch.Upsert(context.TODO(), crm.ObjectDiscountBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.discounts.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.discounts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->discounts->batch->upsert', + example: + "crm\n ->objects\n ->discounts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/emails', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.', + stainlessPath: '(resource) crm.objects.emails > (method) create', + qualified: 'client.crm.objects.emails.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.emails.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/emails`\n\nCreate a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.emails.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.emails.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.emails.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.emails.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().emails().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().emails().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Emails.New(context.TODO(), crm.ObjectEmailNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.emails.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->emails->create', + example: + "crm->objects->emails->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/emails/{emailId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{emailId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.emails > (method) delete', + qualified: 'client.crm.objects.emails.delete', + params: ['emailId: string;'], + markdown: + "## delete\n\n`client.crm.objects.emails.delete(emailId: string): void`\n\n**delete** `/crm/objects/2026-03/emails/{emailId}`\n\nMove an Object identified by `{emailId}` to the recycling bin.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.emails.delete('emailId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.emails.delete('emailId');", + }, + python: { + method: 'crm.objects.emails.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.emails.delete(\n "emailId",\n)', + }, + java: { + method: 'crm().objects().emails().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().emails().delete("emailId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Emails.Delete(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.emails.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.emails.delete("emailId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->emails->delete', + example: + "crm->objects->emails->delete('emailId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/emails/{emailId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.emails > (method) get', + qualified: 'client.crm.objects.emails.get', + params: [ + 'emailId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.emails.get(emailId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/emails/{emailId}`\n\nRead an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.emails.get('emailId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.emails.get('emailId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.emails.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.emails.get(\n email_id="emailId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().emails().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().emails().get("emailId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Emails.Get(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tcrm.ObjectEmailGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.emails.get("emailId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->emails->get', + example: + "crm->objects->emails->get(\n 'emailId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/emails', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of emails. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.emails > (method) list', + qualified: 'client.crm.objects.emails.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.emails.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/emails`\n\nRead a page of emails. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.emails.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.emails.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.emails.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.emails.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().emails().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailListPage;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListPage page = client.crm().objects().emails().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Emails.List(context.TODO(), crm.ObjectEmailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.emails.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->emails->list', + example: + "crm->objects->emails->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/emails/search', + httpMethod: 'post', + summary: 'Search for emails using specified criteria and filters.', + description: + 'Perform a search for emails based on the provided query parameters and return matching results.', + stainlessPath: '(resource) crm.objects.emails > (method) search', + qualified: 'client.crm.objects.emails.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.emails.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/emails/search`\n\nPerform a search for emails based on the provided query parameters and return matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.emails.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.emails.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.emails.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.emails.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().emails().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().emails().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Emails.Search(context.TODO(), crm.ObjectEmailSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.emails.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->emails->search', + example: + "crm\n ->objects\n ->emails\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/emails/{emailId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.emails > (method) update', + qualified: 'client.crm.objects.emails.update', + params: ['emailId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.emails.update(emailId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/emails/{emailId}`\n\nPerform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `emailId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.emails.update('emailId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.emails.update('emailId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.emails.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.emails.update(\n email_id="emailId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().emails().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateParams params = EmailUpdateParams.builder()\n .emailId("emailId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().emails().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Emails.Update(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tcrm.ObjectEmailUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.emails.update("emailId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->emails->update', + example: + "crm->objects->emails->update(\n 'emailId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/emails/batch/create', + httpMethod: 'post', + summary: 'Create a batch of emails', + description: 'Create a batch of emails with specified properties and return the created objects.', + stainlessPath: '(resource) crm.objects.emails.batch > (method) create', + qualified: 'client.crm.objects.emails.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.emails.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/create`\n\nCreate a batch of emails with specified properties and return the created objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.emails.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().emails().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.New(context.TODO(), crm.ObjectEmailBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->emails->batch->create', + example: + "crm->objects->emails->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/emails/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of emails by ID', + description: 'Archive a batch of emails identified by their IDs.', + stainlessPath: '(resource) crm.objects.emails.batch > (method) delete', + qualified: 'client.crm.objects.emails.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.emails.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/emails/batch/archive`\n\nArchive a batch of emails identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.emails.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.emails.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.emails.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.emails.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().emails().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().emails().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Emails.Batch.Delete(context.TODO(), crm.ObjectEmailBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.emails.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.emails.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->emails->batch->delete', + example: + "crm->objects->emails->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/emails/batch/read', + httpMethod: 'post', + summary: 'Read a batch of emails by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.emails.batch > (method) get', + qualified: 'client.crm.objects.emails.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.emails.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.emails.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().emails().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.Get(context.TODO(), crm.ObjectEmailBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->emails->batch->get', + example: + "crm->objects->emails->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/emails/batch/update', + httpMethod: 'post', + summary: 'Update a batch of emails by internal ID, or unique property values', + description: 'Update a batch of emails using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.emails.batch > (method) update', + qualified: 'client.crm.objects.emails.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.emails.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/update`\n\nUpdate a batch of emails using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.emails.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().emails().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.Update(context.TODO(), crm.ObjectEmailBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->emails->batch->update', + example: + "crm->objects->emails->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/emails/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of emails by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.emails.batch > (method) upsert', + qualified: 'client.crm.objects.emails.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.emails.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.emails.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.emails.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.emails.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.emails.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.emails.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().emails().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().emails().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Emails.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Emails.Batch.Upsert(context.TODO(), crm.ObjectEmailBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.emails.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.emails.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->emails->batch->upsert', + example: + "crm\n ->objects\n ->emails\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.feedback_submissions > (method) get', + qualified: 'client.crm.objects.feedbackSubmissions.get', + params: [ + 'feedbackSubmissionId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.feedbackSubmissions.get(feedbackSubmissionId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}`\n\nRead an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `feedbackSubmissionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.feedbackSubmissions.get('feedbackSubmissionId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.feedbackSubmissions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.feedbackSubmissions.get(\n 'feedbackSubmissionId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.feedback_submissions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.feedback_submissions.get(\n feedback_submission_id="feedbackSubmissionId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().feedbackSubmissions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().feedbackSubmissions().get("feedbackSubmissionId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.FeedbackSubmissions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.FeedbackSubmissions.Get(\n\t\tcontext.TODO(),\n\t\t"feedbackSubmissionId",\n\t\tcrm.ObjectFeedbackSubmissionGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.feedback_submissions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.feedback_submissions.get("feedbackSubmissionId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->feedbackSubmissions->get', + example: + "crm\n ->objects\n ->feedbackSubmissions\n ->get(\n 'feedbackSubmissionId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/$FEEDBACK_SUBMISSION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/feedback_submissions', + httpMethod: 'get', + summary: 'List', + description: + 'Read a page of feedback submissions. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.feedback_submissions > (method) list', + qualified: 'client.crm.objects.feedbackSubmissions.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.feedbackSubmissions.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/feedback_submissions`\n\nRead a page of feedback submissions. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.feedbackSubmissions.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.feedbackSubmissions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.feedbackSubmissions.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.feedback_submissions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.feedback_submissions.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().feedbackSubmissions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionListPage;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeedbackSubmissionListPage page = client.crm().objects().feedbackSubmissions().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.FeedbackSubmissions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.FeedbackSubmissions.List(context.TODO(), crm.ObjectFeedbackSubmissionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.feedback_submissions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.feedback_submissions.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->feedbackSubmissions->list', + example: + "crm->objects->feedbackSubmissions->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/feedback_submissions/search', + httpMethod: 'post', + summary: 'Search for feedback submissions using specified criteria.', + description: + 'Execute a search to retrieve feedback submissions based on defined filters, properties, and sorting options.', + stainlessPath: '(resource) crm.objects.feedback_submissions > (method) search', + qualified: 'client.crm.objects.feedbackSubmissions.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.feedbackSubmissions.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/feedback_submissions/search`\n\nExecute a search to retrieve feedback submissions based on defined filters, properties, and sorting options.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.feedbackSubmissions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.feedbackSubmissions.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.feedbackSubmissions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.feedback_submissions.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.feedback_submissions.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().feedbackSubmissions().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().feedbackSubmissions().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.FeedbackSubmissions.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.FeedbackSubmissions.Search(context.TODO(), crm.ObjectFeedbackSubmissionSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.feedback_submissions.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.feedback_submissions.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->feedbackSubmissions->search', + example: + "crm\n ->objects\n ->feedbackSubmissions\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/feedback_submissions/batch/read', + httpMethod: 'post', + summary: 'Read a batch of feedback submissions by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.feedback_submissions.batch > (method) get', + qualified: 'client.crm.objects.feedbackSubmissions.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.feedbackSubmissions.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/feedback_submissions/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.feedbackSubmissions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.feedbackSubmissions.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.feedbackSubmissions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.feedback_submissions.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.feedback_submissions.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().feedbackSubmissions().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().feedbackSubmissions().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.FeedbackSubmissions.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.FeedbackSubmissions.Batch.Get(context.TODO(), crm.ObjectFeedbackSubmissionBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.feedback_submissions.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.feedback_submissions.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->feedbackSubmissions->batch->get', + example: + "crm\n ->objects\n ->feedbackSubmissions\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/fees', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.', + stainlessPath: '(resource) crm.objects.fees > (method) create', + qualified: 'client.crm.objects.fees.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.fees.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/fees`\n\nCreate a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.fees.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.fees.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.fees.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.fees.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().fees().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().fees().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Fees.New(context.TODO(), crm.ObjectFeeNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.fees.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->fees->create', + example: + "crm->objects->fees->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/fees/{feeId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{feeId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.fees > (method) delete', + qualified: 'client.crm.objects.fees.delete', + params: ['feeId: string;'], + markdown: + "## delete\n\n`client.crm.objects.fees.delete(feeId: string): void`\n\n**delete** `/crm/objects/2026-03/fees/{feeId}`\n\nMove an Object identified by `{feeId}` to the recycling bin.\n\n### Parameters\n\n- `feeId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.fees.delete('feeId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.fees.delete('feeId');", + }, + python: { + method: 'crm.objects.fees.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.fees.delete(\n "feeId",\n)', + }, + java: { + method: 'crm().objects().fees().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().fees().delete("feeId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Fees.Delete(context.TODO(), "feeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.fees.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.fees.delete("feeId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->fees->delete', + example: + "crm->objects->fees->delete('feeId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/fees/{feeId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.fees > (method) get', + qualified: 'client.crm.objects.fees.get', + params: [ + 'feeId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.fees.get(feeId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/fees/{feeId}`\n\nRead an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `feeId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.fees.get('feeId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.fees.get('feeId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.fees.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.fees.get(\n fee_id="feeId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().fees().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().fees().get("feeId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Fees.Get(\n\t\tcontext.TODO(),\n\t\t"feeId",\n\t\tcrm.ObjectFeeGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.fees.get("feeId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->fees->get', + example: + "crm->objects->fees->get(\n 'feeId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/fees', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of fees. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.fees > (method) list', + qualified: 'client.crm.objects.fees.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.fees.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/fees`\n\nRead a page of fees. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.fees.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.fees.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.fees.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.fees.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().fees().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeListPage;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeeListPage page = client.crm().objects().fees().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Fees.List(context.TODO(), crm.ObjectFeeListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.fees.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->fees->list', + example: + "crm->objects->fees->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/fees/search', + httpMethod: 'post', + summary: 'Search for fees using specified criteria.', + description: + 'Perform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results.', + stainlessPath: '(resource) crm.objects.fees > (method) search', + qualified: 'client.crm.objects.fees.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.fees.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/fees/search`\n\nPerform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.fees.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.fees.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.fees.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.fees.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().fees().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().fees().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Fees.Search(context.TODO(), crm.ObjectFeeSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.fees.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->fees->search', + example: + "crm\n ->objects\n ->fees\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/fees/{feeId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.fees > (method) update', + qualified: 'client.crm.objects.fees.update', + params: ['feeId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.fees.update(feeId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/fees/{feeId}`\n\nPerform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `feeId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.fees.update('feeId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.fees.update('feeId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.fees.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.fees.update(\n fee_id="feeId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().fees().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeeUpdateParams params = FeeUpdateParams.builder()\n .feeId("feeId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().fees().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Fees.Update(\n\t\tcontext.TODO(),\n\t\t"feeId",\n\t\tcrm.ObjectFeeUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.fees.update("feeId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->fees->update', + example: + "crm->objects->fees->update(\n 'feeId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/fees/batch/create', + httpMethod: 'post', + summary: 'Create a batch of fees', + description: + 'Create multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers.', + stainlessPath: '(resource) crm.objects.fees.batch > (method) create', + qualified: 'client.crm.objects.fees.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.fees.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/create`\n\nCreate multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.fees.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().fees().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.New(context.TODO(), crm.ObjectFeeBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->fees->batch->create', + example: + "crm->objects->fees->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/fees/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of fees by ID', + description: 'Archive multiple fees by their IDs, effectively moving them to the recycling bin.', + stainlessPath: '(resource) crm.objects.fees.batch > (method) delete', + qualified: 'client.crm.objects.fees.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.fees.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/fees/batch/archive`\n\nArchive multiple fees by their IDs, effectively moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.fees.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.fees.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.fees.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.fees.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().fees().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().fees().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Fees.Batch.Delete(context.TODO(), crm.ObjectFeeBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.fees.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.fees.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->fees->batch->delete', + example: + "crm->objects->fees->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/fees/batch/read', + httpMethod: 'post', + summary: 'Read a batch of fees by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.fees.batch > (method) get', + qualified: 'client.crm.objects.fees.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.fees.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.fees.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().fees().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.Get(context.TODO(), crm.ObjectFeeBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->fees->batch->get', + example: + "crm->objects->fees->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/fees/batch/update', + httpMethod: 'post', + summary: 'Update a batch of fees by internal ID, or unique property values', + description: + 'Update multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk.', + stainlessPath: '(resource) crm.objects.fees.batch > (method) update', + qualified: 'client.crm.objects.fees.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.fees.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/update`\n\nUpdate multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.fees.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().fees().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.Update(context.TODO(), crm.ObjectFeeBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->fees->batch->update', + example: + "crm->objects->fees->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/fees/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of fees by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.fees.batch > (method) upsert', + qualified: 'client.crm.objects.fees.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.fees.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.fees.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.fees.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.fees.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.fees.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.fees.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().fees().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().fees().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Fees.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Fees.Batch.Upsert(context.TODO(), crm.ObjectFeeBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.fees.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.fees.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->fees->batch->upsert', + example: + "crm\n ->objects\n ->fees\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/{objectType}', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.', + stainlessPath: '(resource) crm.objects.generic_objects > (method) create', + qualified: 'client.crm.objects.genericObjects.create', + params: [ + 'objectType: string;', + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.genericObjects.create(objectType: string, associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}`\n\nCreate a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.\n\n### Parameters\n\n- `objectType: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.genericObjects.create('objectType', {\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.genericObjects.create('objectType', {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.generic_objects.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.generic_objects.create(\n object_type="objectType",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().genericObjects().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectCreateParams params = GenericObjectCreateParams.builder()\n .objectType("objectType")\n .simplePublicObjectInputForCreate(SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().genericObjects().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GenericObjects.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectNewParams{\n\t\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.generic_objects.create(\n "objectType",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->create', + example: + "crm->objects->genericObjects->create(\n 'objectType',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{objectId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.generic_objects > (method) delete', + qualified: 'client.crm.objects.genericObjects.delete', + params: ['objectType: string;', 'objectId: string;'], + markdown: + "## delete\n\n`client.crm.objects.genericObjects.delete(objectType: string, objectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nMove an Object identified by `{objectId}` to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.genericObjects.delete('objectId', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.genericObjects.delete('objectId', { objectType: 'objectType' });", + }, + python: { + method: 'crm.objects.generic_objects.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.generic_objects.delete(\n object_id="objectId",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().objects().genericObjects().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectDeleteParams params = GenericObjectDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n client.crm().objects().genericObjects().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GenericObjects.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.generic_objects.delete("objectId", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->objects->genericObjects->delete', + example: + "crm->objects->genericObjects->delete(\n 'objectId', objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.generic_objects > (method) get', + qualified: 'client.crm.objects.genericObjects.get', + params: [ + 'objectType: string;', + 'objectId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.genericObjects.get(objectType: string, objectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nRead an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.genericObjects.get('objectId', { objectType: 'objectType' });\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.genericObjects.get('objectId', {\n objectType: 'objectType',\n});\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.generic_objects.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.generic_objects.get(\n object_id="objectId",\n object_type="objectType",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().genericObjects().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectGetParams params = GenericObjectGetParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().genericObjects().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.GenericObjects.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.generic_objects.get("objectId", object_type: "objectType")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->genericObjects->get', + example: + "crm\n ->objects\n ->genericObjects\n ->get(\n 'objectId',\n objectType: 'objectType',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/{objectType}', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of objects. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.generic_objects > (method) list', + qualified: 'client.crm.objects.genericObjects.list', + params: [ + 'objectType: string;', + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.genericObjects.list(objectType: string, after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}`\n\nRead a page of objects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.genericObjects.list('objectType')) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.genericObjects.list(\n 'objectType',\n)) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.generic_objects.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.generic_objects.list(\n object_type="objectType",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().genericObjects().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectListPage;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectListPage page = client.crm().objects().genericObjects().list("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.GenericObjects.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.generic_objects.list("objectType")\n\nputs(page)', + }, + php: { + method: 'crm->objects->genericObjects->list', + example: + "crm->objects->genericObjects->list(\n 'objectType',\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/{objectType}/search', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.generic_objects > (method) search', + qualified: 'client.crm.objects.genericObjects.search', + params: [ + 'objectType: string;', + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.genericObjects.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.genericObjects.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.genericObjects.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.generic_objects.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.generic_objects.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().genericObjects().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectSearchParams params = GenericObjectSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().genericObjects().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.GenericObjects.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.generic_objects.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->search', + example: + "crm\n ->objects\n ->genericObjects\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.generic_objects > (method) update', + qualified: 'client.crm.objects.genericObjects.update', + params: ['objectType: string;', 'objectId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.genericObjects.update(objectType: string, objectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nPerform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.genericObjects.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.genericObjects.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.generic_objects.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.generic_objects.update(\n object_id="objectId",\n object_type="objectType",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().genericObjects().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectUpdateParams params = GenericObjectUpdateParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().genericObjects().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GenericObjects.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.generic_objects.update(\n "objectId",\n object_type: "objectType",\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->update', + example: + "crm->objects->genericObjects->update(\n 'objectId',\n objectType: 'objectType',\n properties: ['foo' => 'string'],\n idProperty: 'idProperty',\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/{objectType}/batch/create', + httpMethod: 'post', + summary: 'Create a batch of objects', + description: 'Create a batch of objects', + stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) create', + qualified: 'client.crm.objects.genericObjects.batch.create', + params: [ + 'objectType: string;', + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.genericObjects.batch.create(objectType: string, inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.create('objectType', { inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.create(\n 'objectType',\n {\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.generic_objects.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.create(\n object_type="objectType",\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().genericObjects().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputForCreate(BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchNewParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.create(\n "objectType",\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->batch->create', + example: + "crm\n ->objects\n ->genericObjects\n ->batch\n ->create(\n 'objectType',\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/{objectType}/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of objects by ID', + description: 'Archive a batch of objects by ID', + stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) delete', + qualified: 'client.crm.objects.genericObjects.batch.delete', + params: ['objectType: string;', 'inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.genericObjects.batch.delete(objectType: string, inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/archive`\n\nArchive a batch of objects by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.genericObjects.batch.delete('objectType', { inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.genericObjects.batch.delete('objectType', { inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.generic_objects.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.generic_objects.batch.delete(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().genericObjects().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectId(BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build())\n .build();\n client.crm().objects().genericObjects().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GenericObjects.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchDeleteParams{\n\t\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.generic_objects.batch.delete("objectType", inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->genericObjects->batch->delete', + example: + "crm->objects->genericObjects->batch->delete(\n 'objectType', inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/{objectType}/batch/read', + httpMethod: 'post', + summary: 'Read a batch of objects by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) get', + qualified: 'client.crm.objects.genericObjects.batch.get', + params: [ + 'objectType: string;', + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.genericObjects.batch.get(objectType: string, inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.get(\n 'objectType',\n {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.generic_objects.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.get(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().genericObjects().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputSimplePublicObjectId(BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchGetParams{\n\t\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.get(\n "objectType",\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->batch->get', + example: + "crm\n ->objects\n ->genericObjects\n ->batch\n ->get(\n 'objectType',\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/{objectType}/batch/update', + httpMethod: 'post', + summary: 'Update a batch of objects by internal ID, or unique property values', + description: 'Update a batch of objects by internal ID, or unique property values', + stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) update', + qualified: 'client.crm.objects.genericObjects.batch.update', + params: [ + 'objectType: string;', + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.genericObjects.batch.update(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/update`\n\nUpdate a batch of objects by internal ID, or unique property values\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.update('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.update(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.generic_objects.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.update(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().genericObjects().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpdateParams params = BatchUpdateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInput(BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchUpdateParams{\n\t\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.update(\n "objectType",\n inputs: [{id: "id", properties: {foo: "string"}}]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->genericObjects->batch->update', + example: + "crm\n ->objects\n ->genericObjects\n ->batch\n ->update(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/{objectType}/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of objects by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) upsert', + qualified: 'client.crm.objects.genericObjects.batch.upsert', + params: [ + 'objectType: string;', + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.genericObjects.batch.upsert(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.genericObjects.batch.upsert('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.genericObjects.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.genericObjects.batch.upsert(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.generic_objects.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.generic_objects.batch.upsert(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().genericObjects().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputUpsert(BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().genericObjects().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GenericObjects.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.GenericObjects.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchUpsertParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.generic_objects.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.generic_objects.batch.upsert(\n "objectType",\n inputs: [{id: "id", properties: {foo: "string"}}]\n)\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->genericObjects->batch->upsert', + example: + "crm\n ->objects\n ->genericObjects\n ->batch\n ->upsert(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/goal_targets', + httpMethod: 'post', + summary: 'Create a goal target', + description: + 'Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) create', + qualified: 'client.crm.objects.goalTargets.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.goalTargets.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets`\n\nCreate a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.goalTargets.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.goalTargets.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.goal_targets.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.goal_targets.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().goalTargets().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().goalTargets().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GoalTargets.New(context.TODO(), crm.ObjectGoalTargetNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.goal_targets.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->create', + example: + "crm->objects->goalTargets->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + httpMethod: 'delete', + summary: 'Delete a goal target', + description: 'Delete a goal target by `{goalTargetId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) delete', + qualified: 'client.crm.objects.goalTargets.delete', + params: ['goalTargetId: string;'], + markdown: + "## delete\n\n`client.crm.objects.goalTargets.delete(goalTargetId: string): void`\n\n**delete** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nDelete a goal target by `{goalTargetId}` to the recycling bin.\n\n### Parameters\n\n- `goalTargetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.goalTargets.delete('goalTargetId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.goalTargets.delete('goalTargetId');", + }, + python: { + method: 'crm.objects.goal_targets.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.goal_targets.delete(\n "goalTargetId",\n)', + }, + java: { + method: 'crm().objects().goalTargets().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().goalTargets().delete("goalTargetId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GoalTargets.Delete(context.TODO(), "goalTargetId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.goal_targets.delete("goalTargetId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->goalTargets->delete', + example: + "crm->objects->goalTargets->delete('goalTargetId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + httpMethod: 'get', + summary: 'Retrieve a goal target', + description: + 'Retrieve a goal target by its ID. You can specify what is returned using the `properties` query parameter.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) get', + qualified: 'client.crm.objects.goalTargets.get', + params: [ + 'goalTargetId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.goalTargets.get(goalTargetId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nRetrieve a goal target by its ID. You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `goalTargetId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.goalTargets.get('goalTargetId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.goalTargets.get('goalTargetId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.goal_targets.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.goal_targets.get(\n goal_target_id="goalTargetId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().goalTargets().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().goalTargets().get("goalTargetId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.GoalTargets.Get(\n\t\tcontext.TODO(),\n\t\t"goalTargetId",\n\t\tcrm.ObjectGoalTargetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.goal_targets.get("goalTargetId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->goalTargets->get', + example: + "crm->objects->goalTargets->get(\n 'goalTargetId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/goal_targets', + httpMethod: 'get', + summary: 'Retrieve goal targets', + description: 'Read a page of goal targets. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) list', + qualified: 'client.crm.objects.goalTargets.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.goalTargets.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/goal_targets`\n\nRead a page of goal targets. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.goalTargets.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.goalTargets.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.goal_targets.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.goal_targets.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().goalTargets().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetListPage;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GoalTargetListPage page = client.crm().objects().goalTargets().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.GoalTargets.List(context.TODO(), crm.ObjectGoalTargetListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.goal_targets.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->goalTargets->list', + example: + "crm->objects->goalTargets->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/goal_targets/search', + httpMethod: 'post', + summary: 'Search for goal targets', + description: 'Search for goal targets using specified criteria.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) search', + qualified: 'client.crm.objects.goalTargets.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.goalTargets.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/goal_targets/search`\n\nSearch for goal targets using specified criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.goalTargets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.goalTargets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.goal_targets.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.goal_targets.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().goalTargets().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().goalTargets().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.GoalTargets.Search(context.TODO(), crm.ObjectGoalTargetSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.goal_targets.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->search', + example: + "crm\n ->objects\n ->goalTargets\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + httpMethod: 'patch', + summary: 'Update a goal target', + description: + 'Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.goal_targets > (method) update', + qualified: 'client.crm.objects.goalTargets.update', + params: ['goalTargetId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.goalTargets.update(goalTargetId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nPerform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `goalTargetId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.goalTargets.update('goalTargetId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.goalTargets.update('goalTargetId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.goal_targets.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.goal_targets.update(\n goal_target_id="goalTargetId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().goalTargets().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GoalTargetUpdateParams params = GoalTargetUpdateParams.builder()\n .goalTargetId("goalTargetId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().goalTargets().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GoalTargets.Update(\n\t\tcontext.TODO(),\n\t\t"goalTargetId",\n\t\tcrm.ObjectGoalTargetUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.goal_targets.update("goalTargetId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->update', + example: + "crm->objects->goalTargets->update(\n 'goalTargetId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/goal_targets/batch/create', + httpMethod: 'post', + summary: 'Create goal targets', + description: 'Create multiple goal targets in a single batch operation.', + stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) create', + qualified: 'client.crm.objects.goalTargets.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.goalTargets.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/create`\n\nCreate multiple goal targets in a single batch operation.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.goal_targets.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().goalTargets().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.New(context.TODO(), crm.ObjectGoalTargetBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->batch->create', + example: + "crm\n ->objects\n ->goalTargets\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/goal_targets/batch/archive', + httpMethod: 'post', + summary: 'Delete goal targets', + description: 'Archive multiple goal targets in a single batch operation using their IDs.', + stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) delete', + qualified: 'client.crm.objects.goalTargets.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.goalTargets.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/archive`\n\nArchive multiple goal targets in a single batch operation using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.goalTargets.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.goalTargets.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.goal_targets.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.goal_targets.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().goalTargets().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().goalTargets().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GoalTargets.Batch.Delete(context.TODO(), crm.ObjectGoalTargetBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.goal_targets.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->goalTargets->batch->delete', + example: + "crm->objects->goalTargets->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/goal_targets/batch/read', + httpMethod: 'post', + summary: 'Retrieve goal targets', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) get', + qualified: 'client.crm.objects.goalTargets.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.goalTargets.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.goal_targets.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().goalTargets().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.Get(context.TODO(), crm.ObjectGoalTargetBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->batch->get', + example: + "crm\n ->objects\n ->goalTargets\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/goal_targets/batch/update', + httpMethod: 'post', + summary: 'Update goal targets', + description: + 'Update multiple goal targets in a single batch operation using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) update', + qualified: 'client.crm.objects.goalTargets.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.goalTargets.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/update`\n\nUpdate multiple goal targets in a single batch operation using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.goal_targets.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().goalTargets().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.Update(context.TODO(), crm.ObjectGoalTargetBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->goalTargets->batch->update', + example: + "crm\n ->objects\n ->goalTargets\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/goal_targets/batch/upsert', + httpMethod: 'post', + summary: 'Upsert goal tagets', + description: + "Create and update a batch of goal targets by a unique property. Goal targets that don't exist will be created, while existing goal targets will be updated.", + stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) upsert', + qualified: 'client.crm.objects.goalTargets.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.goalTargets.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/upsert`\n\nCreate and update a batch of goal targets by a unique property. Goal targets that don't exist will be created, while existing goal targets will be updated.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.goalTargets.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.goalTargets.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.goalTargets.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.goal_targets.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.goal_targets.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().goalTargets().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().goalTargets().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.GoalTargets.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.GoalTargets.Batch.Upsert(context.TODO(), crm.ObjectGoalTargetBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.goal_targets.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.goal_targets.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->goalTargets->batch->upsert', + example: + "crm\n ->objects\n ->goalTargets\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/invoices', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.', + stainlessPath: '(resource) crm.objects.invoices > (method) create', + qualified: 'client.crm.objects.invoices.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.invoices.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/invoices`\n\nCreate a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.invoices.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.invoices.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.invoices.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.invoices.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().invoices().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().invoices().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Invoices.New(context.TODO(), crm.ObjectInvoiceNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.invoices.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->create', + example: + "crm->objects->invoices->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{invoiceId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.invoices > (method) delete', + qualified: 'client.crm.objects.invoices.delete', + params: ['invoiceId: string;'], + markdown: + "## delete\n\n`client.crm.objects.invoices.delete(invoiceId: string): void`\n\n**delete** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nMove an Object identified by `{invoiceId}` to the recycling bin.\n\n### Parameters\n\n- `invoiceId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.invoices.delete('invoiceId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.invoices.delete('invoiceId');", + }, + python: { + method: 'crm.objects.invoices.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.invoices.delete(\n "invoiceId",\n)', + }, + java: { + method: 'crm().objects().invoices().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().invoices().delete("invoiceId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Invoices.Delete(context.TODO(), "invoiceId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.invoices.delete("invoiceId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->invoices->delete', + example: + "crm->objects->invoices->delete('invoiceId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.invoices > (method) get', + qualified: 'client.crm.objects.invoices.get', + params: [ + 'invoiceId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.invoices.get(invoiceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nRead an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `invoiceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.invoices.get('invoiceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.invoices.get('invoiceId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.invoices.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.invoices.get(\n invoice_id="invoiceId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().invoices().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().invoices().get("invoiceId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Invoices.Get(\n\t\tcontext.TODO(),\n\t\t"invoiceId",\n\t\tcrm.ObjectInvoiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.invoices.get("invoiceId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->invoices->get', + example: + "crm->objects->invoices->get(\n 'invoiceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/invoices', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of invoices. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.invoices > (method) list', + qualified: 'client.crm.objects.invoices.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.invoices.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/invoices`\n\nRead a page of invoices. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.invoices.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.invoices.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.invoices.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.invoices.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().invoices().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceListPage;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n InvoiceListPage page = client.crm().objects().invoices().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Invoices.List(context.TODO(), crm.ObjectInvoiceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.invoices.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->invoices->list', + example: + "crm->objects->invoices->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/invoices/search', + httpMethod: 'post', + summary: 'Search for invoices using specified criteria.', + description: + 'Execute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups.', + stainlessPath: '(resource) crm.objects.invoices > (method) search', + qualified: 'client.crm.objects.invoices.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.invoices.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/invoices/search`\n\nExecute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.invoices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.invoices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.invoices.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.invoices.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().invoices().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().invoices().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Invoices.Search(context.TODO(), crm.ObjectInvoiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.invoices.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->search', + example: + "crm\n ->objects\n ->invoices\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.invoices > (method) update', + qualified: 'client.crm.objects.invoices.update', + params: ['invoiceId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.invoices.update(invoiceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nPerform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `invoiceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.invoices.update('invoiceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.invoices.update('invoiceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.invoices.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.invoices.update(\n invoice_id="invoiceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().invoices().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n InvoiceUpdateParams params = InvoiceUpdateParams.builder()\n .invoiceId("invoiceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().invoices().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Invoices.Update(\n\t\tcontext.TODO(),\n\t\t"invoiceId",\n\t\tcrm.ObjectInvoiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.invoices.update("invoiceId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->update', + example: + "crm->objects->invoices->update(\n 'invoiceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/invoices/batch/create', + httpMethod: 'post', + summary: 'Create a batch of invoices', + description: + 'Create multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs.', + stainlessPath: '(resource) crm.objects.invoices.batch > (method) create', + qualified: 'client.crm.objects.invoices.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.invoices.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/create`\n\nCreate multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.invoices.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().invoices().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.New(context.TODO(), crm.ObjectInvoiceBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->batch->create', + example: + "crm\n ->objects\n ->invoices\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/invoices/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of invoices by ID', + description: + 'Archive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference.', + stainlessPath: '(resource) crm.objects.invoices.batch > (method) delete', + qualified: 'client.crm.objects.invoices.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.invoices.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/invoices/batch/archive`\n\nArchive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.invoices.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.invoices.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.invoices.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.invoices.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().invoices().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().invoices().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Invoices.Batch.Delete(context.TODO(), crm.ObjectInvoiceBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.invoices.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->invoices->batch->delete', + example: + "crm->objects->invoices->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/invoices/batch/read', + httpMethod: 'post', + summary: 'Read a batch of invoices by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.invoices.batch > (method) get', + qualified: 'client.crm.objects.invoices.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.invoices.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.invoices.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().invoices().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.Get(context.TODO(), crm.ObjectInvoiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->batch->get', + example: + "crm->objects->invoices->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/invoices/batch/update', + httpMethod: 'post', + summary: 'Update a batch of invoices by internal ID, or unique property values', + description: + 'Update multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records.', + stainlessPath: '(resource) crm.objects.invoices.batch > (method) update', + qualified: 'client.crm.objects.invoices.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.invoices.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/update`\n\nUpdate multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.invoices.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().invoices().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.Update(context.TODO(), crm.ObjectInvoiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->invoices->batch->update', + example: + "crm\n ->objects\n ->invoices\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/invoices/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of invoices by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.invoices.batch > (method) upsert', + qualified: 'client.crm.objects.invoices.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.invoices.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.invoices.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.invoices.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.invoices.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.invoices.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.invoices.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().invoices().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().invoices().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Invoices.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Invoices.Batch.Upsert(context.TODO(), crm.ObjectInvoiceBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.invoices.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.invoices.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->invoices->batch->upsert', + example: + "crm\n ->objects\n ->invoices\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/leads', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.', + stainlessPath: '(resource) crm.objects.leads > (method) create', + qualified: 'client.crm.objects.leads.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.leads.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/leads`\n\nCreate a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.leads.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.leads.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.leads.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.leads.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().leads().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().leads().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Leads.New(context.TODO(), crm.ObjectLeadNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.leads.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->leads->create', + example: + "crm->objects->leads->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/leads/{leadsId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{leadsId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.leads > (method) delete', + qualified: 'client.crm.objects.leads.delete', + params: ['leadsId: string;'], + markdown: + "## delete\n\n`client.crm.objects.leads.delete(leadsId: string): void`\n\n**delete** `/crm/objects/2026-03/leads/{leadsId}`\n\nMove an Object identified by `{leadsId}` to the recycling bin.\n\n### Parameters\n\n- `leadsId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.leads.delete('leadsId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.leads.delete('leadsId');", + }, + python: { + method: 'crm.objects.leads.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.leads.delete(\n "leadsId",\n)', + }, + java: { + method: 'crm().objects().leads().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().leads().delete("leadsId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Leads.Delete(context.TODO(), "leadsId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.leads.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.leads.delete("leadsId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->leads->delete', + example: + "crm->objects->leads->delete('leadsId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/leads/{leadsId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.leads > (method) get', + qualified: 'client.crm.objects.leads.get', + params: [ + 'leadsId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.leads.get(leadsId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/leads/{leadsId}`\n\nRead an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `leadsId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.leads.get('leadsId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.leads.get('leadsId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.leads.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.leads.get(\n leads_id="leadsId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().leads().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().leads().get("leadsId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Leads.Get(\n\t\tcontext.TODO(),\n\t\t"leadsId",\n\t\tcrm.ObjectLeadGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.leads.get("leadsId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->leads->get', + example: + "crm->objects->leads->get(\n 'leadsId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/leads', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of leads. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.leads > (method) list', + qualified: 'client.crm.objects.leads.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.leads.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/leads`\n\nRead a page of leads. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.leads.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.leads.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.leads.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.leads.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().leads().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadListPage;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LeadListPage page = client.crm().objects().leads().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Leads.List(context.TODO(), crm.ObjectLeadListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.leads.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->leads->list', + example: + "crm->objects->leads->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/leads/search', + httpMethod: 'post', + summary: 'Search for leads using specified criteria.', + description: + 'Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.', + stainlessPath: '(resource) crm.objects.leads > (method) search', + qualified: 'client.crm.objects.leads.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.leads.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/leads/search`\n\nPerform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.leads.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.leads.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.leads.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.leads.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().leads().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().leads().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Leads.Search(context.TODO(), crm.ObjectLeadSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.leads.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->leads->search', + example: + "crm\n ->objects\n ->leads\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/leads/{leadsId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.leads > (method) update', + qualified: 'client.crm.objects.leads.update', + params: ['leadsId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.leads.update(leadsId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/leads/{leadsId}`\n\nPerform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `leadsId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.leads.update('leadsId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.leads.update('leadsId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.leads.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.leads.update(\n leads_id="leadsId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().leads().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LeadUpdateParams params = LeadUpdateParams.builder()\n .leadsId("leadsId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().leads().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Leads.Update(\n\t\tcontext.TODO(),\n\t\t"leadsId",\n\t\tcrm.ObjectLeadUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.leads.update("leadsId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->leads->update', + example: + "crm->objects->leads->update(\n 'leadsId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/leads/batch/create', + httpMethod: 'post', + summary: 'Create a batch of leads', + description: + 'Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.', + stainlessPath: '(resource) crm.objects.leads.batch > (method) create', + qualified: 'client.crm.objects.leads.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.leads.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/create`\n\nCreate multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.leads.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().leads().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.New(context.TODO(), crm.ObjectLeadBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->leads->batch->create', + example: + "crm->objects->leads->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/leads/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of leads by ID', + description: 'Archive multiple leads by their IDs in a single request, moving them to the recycling bin.', + stainlessPath: '(resource) crm.objects.leads.batch > (method) delete', + qualified: 'client.crm.objects.leads.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.leads.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/leads/batch/archive`\n\nArchive multiple leads by their IDs in a single request, moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.leads.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.leads.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.leads.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.leads.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().leads().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().leads().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Leads.Batch.Delete(context.TODO(), crm.ObjectLeadBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.leads.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.leads.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->leads->batch->delete', + example: + "crm->objects->leads->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/leads/batch/read', + httpMethod: 'post', + summary: 'Read a batch of leads by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.leads.batch > (method) get', + qualified: 'client.crm.objects.leads.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.leads.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.leads.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().leads().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.Get(context.TODO(), crm.ObjectLeadBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->leads->batch->get', + example: + "crm->objects->leads->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/leads/batch/update', + httpMethod: 'post', + summary: 'Update a batch of leads by internal ID, or unique property values', + description: + "Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.", + stainlessPath: '(resource) crm.objects.leads.batch > (method) update', + qualified: 'client.crm.objects.leads.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.leads.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/update`\n\nUpdate multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.leads.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().leads().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.Update(context.TODO(), crm.ObjectLeadBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->leads->batch->update', + example: + "crm->objects->leads->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/leads/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of leads by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.leads.batch > (method) upsert', + qualified: 'client.crm.objects.leads.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.leads.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.leads.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.leads.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.leads.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.leads.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.leads.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().leads().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().leads().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Leads.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Leads.Batch.Upsert(context.TODO(), crm.ObjectLeadBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.leads.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.leads.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->leads->batch->upsert', + example: + "crm\n ->objects\n ->leads\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/line_items', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.', + stainlessPath: '(resource) crm.objects.line_items > (method) create', + qualified: 'client.crm.objects.lineItems.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.lineItems.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/line_items`\n\nCreate a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.lineItems.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.lineItems.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.line_items.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.line_items.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().lineItems().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().lineItems().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.LineItems.New(context.TODO(), crm.ObjectLineItemNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.line_items.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->create', + example: + "crm->objects->lineItems->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{lineItemId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.line_items > (method) delete', + qualified: 'client.crm.objects.lineItems.delete', + params: ['lineItemId: string;'], + markdown: + "## delete\n\n`client.crm.objects.lineItems.delete(lineItemId: string): void`\n\n**delete** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nMove an Object identified by `{lineItemId}` to the recycling bin.\n\n### Parameters\n\n- `lineItemId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.lineItems.delete('lineItemId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.lineItems.delete('lineItemId');", + }, + python: { + method: 'crm.objects.line_items.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.line_items.delete(\n "lineItemId",\n)', + }, + java: { + method: 'crm().objects().lineItems().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().lineItems().delete("lineItemId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.LineItems.Delete(context.TODO(), "lineItemId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.line_items.delete("lineItemId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->lineItems->delete', + example: + "crm->objects->lineItems->delete('lineItemId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.line_items > (method) get', + qualified: 'client.crm.objects.lineItems.get', + params: [ + 'lineItemId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.lineItems.get(lineItemId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nRead an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `lineItemId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.lineItems.get('lineItemId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.lineItems.get('lineItemId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.line_items.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.line_items.get(\n line_item_id="lineItemId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().lineItems().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().lineItems().get("lineItemId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.LineItems.Get(\n\t\tcontext.TODO(),\n\t\t"lineItemId",\n\t\tcrm.ObjectLineItemGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.line_items.get("lineItemId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->lineItems->get', + example: + "crm->objects->lineItems->get(\n 'lineItemId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/line_items', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of line items. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.line_items > (method) list', + qualified: 'client.crm.objects.lineItems.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.lineItems.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/line_items`\n\nRead a page of line items. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.lineItems.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.lineItems.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.line_items.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.line_items.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().lineItems().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemListPage;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LineItemListPage page = client.crm().objects().lineItems().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.LineItems.List(context.TODO(), crm.ObjectLineItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.line_items.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->lineItems->list', + example: + "crm->objects->lineItems->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/line_items/search', + httpMethod: 'post', + summary: 'Search for line items', + description: + 'Execute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations.', + stainlessPath: '(resource) crm.objects.line_items > (method) search', + qualified: 'client.crm.objects.lineItems.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.lineItems.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/line_items/search`\n\nExecute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.lineItems.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.lineItems.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.line_items.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.line_items.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().lineItems().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().lineItems().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.LineItems.Search(context.TODO(), crm.ObjectLineItemSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.line_items.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->search', + example: + "crm\n ->objects\n ->lineItems\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{lineItemId}`or optionally a unique property value as specified by the `idProperty` query param. `{lineItemId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.line_items > (method) update', + qualified: 'client.crm.objects.lineItems.update', + params: ['lineItemId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.lineItems.update(lineItemId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nPerform a partial update of an Object identified by `{lineItemId}`or optionally a unique property value as specified by the `idProperty` query param. `{lineItemId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `lineItemId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.lineItems.update('lineItemId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.lineItems.update('lineItemId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.line_items.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.line_items.update(\n line_item_id="lineItemId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().lineItems().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LineItemUpdateParams params = LineItemUpdateParams.builder()\n .lineItemId("lineItemId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().lineItems().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.LineItems.Update(\n\t\tcontext.TODO(),\n\t\t"lineItemId",\n\t\tcrm.ObjectLineItemUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.line_items.update("lineItemId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->update', + example: + "crm->objects->lineItems->update(\n 'lineItemId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/line_items/batch/create', + httpMethod: 'post', + summary: 'Create a batch of line items', + description: + 'Create multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers.', + stainlessPath: '(resource) crm.objects.line_items.batch > (method) create', + qualified: 'client.crm.objects.lineItems.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.lineItems.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/create`\n\nCreate multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.line_items.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().lineItems().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.New(context.TODO(), crm.ObjectLineItemBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->batch->create', + example: + "crm\n ->objects\n ->lineItems\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/line_items/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of line items by ID', + description: 'Archive multiple line items simultaneously by specifying their IDs in the request body.', + stainlessPath: '(resource) crm.objects.line_items.batch > (method) delete', + qualified: 'client.crm.objects.lineItems.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.lineItems.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/line_items/batch/archive`\n\nArchive multiple line items simultaneously by specifying their IDs in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.lineItems.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.lineItems.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.line_items.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.line_items.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().lineItems().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().lineItems().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.LineItems.Batch.Delete(context.TODO(), crm.ObjectLineItemBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.line_items.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->lineItems->batch->delete', + example: + "crm->objects->lineItems->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/line_items/batch/read', + httpMethod: 'post', + summary: 'Read a batch of line items by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.line_items.batch > (method) get', + qualified: 'client.crm.objects.lineItems.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.lineItems.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.line_items.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().lineItems().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.Get(context.TODO(), crm.ObjectLineItemBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->batch->get', + example: + "crm->objects->lineItems->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/line_items/batch/update', + httpMethod: 'post', + summary: 'Update a batch of line items by internal ID, or unique property values', + description: + 'Update multiple line items using their internal IDs or unique property values. This endpoint allows for batch processing of updates, ensuring efficient modification of line item records in bulk.', + stainlessPath: '(resource) crm.objects.line_items.batch > (method) update', + qualified: 'client.crm.objects.lineItems.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.lineItems.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/update`\n\nUpdate multiple line items using their internal IDs or unique property values. This endpoint allows for batch processing of updates, ensuring efficient modification of line item records in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.line_items.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().lineItems().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.Update(context.TODO(), crm.ObjectLineItemBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->lineItems->batch->update', + example: + "crm\n ->objects\n ->lineItems\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/line_items/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of line items by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.line_items.batch > (method) upsert', + qualified: 'client.crm.objects.lineItems.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.lineItems.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.lineItems.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.lineItems.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.lineItems.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.line_items.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.line_items.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().lineItems().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().lineItems().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.LineItems.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.LineItems.Batch.Upsert(context.TODO(), crm.ObjectLineItemBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.line_items.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.line_items.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->lineItems->batch->upsert', + example: + "crm\n ->objects\n ->lineItems\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-420', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided.', + stainlessPath: '(resource) crm.objects.listings > (method) create', + qualified: 'client.crm.objects.listings.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.listings.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-420`\n\nCreate a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.listings.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.listings.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.listings.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.listings.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().listings().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().listings().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Listings.New(context.TODO(), crm.ObjectListingNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.listings.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->listings->create', + example: + "crm->objects->listings->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-420/{listingId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{listingId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.listings > (method) delete', + qualified: 'client.crm.objects.listings.delete', + params: ['listingId: string;'], + markdown: + "## delete\n\n`client.crm.objects.listings.delete(listingId: string): void`\n\n**delete** `/crm/objects/2026-03/0-420/{listingId}`\n\nMove an Object identified by `{listingId}` to the recycling bin.\n\n### Parameters\n\n- `listingId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.listings.delete('listingId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.listings.delete('listingId');", + }, + python: { + method: 'crm.objects.listings.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.listings.delete(\n "listingId",\n)', + }, + java: { + method: 'crm().objects().listings().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().listings().delete("listingId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Listings.Delete(context.TODO(), "listingId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.listings.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.listings.delete("listingId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->listings->delete', + example: + "crm->objects->listings->delete('listingId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-420/{listingId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.listings > (method) get', + qualified: 'client.crm.objects.listings.get', + params: [ + 'listingId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.listings.get(listingId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-420/{listingId}`\n\nRead an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `listingId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.listings.get('listingId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.listings.get('listingId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.listings.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.listings.get(\n listing_id="listingId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().listings().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().listings().get("listingId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Listings.Get(\n\t\tcontext.TODO(),\n\t\t"listingId",\n\t\tcrm.ObjectListingGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.listings.get("listingId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->listings->get', + example: + "crm->objects->listings->get(\n 'listingId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/0-420', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of listings. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.listings > (method) list', + qualified: 'client.crm.objects.listings.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.listings.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-420`\n\nRead a page of listings. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.listings.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.listings.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.listings.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.listings.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().listings().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingListPage;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListingListPage page = client.crm().objects().listings().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Listings.List(context.TODO(), crm.ObjectListingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.listings.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->listings->list', + example: + "crm->objects->listings->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/0-420/search', + httpMethod: 'post', + summary: 'Search for listings using various criteria and filters.', + description: 'Execute a search query to find listings based on specified filters and properties.', + stainlessPath: '(resource) crm.objects.listings > (method) search', + qualified: 'client.crm.objects.listings.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.listings.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-420/search`\n\nExecute a search query to find listings based on specified filters and properties.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.listings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.listings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.listings.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.listings.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().listings().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().listings().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Listings.Search(context.TODO(), crm.ObjectListingSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.listings.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->listings->search', + example: + "crm\n ->objects\n ->listings\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-420/{listingId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.listings > (method) update', + qualified: 'client.crm.objects.listings.update', + params: ['listingId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.listings.update(listingId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-420/{listingId}`\n\nPerform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `listingId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.listings.update('listingId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.listings.update('listingId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.listings.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.listings.update(\n listing_id="listingId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().listings().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListingUpdateParams params = ListingUpdateParams.builder()\n .listingId("listingId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().listings().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Listings.Update(\n\t\tcontext.TODO(),\n\t\t"listingId",\n\t\tcrm.ObjectListingUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.listings.update("listingId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->listings->update', + example: + "crm->objects->listings->update(\n 'listingId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-420/batch/create', + httpMethod: 'post', + summary: 'Create a batch of listings', + description: 'Create multiple listings in a single request.', + stainlessPath: '(resource) crm.objects.listings.batch > (method) create', + qualified: 'client.crm.objects.listings.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.listings.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/create`\n\nCreate multiple listings in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.listings.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().listings().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.New(context.TODO(), crm.ObjectListingBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->listings->batch->create', + example: + "crm\n ->objects\n ->listings\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-420/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of listings by ID', + description: 'Archive multiple listings by their IDs.', + stainlessPath: '(resource) crm.objects.listings.batch > (method) delete', + qualified: 'client.crm.objects.listings.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.listings.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-420/batch/archive`\n\nArchive multiple listings by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.listings.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.listings.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.listings.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.listings.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().listings().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().listings().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Listings.Batch.Delete(context.TODO(), crm.ObjectListingBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.listings.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.listings.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->listings->batch->delete', + example: + "crm->objects->listings->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-420/batch/read', + httpMethod: 'post', + summary: 'Read a batch of listings by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.listings.batch > (method) get', + qualified: 'client.crm.objects.listings.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.listings.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.listings.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().listings().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.Get(context.TODO(), crm.ObjectListingBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->listings->batch->get', + example: + "crm->objects->listings->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-420/batch/update', + httpMethod: 'post', + summary: 'Update a batch of listings by internal ID, or unique property values', + description: 'Update multiple listings using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.listings.batch > (method) update', + qualified: 'client.crm.objects.listings.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.listings.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/update`\n\nUpdate multiple listings using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.listings.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().listings().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.Update(context.TODO(), crm.ObjectListingBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->listings->batch->update', + example: + "crm\n ->objects\n ->listings\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/0-420/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of listings by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.listings.batch > (method) upsert', + qualified: 'client.crm.objects.listings.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.listings.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.listings.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.listings.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.listings.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.listings.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.listings.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().listings().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().listings().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Listings.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Listings.Batch.Upsert(context.TODO(), crm.ObjectListingBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.listings.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.listings.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->listings->batch->upsert', + example: + "crm\n ->objects\n ->listings\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/meetings', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.', + stainlessPath: '(resource) crm.objects.meetings > (method) create', + qualified: 'client.crm.objects.meetings.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.meetings.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/meetings`\n\nCreate a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.meetings.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.meetings.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.meetings.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.meetings.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().meetings().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().meetings().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Meetings.New(context.TODO(), crm.ObjectMeetingNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.meetings.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->create', + example: + "crm->objects->meetings->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/meetings/{meetingId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{meetingId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.meetings > (method) delete', + qualified: 'client.crm.objects.meetings.delete', + params: ['meetingId: string;'], + markdown: + "## delete\n\n`client.crm.objects.meetings.delete(meetingId: string): void`\n\n**delete** `/crm/objects/2026-03/meetings/{meetingId}`\n\nMove an Object identified by `{meetingId}` to the recycling bin.\n\n### Parameters\n\n- `meetingId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.meetings.delete('meetingId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.meetings.delete('meetingId');", + }, + python: { + method: 'crm.objects.meetings.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.meetings.delete(\n "meetingId",\n)', + }, + java: { + method: 'crm().objects().meetings().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().meetings().delete("meetingId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Meetings.Delete(context.TODO(), "meetingId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.meetings.delete("meetingId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->meetings->delete', + example: + "crm->objects->meetings->delete('meetingId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/meetings/{meetingId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.meetings > (method) get', + qualified: 'client.crm.objects.meetings.get', + params: [ + 'meetingId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.meetings.get(meetingId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/meetings/{meetingId}`\n\nRead an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `meetingId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.meetings.get('meetingId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.meetings.get('meetingId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.meetings.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.meetings.get(\n meeting_id="meetingId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().meetings().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().meetings().get("meetingId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Meetings.Get(\n\t\tcontext.TODO(),\n\t\t"meetingId",\n\t\tcrm.ObjectMeetingGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.meetings.get("meetingId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->meetings->get', + example: + "crm->objects->meetings->get(\n 'meetingId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/meetings', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of meetings. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.meetings > (method) list', + qualified: 'client.crm.objects.meetings.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.meetings.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/meetings`\n\nRead a page of meetings. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.meetings.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.meetings.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.meetings.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.meetings.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().meetings().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingListPage;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MeetingListPage page = client.crm().objects().meetings().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Meetings.List(context.TODO(), crm.ObjectMeetingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.meetings.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->meetings->list', + example: + "crm->objects->meetings->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/meetings/search', + httpMethod: 'post', + summary: 'Search for meetings', + description: + 'Search for meetings by filtering on properties, searching through associations, and sorting results.', + stainlessPath: '(resource) crm.objects.meetings > (method) search', + qualified: 'client.crm.objects.meetings.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.meetings.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/meetings/search`\n\nSearch for meetings by filtering on properties, searching through associations, and sorting results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.meetings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.meetings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.meetings.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.meetings.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().meetings().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().meetings().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Meetings.Search(context.TODO(), crm.ObjectMeetingSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.meetings.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->search', + example: + "crm\n ->objects\n ->meetings\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/meetings/{meetingId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.meetings > (method) update', + qualified: 'client.crm.objects.meetings.update', + params: ['meetingId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.meetings.update(meetingId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/meetings/{meetingId}`\n\nPerform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `meetingId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.meetings.update('meetingId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.meetings.update('meetingId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.meetings.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.meetings.update(\n meeting_id="meetingId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().meetings().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MeetingUpdateParams params = MeetingUpdateParams.builder()\n .meetingId("meetingId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().meetings().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Meetings.Update(\n\t\tcontext.TODO(),\n\t\t"meetingId",\n\t\tcrm.ObjectMeetingUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.meetings.update("meetingId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->update', + example: + "crm->objects->meetings->update(\n 'meetingId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/meetings/batch/create', + httpMethod: 'post', + summary: 'Create a batch of meetings', + description: + 'Create a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.', + stainlessPath: '(resource) crm.objects.meetings.batch > (method) create', + qualified: 'client.crm.objects.meetings.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.meetings.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/create`\n\nCreate a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.meetings.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().meetings().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.New(context.TODO(), crm.ObjectMeetingBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->batch->create', + example: + "crm\n ->objects\n ->meetings\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/meetings/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of meetings by ID', + description: 'Delete a batch of meetings by ID.', + stainlessPath: '(resource) crm.objects.meetings.batch > (method) delete', + qualified: 'client.crm.objects.meetings.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.meetings.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/meetings/batch/archive`\n\nDelete a batch of meetings by ID.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.meetings.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.meetings.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.meetings.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.meetings.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().meetings().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().meetings().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Meetings.Batch.Delete(context.TODO(), crm.ObjectMeetingBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.meetings.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->meetings->batch->delete', + example: + "crm->objects->meetings->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/meetings/batch/read', + httpMethod: 'post', + summary: 'Read a batch of meetings by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.meetings.batch > (method) get', + qualified: 'client.crm.objects.meetings.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.meetings.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.meetings.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().meetings().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.Get(context.TODO(), crm.ObjectMeetingBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->batch->get', + example: + "crm->objects->meetings->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/meetings/batch/update', + httpMethod: 'post', + summary: 'Update a batch of meetings by internal ID, or unique property values', + description: + 'Update a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.meetings.batch > (method) update', + qualified: 'client.crm.objects.meetings.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.meetings.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/update`\n\nUpdate a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.meetings.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().meetings().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.Update(context.TODO(), crm.ObjectMeetingBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->meetings->batch->update', + example: + "crm\n ->objects\n ->meetings\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/meetings/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of meetings by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.meetings.batch > (method) upsert', + qualified: 'client.crm.objects.meetings.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.meetings.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.meetings.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.meetings.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.meetings.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.meetings.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.meetings.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().meetings().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().meetings().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Meetings.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Meetings.Batch.Upsert(context.TODO(), crm.ObjectMeetingBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.meetings.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.meetings.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->meetings->batch->upsert', + example: + "crm\n ->objects\n ->meetings\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/notes', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.', + stainlessPath: '(resource) crm.objects.notes > (method) create', + qualified: 'client.crm.objects.notes.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.notes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/notes`\n\nCreate a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.notes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.notes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.notes.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.notes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().notes().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().notes().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Notes.New(context.TODO(), crm.ObjectNoteNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.notes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->notes->create', + example: + "crm->objects->notes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/notes/{noteId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{noteId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.notes > (method) delete', + qualified: 'client.crm.objects.notes.delete', + params: ['noteId: string;'], + markdown: + "## delete\n\n`client.crm.objects.notes.delete(noteId: string): void`\n\n**delete** `/crm/objects/2026-03/notes/{noteId}`\n\nMove an Object identified by `{noteId}` to the recycling bin.\n\n### Parameters\n\n- `noteId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.notes.delete('noteId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.notes.delete('noteId');", + }, + python: { + method: 'crm.objects.notes.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.notes.delete(\n "noteId",\n)', + }, + java: { + method: 'crm().objects().notes().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().notes().delete("noteId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Notes.Delete(context.TODO(), "noteId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.notes.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.notes.delete("noteId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->notes->delete', + example: + "crm->objects->notes->delete('noteId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/notes/{noteId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.notes > (method) get', + qualified: 'client.crm.objects.notes.get', + params: [ + 'noteId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.notes.get(noteId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/notes/{noteId}`\n\nRead an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `noteId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.notes.get('noteId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.notes.get('noteId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.notes.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.notes.get(\n note_id="noteId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().notes().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().notes().get("noteId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Notes.Get(\n\t\tcontext.TODO(),\n\t\t"noteId",\n\t\tcrm.ObjectNoteGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.notes.get("noteId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->notes->get', + example: + "crm->objects->notes->get(\n 'noteId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/notes', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of notes. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.notes > (method) list', + qualified: 'client.crm.objects.notes.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.notes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/notes`\n\nRead a page of notes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.notes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.notes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.notes.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.notes.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().notes().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteListPage;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n NoteListPage page = client.crm().objects().notes().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Notes.List(context.TODO(), crm.ObjectNoteListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.notes.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->notes->list', + example: + "crm->objects->notes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/notes/search', + httpMethod: 'post', + summary: 'Search for notes based on specified criteria.', + description: + 'Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.', + stainlessPath: '(resource) crm.objects.notes > (method) search', + qualified: 'client.crm.objects.notes.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.notes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/notes/search`\n\nExecute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.notes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.notes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.notes.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.notes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().notes().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().notes().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Notes.Search(context.TODO(), crm.ObjectNoteSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.notes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->notes->search', + example: + "crm\n ->objects\n ->notes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/notes/{noteId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.notes > (method) update', + qualified: 'client.crm.objects.notes.update', + params: ['noteId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.notes.update(noteId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/notes/{noteId}`\n\nPerform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `noteId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.notes.update('noteId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.notes.update('noteId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.notes.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.notes.update(\n note_id="noteId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().notes().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n NoteUpdateParams params = NoteUpdateParams.builder()\n .noteId("noteId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().notes().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Notes.Update(\n\t\tcontext.TODO(),\n\t\t"noteId",\n\t\tcrm.ObjectNoteUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.notes.update("noteId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->notes->update', + example: + "crm->objects->notes->update(\n 'noteId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/notes/batch/create', + httpMethod: 'post', + summary: 'Create a batch of notes', + description: + 'Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.', + stainlessPath: '(resource) crm.objects.notes.batch > (method) create', + qualified: 'client.crm.objects.notes.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.notes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/create`\n\nCreate multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.notes.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().notes().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.New(context.TODO(), crm.ObjectNoteBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->notes->batch->create', + example: + "crm->objects->notes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/notes/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of notes by ID', + description: + 'Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.', + stainlessPath: '(resource) crm.objects.notes.batch > (method) delete', + qualified: 'client.crm.objects.notes.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.notes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/notes/batch/archive`\n\nArchive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.notes.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.notes.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.notes.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.notes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().notes().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().notes().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Notes.Batch.Delete(context.TODO(), crm.ObjectNoteBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.notes.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.notes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->notes->batch->delete', + example: + "crm->objects->notes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/notes/batch/read', + httpMethod: 'post', + summary: 'Read a batch of notes by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.notes.batch > (method) get', + qualified: 'client.crm.objects.notes.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.notes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.notes.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().notes().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.Get(context.TODO(), crm.ObjectNoteBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->notes->batch->get', + example: + "crm->objects->notes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/notes/batch/update', + httpMethod: 'post', + summary: 'Update a batch of notes by internal ID, or unique property values', + description: + 'Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.', + stainlessPath: '(resource) crm.objects.notes.batch > (method) update', + qualified: 'client.crm.objects.notes.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.notes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/update`\n\nUpdate multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.notes.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().notes().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.Update(context.TODO(), crm.ObjectNoteBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->notes->batch->update', + example: + "crm->objects->notes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/notes/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of notes by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.notes.batch > (method) upsert', + qualified: 'client.crm.objects.notes.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.notes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.notes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.notes.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.notes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.notes.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.notes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().notes().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().notes().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Notes.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Notes.Batch.Upsert(context.TODO(), crm.ObjectNoteBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.notes.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.notes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->notes->batch->upsert', + example: + "crm\n ->objects\n ->notes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/orders', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.', + stainlessPath: '(resource) crm.objects.orders > (method) create', + qualified: 'client.crm.objects.orders.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.orders.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/orders`\n\nCreate a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.orders.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.orders.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.orders.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.orders.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().orders().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().orders().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Orders.New(context.TODO(), crm.ObjectOrderNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.orders.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->orders->create', + example: + "crm->objects->orders->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/orders/{orderId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{orderId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.orders > (method) delete', + qualified: 'client.crm.objects.orders.delete', + params: ['orderId: string;'], + markdown: + "## delete\n\n`client.crm.objects.orders.delete(orderId: string): void`\n\n**delete** `/crm/objects/2026-03/orders/{orderId}`\n\nMove an Object identified by `{orderId}` to the recycling bin.\n\n### Parameters\n\n- `orderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.orders.delete('orderId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.orders.delete('orderId');", + }, + python: { + method: 'crm.objects.orders.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.orders.delete(\n "orderId",\n)', + }, + java: { + method: 'crm().objects().orders().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().orders().delete("orderId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Orders.Delete(context.TODO(), "orderId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.orders.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.orders.delete("orderId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->orders->delete', + example: + "crm->objects->orders->delete('orderId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/orders/{orderId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.orders > (method) get', + qualified: 'client.crm.objects.orders.get', + params: [ + 'orderId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.orders.get(orderId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/orders/{orderId}`\n\nRead an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `orderId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.orders.get('orderId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.orders.get('orderId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.orders.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.orders.get(\n order_id="orderId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().orders().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().orders().get("orderId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Orders.Get(\n\t\tcontext.TODO(),\n\t\t"orderId",\n\t\tcrm.ObjectOrderGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.orders.get("orderId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->orders->get', + example: + "crm->objects->orders->get(\n 'orderId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/orders', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of orders. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.orders > (method) list', + qualified: 'client.crm.objects.orders.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.orders.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/orders`\n\nRead a page of orders. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.orders.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.orders.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.orders.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.orders.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().orders().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderListPage;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OrderListPage page = client.crm().objects().orders().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Orders.List(context.TODO(), crm.ObjectOrderListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.orders.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->orders->list', + example: + "crm->objects->orders->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/orders/search', + httpMethod: 'post', + summary: + 'Search for orders in the CRM using various filters and sorting options to retrieve specific order data.', + description: 'Execute a search for orders using specified criteria and return matching results.', + stainlessPath: '(resource) crm.objects.orders > (method) search', + qualified: 'client.crm.objects.orders.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.orders.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/orders/search`\n\nExecute a search for orders using specified criteria and return matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.orders.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.orders.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.orders.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.orders.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().orders().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().orders().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Orders.Search(context.TODO(), crm.ObjectOrderSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.orders.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->orders->search', + example: + "crm\n ->objects\n ->orders\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/orders/{orderId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.orders > (method) update', + qualified: 'client.crm.objects.orders.update', + params: ['orderId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.orders.update(orderId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/orders/{orderId}`\n\nPerform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `orderId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.orders.update('orderId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.orders.update('orderId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.orders.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.orders.update(\n order_id="orderId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().orders().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OrderUpdateParams params = OrderUpdateParams.builder()\n .orderId("orderId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().orders().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Orders.Update(\n\t\tcontext.TODO(),\n\t\t"orderId",\n\t\tcrm.ObjectOrderUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.orders.update("orderId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->orders->update', + example: + "crm->objects->orders->update(\n 'orderId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/orders/batch/create', + httpMethod: 'post', + summary: 'Create a batch of orders', + description: 'Create a batch of orders in the system.', + stainlessPath: '(resource) crm.objects.orders.batch > (method) create', + qualified: 'client.crm.objects.orders.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.orders.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/create`\n\nCreate a batch of orders in the system.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.orders.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().orders().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.New(context.TODO(), crm.ObjectOrderBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->orders->batch->create', + example: + "crm->objects->orders->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/orders/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of orders by ID', + description: 'Archive a batch of orders identified by their IDs.', + stainlessPath: '(resource) crm.objects.orders.batch > (method) delete', + qualified: 'client.crm.objects.orders.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.orders.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/orders/batch/archive`\n\nArchive a batch of orders identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.orders.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.orders.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.orders.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.orders.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().orders().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().orders().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Orders.Batch.Delete(context.TODO(), crm.ObjectOrderBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.orders.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.orders.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->orders->batch->delete', + example: + "crm->objects->orders->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/orders/batch/read', + httpMethod: 'post', + summary: 'Read a batch of orders by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.orders.batch > (method) get', + qualified: 'client.crm.objects.orders.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.orders.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.orders.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().orders().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.Get(context.TODO(), crm.ObjectOrderBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->orders->batch->get', + example: + "crm->objects->orders->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/orders/batch/update', + httpMethod: 'post', + summary: 'Update a batch of orders by internal ID, or unique property values', + description: 'Update a batch of orders using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.orders.batch > (method) update', + qualified: 'client.crm.objects.orders.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.orders.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/update`\n\nUpdate a batch of orders using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.orders.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().orders().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.Update(context.TODO(), crm.ObjectOrderBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->orders->batch->update', + example: + "crm->objects->orders->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/orders/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of orders by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.orders.batch > (method) upsert', + qualified: 'client.crm.objects.orders.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.orders.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.orders.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.orders.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.orders.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.orders.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.orders.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().orders().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().orders().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Orders.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Orders.Batch.Upsert(context.TODO(), crm.ObjectOrderBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.orders.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.orders.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->orders->batch->upsert', + example: + "crm\n ->objects\n ->orders\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}', + httpMethod: 'get', + summary: 'Retrieve details of a specific partner client.', + description: + 'Retrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes.', + stainlessPath: '(resource) crm.objects.partner_clients > (method) get', + qualified: 'client.crm.objects.partnerClients.get', + params: [ + 'partnerClientId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.partnerClients.get(partnerClientId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients/{partnerClientId}`\n\nRetrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerClients.get('partnerClientId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerClients.get(\n 'partnerClientId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.partner_clients.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.partner_clients.get(\n partner_client_id="partnerClientId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().partnerClients().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().partnerClients().get("partnerClientId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PartnerClients.Get(\n\t\tcontext.TODO(),\n\t\t"partnerClientId",\n\t\tcrm.ObjectPartnerClientGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.partner_clients.get("partnerClientId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->partnerClients->get', + example: + "crm\n ->objects\n ->partnerClients\n ->get(\n 'partnerClientId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/partner_clients', + httpMethod: 'get', + summary: 'Retrieve a list of partner clients.', + description: + "Retrieve a list of partner clients with optional filtering by deleted status, associations, and specific properties. The response can be paginated using the 'after' parameter.", + stainlessPath: '(resource) crm.objects.partner_clients > (method) list', + qualified: 'client.crm.objects.partnerClients.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.partnerClients.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients`\n\nRetrieve a list of partner clients with optional filtering by deleted status, associations, and specific properties. The response can be paginated using the 'after' parameter.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.partnerClients.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.partnerClients.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.partner_clients.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_clients.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().partnerClients().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListPage;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientListPage page = client.crm().objects().partnerClients().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerClients.List(context.TODO(), crm.ObjectPartnerClientListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_clients.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->partnerClients->list', + example: + "crm->objects->partnerClients->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_associations', + endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}', + httpMethod: 'get', + summary: 'List associations of a partner client by type', + description: + 'Retrieve a list of associations for a specific partner client based on the specified object type.', + stainlessPath: '(resource) crm.objects.partner_clients > (method) list_associations', + qualified: 'client.crm.objects.partnerClients.listAssociations', + params: ['partnerClientId: string;', 'toObjectType: string;', 'after?: string;', 'limit?: number;'], + response: + "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", + markdown: + "## list_associations\n\n`client.crm.objects.partnerClients.listAssociations(partnerClientId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}`\n\nRetrieve a list of associations for a specific partner client based on the specified object type.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerClients.listAssociations('toObjectType', { partnerClientId: 'partnerClientId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.listAssociations', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerClients.listAssociations(\n 'toObjectType',\n { partnerClientId: 'partnerClientId' },\n)) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", + }, + python: { + method: 'crm.objects.partner_clients.list_associations', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_clients.list_associations(\n to_object_type="toObjectType",\n partner_client_id="partnerClientId",\n)\npage = page.results[0]\nprint(page.association_types)', + }, + java: { + method: 'crm().objects().partnerClients().listAssociations', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListAssociationsPage;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListAssociationsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientListAssociationsParams params = PartnerClientListAssociationsParams.builder()\n .partnerClientId("partnerClientId")\n .toObjectType("toObjectType")\n .build();\n PartnerClientListAssociationsPage page = client.crm().objects().partnerClients().listAssociations(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.ListAssociations', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerClients.ListAssociations(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.ObjectPartnerClientListAssociationsParams{\n\t\t\tPartnerClientID: "partnerClientId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.list_associations', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_clients.list_associations(\n "toObjectType",\n partner_client_id: "partnerClientId"\n)\n\nputs(page)', + }, + php: { + method: 'crm->objects->partnerClients->listAssociations', + example: + "crm->objects->partnerClients->listAssociations(\n 'toObjectType', partnerClientID: 'partnerClientId', after: 'after', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/partner_clients/search', + httpMethod: 'post', + summary: 'Search for partner clients using specified criteria.', + description: + 'Execute a search for partner clients based on defined filters, properties, and sorting options. This endpoint allows you to retrieve partner client data that matches the search criteria, facilitating integration and data synchronization with third-party systems.', + stainlessPath: '(resource) crm.objects.partner_clients > (method) search', + qualified: 'client.crm.objects.partnerClients.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.partnerClients.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/partner_clients/search`\n\nExecute a search for partner clients based on defined filters, properties, and sorting options. This endpoint allows you to retrieve partner client data that matches the search criteria, facilitating integration and data synchronization with third-party systems.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.partnerClients.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.partnerClients.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.partner_clients.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.partner_clients.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().partnerClients().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().partnerClients().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PartnerClients.Search(context.TODO(), crm.ObjectPartnerClientSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.partner_clients.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerClients->search', + example: + "crm\n ->objects\n ->partnerClients\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}', + httpMethod: 'patch', + summary: 'Update properties of a specific partner client.', + description: 'Update the specified properties of an existing partner client.', + stainlessPath: '(resource) crm.objects.partner_clients > (method) update', + qualified: 'client.crm.objects.partnerClients.update', + params: ['partnerClientId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.partnerClients.update(partnerClientId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/partner_clients/{partnerClientId}`\n\nUpdate the specified properties of an existing partner client.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.partnerClients.update('partnerClientId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.partnerClients.update('partnerClientId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.partner_clients.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.partner_clients.update(\n partner_client_id="partnerClientId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().partnerClients().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientUpdateParams params = PartnerClientUpdateParams.builder()\n .partnerClientId("partnerClientId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().partnerClients().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PartnerClients.Update(\n\t\tcontext.TODO(),\n\t\t"partnerClientId",\n\t\tcrm.ObjectPartnerClientUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.partner_clients.update("partnerClientId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->partnerClients->update', + example: + "crm->objects->partnerClients->update(\n 'partnerClientId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/partner_clients/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of partner client objects.', + description: + 'Retrieve multiple partner client objects in a single request by specifying their IDs. This endpoint is useful for efficiently accessing data for multiple clients at once, particularly when integrating with third-party systems.', + stainlessPath: '(resource) crm.objects.partner_clients.batch > (method) get', + qualified: 'client.crm.objects.partnerClients.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.partnerClients.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_clients/batch/read`\n\nRetrieve multiple partner client objects in a single request by specifying their IDs. This endpoint is useful for efficiently accessing data for multiple clients at once, particularly when integrating with third-party systems.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.partner_clients.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_clients.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().partnerClients().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerClients().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerClients.Batch.Get(context.TODO(), crm.ObjectPartnerClientBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_clients.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerClients->batch->get', + example: + "crm\n ->objects\n ->partnerClients\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/partner_clients/batch/update', + httpMethod: 'post', + summary: 'Update multiple partner client records in a single request.', + description: + 'This endpoint allows you to update several partner client records at once by providing a batch of CRM object records with their respective IDs and properties. It is useful for synchronizing data across systems or making bulk updates efficiently.', + stainlessPath: '(resource) crm.objects.partner_clients.batch > (method) update', + qualified: 'client.crm.objects.partnerClients.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.partnerClients.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_clients/batch/update`\n\nThis endpoint allows you to update several partner client records at once by providing a batch of CRM object records with their respective IDs and properties. It is useful for synchronizing data across systems or making bulk updates efficiently.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerClients.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.partner_clients.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_clients.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().partnerClients().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerClients().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerClients.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerClients.Batch.Update(context.TODO(), crm.ObjectPartnerClientBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_clients.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_clients.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerClients->batch->update', + example: + "crm\n ->objects\n ->partnerClients\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{partnerServiceId}`. `{partnerServiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.partner_services > (method) get', + qualified: 'client.crm.objects.partnerServices.get', + params: [ + 'partnerServiceId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.partnerServices.get(partnerServiceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_services/{partnerServiceId}`\n\nRead an Object identified by `{partnerServiceId}`. `{partnerServiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerServices.get('partnerServiceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerServices.get(\n 'partnerServiceId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.partner_services.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.partner_services.get(\n partner_service_id="partnerServiceId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().partnerServices().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().partnerServices().get("partnerServiceId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PartnerServices.Get(\n\t\tcontext.TODO(),\n\t\t"partnerServiceId",\n\t\tcrm.ObjectPartnerServiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.partner_services.get("partnerServiceId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->partnerServices->get', + example: + "crm\n ->objects\n ->partnerServices\n ->get(\n 'partnerServiceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}', + httpMethod: 'get', + summary: 'List associations of a partner service by type', + description: + 'Retrieve a list of associations for a specific partner service, filtered by the type of associated object.', + stainlessPath: '(resource) crm.objects.partner_services > (method) list', + qualified: 'client.crm.objects.partnerServices.list', + params: ['partnerServiceId: string;', 'toObjectType: string;', 'after?: string;', 'limit?: number;'], + response: + "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", + markdown: + "## list\n\n`client.crm.objects.partnerServices.list(partnerServiceId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}`\n\nRetrieve a list of associations for a specific partner service, filtered by the type of associated object.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerServices.list('toObjectType', { partnerServiceId: 'partnerServiceId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerServices.list(\n 'toObjectType',\n { partnerServiceId: 'partnerServiceId' },\n)) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", + }, + python: { + method: 'crm.objects.partner_services.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_services.list(\n to_object_type="toObjectType",\n partner_service_id="partnerServiceId",\n)\npage = page.results[0]\nprint(page.association_types)', + }, + java: { + method: 'crm().objects().partnerServices().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceListPage;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerServiceListParams params = PartnerServiceListParams.builder()\n .partnerServiceId("partnerServiceId")\n .toObjectType("toObjectType")\n .build();\n PartnerServiceListPage page = client.crm().objects().partnerServices().list(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerServices.List(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.ObjectPartnerServiceListParams{\n\t\t\tPartnerServiceID: "partnerServiceId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_services.list("toObjectType", partner_service_id: "partnerServiceId")\n\nputs(page)', + }, + php: { + method: 'crm->objects->partnerServices->list', + example: + "crm->objects->partnerServices->list(\n 'toObjectType', partnerServiceID: 'partnerServiceId', after: 'after', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/partner_services/search', + httpMethod: 'post', + summary: 'Search for partner services using specified criteria.', + description: + 'Execute a search query to find partner services based on defined filters, properties, and sorting options. This endpoint allows you to retrieve a collection of partner services that match the specified search criteria.', + stainlessPath: '(resource) crm.objects.partner_services > (method) search', + qualified: 'client.crm.objects.partnerServices.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.partnerServices.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/partner_services/search`\n\nExecute a search query to find partner services based on defined filters, properties, and sorting options. This endpoint allows you to retrieve a collection of partner services that match the specified search criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.partnerServices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.partnerServices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.partner_services.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.partner_services.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().partnerServices().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().partnerServices().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PartnerServices.Search(context.TODO(), crm.ObjectPartnerServiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.partner_services.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerServices->search', + example: + "crm\n ->objects\n ->partnerServices\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.partner_services > (method) update', + qualified: 'client.crm.objects.partnerServices.update', + params: ['partnerServiceId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.partnerServices.update(partnerServiceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/partner_services/{partnerServiceId}`\n\nPerform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.partnerServices.update('partnerServiceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.partnerServices.update('partnerServiceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.partner_services.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.partner_services.update(\n partner_service_id="partnerServiceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().partnerServices().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerServiceUpdateParams params = PartnerServiceUpdateParams.builder()\n .partnerServiceId("partnerServiceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().partnerServices().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PartnerServices.Update(\n\t\tcontext.TODO(),\n\t\t"partnerServiceId",\n\t\tcrm.ObjectPartnerServiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.partner_services.update("partnerServiceId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->partnerServices->update', + example: + "crm->objects->partnerServices->update(\n 'partnerServiceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/partner_services/batch/read', + httpMethod: 'post', + summary: 'Read a batch of partner services by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.partner_services.batch > (method) get', + qualified: 'client.crm.objects.partnerServices.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.partnerServices.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_services/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.partner_services.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_services.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().partnerServices().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerServices().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerServices.Batch.Get(context.TODO(), crm.ObjectPartnerServiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_services.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerServices->batch->get', + example: + "crm\n ->objects\n ->partnerServices\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/partner_services/batch/update', + httpMethod: 'post', + summary: 'Update a batch of partner services by internal ID, or unique property values', + description: + 'Update multiple partner services using their internal IDs or unique property values. This operation allows for batch processing of updates, ensuring efficient synchronization of service data between HubSpot and other systems.', + stainlessPath: '(resource) crm.objects.partner_services.batch > (method) update', + qualified: 'client.crm.objects.partnerServices.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.partnerServices.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_services/batch/update`\n\nUpdate multiple partner services using their internal IDs or unique property values. This operation allows for batch processing of updates, ensuring efficient synchronization of service data between HubSpot and other systems.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.partnerServices.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.partner_services.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_services.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().partnerServices().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerServices().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PartnerServices.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerServices.Batch.Update(context.TODO(), crm.ObjectPartnerServiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.partner_services.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_services.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->partnerServices->batch->update', + example: + "crm\n ->objects\n ->partnerServices\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/postal_mail', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a postal mail object with the given properties and return a copy of the object, including the ID. ', + stainlessPath: '(resource) crm.objects.postal_mail > (method) create', + qualified: 'client.crm.objects.postalMail.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.postalMail.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail`\n\nCreate a postal mail object with the given properties and return a copy of the object, including the ID. \n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.postalMail.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.postalMail.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.postal_mail.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.postal_mail.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().postalMail().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().postalMail().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PostalMail.New(context.TODO(), crm.ObjectPostalMailNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.postal_mail.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->create', + example: + "crm->objects->postalMail->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move the postal mail object with the ID `{postalMailId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.postal_mail > (method) delete', + qualified: 'client.crm.objects.postalMail.delete', + params: ['postalMailId: string;'], + markdown: + "## delete\n\n`client.crm.objects.postalMail.delete(postalMailId: string): void`\n\n**delete** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\nMove the postal mail object with the ID `{postalMailId}` to the recycling bin.\n\n### Parameters\n\n- `postalMailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.postalMail.delete('postalMailId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.postalMail.delete('postalMailId');", + }, + python: { + method: 'crm.objects.postal_mail.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.postal_mail.delete(\n "postalMailId",\n)', + }, + java: { + method: 'crm().objects().postalMail().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().postalMail().delete("postalMailId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.PostalMail.Delete(context.TODO(), "postalMailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.postal_mail.delete("postalMailId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->postalMail->delete', + example: + "crm->objects->postalMail->delete('postalMailId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.postal_mail > (method) get', + qualified: 'client.crm.objects.postalMail.get', + params: [ + 'postalMailId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.postalMail.get(postalMailId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\n### Parameters\n\n- `postalMailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.postalMail.get('postalMailId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.postalMail.get('postalMailId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.postal_mail.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.postal_mail.get(\n postal_mail_id="postalMailId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().postalMail().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().postalMail().get("postalMailId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PostalMail.Get(\n\t\tcontext.TODO(),\n\t\t"postalMailId",\n\t\tcrm.ObjectPostalMailGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.postal_mail.get("postalMailId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->postalMail->get', + example: + "crm->objects->postalMail->get(\n 'postalMailId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/postal_mail', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.postal_mail > (method) list', + qualified: 'client.crm.objects.postalMail.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.postalMail.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/postal_mail`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.postalMail.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.postalMail.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.postal_mail.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.postal_mail.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().postalMail().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailListPage;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostalMailListPage page = client.crm().objects().postalMail().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PostalMail.List(context.TODO(), crm.ObjectPostalMailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.postal_mail.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->postalMail->list', + example: + "crm->objects->postalMail->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/postal_mail/search', + httpMethod: 'post', + summary: 'Search', + description: 'Search for postal mail objects using specific criteria in the request.', + stainlessPath: '(resource) crm.objects.postal_mail > (method) search', + qualified: 'client.crm.objects.postalMail.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.postalMail.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/postal_mail/search`\n\nSearch for postal mail objects using specific criteria in the request.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.postalMail.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.postalMail.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.postal_mail.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.postal_mail.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().postalMail().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().postalMail().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PostalMail.Search(context.TODO(), crm.ObjectPostalMailSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.postal_mail.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->search', + example: + "crm\n ->objects\n ->postalMail\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', + httpMethod: 'patch', + summary: '', + description: '', + stainlessPath: '(resource) crm.objects.postal_mail > (method) update', + qualified: 'client.crm.objects.postalMail.update', + params: ['postalMailId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.postalMail.update(postalMailId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\n### Parameters\n\n- `postalMailId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.postalMail.update('postalMailId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.postalMail.update('postalMailId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.postal_mail.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.postal_mail.update(\n postal_mail_id="postalMailId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().postalMail().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostalMailUpdateParams params = PostalMailUpdateParams.builder()\n .postalMailId("postalMailId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().postalMail().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PostalMail.Update(\n\t\tcontext.TODO(),\n\t\t"postalMailId",\n\t\tcrm.ObjectPostalMailUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.postal_mail.update("postalMailId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->update', + example: + "crm->objects->postalMail->update(\n 'postalMailId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/postal_mail/batch/create', + httpMethod: 'post', + summary: 'Batch create', + description: 'Create a batch of postal mail objects.', + stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) create', + qualified: 'client.crm.objects.postalMail.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.postalMail.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/create`\n\nCreate a batch of postal mail objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.postal_mail.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().postalMail().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.New(context.TODO(), crm.ObjectPostalMailBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->batch->create', + example: + "crm\n ->objects\n ->postalMail\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/postal_mail/batch/archive', + httpMethod: 'post', + summary: 'Batch archive', + description: 'Archive a batch of postal mail objects using their IDs.', + stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) delete', + qualified: 'client.crm.objects.postalMail.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.postalMail.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/archive`\n\nArchive a batch of postal mail objects using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.postalMail.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.postalMail.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.postal_mail.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.postal_mail.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().postalMail().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().postalMail().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.PostalMail.Batch.Delete(context.TODO(), crm.ObjectPostalMailBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.postal_mail.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->postalMail->batch->delete', + example: + "crm->objects->postalMail->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/postal_mail/batch/read', + httpMethod: 'post', + summary: '', + description: 'Retrieve multiple postal mail objects using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) get', + qualified: 'client.crm.objects.postalMail.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.postalMail.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/read`\n\nRetrieve multiple postal mail objects using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.postal_mail.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().postalMail().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.Get(context.TODO(), crm.ObjectPostalMailBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->batch->get', + example: + "crm\n ->objects\n ->postalMail\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/postal_mail/batch/update', + httpMethod: 'post', + summary: '', + description: 'Update multiple postal mail objects in a single request.', + stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) update', + qualified: 'client.crm.objects.postalMail.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.postalMail.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/update`\n\nUpdate multiple postal mail objects in a single request.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.postal_mail.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().postalMail().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.Update(context.TODO(), crm.ObjectPostalMailBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->postalMail->batch->update', + example: + "crm\n ->objects\n ->postalMail\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/postal_mail/batch/upsert', + httpMethod: 'post', + summary: 'Batch upsert', + description: + 'Create or update postal mails identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) upsert', + qualified: 'client.crm.objects.postalMail.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.postalMail.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/upsert`\n\nCreate or update postal mails identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.postalMail.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.postalMail.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.postalMail.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.postal_mail.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.postal_mail.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().postalMail().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().postalMail().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.PostalMail.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.PostalMail.Batch.Upsert(context.TODO(), crm.ObjectPostalMailBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.postal_mail.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.postal_mail.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->postalMail->batch->upsert', + example: + "crm\n ->objects\n ->postalMail\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/products', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.', + stainlessPath: '(resource) crm.objects.products > (method) create', + qualified: 'client.crm.objects.products.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.products.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/products`\n\nCreate a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.products.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.products.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.products.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.products.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().products().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().products().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Products.New(context.TODO(), crm.ObjectProductNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.products.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.products.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->products->create', + example: + "crm->objects->products->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/products/{productId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{productId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.products > (method) delete', + qualified: 'client.crm.objects.products.delete', + params: ['productId: string;'], + markdown: + "## delete\n\n`client.crm.objects.products.delete(productId: string): void`\n\n**delete** `/crm/objects/2026-03/products/{productId}`\n\nMove an Object identified by `{productId}` to the recycling bin.\n\n### Parameters\n\n- `productId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.products.delete('productId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.products.delete('productId');", + }, + python: { + method: 'crm.objects.products.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.products.delete(\n "productId",\n)', + }, + java: { + method: 'crm().objects().products().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.products.ProductDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().products().delete("productId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Products.Delete(context.TODO(), "productId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.products.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.products.delete("productId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->products->delete', + example: + "crm->objects->products->delete('productId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/products/{productId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.products > (method) get', + qualified: 'client.crm.objects.products.get', + params: [ + 'productId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.products.get(productId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/products/{productId}`\n\nRead an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `productId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.products.get('productId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.products.get('productId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.products.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.products.get(\n product_id="productId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().products().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.products.ProductGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().products().get("productId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Products.Get(\n\t\tcontext.TODO(),\n\t\t"productId",\n\t\tcrm.ObjectProductGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.products.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.products.get("productId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->products->get', + example: + "crm->objects->products->get(\n 'productId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/products', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of products. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.products > (method) list', + qualified: 'client.crm.objects.products.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.products.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/products`\n\nRead a page of products. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.products.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.products.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.products.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.products.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().products().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.products.ProductListPage;\nimport com.hubspot.sdk.models.crm.objects.products.ProductListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProductListPage page = client.crm().objects().products().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Products.List(context.TODO(), crm.ObjectProductListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.products.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.products.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->products->list', + example: + "crm->objects->products->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/products/search', + httpMethod: 'post', + summary: 'Search for products using specified criteria.', + description: + 'Execute a search for products based on defined filters, properties, and sorting options. This endpoint allows for detailed querying of product data within the CRM, enabling users to retrieve specific product information by applying multiple filter groups and sorting criteria.', + stainlessPath: '(resource) crm.objects.products > (method) search', + qualified: 'client.crm.objects.products.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.products.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/products/search`\n\nExecute a search for products based on defined filters, properties, and sorting options. This endpoint allows for detailed querying of product data within the CRM, enabling users to retrieve specific product information by applying multiple filter groups and sorting criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.products.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.products.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.products.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.products.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().products().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().products().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Products.Search(context.TODO(), crm.ObjectProductSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.products.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.products.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->products->search', + example: + "crm\n ->objects\n ->products\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/products/{productId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.products > (method) update', + qualified: 'client.crm.objects.products.update', + params: ['productId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.products.update(productId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/products/{productId}`\n\nPerform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `productId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.products.update('productId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.products.update('productId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.products.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.products.update(\n product_id="productId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().products().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.products.ProductUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProductUpdateParams params = ProductUpdateParams.builder()\n .productId("productId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().products().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Products.Update(\n\t\tcontext.TODO(),\n\t\t"productId",\n\t\tcrm.ObjectProductUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.products.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.products.update("productId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->products->update', + example: + "crm->objects->products->update(\n 'productId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/products/batch/create', + httpMethod: 'post', + summary: 'Create a batch of products', + description: + 'Create multiple products in a single request by specifying their properties, and receive a response containing the details of the created products.', + stainlessPath: '(resource) crm.objects.products.batch > (method) create', + qualified: 'client.crm.objects.products.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.products.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/create`\n\nCreate multiple products in a single request by specifying their properties, and receive a response containing the details of the created products.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.products.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().products().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.New(context.TODO(), crm.ObjectProductBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.products.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->products->batch->create', + example: + "crm\n ->objects\n ->products\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/products/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of products by ID', + description: + 'Archive multiple products at once by providing their IDs. This operation moves the specified products to the recycling bin, effectively removing them from active use without permanently deleting them.', + stainlessPath: '(resource) crm.objects.products.batch > (method) delete', + qualified: 'client.crm.objects.products.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.products.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/products/batch/archive`\n\nArchive multiple products at once by providing their IDs. This operation moves the specified products to the recycling bin, effectively removing them from active use without permanently deleting them.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.products.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.products.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.products.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.products.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().products().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().products().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Products.Batch.Delete(context.TODO(), crm.ObjectProductBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.products.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.products.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->products->batch->delete', + example: + "crm->objects->products->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/products/batch/read', + httpMethod: 'post', + summary: 'Read a batch of products by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.products.batch > (method) get', + qualified: 'client.crm.objects.products.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.products.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.products.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().products().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.Get(context.TODO(), crm.ObjectProductBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.products.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->products->batch->get', + example: + "crm->objects->products->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/products/batch/update', + httpMethod: 'post', + summary: 'Update a batch of products by internal ID, or unique property values', + description: + 'Update multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error.', + stainlessPath: '(resource) crm.objects.products.batch > (method) update', + qualified: 'client.crm.objects.products.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.products.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/update`\n\nUpdate multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.products.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().products().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.Update(context.TODO(), crm.ObjectProductBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.products.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->products->batch->update', + example: + "crm\n ->objects\n ->products\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/products/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of products by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.products.batch > (method) upsert', + qualified: 'client.crm.objects.products.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.products.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.products.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.products.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.products.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.products.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.products.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().products().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().products().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Products.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Products.Batch.Upsert(context.TODO(), crm.ObjectProductBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.products.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.products.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->products->batch->upsert', + example: + "crm\n ->objects\n ->products\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/projects', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a project with the given properties and return a copy of the object, including the ID.', + stainlessPath: '(resource) crm.objects.projects > (method) create', + qualified: 'client.crm.objects.projects.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.projects.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/projects`\n\nCreate a project with the given properties and return a copy of the object, including the ID.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.projects.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().projects().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.New(context.TODO(), crm.ObjectProjectNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->projects->create', + example: + "crm->objects->projects->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/projects/{projectId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{projectId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.projects > (method) delete', + qualified: 'client.crm.objects.projects.delete', + params: ['projectId: string;'], + markdown: + "## delete\n\n`client.crm.objects.projects.delete(projectId: string): void`\n\n**delete** `/crm/objects/2026-03/projects/{projectId}`\n\nMove an Object identified by `{projectId}` to the recycling bin.\n\n### Parameters\n\n- `projectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.projects.delete('projectId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.projects.delete('projectId');", + }, + python: { + method: 'crm.objects.projects.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.projects.delete(\n "projectId",\n)', + }, + java: { + method: 'crm().objects().projects().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().projects().delete("projectId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Projects.Delete(context.TODO(), "projectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.projects.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.projects.delete("projectId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->projects->delete', + example: + "crm->objects->projects->delete('projectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/projects/{projectId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.projects > (method) get', + qualified: 'client.crm.objects.projects.get', + params: [ + 'projectId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.projects.get(projectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/projects/{projectId}`\n\nRead an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `projectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.projects.get('projectId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.projects.get('projectId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.projects.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.projects.get(\n project_id="projectId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().projects().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().projects().get("projectId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Projects.Get(\n\t\tcontext.TODO(),\n\t\t"projectId",\n\t\tcrm.ObjectProjectGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.projects.get("projectId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->projects->get', + example: + "crm->objects->projects->get(\n 'projectId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/projects', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of projects. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.projects > (method) list', + qualified: 'client.crm.objects.projects.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.projects.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/projects`\n\nRead a page of projects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.projects.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.projects.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.projects.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.projects.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().projects().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectListPage;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProjectListPage page = client.crm().objects().projects().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Projects.List(context.TODO(), crm.ObjectProjectListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.projects.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->projects->list', + example: + "crm->objects->projects->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/projects/merge', + httpMethod: 'post', + summary: 'Merge two projects', + description: + 'Merge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).', + stainlessPath: '(resource) crm.objects.projects > (method) merge', + qualified: 'client.crm.objects.projects.merge', + params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.projects.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/projects/merge`\n\nMerge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.projects.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().projects().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.Merge(context.TODO(), crm.ObjectProjectMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->projects->merge', + example: + "crm->objects->projects->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/projects/search', + httpMethod: 'post', + summary: 'Search for projects', + description: + 'Search for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.projects > (method) search', + qualified: 'client.crm.objects.projects.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.projects.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/projects/search`\n\nSearch for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.projects.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.projects.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.projects.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.projects.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().projects().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().projects().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Projects.Search(context.TODO(), crm.ObjectProjectSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.projects.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->projects->search', + example: + "crm\n ->objects\n ->projects\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/projects/{projectId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.projects > (method) update', + qualified: 'client.crm.objects.projects.update', + params: ['projectId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.projects.update(projectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/projects/{projectId}`\n\nPerform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `projectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.update('projectId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.update('projectId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.projects.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.update(\n project_id="projectId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().projects().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProjectUpdateParams params = ProjectUpdateParams.builder()\n .projectId("projectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.Update(\n\t\tcontext.TODO(),\n\t\t"projectId",\n\t\tcrm.ObjectProjectUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.update("projectId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->projects->update', + example: + "crm->objects->projects->update(\n 'projectId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/projects/batch/create', + httpMethod: 'post', + summary: 'Create a batch of projects', + description: 'Create multiple projects in a single request.', + stainlessPath: '(resource) crm.objects.projects.batch > (method) create', + qualified: 'client.crm.objects.projects.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.projects.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/create`\n\nCreate multiple projects in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.projects.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().projects().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.New(context.TODO(), crm.ObjectProjectBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->projects->batch->create', + example: + "crm\n ->objects\n ->projects\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/projects/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of projects', + description: 'Archive multiple projects using their IDs.', + stainlessPath: '(resource) crm.objects.projects.batch > (method) delete', + qualified: 'client.crm.objects.projects.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.projects.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/projects/batch/archive`\n\nArchive multiple projects using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.projects.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.projects.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.projects.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.projects.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().projects().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().projects().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Projects.Batch.Delete(context.TODO(), crm.ObjectProjectBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.projects.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.projects.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->projects->batch->delete', + example: + "crm->objects->projects->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/projects/batch/read', + httpMethod: 'post', + summary: 'Read a batch of projects', + description: + 'Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.', + stainlessPath: '(resource) crm.objects.projects.batch > (method) get', + qualified: 'client.crm.objects.projects.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.projects.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/read`\n\nRetrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.projects.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().projects().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.Get(context.TODO(), crm.ObjectProjectBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->projects->batch->get', + example: + "crm->objects->projects->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/projects/batch/update', + httpMethod: 'post', + summary: 'Update a batch of projects', + description: 'Update multiple projects using their internal IDs or unique property values.', + stainlessPath: '(resource) crm.objects.projects.batch > (method) update', + qualified: 'client.crm.objects.projects.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.projects.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/update`\n\nUpdate multiple projects using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.projects.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().projects().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.Update(context.TODO(), crm.ObjectProjectBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->projects->batch->update', + example: + "crm\n ->objects\n ->projects\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/projects/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of projects', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.projects.batch > (method) upsert', + qualified: 'client.crm.objects.projects.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.projects.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.projects.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.projects.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.projects.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.projects.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.projects.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().projects().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().projects().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Projects.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Projects.Batch.Upsert(context.TODO(), crm.ObjectProjectBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.projects.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.projects.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->projects->batch->upsert', + example: + "crm\n ->objects\n ->projects\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/quotes', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.', + stainlessPath: '(resource) crm.objects.quotes > (method) create', + qualified: 'client.crm.objects.quotes.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.quotes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/quotes`\n\nCreate a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.quotes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.quotes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.quotes.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.quotes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().quotes().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().quotes().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Quotes.New(context.TODO(), crm.ObjectQuoteNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.quotes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->create', + example: + "crm->objects->quotes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/quotes/{quoteId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{quoteId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.quotes > (method) delete', + qualified: 'client.crm.objects.quotes.delete', + params: ['quoteId: string;'], + markdown: + "## delete\n\n`client.crm.objects.quotes.delete(quoteId: string): void`\n\n**delete** `/crm/objects/2026-03/quotes/{quoteId}`\n\nMove an Object identified by `{quoteId}` to the recycling bin.\n\n### Parameters\n\n- `quoteId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.quotes.delete('quoteId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.quotes.delete('quoteId');", + }, + python: { + method: 'crm.objects.quotes.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.quotes.delete(\n "quoteId",\n)', + }, + java: { + method: 'crm().objects().quotes().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().quotes().delete("quoteId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Quotes.Delete(context.TODO(), "quoteId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.quotes.delete("quoteId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->quotes->delete', + example: + "crm->objects->quotes->delete('quoteId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/quotes/{quoteId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.quotes > (method) get', + qualified: 'client.crm.objects.quotes.get', + params: [ + 'quoteId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.quotes.get(quoteId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/quotes/{quoteId}`\n\nRead an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `quoteId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.quotes.get('quoteId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.quotes.get('quoteId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.quotes.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.quotes.get(\n quote_id="quoteId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().quotes().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().quotes().get("quoteId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Quotes.Get(\n\t\tcontext.TODO(),\n\t\t"quoteId",\n\t\tcrm.ObjectQuoteGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.quotes.get("quoteId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->quotes->get', + example: + "crm->objects->quotes->get(\n 'quoteId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/quotes', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of quotes. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.quotes > (method) list', + qualified: 'client.crm.objects.quotes.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.quotes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/quotes`\n\nRead a page of quotes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.quotes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.quotes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.quotes.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.quotes.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().quotes().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteListPage;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n QuoteListPage page = client.crm().objects().quotes().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Quotes.List(context.TODO(), crm.ObjectQuoteListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.quotes.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->quotes->list', + example: + "crm->objects->quotes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/quotes/search', + httpMethod: 'post', + summary: 'Search for quotes using specified criteria.', + description: + 'Execute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets.', + stainlessPath: '(resource) crm.objects.quotes > (method) search', + qualified: 'client.crm.objects.quotes.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.quotes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/quotes/search`\n\nExecute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.quotes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.quotes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.quotes.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.quotes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().quotes().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().quotes().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Quotes.Search(context.TODO(), crm.ObjectQuoteSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.quotes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->search', + example: + "crm\n ->objects\n ->quotes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/quotes/{quoteId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.quotes > (method) update', + qualified: 'client.crm.objects.quotes.update', + params: ['quoteId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.quotes.update(quoteId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/quotes/{quoteId}`\n\nPerform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `quoteId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.quotes.update('quoteId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.quotes.update('quoteId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.quotes.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.quotes.update(\n quote_id="quoteId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().quotes().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n QuoteUpdateParams params = QuoteUpdateParams.builder()\n .quoteId("quoteId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().quotes().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Quotes.Update(\n\t\tcontext.TODO(),\n\t\t"quoteId",\n\t\tcrm.ObjectQuoteUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.quotes.update("quoteId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->update', + example: + "crm->objects->quotes->update(\n 'quoteId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/quotes/batch/create', + httpMethod: 'post', + summary: 'Create a batch of quotes', + description: + 'Create multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations.', + stainlessPath: '(resource) crm.objects.quotes.batch > (method) create', + qualified: 'client.crm.objects.quotes.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.quotes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/create`\n\nCreate multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.quotes.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().quotes().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.New(context.TODO(), crm.ObjectQuoteBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->batch->create', + example: + "crm->objects->quotes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/quotes/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of quotes by ID', + description: + 'Archive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin.', + stainlessPath: '(resource) crm.objects.quotes.batch > (method) delete', + qualified: 'client.crm.objects.quotes.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.quotes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/quotes/batch/archive`\n\nArchive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.quotes.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.quotes.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.quotes.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.quotes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().quotes().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().quotes().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Quotes.Batch.Delete(context.TODO(), crm.ObjectQuoteBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.quotes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->quotes->batch->delete', + example: + "crm->objects->quotes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/quotes/batch/read', + httpMethod: 'post', + summary: 'Read a batch of quotes by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.quotes.batch > (method) get', + qualified: 'client.crm.objects.quotes.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.quotes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.quotes.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().quotes().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.Get(context.TODO(), crm.ObjectQuoteBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->batch->get', + example: + "crm->objects->quotes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/quotes/batch/update', + httpMethod: 'post', + summary: 'Update a batch of quotes by internal ID, or unique property values', + description: + 'Update multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request.', + stainlessPath: '(resource) crm.objects.quotes.batch > (method) update', + qualified: 'client.crm.objects.quotes.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.quotes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/update`\n\nUpdate multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.quotes.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().quotes().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.Update(context.TODO(), crm.ObjectQuoteBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->quotes->batch->update', + example: + "crm->objects->quotes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/quotes/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of quotes by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.quotes.batch > (method) upsert', + qualified: 'client.crm.objects.quotes.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.quotes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.quotes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.quotes.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.quotes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.quotes.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.quotes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().quotes().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().quotes().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Quotes.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Quotes.Batch.Upsert(context.TODO(), crm.ObjectQuoteBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.quotes.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.quotes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->quotes->batch->upsert', + example: + "crm\n ->objects\n ->quotes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-162', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided.', + stainlessPath: '(resource) crm.objects.services > (method) create', + qualified: 'client.crm.objects.services.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.services.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-162`\n\nCreate a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.services.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.services.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.services.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.services.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().services().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().services().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Services.New(context.TODO(), crm.ObjectServiceNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.services.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.services.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->services->create', + example: + "crm->objects->services->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-162/{serviceId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{serviceId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.services > (method) delete', + qualified: 'client.crm.objects.services.delete', + params: ['serviceId: string;'], + markdown: + "## delete\n\n`client.crm.objects.services.delete(serviceId: string): void`\n\n**delete** `/crm/objects/2026-03/0-162/{serviceId}`\n\nMove an Object identified by `{serviceId}` to the recycling bin.\n\n### Parameters\n\n- `serviceId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.services.delete('serviceId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.services.delete('serviceId');", + }, + python: { + method: 'crm.objects.services.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.services.delete(\n "serviceId",\n)', + }, + java: { + method: 'crm().objects().services().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().services().delete("serviceId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Services.Delete(context.TODO(), "serviceId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.services.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.services.delete("serviceId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->services->delete', + example: + "crm->objects->services->delete('serviceId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-162/{serviceId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.services > (method) get', + qualified: 'client.crm.objects.services.get', + params: [ + 'serviceId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.services.get(serviceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-162/{serviceId}`\n\nRead an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `serviceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.services.get('serviceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.services.get('serviceId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.services.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.services.get(\n service_id="serviceId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().services().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().services().get("serviceId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Services.Get(\n\t\tcontext.TODO(),\n\t\t"serviceId",\n\t\tcrm.ObjectServiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.services.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.services.get("serviceId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->services->get', + example: + "crm->objects->services->get(\n 'serviceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/0-162', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of services. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.services > (method) list', + qualified: 'client.crm.objects.services.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.services.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-162`\n\nRead a page of services. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.services.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.services.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.services.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.services.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().services().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceListPage;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ServiceListPage page = client.crm().objects().services().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Services.List(context.TODO(), crm.ObjectServiceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.services.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.services.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->services->list', + example: + "crm->objects->services->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/0-162/search', + httpMethod: 'post', + summary: 'Search across objects', + description: 'Fetch objects via a search query', + stainlessPath: '(resource) crm.objects.services > (method) search', + qualified: 'client.crm.objects.services.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.services.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-162/search`\n\nFetch objects via a search query\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.services.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.services.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.services.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.services.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().services().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().services().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Services.Search(context.TODO(), crm.ObjectServiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.services.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.services.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->services->search', + example: + "crm\n ->objects\n ->services\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-162/{serviceId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.services > (method) update', + qualified: 'client.crm.objects.services.update', + params: ['serviceId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.services.update(serviceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-162/{serviceId}`\n\nPerform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `serviceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.services.update('serviceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.services.update('serviceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.services.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.services.update(\n service_id="serviceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().services().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ServiceUpdateParams params = ServiceUpdateParams.builder()\n .serviceId("serviceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().services().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Services.Update(\n\t\tcontext.TODO(),\n\t\t"serviceId",\n\t\tcrm.ObjectServiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.services.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.services.update("serviceId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->services->update', + example: + "crm->objects->services->update(\n 'serviceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/0-162/batch/create', + httpMethod: 'post', + summary: 'Create a batch of services', + description: 'Create a batch of objects', + stainlessPath: '(resource) crm.objects.services.batch > (method) create', + qualified: 'client.crm.objects.services.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.services.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.services.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().services().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.New(context.TODO(), crm.ObjectServiceBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.services.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->services->batch->create', + example: + "crm\n ->objects\n ->services\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/0-162/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of services by ID', + description: 'Archive a batch of objects', + stainlessPath: '(resource) crm.objects.services.batch > (method) delete', + qualified: 'client.crm.objects.services.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.services.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-162/batch/archive`\n\nArchive a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.services.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.services.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.services.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.services.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().services().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().services().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Services.Batch.Delete(context.TODO(), crm.ObjectServiceBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.services.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.services.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->services->batch->delete', + example: + "crm->objects->services->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/0-162/batch/read', + httpMethod: 'post', + summary: 'Read a batch of services by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.services.batch > (method) get', + qualified: 'client.crm.objects.services.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.services.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.services.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().services().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.Get(context.TODO(), crm.ObjectServiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.services.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->services->batch->get', + example: + "crm->objects->services->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/0-162/batch/update', + httpMethod: 'post', + summary: 'Update a batch of services by internal ID, or unique property values', + description: 'Update a batch of objects', + stainlessPath: '(resource) crm.objects.services.batch > (method) update', + qualified: 'client.crm.objects.services.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.services.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/update`\n\nUpdate a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.services.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().services().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.Update(context.TODO(), crm.ObjectServiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.services.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->services->batch->update', + example: + "crm\n ->objects\n ->services\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/0-162/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of services by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.services.batch > (method) upsert', + qualified: 'client.crm.objects.services.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.services.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.services.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.services.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.services.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.services.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.services.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().services().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().services().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Services.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Services.Batch.Upsert(context.TODO(), crm.ObjectServiceBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.services.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.services.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->services->batch->upsert', + example: + "crm\n ->objects\n ->services\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/subscriptions', + httpMethod: 'post', + summary: 'Create a new subscription object.', + description: 'Create a new subscription object with specified properties and optional associations.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) create', + qualified: 'client.crm.objects.subscriptions.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.subscriptions.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions`\n\nCreate a new subscription object with specified properties and optional associations.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.subscriptions.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.subscriptions.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.subscriptions.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.subscriptions.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().subscriptions().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().subscriptions().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Subscriptions.New(context.TODO(), crm.ObjectSubscriptionNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.subscriptions.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->create', + example: + "crm->objects->subscriptions->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + httpMethod: 'delete', + summary: 'Delete a subscription.', + description: 'Delete a specific subscription by its ID.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) delete', + qualified: 'client.crm.objects.subscriptions.delete', + params: ['subscriptionId: string;'], + markdown: + "## delete\n\n`client.crm.objects.subscriptions.delete(subscriptionId: string): void`\n\n**delete** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nDelete a specific subscription by its ID.\n\n### Parameters\n\n- `subscriptionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.subscriptions.delete('subscriptionId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.subscriptions.delete('subscriptionId');", + }, + python: { + method: 'crm.objects.subscriptions.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.subscriptions.delete(\n "subscriptionId",\n)', + }, + java: { + method: 'crm().objects().subscriptions().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().subscriptions().delete("subscriptionId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Subscriptions.Delete(context.TODO(), "subscriptionId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.subscriptions.delete("subscriptionId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->subscriptions->delete', + example: + "crm->objects->subscriptions->delete('subscriptionId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + httpMethod: 'get', + summary: 'Retrieve a subscription.', + description: 'Retrieve a specific subscription by its ID, including its properties and associations.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) get', + qualified: 'client.crm.objects.subscriptions.get', + params: [ + 'subscriptionId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.subscriptions.get(subscriptionId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nRetrieve a specific subscription by its ID, including its properties and associations.\n\n### Parameters\n\n- `subscriptionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.subscriptions.get('subscriptionId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.subscriptions.get(\n 'subscriptionId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.subscriptions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.subscriptions.get(\n subscription_id="subscriptionId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().subscriptions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().subscriptions().get("subscriptionId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Subscriptions.Get(\n\t\tcontext.TODO(),\n\t\t"subscriptionId",\n\t\tcrm.ObjectSubscriptionGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.subscriptions.get("subscriptionId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->subscriptions->get', + example: + "crm->objects->subscriptions->get(\n 'subscriptionId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/subscriptions', + httpMethod: 'get', + summary: 'Retrieve a list of subscription objects.', + description: + 'Retrieve a list of subscription objects, with options to filter by properties, associations, and archived status.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) list', + qualified: 'client.crm.objects.subscriptions.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.subscriptions.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/subscriptions`\n\nRetrieve a list of subscription objects, with options to filter by properties, associations, and archived status.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.subscriptions.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.subscriptions.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.subscriptions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.subscriptions.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().subscriptions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionListPage;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionListPage page = client.crm().objects().subscriptions().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Subscriptions.List(context.TODO(), crm.ObjectSubscriptionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.subscriptions.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->subscriptions->list', + example: + "crm->objects->subscriptions->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/subscriptions/search', + httpMethod: 'post', + summary: 'Search for CRM commerce subscriptions using specified criteria.', + description: + 'Execute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) search', + qualified: 'client.crm.objects.subscriptions.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.subscriptions.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/subscriptions/search`\n\nExecute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.subscriptions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.subscriptions.search(\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.subscriptions.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.subscriptions.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().subscriptions().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().subscriptions().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Subscriptions.Search(context.TODO(), crm.ObjectSubscriptionSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.subscriptions.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->search', + example: + "crm\n ->objects\n ->subscriptions\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + httpMethod: 'patch', + summary: 'Update a subscription.', + description: 'Update a specific subscription by its ID with new property values.', + stainlessPath: '(resource) crm.objects.subscriptions > (method) update', + qualified: 'client.crm.objects.subscriptions.update', + params: ['subscriptionId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.subscriptions.update(subscriptionId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nUpdate a specific subscription by its ID with new property values.\n\n### Parameters\n\n- `subscriptionId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.subscriptions.update('subscriptionId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.subscriptions.update('subscriptionId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.subscriptions.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.subscriptions.update(\n subscription_id="subscriptionId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().subscriptions().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionUpdateParams params = SubscriptionUpdateParams.builder()\n .subscriptionId("subscriptionId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().subscriptions().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Subscriptions.Update(\n\t\tcontext.TODO(),\n\t\t"subscriptionId",\n\t\tcrm.ObjectSubscriptionUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.subscriptions.update("subscriptionId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->update', + example: + "crm->objects->subscriptions->update(\n 'subscriptionId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/subscriptions/batch/create', + httpMethod: 'post', + summary: 'Batch create subscription objects.', + description: + 'Create multiple subscription objects in a single batch operation, allowing for efficient data entry and management.', + stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) create', + qualified: 'client.crm.objects.subscriptions.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.subscriptions.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/create`\n\nCreate multiple subscription objects in a single batch operation, allowing for efficient data entry and management.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.subscriptions.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().subscriptions().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.New(context.TODO(), crm.ObjectSubscriptionBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->batch->create', + example: + "crm\n ->objects\n ->subscriptions\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/subscriptions/batch/archive', + httpMethod: 'post', + summary: 'Archive multiple subscription objects in a single request.', + description: 'Archive a batch of subscription objects by providing their IDs in the request body.', + stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) delete', + qualified: 'client.crm.objects.subscriptions.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.subscriptions.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/archive`\n\nArchive a batch of subscription objects by providing their IDs in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.subscriptions.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.subscriptions.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.subscriptions.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.subscriptions.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().subscriptions().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().subscriptions().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Subscriptions.Batch.Delete(context.TODO(), crm.ObjectSubscriptionBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.subscriptions.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->subscriptions->batch->delete', + example: + "crm->objects->subscriptions->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/subscriptions/batch/read', + httpMethod: 'post', + summary: 'Retrieve a batch of subscription objects by IDs.', + description: + 'Retrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories.', + stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) get', + qualified: 'client.crm.objects.subscriptions.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.subscriptions.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/read`\n\nRetrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.subscriptions.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().subscriptions().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.Get(context.TODO(), crm.ObjectSubscriptionBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->batch->get', + example: + "crm\n ->objects\n ->subscriptions\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/subscriptions/batch/update', + httpMethod: 'post', + summary: 'Update multiple subscriptions in a batch.', + description: + 'Update multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records.', + stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) update', + qualified: 'client.crm.objects.subscriptions.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.subscriptions.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/update`\n\nUpdate multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.subscriptions.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().subscriptions().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.Update(context.TODO(), crm.ObjectSubscriptionBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->subscriptions->batch->update', + example: + "crm\n ->objects\n ->subscriptions\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/subscriptions/batch/upsert', + httpMethod: 'post', + summary: 'Perform a batch upsert operation on subscription objects.', + description: + 'This endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects.', + stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) upsert', + qualified: 'client.crm.objects.subscriptions.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.subscriptions.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/upsert`\n\nThis endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.subscriptions.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.subscriptions.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.subscriptions.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.subscriptions.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.subscriptions.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().subscriptions().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().subscriptions().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Subscriptions.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Subscriptions.Batch.Upsert(context.TODO(), crm.ObjectSubscriptionBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.subscriptions.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.subscriptions.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->subscriptions->batch->upsert', + example: + "crm\n ->objects\n ->subscriptions\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/tasks', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.', + stainlessPath: '(resource) crm.objects.tasks > (method) create', + qualified: 'client.crm.objects.tasks.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.tasks.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tasks`\n\nCreate a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tasks.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tasks.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.tasks.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tasks.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().tasks().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tasks().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tasks.New(context.TODO(), crm.ObjectTaskNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tasks.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->create', + example: + "crm->objects->tasks->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/tasks/{taskId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{taskId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.tasks > (method) delete', + qualified: 'client.crm.objects.tasks.delete', + params: ['taskId: string;'], + markdown: + "## delete\n\n`client.crm.objects.tasks.delete(taskId: string): void`\n\n**delete** `/crm/objects/2026-03/tasks/{taskId}`\n\nMove an Object identified by `{taskId}` to the recycling bin.\n\n### Parameters\n\n- `taskId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tasks.delete('taskId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tasks.delete('taskId');", + }, + python: { + method: 'crm.objects.tasks.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tasks.delete(\n "taskId",\n)', + }, + java: { + method: 'crm().objects().tasks().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().tasks().delete("taskId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tasks.Delete(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tasks.delete("taskId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->tasks->delete', + example: + "crm->objects->tasks->delete('taskId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/tasks/{taskId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.tasks > (method) get', + qualified: 'client.crm.objects.tasks.get', + params: [ + 'taskId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.tasks.get(taskId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tasks/{taskId}`\n\nRead an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `taskId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tasks.get('taskId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tasks.get('taskId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.tasks.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.tasks.get(\n task_id="taskId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().tasks().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().tasks().get("taskId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Tasks.Get(\n\t\tcontext.TODO(),\n\t\t"taskId",\n\t\tcrm.ObjectTaskGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.tasks.get("taskId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->tasks->get', + example: + "crm->objects->tasks->get(\n 'taskId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/tasks', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of tasks. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.tasks > (method) list', + qualified: 'client.crm.objects.tasks.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.tasks.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tasks`\n\nRead a page of tasks. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tasks.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tasks.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.tasks.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.tasks.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().tasks().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskListPage;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaskListPage page = client.crm().objects().tasks().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Tasks.List(context.TODO(), crm.ObjectTaskListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.tasks.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->tasks->list', + example: + "crm->objects->tasks->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/tasks/search', + httpMethod: 'post', + summary: 'Search for tasks using specified criteria.', + description: + 'Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.', + stainlessPath: '(resource) crm.objects.tasks > (method) search', + qualified: 'client.crm.objects.tasks.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.tasks.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/tasks/search`\n\nExecute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tasks.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tasks.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.tasks.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.tasks.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().tasks().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().tasks().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Tasks.Search(context.TODO(), crm.ObjectTaskSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.tasks.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->search', + example: + "crm\n ->objects\n ->tasks\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/tasks/{taskId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.tasks > (method) update', + qualified: 'client.crm.objects.tasks.update', + params: ['taskId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.tasks.update(taskId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/tasks/{taskId}`\n\nPerform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `taskId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tasks.update('taskId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tasks.update('taskId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.tasks.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tasks.update(\n task_id="taskId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().tasks().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaskUpdateParams params = TaskUpdateParams.builder()\n .taskId("taskId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tasks().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tasks.Update(\n\t\tcontext.TODO(),\n\t\t"taskId",\n\t\tcrm.ObjectTaskUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tasks.update("taskId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->update', + example: + "crm->objects->tasks->update(\n 'taskId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/tasks/batch/create', + httpMethod: 'post', + summary: 'Create a batch of tasks', + description: + 'Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.', + stainlessPath: '(resource) crm.objects.tasks.batch > (method) create', + qualified: 'client.crm.objects.tasks.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.tasks.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/create`\n\nCreate multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tasks.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tasks().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.New(context.TODO(), crm.ObjectTaskBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->batch->create', + example: + "crm->objects->tasks->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/tasks/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of tasks by ID', + description: + 'Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.', + stainlessPath: '(resource) crm.objects.tasks.batch > (method) delete', + qualified: 'client.crm.objects.tasks.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.tasks.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/tasks/batch/archive`\n\nArchive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tasks.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tasks.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.tasks.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tasks.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().tasks().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().tasks().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tasks.Batch.Delete(context.TODO(), crm.ObjectTaskBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tasks.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->tasks->batch->delete', + example: + "crm->objects->tasks->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/tasks/batch/read', + httpMethod: 'post', + summary: 'Read a batch of tasks by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.tasks.batch > (method) get', + qualified: 'client.crm.objects.tasks.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.tasks.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tasks.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tasks().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.Get(context.TODO(), crm.ObjectTaskBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->batch->get', + example: + "crm->objects->tasks->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/tasks/batch/update', + httpMethod: 'post', + summary: 'Update a batch of tasks by internal ID, or unique property values', + description: + 'Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.', + stainlessPath: '(resource) crm.objects.tasks.batch > (method) update', + qualified: 'client.crm.objects.tasks.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.tasks.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/update`\n\nUpdate multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tasks.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tasks().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.Update(context.TODO(), crm.ObjectTaskBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tasks->batch->update', + example: + "crm->objects->tasks->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/tasks/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of tasks by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.tasks.batch > (method) upsert', + qualified: 'client.crm.objects.tasks.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.tasks.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tasks.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tasks.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tasks.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.tasks.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.tasks.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().tasks().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().tasks().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tasks.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Tasks.Batch.Upsert(context.TODO(), crm.ObjectTaskBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tasks.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.tasks.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->tasks->batch->upsert', + example: + "crm\n ->objects\n ->tasks\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/taxes', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.', + stainlessPath: '(resource) crm.objects.taxes > (method) create', + qualified: 'client.crm.objects.taxes.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.taxes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/taxes`\n\nCreate a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.taxes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.taxes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.taxes.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.taxes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().taxes().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().taxes().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Taxes.New(context.TODO(), crm.ObjectTaxNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.taxes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->create', + example: + "crm->objects->taxes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/taxes/{taxId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{taxId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.taxes > (method) delete', + qualified: 'client.crm.objects.taxes.delete', + params: ['taxId: string;'], + markdown: + "## delete\n\n`client.crm.objects.taxes.delete(taxId: string): void`\n\n**delete** `/crm/objects/2026-03/taxes/{taxId}`\n\nMove an Object identified by `{taxId}` to the recycling bin.\n\n### Parameters\n\n- `taxId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.taxes.delete('taxId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.taxes.delete('taxId');", + }, + python: { + method: 'crm.objects.taxes.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.taxes.delete(\n "taxId",\n)', + }, + java: { + method: 'crm().objects().taxes().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().taxes().delete("taxId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Taxes.Delete(context.TODO(), "taxId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.taxes.delete("taxId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->taxes->delete', + example: + "crm->objects->taxes->delete('taxId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/taxes/{taxId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.taxes > (method) get', + qualified: 'client.crm.objects.taxes.get', + params: [ + 'taxId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.taxes.get(taxId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/taxes/{taxId}`\n\nRead an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `taxId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.taxes.get('taxId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.taxes.get('taxId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.taxes.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.taxes.get(\n tax_id="taxId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().taxes().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().taxes().get("taxId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Taxes.Get(\n\t\tcontext.TODO(),\n\t\t"taxId",\n\t\tcrm.ObjectTaxGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.taxes.get("taxId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->taxes->get', + example: + "crm->objects->taxes->get(\n 'taxId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/taxes', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of taxes. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.taxes > (method) list', + qualified: 'client.crm.objects.taxes.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.taxes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/taxes`\n\nRead a page of taxes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.taxes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.taxes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.taxes.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.taxes.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().taxes().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxListPage;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxListPage page = client.crm().objects().taxes().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Taxes.List(context.TODO(), crm.ObjectTaxListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.taxes.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->taxes->list', + example: + "crm->objects->taxes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/taxes/search', + httpMethod: 'post', + summary: 'Search for taxes using specified criteria.', + description: + 'Execute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters.', + stainlessPath: '(resource) crm.objects.taxes > (method) search', + qualified: 'client.crm.objects.taxes.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.taxes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/taxes/search`\n\nExecute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.taxes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.taxes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.taxes.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.taxes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().taxes().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().taxes().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Taxes.Search(context.TODO(), crm.ObjectTaxSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.taxes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->search', + example: + "crm\n ->objects\n ->taxes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/taxes/{taxId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.taxes > (method) update', + qualified: 'client.crm.objects.taxes.update', + params: ['taxId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.taxes.update(taxId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/taxes/{taxId}`\n\nPerform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `taxId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.taxes.update('taxId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.taxes.update('taxId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.taxes.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.taxes.update(\n tax_id="taxId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().taxes().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxUpdateParams params = TaxUpdateParams.builder()\n .taxId("taxId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().taxes().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Taxes.Update(\n\t\tcontext.TODO(),\n\t\t"taxId",\n\t\tcrm.ObjectTaxUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.taxes.update("taxId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->update', + example: + "crm->objects->taxes->update(\n 'taxId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/taxes/batch/create', + httpMethod: 'post', + summary: 'Create a batch of taxes', + description: + 'Create multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects.', + stainlessPath: '(resource) crm.objects.taxes.batch > (method) create', + qualified: 'client.crm.objects.taxes.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.taxes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/create`\n\nCreate multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.taxes.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().taxes().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.New(context.TODO(), crm.ObjectTaxBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->batch->create', + example: + "crm->objects->taxes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/taxes/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of taxes by ID', + description: 'Archive multiple taxes by their IDs in a single request.', + stainlessPath: '(resource) crm.objects.taxes.batch > (method) delete', + qualified: 'client.crm.objects.taxes.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.taxes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/taxes/batch/archive`\n\nArchive multiple taxes by their IDs in a single request.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.taxes.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.taxes.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.taxes.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.taxes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().taxes().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().taxes().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Taxes.Batch.Delete(context.TODO(), crm.ObjectTaxBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.taxes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->taxes->batch->delete', + example: + "crm->objects->taxes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/taxes/batch/read', + httpMethod: 'post', + summary: 'Read a batch of taxes by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.taxes.batch > (method) get', + qualified: 'client.crm.objects.taxes.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.taxes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.taxes.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().taxes().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.Get(context.TODO(), crm.ObjectTaxBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->batch->get', + example: + "crm->objects->taxes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/taxes/batch/update', + httpMethod: 'post', + summary: 'Update a batch of taxes by internal ID, or unique property values', + description: + 'Update multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk.', + stainlessPath: '(resource) crm.objects.taxes.batch > (method) update', + qualified: 'client.crm.objects.taxes.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.taxes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/update`\n\nUpdate multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.taxes.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().taxes().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.Update(context.TODO(), crm.ObjectTaxBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->taxes->batch->update', + example: + "crm->objects->taxes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/taxes/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of taxes by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.taxes.batch > (method) upsert', + qualified: 'client.crm.objects.taxes.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.taxes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.taxes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.taxes.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.taxes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.taxes.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.taxes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().taxes().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().taxes().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Taxes.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Taxes.Batch.Upsert(context.TODO(), crm.ObjectTaxBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.taxes.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.taxes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->taxes->batch->upsert', + example: + "crm\n ->objects\n ->taxes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/tickets', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.', + stainlessPath: '(resource) crm.objects.tickets > (method) create', + qualified: 'client.crm.objects.tickets.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.tickets.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tickets`\n\nCreate a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.tickets.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().tickets().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.New(context.TODO(), crm.ObjectTicketNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->create', + example: + "crm->objects->tickets->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/tickets/{ticketId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{ticketId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.tickets > (method) delete', + qualified: 'client.crm.objects.tickets.delete', + params: ['ticketId: string;'], + markdown: + "## delete\n\n`client.crm.objects.tickets.delete(ticketId: string): void`\n\n**delete** `/crm/objects/2026-03/tickets/{ticketId}`\n\nMove an Object identified by `{ticketId}` to the recycling bin.\n\n### Parameters\n\n- `ticketId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tickets.delete('ticketId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tickets.delete('ticketId');", + }, + python: { + method: 'crm.objects.tickets.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tickets.delete(\n "ticketId",\n)', + }, + java: { + method: 'crm().objects().tickets().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().tickets().delete("ticketId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tickets.Delete(context.TODO(), "ticketId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tickets.delete("ticketId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->tickets->delete', + example: + "crm->objects->tickets->delete('ticketId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/tickets/{ticketId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.tickets > (method) get', + qualified: 'client.crm.objects.tickets.get', + params: [ + 'ticketId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.tickets.get(ticketId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tickets/{ticketId}`\n\nRead an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `ticketId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tickets.get('ticketId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tickets.get('ticketId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.tickets.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.tickets.get(\n ticket_id="ticketId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().tickets().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().tickets().get("ticketId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Tickets.Get(\n\t\tcontext.TODO(),\n\t\t"ticketId",\n\t\tcrm.ObjectTicketGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.tickets.get("ticketId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->tickets->get', + example: + "crm->objects->tickets->get(\n 'ticketId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/tickets', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of tickets. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.tickets > (method) list', + qualified: 'client.crm.objects.tickets.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.tickets.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tickets`\n\nRead a page of tickets. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tickets.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tickets.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.tickets.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.tickets.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().tickets().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketListPage;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TicketListPage page = client.crm().objects().tickets().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Tickets.List(context.TODO(), crm.ObjectTicketListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.tickets.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->tickets->list', + example: + "crm->objects->tickets->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'merge', + endpoint: '/crm/objects/2026-03/tickets/merge', + httpMethod: 'post', + summary: 'Merge two tickets', + description: 'Merge two tickets, combining them into one ticket record.', + stainlessPath: '(resource) crm.objects.tickets > (method) merge', + qualified: 'client.crm.objects.tickets.merge', + params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## merge\n\n`client.crm.objects.tickets.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/merge`\n\nMerge two tickets, combining them into one ticket record.\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.merge', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.tickets.merge', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().tickets().merge', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().merge(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Merge', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.Merge(context.TODO(), crm.ObjectTicketMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.merge', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->merge', + example: + "crm->objects->tickets->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/tickets/search', + httpMethod: 'post', + summary: 'Search for tickets', + description: + 'Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', + stainlessPath: '(resource) crm.objects.tickets > (method) search', + qualified: 'client.crm.objects.tickets.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.tickets.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/tickets/search`\n\nSearch for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tickets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tickets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.tickets.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.tickets.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().tickets().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().tickets().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Tickets.Search(context.TODO(), crm.ObjectTicketSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.tickets.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->search', + example: + "crm\n ->objects\n ->tickets\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/tickets/{ticketId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.tickets > (method) update', + qualified: 'client.crm.objects.tickets.update', + params: ['ticketId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.tickets.update(ticketId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/tickets/{ticketId}`\n\nPerform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `ticketId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.update('ticketId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.update('ticketId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.tickets.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.update(\n ticket_id="ticketId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().tickets().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TicketUpdateParams params = TicketUpdateParams.builder()\n .ticketId("ticketId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.Update(\n\t\tcontext.TODO(),\n\t\t"ticketId",\n\t\tcrm.ObjectTicketUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.update("ticketId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->update', + example: + "crm->objects->tickets->update(\n 'ticketId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/tickets/batch/create', + httpMethod: 'post', + summary: 'Create a batch of tickets', + description: + 'Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', + stainlessPath: '(resource) crm.objects.tickets.batch > (method) create', + qualified: 'client.crm.objects.tickets.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.tickets.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/create`\n\nCreate a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tickets.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tickets().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.New(context.TODO(), crm.ObjectTicketBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->batch->create', + example: + "crm\n ->objects\n ->tickets\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/tickets/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of tickets by ID', + description: + 'Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', + stainlessPath: '(resource) crm.objects.tickets.batch > (method) delete', + qualified: 'client.crm.objects.tickets.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.tickets.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/tickets/batch/archive`\n\nDelete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tickets.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tickets.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.tickets.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tickets.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().tickets().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().tickets().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tickets.Batch.Delete(context.TODO(), crm.ObjectTicketBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tickets.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->tickets->batch->delete', + example: + "crm->objects->tickets->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/tickets/batch/read', + httpMethod: 'post', + summary: 'Read a batch of tickets by internal ID, or unique property values', + description: 'Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). ', + stainlessPath: '(resource) crm.objects.tickets.batch > (method) get', + qualified: 'client.crm.objects.tickets.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.tickets.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/read`\n\nRetrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tickets.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tickets().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.Get(context.TODO(), crm.ObjectTicketBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->batch->get', + example: + "crm->objects->tickets->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/tickets/batch/update', + httpMethod: 'post', + summary: 'Update a batch of tickets by internal ID, or unique property values', + description: + 'Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.tickets.batch > (method) update', + qualified: 'client.crm.objects.tickets.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.tickets.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/update`\n\nUpdate a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.tickets.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().tickets().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.Update(context.TODO(), crm.ObjectTicketBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->tickets->batch->update', + example: + "crm\n ->objects\n ->tickets\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/tickets/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of tickets by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.tickets.batch > (method) upsert', + qualified: 'client.crm.objects.tickets.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.tickets.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tickets.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.tickets.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tickets.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.tickets.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.tickets.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().tickets().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().tickets().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Tickets.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Tickets.Batch.Upsert(context.TODO(), crm.ObjectTicketBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.tickets.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.tickets.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->tickets->batch->upsert', + example: + "crm\n ->objects\n ->tickets\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/users', + httpMethod: 'post', + summary: 'Create', + description: + 'Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.', + stainlessPath: '(resource) crm.objects.users > (method) create', + qualified: 'client.crm.objects.users.create', + params: [ + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + 'properties: object;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## create\n\n`client.crm.objects.users.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/users`\n\nCreate a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.users.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.users.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.users.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.users.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().users().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().users().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Users.New(context.TODO(), crm.ObjectUserNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.users.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.users.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->users->create', + example: + "crm->objects->users->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/users/{userId}', + httpMethod: 'delete', + summary: 'Archive', + description: 'Move an Object identified by `{userId}` to the recycling bin.', + stainlessPath: '(resource) crm.objects.users > (method) delete', + qualified: 'client.crm.objects.users.delete', + params: ['userId: string;'], + markdown: + "## delete\n\n`client.crm.objects.users.delete(userId: string): void`\n\n**delete** `/crm/objects/2026-03/users/{userId}`\n\nMove an Object identified by `{userId}` to the recycling bin.\n\n### Parameters\n\n- `userId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.users.delete('userId')\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.users.delete('userId');", + }, + python: { + method: 'crm.objects.users.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.users.delete(\n "userId",\n)', + }, + java: { + method: 'crm().objects().users().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.users.UserDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().users().delete("userId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Users.Delete(context.TODO(), "userId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.users.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.users.delete("userId")\n\nputs(result)', + }, + php: { + method: 'crm->objects->users->delete', + example: + "crm->objects->users->delete('userId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/users/{userId}', + httpMethod: 'get', + summary: 'Read', + description: + 'Read an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.users > (method) get', + qualified: 'client.crm.objects.users.get', + params: [ + 'userId: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'idProperty?: string;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## get\n\n`client.crm.objects.users.get(userId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/users/{userId}`\n\nRead an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.users.get('userId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.users.get('userId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", + }, + python: { + method: 'crm.objects.users.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.users.get(\n user_id="userId",\n)\nprint(simple_public_object_with_associations.id)', + }, + java: { + method: 'crm().objects().users().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.users.UserGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().users().get("userId");\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Users.Get(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tcrm.ObjectUserGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.users.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.users.get("userId")\n\nputs(simple_public_object_with_associations)', + }, + php: { + method: 'crm->objects->users->get', + example: + "crm->objects->users->get(\n 'userId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/objects/2026-03/users', + httpMethod: 'get', + summary: 'List', + description: 'Read a page of users. Control what is returned via the `properties` query param.', + stainlessPath: '(resource) crm.objects.users > (method) list', + qualified: 'client.crm.objects.users.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'associations?: string[];', + 'limit?: number;', + 'properties?: string[];', + 'propertiesWithHistory?: string[];', + ], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## list\n\n`client.crm.objects.users.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/users`\n\nRead a page of users. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.users.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.users.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", + }, + python: { + method: 'crm.objects.users.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.users.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().objects().users().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.users.UserListPage;\nimport com.hubspot.sdk.models.crm.objects.users.UserListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserListPage page = client.crm().objects().users().list();\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Users.List(context.TODO(), crm.ObjectUserListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.objects.users.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.users.list\n\nputs(page)', + }, + php: { + method: 'crm->objects->users->list', + example: + "crm->objects->users->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/crm/objects/2026-03/users/search', + httpMethod: 'post', + summary: 'Search for users based on specified criteria.', + description: + 'Execute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request.', + stainlessPath: '(resource) crm.objects.users > (method) search', + qualified: 'client.crm.objects.users.search', + params: [ + 'after: string;', + 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', + 'limit: number;', + 'properties: string[];', + 'sorts: string[];', + 'query?: string;', + ], + response: + '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search\n\n`client.crm.objects.users.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/users/search`\n\nExecute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.users.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.users.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", + }, + python: { + method: 'crm.objects.users.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.users.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', + }, + java: { + method: 'crm().objects().users().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().users().search(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Users.Search(context.TODO(), crm.ObjectUserSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', + }, + ruby: { + method: 'crm.objects.users.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.users.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', + }, + php: { + method: 'crm->objects->users->search', + example: + "crm\n ->objects\n ->users\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/users/{userId}', + httpMethod: 'patch', + summary: 'Update', + description: + 'Perform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', + stainlessPath: '(resource) crm.objects.users > (method) update', + qualified: 'client.crm.objects.users.update', + params: ['userId: string;', 'properties: object;', 'idProperty?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', + markdown: + "## update\n\n`client.crm.objects.users.update(userId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/users/{userId}`\n\nPerform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `userId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.users.update('userId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.users.update('userId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", + }, + python: { + method: 'crm.objects.users.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.users.update(\n user_id="userId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', + }, + java: { + method: 'crm().objects().users().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.users.UserUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserUpdateParams params = UserUpdateParams.builder()\n .userId("userId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().users().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Users.Update(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tcrm.ObjectUserUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', + }, + ruby: { + method: 'crm.objects.users.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.users.update("userId", properties: {foo: "string"})\n\nputs(simple_public_object)', + }, + php: { + method: 'crm->objects->users->update', + example: + "crm->objects->users->update(\n 'userId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/objects/2026-03/users/batch/create', + httpMethod: 'post', + summary: 'Create a batch of users', + description: + 'Create multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs.', + stainlessPath: '(resource) crm.objects.users.batch > (method) create', + qualified: 'client.crm.objects.users.batch.create', + params: [ + 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.objects.users.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/create`\n\nCreate multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.users.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().users().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.New(context.TODO(), crm.ObjectUserBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.users.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->users->batch->create', + example: + "crm->objects->users->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/objects/2026-03/users/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of users by ID', + description: + 'Archive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use.', + stainlessPath: '(resource) crm.objects.users.batch > (method) delete', + qualified: 'client.crm.objects.users.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.crm.objects.users.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/users/batch/archive`\n\nArchive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.users.batch.delete({ inputs: [{ id: '430001' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.users.batch.delete({ inputs: [{ id: '430001' }] });", + }, + python: { + method: 'crm.objects.users.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.users.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', + }, + java: { + method: 'crm().objects().users().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().users().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Users.Batch.Delete(context.TODO(), crm.ObjectUserBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.objects.users.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.users.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', + }, + php: { + method: 'crm->objects->users->batch->delete', + example: + "crm->objects->users->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/objects/2026-03/users/batch/read', + httpMethod: 'post', + summary: 'Read a batch of users by internal ID, or unique property values', + description: + 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', + stainlessPath: '(resource) crm.objects.users.batch > (method) get', + qualified: 'client.crm.objects.users.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'properties: string[];', + 'propertiesWithHistory: string[];', + 'archived?: boolean;', + 'idProperty?: string;', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.objects.users.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.users.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().users().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.Get(context.TODO(), crm.ObjectUserBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.users.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->users->batch->get', + example: + "crm->objects->users->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/objects/2026-03/users/batch/update', + httpMethod: 'post', + summary: 'Update a batch of users by internal ID, or unique property values', + description: + 'Update multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles.', + stainlessPath: '(resource) crm.objects.users.batch > (method) update', + qualified: 'client.crm.objects.users.batch.update', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.crm.objects.users.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/update`\n\nUpdate multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", + }, + python: { + method: 'crm.objects.users.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', + }, + java: { + method: 'crm().objects().users().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.Update(context.TODO(), crm.ObjectUserBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.users.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', + }, + php: { + method: 'crm->objects->users->batch->update', + example: + "crm->objects->users->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert', + endpoint: '/crm/objects/2026-03/users/batch/upsert', + httpMethod: 'post', + summary: 'Create or update a batch of users by unique property values', + description: + 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', + stainlessPath: '(resource) crm.objects.users.batch > (method) upsert', + qualified: 'client.crm.objects.users.batch.upsert', + params: [ + 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## upsert\n\n`client.crm.objects.users.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.users.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", + perLanguage: { + typescript: { + method: 'client.crm.objects.users.batch.upsert', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.users.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", + }, + python: { + method: 'crm.objects.users.batch.upsert', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.users.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', + }, + java: { + method: 'crm().objects().users().batch().upsert', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().users().batch().upsert(params);\n }\n}', + }, + go: { + method: 'client.Crm.Objects.Users.Batch.Upsert', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Users.Batch.Upsert(context.TODO(), crm.ObjectUserBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.objects.users.batch.upsert', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.users.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', + }, + php: { + method: 'crm->objects->users->batch->upsert', + example: + "crm\n ->objects\n ->users\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/owners/2026-03/{ownerId}', + httpMethod: 'get', + summary: 'Retrieve a specific owner by ID', + description: "Retrieve details of a specific owner using either their 'id' or 'userId'.", + stainlessPath: '(resource) crm.owners > (method) get', + qualified: 'client.crm.owners.get', + params: ['ownerId: number;', 'archived?: boolean;', "idProperty?: 'id' | 'userId';"], + response: + "{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }", + markdown: + "## get\n\n`client.crm.owners.get(ownerId: number, archived?: boolean, idProperty?: 'id' | 'userId'): { id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: public_team[]; userId?: number; userIdIncludingInactive?: number; }`\n\n**get** `/crm/owners/2026-03/{ownerId}`\n\nRetrieve details of a specific owner using either their 'id' or 'userId'.\n\n### Parameters\n\n- `ownerId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: 'id' | 'userId'`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `type: 'PERSON' | 'QUEUE'`\n - `updatedAt: string`\n - `email?: string`\n - `firstName?: string`\n - `lastName?: string`\n - `teams?: { id: string; name: string; primary: boolean; }[]`\n - `userId?: number`\n - `userIdIncludingInactive?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicOwner = await client.crm.owners.get(0);\n\nconsole.log(publicOwner);\n```", + perLanguage: { + typescript: { + method: 'client.crm.owners.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicOwner = await client.crm.owners.get(0);\n\nconsole.log(publicOwner.id);", + }, + python: { + method: 'crm.owners.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_owner = client.crm.owners.get(\n owner_id=0,\n)\nprint(public_owner.id)', + }, + java: { + method: 'crm().owners().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.owners.OwnerGetParams;\nimport com.hubspot.sdk.models.crm.owners.PublicOwner;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicOwner publicOwner = client.crm().owners().get(0);\n }\n}', + }, + go: { + method: 'client.Crm.Owners.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicOwner, err := client.Crm.Owners.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.OwnerGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicOwner.ID)\n}\n', + }, + ruby: { + method: 'crm.owners.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_owner = hubspot.crm.owners.get(0)\n\nputs(public_owner)', + }, + php: { + method: 'crm->owners->get', + example: + "crm->owners->get(0, archived: true, idProperty: 'id');\n\nvar_dump($publicOwner);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/owners/2026-03/$OWNER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/owners/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) crm.owners > (method) list', + qualified: 'client.crm.owners.list', + params: ['after?: string;', 'archived?: boolean;', 'email?: string;', 'limit?: number;'], + response: + "{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }", + markdown: + "## list\n\n`client.crm.owners.list(after?: string, archived?: boolean, email?: string, limit?: number): { id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: public_team[]; userId?: number; userIdIncludingInactive?: number; }`\n\n**get** `/crm/owners/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `email?: string`\n Filter by email address (optional)\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `type: 'PERSON' | 'QUEUE'`\n - `updatedAt: string`\n - `email?: string`\n - `firstName?: string`\n - `lastName?: string`\n - `teams?: { id: string; name: string; primary: boolean; }[]`\n - `userId?: number`\n - `userIdIncludingInactive?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicOwner of client.crm.owners.list()) {\n console.log(publicOwner);\n}\n```", + perLanguage: { + typescript: { + method: 'client.crm.owners.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicOwner of client.crm.owners.list()) {\n console.log(publicOwner.id);\n}", + }, + python: { + method: 'crm.owners.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.owners.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'crm().owners().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.owners.OwnerListPage;\nimport com.hubspot.sdk.models.crm.owners.OwnerListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OwnerListPage page = client.crm().owners().list();\n }\n}', + }, + go: { + method: 'client.Crm.Owners.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Owners.List(context.TODO(), crm.OwnerListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'crm.owners.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.owners.list\n\nputs(page)', + }, + php: { + method: 'crm->owners->list', + example: + "crm->owners->list(\n after: 'after', archived: true, email: 'email', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/owners/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/pipelines/2026-03/{objectType}', + httpMethod: 'post', + summary: 'Create a pipeline', + description: + 'Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.', + stainlessPath: '(resource) crm.pipelines > (method) create', + qualified: 'client.crm.pipelines.create', + params: [ + 'objectType: string;', + 'displayOrder: number;', + 'label: string;', + 'stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[];', + 'pipelineId?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", + markdown: + "## create\n\n`client.crm.pipelines.create(objectType: string, displayOrder: number, label: string, stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[], pipelineId?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**post** `/crm/pipelines/2026-03/{objectType}`\n\nCreate a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A unique label used to organize pipelines in HubSpot's UI\n\n- `stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[]`\n Pipeline stage inputs used to create the new or replacement pipeline.\n\n- `pipelineId?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.create('objectType', {\n displayOrder: 0,\n label: 'label',\n stages: [{\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n}],\n});\n\nconsole.log(pipeline);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.create('objectType', {\n displayOrder: 0,\n label: 'label',\n stages: [\n {\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(pipeline.id);", + }, + python: { + method: 'crm.pipelines.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.create(\n object_type="objectType",\n display_order=0,\n label="label",\n stages=[{\n "display_order": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n },\n }],\n)\nprint(pipeline.id)', + }, + java: { + method: 'crm().pipelines().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineCreateParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineCreateParams params = PipelineCreateParams.builder()\n .objectType("objectType")\n .pipelineInput(PipelineInput.builder()\n .displayOrder(0)\n .label("label")\n .addStage(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n Pipeline pipeline = client.crm().pipelines().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PipelineNewParams{\n\t\t\tPipelineInput: crm.PipelineInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tStages: []crm.PipelineStageInputParam{{\n\t\t\t\t\tDisplayOrder: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.create(\n "objectType",\n display_order: 0,\n label: "label",\n stages: [{displayOrder: 0, label: "label", metadata: {foo: "string"}}]\n)\n\nputs(pipeline)', + }, + php: { + method: 'crm->pipelines->create', + example: + "crm->pipelines->create(\n 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n [\n 'displayOrder' => 0,\n 'label' => 'label',\n 'metadata' => ['foo' => 'string'],\n 'stageID' => 'stageId',\n ],\n ],\n pipelineID: 'pipelineId',\n);\n\nvar_dump($pipeline);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "stages": [\n {\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_stage', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', + httpMethod: 'post', + summary: 'Create a pipeline stage', + description: 'Create a pipeline stage', + stainlessPath: '(resource) crm.pipelines > (method) create_stage', + qualified: 'client.crm.pipelines.createStage', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'displayOrder: number;', + 'label: string;', + 'metadata: object;', + 'stageId?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", + markdown: + "## create_stage\n\n`client.crm.pipelines.createStage(objectType: string, pipelineId: string, displayOrder: number, label: string, metadata: object, stageId?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**post** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`\n\nCreate a pipeline stage\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n- `stageId?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.createStage('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.createStage', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.createStage('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", + }, + python: { + method: 'crm.pipelines.create_stage', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.create_stage(\n pipeline_id="pipelineId",\n object_type="objectType",\n display_order=0,\n label="label",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', + }, + java: { + method: 'crm().pipelines().createStage', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineCreateStageParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineCreateStageParams params = PipelineCreateStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelineStageInput(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().createStage(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.NewStage', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.NewStage(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineNewStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineStageInput: crm.PipelineStageInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.create_stage', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.create_stage(\n "pipelineId",\n object_type: "objectType",\n display_order: 0,\n label: "label",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', + }, + php: { + method: 'crm->pipelines->createStage', + example: + "crm->pipelines->createStage(\n 'pipelineId',\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: ['foo' => 'string'],\n stageID: 'stageId',\n);\n\nvar_dump($pipelineStage);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + httpMethod: 'delete', + summary: 'Delete a pipeline', + description: 'Delete a pipeline', + stainlessPath: '(resource) crm.pipelines > (method) delete', + qualified: 'client.crm.pipelines.delete', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'validateDealStageUsagesBeforeDelete?: boolean;', + 'validateReferencesBeforeDelete?: boolean;', + ], + markdown: + "## delete\n\n`client.crm.pipelines.delete(objectType: string, pipelineId: string, validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean): void`\n\n**delete** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nDelete a pipeline\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.pipelines.delete('pipelineId', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.pipelines.delete('pipelineId', { objectType: 'objectType' });", + }, + python: { + method: 'crm.pipelines.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.pipelines.delete(\n pipeline_id="pipelineId",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().pipelines().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineDeleteParams params = PipelineDeleteParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n client.crm().pipelines().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Pipelines.Delete(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.pipelines.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.pipelines.delete("pipelineId", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->pipelines->delete', + example: + "crm->pipelines->delete(\n 'pipelineId',\n objectType: 'objectType',\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_stage', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + httpMethod: 'delete', + summary: 'Delete a pipeline stage', + description: 'Delete a pipeline stage', + stainlessPath: '(resource) crm.pipelines > (method) delete_stage', + qualified: 'client.crm.pipelines.deleteStage', + params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], + markdown: + "## delete_stage\n\n`client.crm.pipelines.deleteStage(objectType: string, pipelineId: string, stageId: string): void`\n\n**delete** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nDelete a pipeline stage\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.pipelines.deleteStage('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.deleteStage', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.pipelines.deleteStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n});", + }, + python: { + method: 'crm.pipelines.delete_stage', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.pipelines.delete_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)', + }, + java: { + method: 'crm().pipelines().deleteStage', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineDeleteStageParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineDeleteStageParams params = PipelineDeleteStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n client.crm().pipelines().deleteStage(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.DeleteStage', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Pipelines.DeleteStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineDeleteStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.pipelines.delete_stage', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.pipelines.delete_stage("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(result)', + }, + php: { + method: 'crm->pipelines->deleteStage', + example: + "crm->pipelines->deleteStage(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + httpMethod: 'get', + summary: 'Return a pipeline by ID', + description: 'Return a single pipeline object identified by its unique `{pipelineId}`.', + stainlessPath: '(resource) crm.pipelines > (method) get', + qualified: 'client.crm.pipelines.get', + params: ['objectType: string;', 'pipelineId: string;'], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", + markdown: + "## get\n\n`client.crm.pipelines.get(objectType: string, pipelineId: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nReturn a single pipeline object identified by its unique `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.get('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.get('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline.id);", + }, + python: { + method: 'crm.pipelines.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.get(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(pipeline.id)', + }, + java: { + method: 'crm().pipelines().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineGetParams params = PipelineGetParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n Pipeline pipeline = client.crm().pipelines().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.Get(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.get("pipelineId", object_type: "objectType")\n\nputs(pipeline)', + }, + php: { + method: 'crm->pipelines->get', + example: + "crm->pipelines->get(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($pipeline);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_stage', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + httpMethod: 'get', + summary: 'Return a pipeline stage by ID', + description: 'Return a pipeline stage by ID', + stainlessPath: '(resource) crm.pipelines > (method) get_stage', + qualified: 'client.crm.pipelines.getStage', + params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", + markdown: + "## get_stage\n\n`client.crm.pipelines.getStage(objectType: string, pipelineId: string, stageId: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nReturn a pipeline stage by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.getStage('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' });\n\nconsole.log(pipelineStage);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.getStage', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.getStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n});\n\nconsole.log(pipelineStage.id);", + }, + python: { + method: 'crm.pipelines.get_stage', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.get_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)\nprint(pipeline_stage.id)', + }, + java: { + method: 'crm().pipelines().getStage', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineGetStageParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineGetStageParams params = PipelineGetStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().getStage(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.GetStage', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.GetStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineGetStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.get_stage', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.get_stage("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(pipeline_stage)', + }, + php: { + method: 'crm->pipelines->getStage', + example: + "crm->pipelines->getStage(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($pipelineStage);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/pipelines/2026-03/{objectType}', + httpMethod: 'get', + summary: 'Retrieve all pipelines', + description: 'Return all pipelines for the object type specified by `{objectType}`.', + stainlessPath: '(resource) crm.pipelines > (method) list', + qualified: 'client.crm.pipelines.list', + params: ['objectType: string;'], + response: + '{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }[]; }', + markdown: + "## list\n\n`client.crm.pipelines.list(objectType: string): { results: pipeline[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}`\n\nReturn all pipelines for the object type specified by `{objectType}`.\n\n### Parameters\n\n- `objectType: string`\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }[]; }`\n\n - `results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePipelineNoPaging = await client.crm.pipelines.list('objectType');\n\nconsole.log(collectionResponsePipelineNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePipelineNoPaging = await client.crm.pipelines.list('objectType');\n\nconsole.log(collectionResponsePipelineNoPaging.results);", + }, + python: { + method: 'crm.pipelines.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_pipeline_no_paging = client.crm.pipelines.list(\n "objectType",\n)\nprint(collection_response_pipeline_no_paging.results)', + }, + java: { + method: 'crm().pipelines().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePipelineNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePipelineNoPaging collectionResponsePipelineNoPaging = client.crm().pipelines().list("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePipelineNoPaging, err := client.Crm.Pipelines.List(context.TODO(), "objectType")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePipelineNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.pipelines.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_pipeline_no_paging = hubspot.crm.pipelines.list("objectType")\n\nputs(collection_response_pipeline_no_paging)', + }, + php: { + method: 'crm->pipelines->list', + example: + "crm->pipelines->list(\n 'objectType'\n);\n\nvar_dump($collectionResponsePipelineNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_audit', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit', + httpMethod: 'get', + summary: 'Return an audit of all changes to the pipeline', + description: + 'Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.', + stainlessPath: '(resource) crm.pipelines > (method) list_audit', + qualified: 'client.crm.pipelines.listAudit', + params: ['objectType: string;', 'pipelineId: string;'], + response: + '{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }', + markdown: + "## list_audit\n\n`client.crm.pipelines.listAudit(objectType: string, pipelineId: string): { results: public_audit_info[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit`\n\nReturn a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }`\n\n - `results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listAudit('pipelineId', { objectType: 'objectType' });\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.listAudit', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listAudit(\n 'pipelineId',\n { objectType: 'objectType' },\n);\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging.results);", + }, + python: { + method: 'crm.pipelines.list_audit', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_audit_info_no_paging = client.crm.pipelines.list_audit(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(collection_response_public_audit_info_no_paging.results)', + }, + java: { + method: 'crm().pipelines().listAudit', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePublicAuditInfoNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListAuditParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListAuditParams params = PipelineListAuditParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n CollectionResponsePublicAuditInfoNoPaging collectionResponsePublicAuditInfoNoPaging = client.crm().pipelines().listAudit(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.ListAudit', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAuditInfoNoPaging, err := client.Crm.Pipelines.ListAudit(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineListAuditParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAuditInfoNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.pipelines.list_audit', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_audit_info_no_paging = hubspot.crm.pipelines.list_audit("pipelineId", object_type: "objectType")\n\nputs(collection_response_public_audit_info_no_paging)', + }, + php: { + method: 'crm->pipelines->listAudit', + example: + "crm->pipelines->listAudit(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($collectionResponsePublicAuditInfoNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/audit \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_stage_audit', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit', + httpMethod: 'get', + summary: '', + description: + 'Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.', + stainlessPath: '(resource) crm.pipelines > (method) list_stage_audit', + qualified: 'client.crm.pipelines.listStageAudit', + params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], + response: + '{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }', + markdown: + "## list_stage_audit\n\n`client.crm.pipelines.listStageAudit(objectType: string, pipelineId: string, stageId: string): { results: public_audit_info[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit`\n\nReturn a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Returns\n\n- `{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }`\n\n - `results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listStageAudit('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' });\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.listStageAudit', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listStageAudit(\n 'stageId',\n { objectType: 'objectType', pipelineId: 'pipelineId' },\n);\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging.results);", + }, + python: { + method: 'crm.pipelines.list_stage_audit', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_audit_info_no_paging = client.crm.pipelines.list_stage_audit(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)\nprint(collection_response_public_audit_info_no_paging.results)', + }, + java: { + method: 'crm().pipelines().listStageAudit', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePublicAuditInfoNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListStageAuditParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListStageAuditParams params = PipelineListStageAuditParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n CollectionResponsePublicAuditInfoNoPaging collectionResponsePublicAuditInfoNoPaging = client.crm().pipelines().listStageAudit(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.ListStageAudit', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAuditInfoNoPaging, err := client.Crm.Pipelines.ListStageAudit(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineListStageAuditParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAuditInfoNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.pipelines.list_stage_audit', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_audit_info_no_paging = hubspot.crm.pipelines.list_stage_audit("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(collection_response_public_audit_info_no_paging)', + }, + php: { + method: 'crm->pipelines->listStageAudit', + example: + "crm\n ->pipelines\n ->listStageAudit(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($collectionResponsePublicAuditInfoNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID/audit \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_stages', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', + httpMethod: 'get', + summary: 'Return all stages of a pipeline', + description: 'Return all the stages associated with the pipeline identified by `{pipelineId}`.', + stainlessPath: '(resource) crm.pipelines > (method) list_stages', + qualified: 'client.crm.pipelines.listStages', + params: ['objectType: string;', 'pipelineId: string;'], + response: + "{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; }", + markdown: + "## list_stages\n\n`client.crm.pipelines.listStages(objectType: string, pipelineId: string): { results: pipeline_stage[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`\n\nReturn all the stages associated with the pipeline identified by `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; }`\n\n - `results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePipelineStageNoPaging = await client.crm.pipelines.listStages('pipelineId', { objectType: 'objectType' });\n\nconsole.log(collectionResponsePipelineStageNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.listStages', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePipelineStageNoPaging = await client.crm.pipelines.listStages(\n 'pipelineId',\n { objectType: 'objectType' },\n);\n\nconsole.log(collectionResponsePipelineStageNoPaging.results);", + }, + python: { + method: 'crm.pipelines.list_stages', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_pipeline_stage_no_paging = client.crm.pipelines.list_stages(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(collection_response_pipeline_stage_no_paging.results)', + }, + java: { + method: 'crm().pipelines().listStages', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePipelineStageNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListStagesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListStagesParams params = PipelineListStagesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n CollectionResponsePipelineStageNoPaging collectionResponsePipelineStageNoPaging = client.crm().pipelines().listStages(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.ListStages', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePipelineStageNoPaging, err := client.Crm.Pipelines.ListStages(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineListStagesParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePipelineStageNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.pipelines.list_stages', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_pipeline_stage_no_paging = hubspot.crm.pipelines.list_stages("pipelineId", object_type: "objectType")\n\nputs(collection_response_pipeline_stage_no_paging)', + }, + php: { + method: 'crm->pipelines->listStages', + example: + "crm->pipelines->listStages(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($collectionResponsePipelineStageNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + httpMethod: 'patch', + summary: '', + description: + 'Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.', + stainlessPath: '(resource) crm.pipelines > (method) update', + qualified: 'client.crm.pipelines.update', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'validateDealStageUsagesBeforeDelete?: boolean;', + 'validateReferencesBeforeDelete?: boolean;', + 'archived?: boolean;', + 'displayOrder?: number;', + 'label?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", + markdown: + "## update\n\n`client.crm.pipelines.update(objectType: string, pipelineId: string, validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean, archived?: boolean, displayOrder?: number, label?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**patch** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nPerform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n- `archived?: boolean`\n Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned.\n\n- `displayOrder?: number`\n The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label?: string`\n A unique label used to organize pipelines in HubSpot's UI\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.update('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.update('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline.id);", + }, + python: { + method: 'crm.pipelines.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.update(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(pipeline.id)', + }, + java: { + method: 'crm().pipelines().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelinePatchInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateParams params = PipelineUpdateParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelinePatchInput(PipelinePatchInput.builder().build())\n .build();\n Pipeline pipeline = client.crm().pipelines().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.Update(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelinePatchInput: crm.PipelinePatchInputParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.update("pipelineId", object_type: "objectType")\n\nputs(pipeline)', + }, + php: { + method: 'crm->pipelines->update', + example: + "crm->pipelines->update(\n 'pipelineId',\n objectType: 'objectType',\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n archived: true,\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($pipeline);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_all_properties', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + httpMethod: 'put', + summary: 'Replace a pipeline', + description: 'Replace a pipeline', + stainlessPath: '(resource) crm.pipelines > (method) update_all_properties', + qualified: 'client.crm.pipelines.updateAllProperties', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'displayOrder: number;', + 'label: string;', + 'stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[];', + 'validateDealStageUsagesBeforeDelete?: boolean;', + 'validateReferencesBeforeDelete?: boolean;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", + markdown: + "## update_all_properties\n\n`client.crm.pipelines.updateAllProperties(objectType: string, pipelineId: string, displayOrder: number, label: string, stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[], validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**put** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nReplace a pipeline\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[]`\n The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.updateAllProperties('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [{\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n}],\n});\n\nconsole.log(pipeline);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.updateAllProperties', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.updateAllProperties('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n {\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(pipeline.id);", + }, + python: { + method: 'crm.pipelines.update_all_properties', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.update_all_properties(\n pipeline_id="pipelineId",\n object_type="objectType",\n display_order=0,\n label="label",\n stages=[{\n "display_order": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n },\n }],\n)\nprint(pipeline.id)', + }, + java: { + method: 'crm().pipelines().updateAllProperties', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineReplaceInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateAllPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateAllPropertiesParams params = PipelineUpdateAllPropertiesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelineReplaceInput(PipelineReplaceInput.builder()\n .displayOrder(0)\n .label("label")\n .addStage(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n Pipeline pipeline = client.crm().pipelines().updateAllProperties(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.UpdateAllProperties', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.UpdateAllProperties(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineUpdateAllPropertiesParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineReplaceInput: crm.PipelineReplaceInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tStages: []crm.PipelineStageInputParam{{\n\t\t\t\t\tDisplayOrder: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.update_all_properties', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.update_all_properties(\n "pipelineId",\n object_type: "objectType",\n display_order: 0,\n label: "label",\n stages: [{displayOrder: 0, label: "label", metadata: {foo: "string"}}]\n)\n\nputs(pipeline)', + }, + php: { + method: 'crm->pipelines->updateAllProperties', + example: + "crm->pipelines->updateAllProperties(\n 'pipelineId',\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n [\n 'displayOrder' => 0,\n 'label' => 'label',\n 'metadata' => ['foo' => 'string'],\n 'stageID' => 'stageId',\n ],\n ],\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n);\n\nvar_dump($pipeline);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "stages": [\n {\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update_stage', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + httpMethod: 'patch', + summary: '', + description: '', + stainlessPath: '(resource) crm.pipelines > (method) update_stage', + qualified: 'client.crm.pipelines.updateStage', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'stageId: string;', + 'metadata: object;', + 'archived?: boolean;', + 'displayOrder?: number;', + 'label?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", + markdown: + "## update_stage\n\n`client.crm.pipelines.updateStage(objectType: string, pipelineId: string, stageId: string, metadata: object, archived?: boolean, displayOrder?: number, label?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**patch** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n- `archived?: boolean`\n Whether the pipeline is archived.\n\n- `displayOrder?: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label?: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.updateStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.updateStage', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.updateStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", + }, + python: { + method: 'crm.pipelines.update_stage', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.update_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', + }, + java: { + method: 'crm().pipelines().updateStage', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStagePatchInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateStageParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateStageParams params = PipelineUpdateStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .pipelineStagePatchInput(PipelineStagePatchInput.builder()\n .metadata(PipelineStagePatchInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().updateStage(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.UpdateStage', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.UpdateStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineUpdateStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t\tPipelineStagePatchInput: crm.PipelineStagePatchInputParam{\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.update_stage', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.update_stage(\n "stageId",\n object_type: "objectType",\n pipeline_id: "pipelineId",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', + }, + php: { + method: 'crm->pipelines->updateStage', + example: + "crm->pipelines->updateStage(\n 'stageId',\n objectType: 'objectType',\n pipelineID: 'pipelineId',\n metadata: ['foo' => 'string'],\n archived: true,\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($pipelineStage);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "metadata": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'update_stage_all_properties', + endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + httpMethod: 'put', + summary: 'Replace a pipeline stage', + description: + 'Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.', + stainlessPath: '(resource) crm.pipelines > (method) update_stage_all_properties', + qualified: 'client.crm.pipelines.updateStageAllProperties', + params: [ + 'objectType: string;', + 'pipelineId: string;', + 'stageId: string;', + 'displayOrder: number;', + 'label: string;', + 'metadata: object;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", + markdown: + "## update_stage_all_properties\n\n`client.crm.pipelines.updateStageAllProperties(objectType: string, pipelineId: string, stageId: string, displayOrder: number, label: string, metadata: object): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**put** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nReplace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.updateStageAllProperties('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", + perLanguage: { + typescript: { + method: 'client.crm.pipelines.updateStageAllProperties', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.updateStageAllProperties('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", + }, + python: { + method: 'crm.pipelines.update_stage_all_properties', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.update_stage_all_properties(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n display_order=0,\n label="label",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', + }, + java: { + method: 'crm().pipelines().updateStageAllProperties', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageReplaceInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateStageAllPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateStageAllPropertiesParams params = PipelineUpdateStageAllPropertiesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .pipelineStageReplaceInput(PipelineStageReplaceInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageReplaceInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().updateStageAllProperties(params);\n }\n}', + }, + go: { + method: 'client.Crm.Pipelines.UpdateStageAllProperties', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.UpdateStageAllProperties(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineUpdateStageAllPropertiesParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t\tPipelineStageReplaceInput: crm.PipelineStageReplaceInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', + }, + ruby: { + method: 'crm.pipelines.update_stage_all_properties', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.update_stage_all_properties(\n "stageId",\n object_type: "objectType",\n pipeline_id: "pipelineId",\n display_order: 0,\n label: "label",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', + }, + php: { + method: 'crm->pipelines->updateStageAllProperties', + example: + "crm->pipelines->updateStageAllProperties(\n 'stageId',\n objectType: 'objectType',\n pipelineID: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: ['foo' => 'string'],\n);\n\nvar_dump($pipelineStage);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/properties/2026-03/{objectType}', + httpMethod: 'post', + summary: 'Create a property', + description: 'Create and return a copy of a new property for the specified object type.', + stainlessPath: '(resource) crm.properties > (method) create', + qualified: 'client.crm.properties.create', + params: [ + 'objectType: string;', + 'fieldType: string;', + 'groupName: string;', + 'label: string;', + 'name: string;', + "type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", + 'calculationFormula?: string;', + 'currencyPropertyName?: string;', + "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'description?: string;', + 'displayOrder?: number;', + 'externalOptions?: boolean;', + 'formField?: boolean;', + 'hasUniqueValue?: boolean;', + 'hidden?: boolean;', + "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + 'referencedObjectType?: string;', + 'showCurrencySymbol?: boolean;', + ], + response: + "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", + markdown: + "## create\n\n`client.crm.properties.create(objectType: string, fieldType: string, groupName: string, label: string, name: string, type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string', calculationFormula?: string, currencyPropertyName?: string, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', description?: string, displayOrder?: number, externalOptions?: boolean, formField?: boolean, hasUniqueValue?: boolean, hidden?: boolean, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], referencedObjectType?: string, showCurrencySymbol?: boolean): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}`\n\nCreate and return a copy of a new property for the specified object type.\n\n### Parameters\n\n- `objectType: string`\n\n- `fieldType: string`\n\n- `groupName: string`\n\n- `label: string`\n\n- `name: string`\n\n- `type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `externalOptions?: boolean`\n\n- `formField?: boolean`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `referencedObjectType?: string`\n\n- `showCurrencySymbol?: boolean`\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.create('objectType', {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(property);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.create('objectType', {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(property.hidden);", + }, + python: { + method: 'crm.properties.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.create(\n object_type="objectType",\n field_type="booleancheckbox",\n group_name="groupName",\n label="label",\n name="name",\n type="bool",\n)\nprint(property.hidden)', + }, + java: { + method: 'crm().properties().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.crm.properties.PropertyCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyCreateParams params = PropertyCreateParams.builder()\n .objectType("objectType")\n .propertyCreate(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build();\n Property property = client.crm().properties().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyNewParams{\n\t\t\tPropertyCreate: shared.PropertyCreateParam{\n\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\tGroupName: "groupName",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', + }, + ruby: { + method: 'crm.properties.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.create(\n "objectType",\n field_type: :booleancheckbox,\n group_name: "groupName",\n label: "label",\n name: "name",\n type: :bool\n)\n\nputs(property)', + }, + php: { + method: 'crm->properties->create', + example: + "crm->properties->create(\n 'objectType',\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n dataSensitivity: 'highly_sensitive',\n description: 'description',\n displayOrder: 0,\n externalOptions: true,\n formField: true,\n hasUniqueValue: true,\n hidden: true,\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n referencedObjectType: 'referencedObjectType',\n showCurrencySymbol: true,\n);\n\nvar_dump($property);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', + httpMethod: 'delete', + summary: 'Archive a property', + description: 'Move a property identified by {propertyName} to the recycling bin.', + stainlessPath: '(resource) crm.properties > (method) delete', + qualified: 'client.crm.properties.delete', + params: ['objectType: string;', 'propertyName: string;'], + markdown: + "## delete\n\n`client.crm.properties.delete(objectType: string, propertyName: string): void`\n\n**delete** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nMove a property identified by {propertyName} to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.delete('propertyName', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.delete('propertyName', { objectType: 'objectType' });", + }, + python: { + method: 'crm.properties.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.delete(\n property_name="propertyName",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().properties().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.PropertyDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyDeleteParams params = PropertyDeleteParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n client.crm().properties().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Delete(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.properties.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.delete("propertyName", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->properties->delete', + example: + "crm->properties->delete(\n 'propertyName', objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', + httpMethod: 'get', + summary: 'Read a property', + description: 'Read a property identified by {propertyName}.', + stainlessPath: '(resource) crm.properties > (method) get', + qualified: 'client.crm.properties.get', + params: [ + 'objectType: string;', + 'propertyName: string;', + 'archived?: boolean;', + "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'locale?: string;', + 'properties?: string;', + ], + response: + "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", + markdown: + "## get\n\n`client.crm.properties.get(objectType: string, propertyName: string, archived?: boolean, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', locale?: string, properties?: string): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**get** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nRead a property identified by {propertyName}.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `locale?: string`\n\n- `properties?: string`\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.get('propertyName', { objectType: 'objectType' });\n\nconsole.log(property);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.get('propertyName', { objectType: 'objectType' });\n\nconsole.log(property.hidden);", + }, + python: { + method: 'crm.properties.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.get(\n property_name="propertyName",\n object_type="objectType",\n)\nprint(property.hidden)', + }, + java: { + method: 'crm().properties().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.crm.properties.PropertyGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyGetParams params = PropertyGetParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n Property property = client.crm().properties().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.Get(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', + }, + ruby: { + method: 'crm.properties.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.get("propertyName", object_type: "objectType")\n\nputs(property)', + }, + php: { + method: 'crm->properties->get', + example: + "crm->properties->get(\n 'propertyName',\n objectType: 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n locale: 'locale',\n properties: 'properties',\n);\n\nvar_dump($property);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/properties/2026-03/{objectType}', + httpMethod: 'get', + summary: 'Read all properties', + description: 'Read all existing properties for the specified object type and HubSpot account.', + stainlessPath: '(resource) crm.properties > (method) list', + qualified: 'client.crm.properties.list', + params: [ + 'objectType: string;', + 'archived?: boolean;', + "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'locale?: string;', + 'properties?: string;', + ], + response: + "{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }", + markdown: + "## list\n\n`client.crm.properties.list(objectType: string, archived?: boolean, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', locale?: string, properties?: string): { results: property[]; }`\n\n**get** `/crm/properties/2026-03/{objectType}`\n\nRead all existing properties for the specified object type and HubSpot account.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `locale?: string`\n\n- `properties?: string`\n\n### Returns\n\n- `{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }`\n\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyNoPaging = await client.crm.properties.list('objectType');\n\nconsole.log(collectionResponsePropertyNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyNoPaging = await client.crm.properties.list('objectType');\n\nconsole.log(collectionResponsePropertyNoPaging.results);", + }, + python: { + method: 'crm.properties.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_no_paging = client.crm.properties.list(\n object_type="objectType",\n)\nprint(collection_response_property_no_paging.results)', + }, + java: { + method: 'crm().properties().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.CollectionResponsePropertyNoPaging;\nimport com.hubspot.sdk.models.crm.properties.PropertyListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePropertyNoPaging collectionResponsePropertyNoPaging = client.crm().properties().list("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.Properties.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyNoPaging, err := client.Crm.Properties.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.properties.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_no_paging = hubspot.crm.properties.list("objectType")\n\nputs(collection_response_property_no_paging)', + }, + php: { + method: 'crm->properties->list', + example: + "crm->properties->list(\n 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n locale: 'locale',\n properties: 'properties',\n);\n\nvar_dump($collectionResponsePropertyNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', + httpMethod: 'patch', + summary: 'Update a property', + description: + 'Perform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.', + stainlessPath: '(resource) crm.properties > (method) update', + qualified: 'client.crm.properties.update', + params: [ + 'objectType: string;', + 'propertyName: string;', + 'calculationFormula?: string;', + 'currencyPropertyName?: string;', + 'description?: string;', + 'displayOrder?: number;', + 'fieldType?: string;', + 'formField?: boolean;', + 'groupName?: string;', + 'hidden?: boolean;', + 'label?: string;', + "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + 'showCurrencySymbol?: boolean;', + "type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", + ], + response: + "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", + markdown: + "## update\n\n`client.crm.properties.update(objectType: string, propertyName: string, calculationFormula?: string, currencyPropertyName?: string, description?: string, displayOrder?: number, fieldType?: string, formField?: boolean, groupName?: string, hidden?: boolean, label?: string, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], showCurrencySymbol?: boolean, type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**patch** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nPerform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `calculationFormula?: string`\n Represents a formula that is used to compute a calculated property.\n\n- `currencyPropertyName?: string`\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `displayOrder?: number`\n Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.\n\n- `fieldType?: string`\n Controls how the property appears in HubSpot.\n\n- `formField?: boolean`\n Whether or not the property can be used in a HubSpot form.\n\n- `groupName?: string`\n The name of the property group the property belongs to.\n\n- `hidden?: boolean`\n If true, the property won't be visible and can't be used in HubSpot.\n\n- `label?: string`\n A human-readable property label that will be shown in HubSpot.\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of valid options for the property.\n\n- `showCurrencySymbol?: boolean`\n\n- `type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n The data type of the property.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.update('propertyName', { objectType: 'objectType' });\n\nconsole.log(property);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.update('propertyName', { objectType: 'objectType' });\n\nconsole.log(property.hidden);", + }, + python: { + method: 'crm.properties.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.update(\n property_name="propertyName",\n object_type="objectType",\n)\nprint(property.hidden)', + }, + java: { + method: 'crm().properties().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.crm.properties.PropertyUpdate;\nimport com.hubspot.sdk.models.crm.properties.PropertyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyUpdateParams params = PropertyUpdateParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .propertyUpdate(PropertyUpdate.builder().build())\n .build();\n Property property = client.crm().properties().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.Update(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyUpdate: crm.PropertyUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', + }, + ruby: { + method: 'crm.properties.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.update("propertyName", object_type: "objectType")\n\nputs(property)', + }, + php: { + method: 'crm->properties->update', + example: + "crm->properties->update(\n 'propertyName',\n objectType: 'objectType',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n description: 'description',\n displayOrder: 0,\n fieldType: 'booleancheckbox',\n formField: true,\n groupName: 'groupName',\n hidden: true,\n label: 'label',\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n showCurrencySymbol: true,\n type: 'bool',\n);\n\nvar_dump($property);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create', + endpoint: '/crm/properties/2026-03/{objectType}/batch/create', + httpMethod: 'post', + summary: 'Create a batch of properties', + description: 'Create a batch of properties using the same rules as when creating an individual property.', + stainlessPath: '(resource) crm.properties.batch > (method) create', + qualified: 'client.crm.properties.batch.create', + params: [ + 'objectType: string;', + "inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[];", + ], + response: + "{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.properties.batch.create(objectType: string, inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]): { completedAt: string; results: property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/create`\n\nCreate a batch of properties using the same rules as when creating an individual property.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.crm.properties.batch.create('objectType', { inputs: [{\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n}] });\n\nconsole.log(batchResponseProperty);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.crm.properties.batch.create('objectType', {\n inputs: [\n {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n});\n\nconsole.log(batchResponseProperty.completedAt);", + }, + python: { + method: 'crm.properties.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.crm.properties.batch.create(\n object_type="objectType",\n inputs=[{\n "field_type": "booleancheckbox",\n "group_name": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n)\nprint(batch_response_property.completed_at)', + }, + java: { + method: 'crm().properties().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyCreate;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.crm.properties.BatchResponseProperty;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputPropertyCreate(BatchInputPropertyCreate.builder()\n .addInput(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.crm().properties().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Crm.Properties.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchNewParams{\n\t\t\tBatchInputPropertyCreate: shared.BatchInputPropertyCreateParam{\n\t\t\t\tInputs: []shared.PropertyCreateParam{{\n\t\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\t\tGroupName: "groupName",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.properties.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.crm.properties.batch.create(\n "objectType",\n inputs: [{fieldType: :booleancheckbox, groupName: "groupName", label: "label", name: "name", type: :bool}]\n)\n\nputs(batch_response_property)', + }, + php: { + method: 'crm->properties->batch->create', + example: + "crm->properties->batch->create(\n 'objectType',\n inputs: [\n [\n 'fieldType' => 'booleancheckbox',\n 'groupName' => 'groupName',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'calculationFormula' => 'calculationFormula',\n 'currencyPropertyName' => 'currencyPropertyName',\n 'dataSensitivity' => 'highly_sensitive',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptions' => true,\n 'formField' => true,\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'referencedObjectType' => 'referencedObjectType',\n 'showCurrencySymbol' => true,\n ],\n ],\n);\n\nvar_dump($batchResponseProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/properties/2026-03/{objectType}/batch/archive', + httpMethod: 'post', + summary: 'Archive a batch of properties', + description: + 'Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).', + stainlessPath: '(resource) crm.properties.batch > (method) delete', + qualified: 'client.crm.properties.batch.delete', + params: ['objectType: string;', 'inputs: { name: string; }[];'], + markdown: + "## delete\n\n`client.crm.properties.batch.delete(objectType: string, inputs: { name: string; }[]): void`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/archive`\n\nArchive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { name: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.batch.delete('objectType', { inputs: [{ name: 'name' }] })\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.batch.delete('objectType', { inputs: [{ name: 'name' }] });", + }, + python: { + method: 'crm.properties.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.batch.delete(\n object_type="objectType",\n inputs=[{\n "name": "name"\n }],\n)', + }, + java: { + method: 'crm().properties().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputPropertyName(BatchInputPropertyName.builder()\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n client.crm().properties().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchDeleteParams{\n\t\t\tBatchInputPropertyName: shared.BatchInputPropertyNameParam{\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.properties.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.batch.delete("objectType", inputs: [{name: "name"}])\n\nputs(result)', + }, + php: { + method: 'crm->properties->batch->delete', + example: + "crm->properties->batch->delete(\n 'objectType', inputs: [['name' => 'name']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/properties/2026-03/{objectType}/batch/read', + httpMethod: 'post', + summary: 'Read a batch of properties', + description: 'Read a provided list of properties.', + stainlessPath: '(resource) crm.properties.batch > (method) get', + qualified: 'client.crm.properties.batch.get', + params: [ + 'objectType: string;', + 'archived: boolean;', + "dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", + 'inputs: { name: string; }[];', + 'locale?: string;', + ], + response: + "{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.crm.properties.batch.get(objectType: string, archived: boolean, dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive', inputs: { name: string; }[], locale?: string): { completedAt: string; results: property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/read`\n\nRead a provided list of properties.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived: boolean`\n\n- `dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `inputs: { name: string; }[]`\n\n- `locale?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.crm.properties.batch.get('objectType', {\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.crm.properties.batch.get('objectType', {\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty.completedAt);", + }, + python: { + method: 'crm.properties.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.crm.properties.batch.get(\n object_type="objectType",\n archived=True,\n data_sensitivity="highly_sensitive",\n inputs=[{\n "name": "name"\n }],\n)\nprint(batch_response_property.completed_at)', + }, + java: { + method: 'crm().properties().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchReadInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.crm.properties.BatchResponseProperty;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputPropertyName(BatchReadInputPropertyName.builder()\n .archived(true)\n .dataSensitivity(BatchReadInputPropertyName.DataSensitivity.HIGHLY_SENSITIVE)\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.crm().properties().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Crm.Properties.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchGetParams{\n\t\t\tBatchReadInputPropertyName: shared.BatchReadInputPropertyNameParam{\n\t\t\t\tArchived: true,\n\t\t\t\tDataSensitivity: shared.BatchReadInputPropertyNameDataSensitivityHighlySensitive,\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.properties.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.crm.properties.batch.get(\n "objectType",\n archived: true,\n data_sensitivity: :highly_sensitive,\n inputs: [{name: "name"}]\n)\n\nputs(batch_response_property)', + }, + php: { + method: 'crm->properties->batch->get', + example: + "crm->properties->batch->get(\n 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [['name' => 'name']],\n locale: 'locale',\n);\n\nvar_dump($batchResponseProperty);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "archived": true,\n "dataSensitivity": "highly_sensitive",\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/crm/properties/2026-03/{objectType}/groups', + httpMethod: 'post', + summary: 'Create a property group', + description: 'Create and return a copy of a new property group.', + stainlessPath: '(resource) crm.properties.groups > (method) create', + qualified: 'client.crm.properties.groups.create', + params: ['objectType: string;', 'label: string;', 'name: string;', 'displayOrder?: number;'], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## create\n\n`client.crm.properties.groups.create(objectType: string, label: string, name: string, displayOrder?: number): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**post** `/crm/properties/2026-03/{objectType}/groups`\n\nCreate and return a copy of a new property group.\n\n### Parameters\n\n- `objectType: string`\n\n- `label: string`\n\n- `name: string`\n\n- `displayOrder?: number`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.create('objectType', { label: 'label', name: 'name' });\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.groups.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.create('objectType', {\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'crm.properties.groups.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.create(\n object_type="objectType",\n label="label",\n name="name",\n)\nprint(property_group.archived)', + }, + java: { + method: 'crm().properties().groups().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupCreate;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupCreateParams params = GroupCreateParams.builder()\n .objectType("objectType")\n .propertyGroupCreate(PropertyGroupCreate.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Groups.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyGroupNewParams{\n\t\t\tPropertyGroupCreate: shared.PropertyGroupCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'crm.properties.groups.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.create("objectType", label: "label", name: "name")\n\nputs(property_group)', + }, + php: { + method: 'crm->properties->groups->create', + example: + "crm->properties->groups->create(\n 'objectType', label: 'label', name: 'name', displayOrder: 0\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + httpMethod: 'delete', + summary: 'Archive a property group', + description: 'Move a property group identified by {groupName} to the recycling bin.', + stainlessPath: '(resource) crm.properties.groups > (method) delete', + qualified: 'client.crm.properties.groups.delete', + params: ['objectType: string;', 'groupName: string;'], + markdown: + "## delete\n\n`client.crm.properties.groups.delete(objectType: string, groupName: string): void`\n\n**delete** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nMove a property group identified by {groupName} to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.groups.delete('groupName', { objectType: 'objectType' })\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.groups.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.groups.delete('groupName', { objectType: 'objectType' });", + }, + python: { + method: 'crm.properties.groups.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.groups.delete(\n group_name="groupName",\n object_type="objectType",\n)', + }, + java: { + method: 'crm().properties().groups().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupDeleteParams params = GroupDeleteParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .build();\n client.crm().properties().groups().delete(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Groups.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Groups.Delete(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.properties.groups.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.groups.delete("groupName", object_type: "objectType")\n\nputs(result)', + }, + php: { + method: 'crm->properties->groups->delete', + example: + "crm->properties->groups->delete(\n 'groupName', objectType: 'objectType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + httpMethod: 'get', + summary: 'Read a property group', + description: 'Read a property group identified by {groupName}.', + stainlessPath: '(resource) crm.properties.groups > (method) get', + qualified: 'client.crm.properties.groups.get', + params: ['objectType: string;', 'groupName: string;', 'locale?: string;'], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## get\n\n`client.crm.properties.groups.get(objectType: string, groupName: string, locale?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**get** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nRead a property group identified by {groupName}.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `locale?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.get('groupName', { objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.groups.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.get('groupName', {\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'crm.properties.groups.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.get(\n group_name="groupName",\n object_type="objectType",\n)\nprint(property_group.archived)', + }, + java: { + method: 'crm().properties().groups().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupGetParams params = GroupGetParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().get(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Groups.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.Get(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'crm.properties.groups.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.get("groupName", object_type: "objectType")\n\nputs(property_group)', + }, + php: { + method: 'crm->properties->groups->get', + example: + "crm->properties->groups->get(\n 'groupName', objectType: 'objectType', locale: 'locale'\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/crm/properties/2026-03/{objectType}/groups', + httpMethod: 'get', + summary: 'Read all property groups', + description: 'Read all existing property groups for the specified object type and HubSpot account.', + stainlessPath: '(resource) crm.properties.groups > (method) list', + qualified: 'client.crm.properties.groups.list', + params: ['objectType: string;', 'locale?: string;'], + response: '{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }', + markdown: + "## list\n\n`client.crm.properties.groups.list(objectType: string, locale?: string): { results: property_group[]; }`\n\n**get** `/crm/properties/2026-03/{objectType}/groups`\n\nRead all existing property groups for the specified object type and HubSpot account.\n\n### Parameters\n\n- `objectType: string`\n\n- `locale?: string`\n\n### Returns\n\n- `{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }`\n\n - `results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyGroupNoPaging = await client.crm.properties.groups.list('objectType');\n\nconsole.log(collectionResponsePropertyGroupNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.groups.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyGroupNoPaging = await client.crm.properties.groups.list(\n 'objectType',\n);\n\nconsole.log(collectionResponsePropertyGroupNoPaging.results);", + }, + python: { + method: 'crm.properties.groups.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_group_no_paging = client.crm.properties.groups.list(\n object_type="objectType",\n)\nprint(collection_response_property_group_no_paging.results)', + }, + java: { + method: 'crm().properties().groups().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.CollectionResponsePropertyGroupNoPaging;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePropertyGroupNoPaging collectionResponsePropertyGroupNoPaging = client.crm().properties().groups().list("objectType");\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Groups.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyGroupNoPaging, err := client.Crm.Properties.Groups.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyGroupListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyGroupNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.properties.groups.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_group_no_paging = hubspot.crm.properties.groups.list("objectType")\n\nputs(collection_response_property_group_no_paging)', + }, + php: { + method: 'crm->properties->groups->list', + example: + "crm\n ->properties\n ->groups\n ->list('objectType', locale: 'locale');\n\nvar_dump($collectionResponsePropertyGroupNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + httpMethod: 'patch', + summary: 'Update a property group', + description: + 'Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.', + stainlessPath: '(resource) crm.properties.groups > (method) update', + qualified: 'client.crm.properties.groups.update', + params: ['objectType: string;', 'groupName: string;', 'displayOrder?: number;', 'label?: string;'], + response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', + markdown: + "## update\n\n`client.crm.properties.groups.update(objectType: string, groupName: string, displayOrder?: number, label?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**patch** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nPerform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `displayOrder?: number`\n\n- `label?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.update('groupName', { objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", + perLanguage: { + typescript: { + method: 'client.crm.properties.groups.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.update('groupName', {\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", + }, + python: { + method: 'crm.properties.groups.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.update(\n group_name="groupName",\n object_type="objectType",\n)\nprint(property_group.archived)', + }, + java: { + method: 'crm().properties().groups().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupUpdate;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupUpdateParams params = GroupUpdateParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .propertyGroupUpdate(PropertyGroupUpdate.builder().build())\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().update(params);\n }\n}', + }, + go: { + method: 'client.Crm.Properties.Groups.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.Update(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyGroupUpdate: shared.PropertyGroupUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', + }, + ruby: { + method: 'crm.properties.groups.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.update("groupName", object_type: "objectType")\n\nputs(property_group)', + }, + php: { + method: 'crm->properties->groups->update', + example: + "crm->properties->groups->update(\n 'groupName', objectType: 'objectType', displayOrder: 0, label: 'label'\n);\n\nvar_dump($propertyGroup);", + }, + http: { + example: + "curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'get_by_object_type_id', + endpoint: '/crm/property-validations/2026-03/{objectTypeId}', + httpMethod: 'get', + summary: 'Read all property validation rules for an object', + description: 'Read all properties with validation rules for a given object.', + stainlessPath: '(resource) crm.properties_validations > (method) get_by_object_type_id', + qualified: 'client.crm.propertiesValidations.getByObjectTypeID', + params: ['objectTypeId: string;'], + response: + '{ results: { propertyName: string; propertyValidationRules: public_property_validation_rule[]; }[]; }', + markdown: + "## get_by_object_type_id\n\n`client.crm.propertiesValidations.getByObjectTypeID(objectTypeId: string): { results: public_property_validation_rule_map[]; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}`\n\nRead all properties with validation rules for a given object.\n\n### Parameters\n\n- `objectTypeId: string`\n\n### Returns\n\n- `{ results: { propertyName: string; propertyValidationRules: public_property_validation_rule[]; }[]; }`\n\n - `results: { propertyName: string; propertyValidationRules: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPropertyValidationRuleMapNoPaging = await client.crm.propertiesValidations.getByObjectTypeID('objectTypeId');\n\nconsole.log(collectionResponsePublicPropertyValidationRuleMapNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.propertiesValidations.getByObjectTypeID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPropertyValidationRuleMapNoPaging =\n await client.crm.propertiesValidations.getByObjectTypeID('objectTypeId');\n\nconsole.log(collectionResponsePublicPropertyValidationRuleMapNoPaging.results);", + }, + python: { + method: 'crm.properties_validations.get_by_object_type_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_property_validation_rule_map_no_paging = client.crm.properties_validations.get_by_object_type_id(\n "objectTypeId",\n)\nprint(collection_response_public_property_validation_rule_map_no_paging.results)', + }, + java: { + method: 'crm().propertiesValidations().getByObjectTypeId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.CollectionResponsePublicPropertyValidationRuleMapNoPaging;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicPropertyValidationRuleMapNoPaging collectionResponsePublicPropertyValidationRuleMapNoPaging = client.crm().propertiesValidations().getByObjectTypeId("objectTypeId");\n }\n}', + }, + go: { + method: 'client.Crm.PropertiesValidations.GetByObjectTypeID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPropertyValidationRuleMapNoPaging, err := client.Crm.PropertiesValidations.GetByObjectTypeID(context.TODO(), "objectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPropertyValidationRuleMapNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.properties_validations.get_by_object_type_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_property_validation_rule_map_no_paging = hubspot.crm.properties_validations.get_by_object_type_id("objectTypeId")\n\nputs(collection_response_public_property_validation_rule_map_no_paging)', + }, + php: { + method: 'crm->propertiesValidations->getByObjectTypeID', + example: + "crm\n ->propertiesValidations\n ->getByObjectTypeID('objectTypeId');\n\nvar_dump($collectionResponsePublicPropertyValidationRuleMapNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_object_type_id_and_property_name', + endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}', + httpMethod: 'get', + summary: 'Read validation rules for a property', + description: "Read a property's validation rules identified by {propertyName}.", + stainlessPath: '(resource) crm.properties_validations > (method) get_by_object_type_id_and_property_name', + qualified: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', + params: ['objectTypeId: string;', 'propertyName: string;'], + response: + '{ results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }', + markdown: + "## get_by_object_type_id_and_property_name\n\n`client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName(objectTypeId: string, propertyName: string): { results: public_property_validation_rule[]; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}`\n\nRead a property's validation rules identified by {propertyName}.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n### Returns\n\n- `{ results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }`\n\n - `results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPropertyValidationRuleNoPaging = await client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName('propertyName', { objectTypeId: 'objectTypeId' });\n\nconsole.log(collectionResponsePublicPropertyValidationRuleNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPropertyValidationRuleNoPaging =\n await client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName('propertyName', {\n objectTypeId: 'objectTypeId',\n });\n\nconsole.log(collectionResponsePublicPropertyValidationRuleNoPaging.results);", + }, + python: { + method: 'crm.properties_validations.get_by_object_type_id_and_property_name', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_property_validation_rule_no_paging = client.crm.properties_validations.get_by_object_type_id_and_property_name(\n property_name="propertyName",\n object_type_id="objectTypeId",\n)\nprint(collection_response_public_property_validation_rule_no_paging.results)', + }, + java: { + method: 'crm().propertiesValidations().getByObjectTypeIdAndPropertyName', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.CollectionResponsePublicPropertyValidationRuleNoPaging;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdAndPropertyNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationGetByObjectTypeIdAndPropertyNameParams params = PropertiesValidationGetByObjectTypeIdAndPropertyNameParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .build();\n CollectionResponsePublicPropertyValidationRuleNoPaging collectionResponsePublicPropertyValidationRuleNoPaging = client.crm().propertiesValidations().getByObjectTypeIdAndPropertyName(params);\n }\n}', + }, + go: { + method: 'client.Crm.PropertiesValidations.GetByObjectTypeIDAndPropertyName', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPropertyValidationRuleNoPaging, err := client.Crm.PropertiesValidations.GetByObjectTypeIDAndPropertyName(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertiesValidationGetByObjectTypeIDAndPropertyNameParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPropertyValidationRuleNoPaging.Results)\n}\n', + }, + ruby: { + method: 'crm.properties_validations.get_by_object_type_id_and_property_name', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_property_validation_rule_no_paging = hubspot.crm.properties_validations.get_by_object_type_id_and_property_name(\n "propertyName",\n object_type_id: "objectTypeId"\n)\n\nputs(collection_response_public_property_validation_rule_no_paging)', + }, + php: { + method: 'crm->propertiesValidations->getByObjectTypeIDAndPropertyName', + example: + "crm\n ->propertiesValidations\n ->getByObjectTypeIDAndPropertyName(\n 'propertyName', objectTypeID: 'objectTypeId'\n);\n\nvar_dump($collectionResponsePublicPropertyValidationRuleNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_object_type_id_property_name_and_rule_type', + endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', + httpMethod: 'get', + summary: + 'Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted.', + description: 'Retrieve a specific validation rule for a property identified by its name and rule type.', + stainlessPath: + '(resource) crm.properties_validations > (method) get_by_object_type_id_property_name_and_rule_type', + qualified: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', + params: ['objectTypeId: string;', 'propertyName: string;', 'ruleType: string;'], + response: '{ ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }', + markdown: + "## get_by_object_type_id_property_name_and_rule_type\n\n`client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType(objectTypeId: string, propertyName: string, ruleType: string): { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}`\n\nRetrieve a specific validation rule for a property identified by its name and rule type.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n- `ruleType: string`\n\n### Returns\n\n- `{ ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }`\n\n - `ruleArguments: string[]`\n - `ruleType: string`\n - `shouldApplyNormalization?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicPropertyValidationRule = await client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType('AFTER_DATETIME_DURATION', { objectTypeId: 'objectTypeId', propertyName: 'propertyName' });\n\nconsole.log(publicPropertyValidationRule);\n```", + perLanguage: { + typescript: { + method: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicPropertyValidationRule =\n await client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n { objectTypeId: 'objectTypeId', propertyName: 'propertyName' },\n );\n\nconsole.log(publicPropertyValidationRule.ruleArguments);", + }, + python: { + method: 'crm.properties_validations.get_by_object_type_id_property_name_and_rule_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_property_validation_rule = client.crm.properties_validations.get_by_object_type_id_property_name_and_rule_type(\n rule_type="AFTER_DATETIME_DURATION",\n object_type_id="objectTypeId",\n property_name="propertyName",\n)\nprint(public_property_validation_rule.rule_arguments)', + }, + java: { + method: 'crm().propertiesValidations().getByObjectTypeIdPropertyNameAndRuleType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PublicPropertyValidationRule;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams params = PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .ruleType(PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams.RuleType.AFTER_DATETIME_DURATION)\n .build();\n PublicPropertyValidationRule publicPropertyValidationRule = client.crm().propertiesValidations().getByObjectTypeIdPropertyNameAndRuleType(params);\n }\n}', + }, + go: { + method: 'client.Crm.PropertiesValidations.GetByObjectTypeIDPropertyNameAndRuleType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicPropertyValidationRule, err := client.Crm.PropertiesValidations.GetByObjectTypeIDPropertyNameAndRuleType(\n\t\tcontext.TODO(),\n\t\tcrm.PropertiesValidationGetByObjectTypeIDPropertyNameAndRuleTypeParamsRuleTypeAfterDatetimeDuration,\n\t\tcrm.PropertiesValidationGetByObjectTypeIDPropertyNameAndRuleTypeParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tPropertyName: "propertyName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicPropertyValidationRule.RuleArguments)\n}\n', + }, + ruby: { + method: 'crm.properties_validations.get_by_object_type_id_property_name_and_rule_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_property_validation_rule = hubspot.crm.properties_validations.get_by_object_type_id_property_name_and_rule_type(\n :AFTER_DATETIME_DURATION,\n object_type_id: "objectTypeId",\n property_name: "propertyName"\n)\n\nputs(public_property_validation_rule)', + }, + php: { + method: 'crm->propertiesValidations->getByObjectTypeIDPropertyNameAndRuleType', + example: + "crm\n ->propertiesValidations\n ->getByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n);\n\nvar_dump($publicPropertyValidationRule);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME/rule-type/$RULE_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_by_object_type_id_property_name_and_rule_type', + endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', + httpMethod: 'put', + summary: + 'Update a validation rule for a specific property and rule type, allowing customization of property value constraints.', + description: 'Update a specific validation rule for a property identified by its name and rule type.', + stainlessPath: + '(resource) crm.properties_validations > (method) update_by_object_type_id_property_name_and_rule_type', + qualified: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', + params: [ + 'objectTypeId: string;', + 'propertyName: string;', + 'ruleType: string;', + 'ruleArguments: string[];', + 'shouldApplyNormalization?: boolean;', + ], + markdown: + "## update_by_object_type_id_property_name_and_rule_type\n\n`client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType(objectTypeId: string, propertyName: string, ruleType: string, ruleArguments: string[], shouldApplyNormalization?: boolean): void`\n\n**put** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}`\n\nUpdate a specific validation rule for a property identified by its name and rule type.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n- `ruleType: string`\n\n- `ruleArguments: string[]`\n A list of arguments that define the constraints for the validation rule.\n\n- `shouldApplyNormalization?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType('AFTER_DATETIME_DURATION', {\n objectTypeId: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n})\n```", + perLanguage: { + typescript: { + method: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n {\n objectTypeId: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n },\n);", + }, + python: { + method: 'crm.properties_validations.update_by_object_type_id_property_name_and_rule_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties_validations.update_by_object_type_id_property_name_and_rule_type(\n rule_type="AFTER_DATETIME_DURATION",\n object_type_id="objectTypeId",\n property_name="propertyName",\n rule_arguments=["string"],\n)', + }, + java: { + method: 'crm().propertiesValidations().updateByObjectTypeIdPropertyNameAndRuleType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PublicPropertyValidationRuleUpdate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams params = PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .ruleType(PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams.RuleType.AFTER_DATETIME_DURATION)\n .publicPropertyValidationRuleUpdate(PublicPropertyValidationRuleUpdate.builder()\n .addRuleArgument("string")\n .build())\n .build();\n client.crm().propertiesValidations().updateByObjectTypeIdPropertyNameAndRuleType(params);\n }\n}', + }, + go: { + method: 'client.Crm.PropertiesValidations.UpdateByObjectTypeIDPropertyNameAndRuleType', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.PropertiesValidations.UpdateByObjectTypeIDPropertyNameAndRuleType(\n\t\tcontext.TODO(),\n\t\tcrm.PropertiesValidationUpdateByObjectTypeIDPropertyNameAndRuleTypeParamsRuleTypeAfterDatetimeDuration,\n\t\tcrm.PropertiesValidationUpdateByObjectTypeIDPropertyNameAndRuleTypeParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tPropertyName: "propertyName",\n\t\t\tPublicPropertyValidationRuleUpdate: crm.PublicPropertyValidationRuleUpdateParam{\n\t\t\t\tRuleArguments: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.properties_validations.update_by_object_type_id_property_name_and_rule_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties_validations.update_by_object_type_id_property_name_and_rule_type(\n :AFTER_DATETIME_DURATION,\n object_type_id: "objectTypeId",\n property_name: "propertyName",\n rule_arguments: ["string"]\n)\n\nputs(result)', + }, + php: { + method: 'crm->propertiesValidations->updateByObjectTypeIDPropertyNameAndRuleType', + example: + "crm\n ->propertiesValidations\n ->updateByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n shouldApplyNormalization: true,\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME/rule-type/$RULE_TYPE \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "ruleArguments": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'create_event', + endpoint: '/integrators/timeline/2026-03/events', + httpMethod: 'post', + summary: 'Send event data (single)', + description: 'Send a single instance of event data to a specified event type.', + stainlessPath: '(resource) crm.timeline > (method) create_event', + qualified: 'client.crm.timeline.createEvent', + params: [ + 'id: string;', + 'eventTypeName: string;', + 'properties: object;', + 'domain?: string;', + 'email?: string;', + 'extraData?: object;', + 'objectId?: string;', + 'objectTypeFullyQualifiedName?: string;', + 'timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; };', + 'timestamp?: string;', + 'utk?: string;', + ], + markdown: + "## create_event\n\n`client.crm.timeline.createEvent(id: string, eventTypeName: string, properties: object, domain?: string, email?: string, extraData?: object, objectId?: string, objectTypeFullyQualifiedName?: string, timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }, timestamp?: string, utk?: string): void`\n\n**post** `/integrators/timeline/2026-03/events`\n\nSend a single instance of event data to a specified event type.\n\n### Parameters\n\n- `id: string`\n\n- `eventTypeName: string`\n\n- `properties: object`\n\n- `domain?: string`\n\n- `email?: string`\n\n- `extraData?: object`\n\n- `objectId?: string`\n\n- `objectTypeFullyQualifiedName?: string`\n\n- `timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }`\n - `headerLabel: string`\n The label of the modal window that displays the iframe contents.\n - `height: number`\n The height of the modal window in pixels.\n - `linkLabel: string`\n The text displaying the link that will display the iframe.\n - `url: string`\n The URI of the iframe contents.\n - `width: number`\n The width of the modal window in pixels.\n\n- `timestamp?: string`\n\n- `utk?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.timeline.createEvent({\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n})\n```", + perLanguage: { + typescript: { + method: 'client.crm.timeline.createEvent', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.timeline.createEvent({\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n});", + }, + python: { + method: 'crm.timeline.create_event', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.timeline.create_event(\n id="id",\n event_type_name="eventTypeName",\n properties={\n "foo": "string"\n },\n)', + }, + java: { + method: 'crm().timeline().createEvent', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.timeline.AppEventOccurrence;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AppEventOccurrence params = AppEventOccurrence.builder()\n .id("id")\n .eventTypeName("eventTypeName")\n .properties(AppEventOccurrence.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n client.crm().timeline().createEvent(params);\n }\n}', + }, + go: { + method: 'client.Crm.Timeline.NewEvent', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Timeline.NewEvent(context.TODO(), crm.TimelineNewEventParams{\n\t\tAppEventOccurrence: crm.AppEventOccurrenceParam{\n\t\t\tID: "id",\n\t\t\tEventTypeName: "eventTypeName",\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'crm.timeline.create_event', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.timeline.create_event(id: "id", event_type_name: "eventTypeName", properties: {foo: "string"})\n\nputs(result)', + }, + php: { + method: 'crm->timeline->createEvent', + example: + "crm->timeline->createEvent(\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: ['foo' => 'string'],\n domain: 'domain',\n email: 'email',\n extraData: (object) [],\n objectID: 'objectId',\n objectTypeFullyQualifiedName: 'objectTypeFullyQualifiedName',\n timelineIFrame: [\n 'headerLabel' => 'headerLabel',\n 'height' => 0,\n 'linkLabel' => 'linkLabel',\n 'url' => 'url',\n 'width' => 0,\n ],\n timestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n utk: 'utk',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/integrators/timeline/2026-03/events \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "eventTypeName": "eventTypeName",\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create_project_type', + endpoint: '/integrators/timeline/2026-03/types/projects', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.timeline > (method) create_project_type', + qualified: 'client.crm.timeline.createProjectType', + params: ['developerSymbol: string;', 'projectName: string;'], + response: + '{ developerQualifiedSymbol: { developerSymbol: string; projectName: string; }; fullyQualifiedName: string; }', + markdown: + "## create_project_type\n\n`client.crm.timeline.createProjectType(developerSymbol: string, projectName: string): { developerQualifiedSymbol: developer_qualified_symbol; fullyQualifiedName: string; }`\n\n**post** `/integrators/timeline/2026-03/types/projects`\n\n### Parameters\n\n- `developerSymbol: string`\n\n- `projectName: string`\n\n### Returns\n\n- `{ developerQualifiedSymbol: { developerSymbol: string; projectName: string; }; fullyQualifiedName: string; }`\n\n - `developerQualifiedSymbol: { developerSymbol: string; projectName: string; }`\n - `fullyQualifiedName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst appEventResolutionResponse = await client.crm.timeline.createProjectType({ developerSymbol: 'developerSymbol', projectName: 'projectName' });\n\nconsole.log(appEventResolutionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.crm.timeline.createProjectType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst appEventResolutionResponse = await client.crm.timeline.createProjectType({\n developerSymbol: 'developerSymbol',\n projectName: 'projectName',\n});\n\nconsole.log(appEventResolutionResponse.developerQualifiedSymbol);", + }, + python: { + method: 'crm.timeline.create_project_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\napp_event_resolution_response = client.crm.timeline.create_project_type(\n developer_symbol="developerSymbol",\n project_name="projectName",\n)\nprint(app_event_resolution_response.developer_qualified_symbol)', + }, + java: { + method: 'crm().timeline().createProjectType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.timeline.AppEventResolutionResponse;\nimport com.hubspot.sdk.models.crm.timeline.ExternalAppEventResolutionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalAppEventResolutionRequest params = ExternalAppEventResolutionRequest.builder()\n .developerSymbol("developerSymbol")\n .projectName("projectName")\n .build();\n AppEventResolutionResponse appEventResolutionResponse = client.crm().timeline().createProjectType(params);\n }\n}', + }, + go: { + method: 'client.Crm.Timeline.NewProjectType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tappEventResolutionResponse, err := client.Crm.Timeline.NewProjectType(context.TODO(), crm.TimelineNewProjectTypeParams{\n\t\tExternalAppEventResolutionRequest: crm.ExternalAppEventResolutionRequestParam{\n\t\t\tDeveloperSymbol: "developerSymbol",\n\t\t\tProjectName: "projectName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", appEventResolutionResponse.DeveloperQualifiedSymbol)\n}\n', + }, + ruby: { + method: 'crm.timeline.create_project_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\napp_event_resolution_response = hubspot.crm.timeline.create_project_type(developer_symbol: "developerSymbol", project_name: "projectName")\n\nputs(app_event_resolution_response)', + }, + php: { + method: 'crm->timeline->createProjectType', + example: + "crm->timeline->createProjectType(\n developerSymbol: 'developerSymbol', projectName: 'projectName'\n);\n\nvar_dump($appEventResolutionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/integrators/timeline/2026-03/types/projects \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "developerSymbol": "developerSymbol",\n "projectName": "projectName"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/integrators/timeline/2026-03/events/batch', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) crm.timeline.batch > (method) create', + qualified: 'client.crm.timeline.batch.create', + params: [ + 'inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[];', + ], + response: + "{ completedAt: string; results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create\n\n`client.crm.timeline.batch.create(inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]): { completedAt: string; results: app_event_occurrence[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/integrators/timeline/2026-03/events/batch`\n\n### Parameters\n\n- `inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseAppEventOccurrence = await client.crm.timeline.batch.create({ inputs: [{\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseAppEventOccurrence);\n```", + perLanguage: { + typescript: { + method: 'client.crm.timeline.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseAppEventOccurrence = await client.crm.timeline.batch.create({\n inputs: [\n {\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseAppEventOccurrence.completedAt);", + }, + python: { + method: 'crm.timeline.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_app_event_occurrence = client.crm.timeline.batch.create(\n inputs=[{\n "id": "id",\n "event_type_name": "eventTypeName",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_app_event_occurrence.completed_at)', + }, + java: { + method: 'crm().timeline().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.timeline.AppEventOccurrence;\nimport com.hubspot.sdk.models.crm.timeline.BatchInputAppEventOccurrence;\nimport com.hubspot.sdk.models.crm.timeline.BatchResponseAppEventOccurrence;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputAppEventOccurrence params = BatchInputAppEventOccurrence.builder()\n .addInput(AppEventOccurrence.builder()\n .id("id")\n .eventTypeName("eventTypeName")\n .properties(AppEventOccurrence.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseAppEventOccurrence batchResponseAppEventOccurrence = client.crm().timeline().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Crm.Timeline.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseAppEventOccurrence, err := client.Crm.Timeline.Batch.New(context.TODO(), crm.TimelineBatchNewParams{\n\t\tBatchInputAppEventOccurrence: crm.BatchInputAppEventOccurrenceParam{\n\t\t\tInputs: []crm.AppEventOccurrenceParam{{\n\t\t\t\tID: "id",\n\t\t\t\tEventTypeName: "eventTypeName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseAppEventOccurrence.CompletedAt)\n}\n', + }, + ruby: { + method: 'crm.timeline.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_app_event_occurrence = hubspot.crm.timeline.batch.create(\n inputs: [{id: "id", eventTypeName: "eventTypeName", properties: {foo: "string"}}]\n)\n\nputs(batch_response_app_event_occurrence)', + }, + php: { + method: 'crm->timeline->batch->create', + example: + "crm->timeline->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'eventTypeName' => 'eventTypeName',\n 'properties' => ['foo' => 'string'],\n 'domain' => 'domain',\n 'email' => 'email',\n 'extraData' => (object) [],\n 'objectID' => 'objectId',\n 'objectTypeFullyQualifiedName' => 'objectTypeFullyQualifiedName',\n 'timelineIFrame' => [\n 'headerLabel' => 'headerLabel',\n 'height' => 0,\n 'linkLabel' => 'linkLabel',\n 'url' => 'url',\n 'width' => 0,\n ],\n 'timestamp' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n ],\n ],\n);\n\nvar_dump($batchResponseAppEventOccurrence);", + }, + http: { + example: + 'curl https://api.hubapi.com/integrators/timeline/2026-03/events/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "eventTypeName": "eventTypeName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/events/2026-03/event-definitions', + httpMethod: 'post', + summary: 'Create custom event definition', + description: 'Create a custom event definition.', + stainlessPath: '(resource) events.definitions > (method) create', + qualified: 'client.events.definitions.create', + params: [ + 'includeDefaultProperties: boolean;', + 'label: string;', + 'propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; }[];', + 'customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; };', + 'description?: string;', + 'name?: string;', + 'primaryObject?: string;', + ], + response: + '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', + markdown: + "## create\n\n`client.events.definitions.create(includeDefaultProperties: boolean, label: string, propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: option_input[]; }[], customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }, description?: string, name?: string, primaryObject?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**post** `/events/2026-03/event-definitions`\n\nCreate a custom event definition.\n\n### Parameters\n\n- `includeDefaultProperties: boolean`\n\n- `label: string`\n Human readable label for the event. Used in HubSpot UI\n\n- `propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; }[]`\n List of custom properties on event\n\n- `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }`\n\n- `description?: string`\n A description of the event that will be shown as help text in HubSpot.\n\n- `name?: string`\n Internal event name, which must be used when referencing the event from this event definitions API. If a name is not supplied, one will be generated based on the label. The `name` value will also be used to automatically generate a `fullyQualifiedName` for the event definition, which you'll use when sending event completions to this event. \n\n- `primaryObject?: string`\n The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects.\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.create({\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [{ label: 'label', type: 'type' }],\n});\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.create({\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [{ label: 'label', type: 'type' }],\n});\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", + }, + python: { + method: 'events.definitions.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.create(\n include_default_properties=True,\n label="label",\n property_definitions=[{\n "label": "label",\n "type": "type",\n }],\n)\nprint(external_behavioral_event_type_definition.id)', + }, + java: { + method: 'events().definitions().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyCreate;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinitionEgg;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalBehavioralEventTypeDefinitionEgg params = ExternalBehavioralEventTypeDefinitionEgg.builder()\n .includeDefaultProperties(true)\n .label("label")\n .addPropertyDefinition(ExternalBehavioralEventPropertyCreate.builder()\n .label("label")\n .type("type")\n .build())\n .build();\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().create(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.New(context.TODO(), events.DefinitionNewParams{\n\t\tExternalBehavioralEventTypeDefinitionEgg: events.ExternalBehavioralEventTypeDefinitionEggParam{\n\t\t\tIncludeDefaultProperties: true,\n\t\t\tLabel: "label",\n\t\t\tPropertyDefinitions: []events.ExternalBehavioralEventPropertyCreateParam{{\n\t\t\t\tLabel: "label",\n\t\t\t\tType: "type",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', + }, + ruby: { + method: 'events.definitions.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.create(\n include_default_properties: true,\n label: "label",\n property_definitions: [{label: "label", type: "type"}]\n)\n\nputs(external_behavioral_event_type_definition)', + }, + php: { + method: 'events->definitions->create', + example: + "events->definitions->create(\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [\n [\n 'label' => 'label',\n 'type' => 'type',\n 'description' => 'description',\n 'name' => 'name',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n ],\n ],\n customMatchingID: [\n 'primaryObjectRule' => [\n 'eventPropertyName' => 'eventPropertyName',\n 'targetObjectPropertyName' => 'targetObjectPropertyName',\n ],\n ],\n description: 'description',\n name: 'name',\n primaryObject: 'primaryObject',\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "includeDefaultProperties": true,\n "label": "label",\n "propertyDefinitions": [\n {\n "label": "label",\n "type": "type"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_property', + endpoint: '/events/2026-03/event-definitions/{eventName}/property', + httpMethod: 'post', + summary: 'Create a property for an event definition', + description: 'Create a new property for an existing event definition.', + stainlessPath: '(resource) events.definitions > (method) create_property', + qualified: 'client.events.definitions.createProperty', + params: [ + 'eventName: string;', + 'label: string;', + 'type: string;', + 'description?: string;', + 'name?: string;', + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + ], + response: + "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", + markdown: + "## create_property\n\n`client.events.definitions.createProperty(eventName: string, label: string, type: string, description?: string, name?: string, options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**post** `/events/2026-03/event-definitions/{eventName}/property`\n\nCreate a new property for an existing event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `label: string`\n Human readable label for the property. Used in HubSpot UI\n\n- `type: string`\n The data type of the property. Can be one of the following: [string, number, enumeration, datetime]\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `name?: string`\n Internal property name, which must be used when referencing the property from the API\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.events.definitions.createProperty('eventName', { label: 'label', type: 'type' });\n\nconsole.log(property);\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.createProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.events.definitions.createProperty('eventName', {\n label: 'label',\n type: 'type',\n});\n\nconsole.log(property.hidden);", + }, + python: { + method: 'events.definitions.create_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.events.definitions.create_property(\n event_name="eventName",\n label="label",\n type="type",\n)\nprint(property.hidden)', + }, + java: { + method: 'events().definitions().createProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.events.definitions.DefinitionCreatePropertyParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreatePropertyParams params = DefinitionCreatePropertyParams.builder()\n .eventName("eventName")\n .externalBehavioralEventPropertyCreate(ExternalBehavioralEventPropertyCreate.builder()\n .label("label")\n .type("type")\n .build())\n .build();\n Property property = client.events().definitions().createProperty(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.NewProperty', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Events.Definitions.NewProperty(\n\t\tcontext.TODO(),\n\t\t"eventName",\n\t\tevents.DefinitionNewPropertyParams{\n\t\t\tExternalBehavioralEventPropertyCreate: events.ExternalBehavioralEventPropertyCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tType: "type",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', + }, + ruby: { + method: 'events.definitions.create_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.events.definitions.create_property("eventName", label: "label", type: "type")\n\nputs(property)', + }, + php: { + method: 'events->definitions->createProperty', + example: + "events->definitions->createProperty(\n 'eventName',\n label: 'label',\n type: 'type',\n description: 'description',\n name: 'name',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n);\n\nvar_dump($property);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "type": "type"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/events/2026-03/event-definitions/{eventName}', + httpMethod: 'delete', + summary: 'Delete an event definition', + description: 'Delete a custom event definition by name.', + stainlessPath: '(resource) events.definitions > (method) delete', + qualified: 'client.events.definitions.delete', + params: ['eventName: string;'], + markdown: + "## delete\n\n`client.events.definitions.delete(eventName: string): void`\n\n**delete** `/events/2026-03/event-definitions/{eventName}`\n\nDelete a custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.delete('eventName')\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.delete('eventName');", + }, + python: { + method: 'events.definitions.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.delete(\n "eventName",\n)', + }, + java: { + method: 'events().definitions().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.events().definitions().delete("eventName");\n }\n}', + }, + go: { + method: 'client.Events.Definitions.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.Delete(context.TODO(), "eventName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'events.definitions.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.delete("eventName")\n\nputs(result)', + }, + php: { + method: 'events->definitions->delete', + example: + "events->definitions->delete('eventName');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_property', + endpoint: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', + httpMethod: 'delete', + summary: 'Delete a property from a custom event definition', + description: 'Delete an existing property from a custom event definition.', + stainlessPath: '(resource) events.definitions > (method) delete_property', + qualified: 'client.events.definitions.deleteProperty', + params: ['eventName: string;', 'propertyName: string;'], + markdown: + "## delete_property\n\n`client.events.definitions.deleteProperty(eventName: string, propertyName: string): void`\n\n**delete** `/events/2026-03/event-definitions/{eventName}/property/{propertyName}`\n\nDelete an existing property from a custom event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.deleteProperty('propertyName', { eventName: 'eventName' })\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.deleteProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.deleteProperty('propertyName', { eventName: 'eventName' });", + }, + python: { + method: 'events.definitions.delete_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.delete_property(\n property_name="propertyName",\n event_name="eventName",\n)', + }, + java: { + method: 'events().definitions().deleteProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionDeletePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionDeletePropertyParams params = DefinitionDeletePropertyParams.builder()\n .eventName("eventName")\n .propertyName("propertyName")\n .build();\n client.events().definitions().deleteProperty(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.DeleteProperty', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.DeleteProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tevents.DefinitionDeletePropertyParams{\n\t\t\tEventName: "eventName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'events.definitions.delete_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.delete_property("propertyName", event_name: "eventName")\n\nputs(result)', + }, + php: { + method: 'events->definitions->deleteProperty', + example: + "events->definitions->deleteProperty(\n 'propertyName', eventName: 'eventName'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/events/2026-03/event-definitions/{eventName}', + httpMethod: 'get', + summary: 'Retrieve a custom event definition', + description: 'Fetch a single custom event definition by name.', + stainlessPath: '(resource) events.definitions > (method) get', + qualified: 'client.events.definitions.get', + params: ['eventName: string;'], + response: + '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', + markdown: + "## get\n\n`client.events.definitions.get(eventName: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**get** `/events/2026-03/event-definitions/{eventName}`\n\nFetch a single custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.get('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.get('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", + }, + python: { + method: 'events.definitions.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.get(\n "eventName",\n)\nprint(external_behavioral_event_type_definition.id)', + }, + java: { + method: 'events().definitions().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionGetParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().get("eventName");\n }\n}', + }, + go: { + method: 'client.Events.Definitions.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.Get(context.TODO(), "eventName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', + }, + ruby: { + method: 'events.definitions.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.get("eventName")\n\nputs(external_behavioral_event_type_definition)', + }, + php: { + method: 'events->definitions->get', + example: + "events->definitions->get(\n 'eventName'\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/events/2026-03/event-definitions', + httpMethod: 'get', + summary: 'Retrieve event definitions', + description: 'Retrieve existing custom event definitions.', + stainlessPath: '(resource) events.definitions > (method) list', + qualified: 'client.events.definitions.list', + params: [ + 'after?: string;', + 'includeProperties?: boolean;', + 'limit?: number;', + 'searchString?: string;', + 'sortOrder?: string;', + ], + response: + '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', + markdown: + "## list\n\n`client.events.definitions.list(after?: string, includeProperties?: boolean, limit?: number, searchString?: string, sortOrder?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**get** `/events/2026-03/event-definitions`\n\nRetrieve existing custom event definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `includeProperties?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `searchString?: string`\n\n- `sortOrder?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalBehavioralEventTypeDefinition of client.events.definitions.list()) {\n console.log(externalBehavioralEventTypeDefinition);\n}\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalBehavioralEventTypeDefinition of client.events.definitions.list()) {\n console.log(externalBehavioralEventTypeDefinition.id);\n}", + }, + python: { + method: 'events.definitions.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.events.definitions.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'events().definitions().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionListPage;\nimport com.hubspot.sdk.models.events.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionListPage page = client.events().definitions().list();\n }\n}', + }, + go: { + method: 'client.Events.Definitions.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Events.Definitions.List(context.TODO(), events.DefinitionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'events.definitions.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.events.definitions.list\n\nputs(page)', + }, + php: { + method: 'events->definitions->list', + example: + "events->definitions->list(\n after: 'after',\n includeProperties: true,\n limit: 0,\n searchString: 'searchString',\n sortOrder: 'sortOrder',\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/event-definitions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'send_batch', + endpoint: '/events/2026-03/send/batch', + httpMethod: 'post', + summary: 'Send a batch of event occurrences', + description: 'Send multiple event occurrences at once.', + stainlessPath: '(resource) events.definitions > (method) send_batch', + qualified: 'client.events.definitions.sendBatch', + params: [ + 'inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[];', + ], + markdown: + "## send_batch\n\n`client.events.definitions.sendBatch(inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]): void`\n\n**post** `/events/2026-03/send/batch`\n\nSend multiple event occurrences at once.\n\n### Parameters\n\n- `inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.sendBatch({ inputs: [{\n eventName: 'eventName',\n properties: { foo: 'string' },\n}] })\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.sendBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.sendBatch({\n inputs: [\n {\n eventName: 'eventName',\n properties: { foo: 'string' },\n },\n ],\n});", + }, + python: { + method: 'events.definitions.send_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.send_batch(\n inputs=[{\n "event_name": "eventName",\n "properties": {\n "foo": "string"\n },\n }],\n)', + }, + java: { + method: 'events().definitions().sendBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BatchedBehavioralEventHttpCompletionRequest;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchedBehavioralEventHttpCompletionRequest params = BatchedBehavioralEventHttpCompletionRequest.builder()\n .addInput(BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n client.events().definitions().sendBatch(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.SendBatch', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.SendBatch(context.TODO(), events.DefinitionSendBatchParams{\n\t\tBatchedBehavioralEventHTTPCompletionRequest: events.BatchedBehavioralEventHTTPCompletionRequestParam{\n\t\t\tInputs: []events.BehavioralEventHTTPCompletionRequestParam{{\n\t\t\t\tEventName: "eventName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'events.definitions.send_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.send_batch(inputs: [{eventName: "eventName", properties: {foo: "string"}}])\n\nputs(result)', + }, + php: { + method: 'events->definitions->sendBatch', + example: + "events->definitions->sendBatch(\n inputs: [\n [\n 'eventName' => 'eventName',\n 'properties' => ['foo' => 'string'],\n 'email' => 'email',\n 'objectID' => 'objectId',\n 'occurredAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n 'uuid' => 'uuid',\n ],\n ],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/send/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/events/2026-03/event-definitions/{eventName}', + httpMethod: 'patch', + summary: 'Update a custom event definition', + description: 'Update a specific custom event definition by name.', + stainlessPath: '(resource) events.definitions > (method) update', + qualified: 'client.events.definitions.update', + params: ['eventName: string;', 'description?: string;', 'label?: string;'], + response: + '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', + markdown: + "## update\n\n`client.events.definitions.update(eventName: string, description?: string, label?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**patch** `/events/2026-03/event-definitions/{eventName}`\n\nUpdate a specific custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n- `description?: string`\n A description of the event that will be shown as help text in HubSpot.\n\n- `label?: string`\n Human readable label for the event. Used in HubSpot UI\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.update('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.update('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", + }, + python: { + method: 'events.definitions.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.update(\n event_name="eventName",\n)\nprint(external_behavioral_event_type_definition.id)', + }, + java: { + method: 'events().definitions().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionUpdateParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinitionPatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdateParams params = DefinitionUpdateParams.builder()\n .eventName("eventName")\n .externalBehavioralEventTypeDefinitionPatch(ExternalBehavioralEventTypeDefinitionPatch.builder().build())\n .build();\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().update(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.Update(\n\t\tcontext.TODO(),\n\t\t"eventName",\n\t\tevents.DefinitionUpdateParams{\n\t\t\tExternalBehavioralEventTypeDefinitionPatch: events.ExternalBehavioralEventTypeDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', + }, + ruby: { + method: 'events.definitions.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.update("eventName")\n\nputs(external_behavioral_event_type_definition)', + }, + php: { + method: 'events->definitions->update', + example: + "events->definitions->update(\n 'eventName', description: 'description', label: 'label'\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", + }, + http: { + example: + "curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_property', + endpoint: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', + httpMethod: 'patch', + summary: 'Update an existing custom event property', + description: 'Update an existing property in a custom event definition.', + stainlessPath: '(resource) events.definitions > (method) update_property', + qualified: 'client.events.definitions.updateProperty', + params: [ + 'eventName: string;', + 'propertyName: string;', + 'description?: string;', + 'label?: string;', + 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', + ], + response: + "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", + markdown: + "## update_property\n\n`client.events.definitions.updateProperty(eventName: string, propertyName: string, description?: string, label?: string, options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**patch** `/events/2026-03/event-definitions/{eventName}/property/{propertyName}`\n\nUpdate an existing property in a custom event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `propertyName: string`\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `label?: string`\n Human readable label for the property. Used in HubSpot UI\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.events.definitions.updateProperty('propertyName', { eventName: 'eventName' });\n\nconsole.log(property);\n```", + perLanguage: { + typescript: { + method: 'client.events.definitions.updateProperty', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.events.definitions.updateProperty('propertyName', {\n eventName: 'eventName',\n});\n\nconsole.log(property.hidden);", + }, + python: { + method: 'events.definitions.update_property', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.events.definitions.update_property(\n property_name="propertyName",\n event_name="eventName",\n)\nprint(property.hidden)', + }, + java: { + method: 'events().definitions().updateProperty', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.events.definitions.DefinitionUpdatePropertyParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyDefinitionPatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdatePropertyParams params = DefinitionUpdatePropertyParams.builder()\n .eventName("eventName")\n .propertyName("propertyName")\n .externalBehavioralEventPropertyDefinitionPatch(ExternalBehavioralEventPropertyDefinitionPatch.builder().build())\n .build();\n Property property = client.events().definitions().updateProperty(params);\n }\n}', + }, + go: { + method: 'client.Events.Definitions.UpdateProperty', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Events.Definitions.UpdateProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tevents.DefinitionUpdatePropertyParams{\n\t\t\tEventName: "eventName",\n\t\t\tExternalBehavioralEventPropertyDefinitionPatch: events.ExternalBehavioralEventPropertyDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', + }, + ruby: { + method: 'events.definitions.update_property', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.events.definitions.update_property("propertyName", event_name: "eventName")\n\nputs(property)', + }, + php: { + method: 'events->definitions->updateProperty', + example: + "events->definitions->updateProperty(\n 'propertyName',\n eventName: 'eventName',\n description: 'description',\n label: 'label',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n);\n\nvar_dump($property);", + }, + http: { + example: + "curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'list', + endpoint: '/events/event-occurrences/2026-03', + httpMethod: 'get', + summary: 'Retrieve event occurrences', + description: + 'Retrieve event occurrences for the specified time frame. This endpoint allows filtering by various parameters such as object type, event type, and occurrence time. It supports pagination and sorting of results.', + stainlessPath: '(resource) events.occurrences > (method) list', + qualified: 'client.events.occurrences.list', + params: [ + 'id?: string[];', + 'after?: string;', + 'before?: string;', + 'eventType?: string;', + 'limit?: number;', + 'objectId?: number;', + 'objectProperty?: { {propname}?: object; };', + 'objectType?: string;', + 'occurredAfter?: string;', + 'occurredBefore?: string;', + 'properties?: string[];', + 'property?: { {propname}?: object; };', + 'sort?: string[];', + ], + response: + '{ id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }', + markdown: + "## list\n\n`client.events.occurrences.list(id?: string[], after?: string, before?: string, eventType?: string, limit?: number, objectId?: number, objectProperty?: { {propname}?: object; }, objectType?: string, occurredAfter?: string, occurredBefore?: string, properties?: string[], property?: { {propname}?: object; }, sort?: string[]): { id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }`\n\n**get** `/events/event-occurrences/2026-03`\n\nRetrieve event occurrences for the specified time frame. This endpoint allows filtering by various parameters such as object type, event type, and occurrence time. It supports pagination and sorting of results.\n\n### Parameters\n\n- `id?: string[]`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `eventType?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `objectId?: number`\n\n- `objectProperty?: { {propname}?: object; }`\n - `{propname}?: object`\n\n- `objectType?: string`\n\n- `occurredAfter?: string`\n\n- `occurredBefore?: string`\n\n- `properties?: string[]`\n\n- `property?: { {propname}?: object; }`\n - `{propname}?: object`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }`\n\n - `id: string`\n - `eventType: string`\n - `objectId: string`\n - `objectType: string`\n - `occurredAt: string`\n - `properties: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalUnifiedEvent of client.events.occurrences.list()) {\n console.log(externalUnifiedEvent);\n}\n```", + perLanguage: { + typescript: { + method: 'client.events.occurrences.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalUnifiedEvent of client.events.occurrences.list()) {\n console.log(externalUnifiedEvent.id);\n}", + }, + python: { + method: 'events.occurrences.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.events.occurrences.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'events().occurrences().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListPage;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OccurrenceListPage page = client.events().occurrences().list();\n }\n}', + }, + go: { + method: 'client.Events.Occurrences.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Events.Occurrences.List(context.TODO(), events.OccurrenceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'events.occurrences.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.events.occurrences.list\n\nputs(page)', + }, + php: { + method: 'events->occurrences->list', + example: + "events->occurrences->list(\n id: ['string'],\n after: 'after',\n before: 'before',\n eventType: 'eventType',\n limit: 0,\n objectID: 0,\n objectProperty: ['_propname' => (object) []],\n objectType: 'objectType',\n occurredAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n occurredBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n properties: ['string'],\n property: ['_propname' => (object) []],\n sort: ['string'],\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/event-occurrences/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_event_types', + endpoint: '/events/event-occurrences/2026-03/event-types', + httpMethod: 'get', + summary: 'Retrieve event types', + description: + 'Retrieve a list of event type names. You may use these event types to query the API for event occurrences of a desired type.\n\nNote: the `get_types` method is only supported in the Python SDK version `12.0.0-beta.1` or later. ', + stainlessPath: '(resource) events.occurrences > (method) list_event_types', + qualified: 'client.events.occurrences.listEventTypes', + response: '{ eventTypes: string[]; }', + markdown: + "## list_event_types\n\n`client.events.occurrences.listEventTypes(): { eventTypes: string[]; }`\n\n**get** `/events/event-occurrences/2026-03/event-types`\n\nRetrieve a list of event type names. You may use these event types to query the API for event occurrences of a desired type.\n\nNote: the `get_types` method is only supported in the Python SDK version `12.0.0-beta.1` or later. \n\n### Returns\n\n- `{ eventTypes: string[]; }`\n\n - `eventTypes: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst visibleExternalEventTypeNames = await client.events.occurrences.listEventTypes();\n\nconsole.log(visibleExternalEventTypeNames);\n```", + perLanguage: { + typescript: { + method: 'client.events.occurrences.listEventTypes', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst visibleExternalEventTypeNames = await client.events.occurrences.listEventTypes();\n\nconsole.log(visibleExternalEventTypeNames.eventTypes);", + }, + python: { + method: 'events.occurrences.list_event_types', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nvisible_external_event_type_names = client.events.occurrences.list_event_types()\nprint(visible_external_event_type_names.event_types)', + }, + java: { + method: 'events().occurrences().listEventTypes', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListEventTypesParams;\nimport com.hubspot.sdk.models.events.occurrences.VisibleExternalEventTypeNames;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n VisibleExternalEventTypeNames visibleExternalEventTypeNames = client.events().occurrences().listEventTypes();\n }\n}', + }, + go: { + method: 'client.Events.Occurrences.ListEventTypes', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tvisibleExternalEventTypeNames, err := client.Events.Occurrences.ListEventTypes(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", visibleExternalEventTypeNames.EventTypes)\n}\n', + }, + ruby: { + method: 'events.occurrences.list_event_types', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nvisible_external_event_type_names = hubspot.events.occurrences.list_event_types\n\nputs(visible_external_event_type_names)', + }, + php: { + method: 'events->occurrences->listEventTypes', + example: + "events->occurrences->listEventTypes();\n\nvar_dump($visibleExternalEventTypeNames);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/event-occurrences/2026-03/event-types \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'batch_send', + endpoint: '/events/2026-03/send/batch', + httpMethod: 'post', + summary: 'Send a batch of event occurrences', + description: 'Send multiple event occurrences at once.', + stainlessPath: '(resource) events.send > (method) batch_send', + qualified: 'client.events.send.batchSend', + params: [ + 'inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[];', + ], + markdown: + "## batch_send\n\n`client.events.send.batchSend(inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]): void`\n\n**post** `/events/2026-03/send/batch`\n\nSend multiple event occurrences at once.\n\n### Parameters\n\n- `inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.send.batchSend({ inputs: [{\n eventName: 'eventName',\n properties: { foo: 'string' },\n}] })\n```", + perLanguage: { + typescript: { + method: 'client.events.send.batchSend', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.send.batchSend({\n inputs: [\n {\n eventName: 'eventName',\n properties: { foo: 'string' },\n },\n ],\n});", + }, + python: { + method: 'events.send.batch_send', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.send.batch_send(\n inputs=[{\n "event_name": "eventName",\n "properties": {\n "foo": "string"\n },\n }],\n)', + }, + java: { + method: 'events().send().batchSend', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BatchedBehavioralEventHttpCompletionRequest;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchedBehavioralEventHttpCompletionRequest params = BatchedBehavioralEventHttpCompletionRequest.builder()\n .addInput(BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n client.events().send().batchSend(params);\n }\n}', + }, + go: { + method: 'client.Events.Send.BatchSend', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Send.BatchSend(context.TODO(), events.SendBatchSendParams{\n\t\tBatchedBehavioralEventHTTPCompletionRequest: events.BatchedBehavioralEventHTTPCompletionRequestParam{\n\t\t\tInputs: []events.BehavioralEventHTTPCompletionRequestParam{{\n\t\t\t\tEventName: "eventName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'events.send_.batch_send', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.send_.batch_send(inputs: [{eventName: "eventName", properties: {foo: "string"}}])\n\nputs(result)', + }, + php: { + method: 'events->send->batchSend', + example: + "events->send->batchSend(\n inputs: [\n [\n 'eventName' => 'eventName',\n 'properties' => ['foo' => 'string'],\n 'email' => 'email',\n 'objectID' => 'objectId',\n 'occurredAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n 'uuid' => 'uuid',\n ],\n ],\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/send/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'send', + endpoint: '/events/2026-03/send', + httpMethod: 'post', + summary: 'Send a custom event occurrence', + description: 'Send data for a single custom event occurrence.', + stainlessPath: '(resource) events.send > (method) send', + qualified: 'client.events.send.send', + params: [ + 'eventName: string;', + 'properties: object;', + 'email?: string;', + 'objectId?: string;', + 'occurredAt?: string;', + 'utk?: string;', + 'uuid?: string;', + ], + markdown: + "## send\n\n`client.events.send.send(eventName: string, properties: object, email?: string, objectId?: string, occurredAt?: string, utk?: string, uuid?: string): void`\n\n**post** `/events/2026-03/send`\n\nSend data for a single custom event occurrence.\n\n### Parameters\n\n- `eventName: string`\n Internal name of the event-type to trigger\n\n- `properties: object`\n Map of properties for the event in the format property internal name - property value\n\n- `email?: string`\n Email of visitor\n\n- `objectId?: string`\n The object id that this event occurred on. Could be a contact id or a visitor id.\n\n- `occurredAt?: string`\n The time when this event occurred (if any). If this isn't set, the current time will be used\n\n- `utk?: string`\n User token\n\n- `uuid?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.send.send({\n eventName: 'eventName',\n properties: { foo: 'string' },\n})\n```", + perLanguage: { + typescript: { + method: 'client.events.send.send', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.send.send({\n eventName: 'eventName',\n properties: { foo: 'string' },\n});", + }, + python: { + method: 'events.send.send', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.send.send(\n event_name="eventName",\n properties={\n "foo": "string"\n },\n)', + }, + java: { + method: 'events().send().send', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BehavioralEventHttpCompletionRequest params = BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n client.events().send().send(params);\n }\n}', + }, + go: { + method: 'client.Events.Send.Send', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Send.Send(context.TODO(), events.SendSendParams{\n\t\tBehavioralEventHTTPCompletionRequest: events.BehavioralEventHTTPCompletionRequestParam{\n\t\t\tEventName: "eventName",\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'events.send_.send_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.send_.send_(event_name: "eventName", properties: {foo: "string"})\n\nputs(result)', + }, + php: { + method: 'events->send->send', + example: + "events->send->send(\n eventName: 'eventName',\n properties: ['foo' => 'string'],\n email: 'email',\n objectID: 'objectId',\n occurredAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n utk: 'utk',\n uuid: 'uuid',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/events/2026-03/send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/files/2026-03/folders', + httpMethod: 'post', + summary: 'Create folder', + description: 'Creates a folder.', + stainlessPath: '(resource) files.file_assets > (method) create', + qualified: 'client.files.fileAssets.create', + params: ['name: string;', 'parentFolderId?: string;', 'parentPath?: string;'], + response: + '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', + markdown: + "## create\n\n`client.files.fileAssets.create(name: string, parentFolderId?: string, parentPath?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**post** `/files/2026-03/folders`\n\nCreates a folder.\n\n### Parameters\n\n- `name: string`\n Desired name for the folder.\n\n- `parentFolderId?: string`\n FolderId of the parent of the created folder. If not specified, the folder will be created at the root level. parentFolderId and parentFolderPath cannot be set at the same time.\n\n- `parentPath?: string`\n Path of the parent of the created folder. If not specified the folder will be created at the root level. parentFolderPath and parentFolderId cannot be set at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.fileAssets.create({ name: 'name' });\n\nconsole.log(folder);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.fileAssets.create({ name: 'name' });\n\nconsole.log(folder.id);", + }, + python: { + method: 'files.file_assets.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.file_assets.create(\n name="name",\n)\nprint(folder.id)', + }, + java: { + method: 'files().fileAssets().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.FolderInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderInput params = FolderInput.builder()\n .name("name")\n .build();\n Folder folder = client.files().fileAssets().create(params);\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.FileAssets.New(context.TODO(), files.FileAssetNewParams{\n\t\tFolderInput: files.FolderInputParam{\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.file_assets.create(name: "name")\n\nputs(folder)', + }, + php: { + method: 'files->fileAssets->create', + example: + "files->fileAssets->create(\n name: 'name', parentFolderID: 'parentFolderId', parentPath: 'parentPath'\n);\n\nvar_dump($folder);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/files/2026-03/files/{fileId}', + httpMethod: 'delete', + summary: 'Delete file by ID', + description: 'Delete a file by ID', + stainlessPath: '(resource) files.file_assets > (method) delete', + qualified: 'client.files.fileAssets.delete', + params: ['fileId: string;'], + markdown: + "## delete\n\n`client.files.fileAssets.delete(fileId: string): void`\n\n**delete** `/files/2026-03/files/{fileId}`\n\nDelete a file by ID\n\n### Parameters\n\n- `fileId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.fileAssets.delete('321669910225')\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.fileAssets.delete('321669910225');", + }, + python: { + method: 'files.file_assets.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.file_assets.delete(\n "321669910225",\n)', + }, + java: { + method: 'files().fileAssets().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().fileAssets().delete("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.FileAssets.Delete(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'files.file_assets.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.file_assets.delete("321669910225")\n\nputs(result)', + }, + php: { + method: 'files->fileAssets->delete', + example: + "files->fileAssets->delete('321669910225');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'gdpr_delete', + endpoint: '/files/2026-03/files/{fileId}/gdpr-delete', + httpMethod: 'delete', + summary: 'GDPR-delete file', + description: 'Delete a file in accordance with GDPR regulations.', + stainlessPath: '(resource) files.file_assets > (method) gdpr_delete', + qualified: 'client.files.fileAssets.gdprDelete', + params: ['fileId: string;'], + markdown: + "## gdpr_delete\n\n`client.files.fileAssets.gdprDelete(fileId: string): void`\n\n**delete** `/files/2026-03/files/{fileId}/gdpr-delete`\n\nDelete a file in accordance with GDPR regulations.\n\n### Parameters\n\n- `fileId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.fileAssets.gdprDelete('321669910225')\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.gdprDelete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.fileAssets.gdprDelete('321669910225');", + }, + python: { + method: 'files.file_assets.gdpr_delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.file_assets.gdpr_delete(\n "321669910225",\n)', + }, + java: { + method: 'files().fileAssets().gdprDelete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGdprDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().fileAssets().gdprDelete("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.GdprDelete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.FileAssets.GdprDelete(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'files.file_assets.gdpr_delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.file_assets.gdpr_delete("321669910225")\n\nputs(result)', + }, + php: { + method: 'files->fileAssets->gdprDelete', + example: + "files->fileAssets->gdprDelete('321669910225');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID/gdpr-delete \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/files/2026-03/files/{fileId}', + httpMethod: 'get', + summary: 'Retrieve file by ID', + description: 'Retrieve a file by its ID.', + stainlessPath: '(resource) files.file_assets > (method) get', + qualified: 'client.files.fileAssets.get', + params: ['fileId: string;', 'properties?: string[];'], + response: + "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", + markdown: + "## get\n\n`client.files.fileAssets.get(fileId: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**get** `/files/2026-03/files/{fileId}`\n\nRetrieve a file by its ID.\n\n### Parameters\n\n- `fileId: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.get('321669910225');\n\nconsole.log(file);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.get('321669910225');\n\nconsole.log(file.id);", + }, + python: { + method: 'files.file_assets.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.get(\n file_id="321669910225",\n)\nprint(file.id)', + }, + java: { + method: 'files().fileAssets().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().get("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Get(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.get("321669910225")\n\nputs(file)', + }, + php: { + method: 'files->fileAssets->get', + example: + "files->fileAssets->get('321669910225', properties: ['string']);\n\nvar_dump($file);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_import_task_status', + endpoint: '/files/2026-03/files/import-from-url/async/tasks/{taskId}/status', + httpMethod: 'get', + summary: 'Check import status', + description: 'Check the status of requested import.', + stainlessPath: '(resource) files.file_assets > (method) get_import_task_status', + qualified: 'client.files.fileAssets.getImportTaskStatus', + params: ['taskId: string;'], + response: + "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }; }", + markdown: + "## get_import_task_status\n\n`client.files.fileAssets.getImportTaskStatus(taskId: string): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: file; }`\n\n**get** `/files/2026-03/files/import-from-url/async/tasks/{taskId}/status`\n\nCheck the status of requested import.\n\n### Parameters\n\n- `taskId: string`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `taskId: string`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst fileActionResponse = await client.files.fileAssets.getImportTaskStatus('taskId');\n\nconsole.log(fileActionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.getImportTaskStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst fileActionResponse = await client.files.fileAssets.getImportTaskStatus('taskId');\n\nconsole.log(fileActionResponse.completedAt);", + }, + python: { + method: 'files.file_assets.get_import_task_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile_action_response = client.files.file_assets.get_import_task_status(\n "taskId",\n)\nprint(file_action_response.completed_at)', + }, + java: { + method: 'files().fileAssets().getImportTaskStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FileActionResponse;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetImportTaskStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileActionResponse fileActionResponse = client.files().fileAssets().getImportTaskStatus("taskId");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.GetImportTaskStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfileActionResponse, err := client.Files.FileAssets.GetImportTaskStatus(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", fileActionResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'files.file_assets.get_import_task_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile_action_response = hubspot.files.file_assets.get_import_task_status("taskId")\n\nputs(file_action_response)', + }, + php: { + method: 'files->fileAssets->getImportTaskStatus', + example: + "files->fileAssets->getImportTaskStatus('taskId');\n\nvar_dump($fileActionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/import-from-url/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_signed_url', + endpoint: '/files/2026-03/files/{fileId}/signed-url', + httpMethod: 'get', + summary: 'Get signed URL to access private file', + description: 'Generates signed URL that allows temporary access to a private file.', + stainlessPath: '(resource) files.file_assets > (method) get_signed_url', + qualified: 'client.files.fileAssets.getSignedURL', + params: [ + 'fileId: string;', + 'expirationSeconds?: number;', + "size?: 'icon' | 'medium' | 'preview' | 'thumb';", + 'upscale?: boolean;', + ], + response: + '{ expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }', + markdown: + "## get_signed_url\n\n`client.files.fileAssets.getSignedURL(fileId: string, expirationSeconds?: number, size?: 'icon' | 'medium' | 'preview' | 'thumb', upscale?: boolean): { expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }`\n\n**get** `/files/2026-03/files/{fileId}/signed-url`\n\nGenerates signed URL that allows temporary access to a private file.\n\n### Parameters\n\n- `fileId: string`\n\n- `expirationSeconds?: number`\n\n- `size?: 'icon' | 'medium' | 'preview' | 'thumb'`\n\n- `upscale?: boolean`\n\n### Returns\n\n- `{ expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }`\n\n - `expiresAt: string`\n - `url: string`\n - `extension?: string`\n - `height?: number`\n - `name?: string`\n - `size?: number`\n - `type?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst signedURL = await client.files.fileAssets.getSignedURL('321669910225');\n\nconsole.log(signedURL);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.getSignedURL', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst signedURL = await client.files.fileAssets.getSignedURL('321669910225');\n\nconsole.log(signedURL.width);", + }, + python: { + method: 'files.file_assets.get_signed_url', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsigned_url = client.files.file_assets.get_signed_url(\n file_id="321669910225",\n)\nprint(signed_url.width)', + }, + java: { + method: 'files().fileAssets().getSignedUrl', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.SignedUrl;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetSignedUrlParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SignedUrl signedUrl = client.files().fileAssets().getSignedUrl("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.GetSignedURL', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsignedURL, err := client.Files.FileAssets.GetSignedURL(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetGetSignedURLParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", signedURL.Width)\n}\n', + }, + ruby: { + method: 'files.file_assets.get_signed_url', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsigned_url = hubspot.files.file_assets.get_signed_url("321669910225")\n\nputs(signed_url)', + }, + php: { + method: 'files->fileAssets->getSignedURL', + example: + "files->fileAssets->getSignedURL(\n '321669910225', expirationSeconds: 0, size: 'icon', upscale: true\n);\n\nvar_dump($signedURL);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID/signed-url \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'import_from_url_async', + endpoint: '/files/2026-03/files/import-from-url/async', + httpMethod: 'post', + summary: 'Import file from URL', + description: 'Asynchronously imports the file at the given URL into the file manager.', + stainlessPath: '(resource) files.file_assets > (method) import_from_url_async', + qualified: 'client.files.fileAssets.importFromURLAsync', + params: [ + 'access: string;', + "duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER';", + "duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING';", + 'overwrite: boolean;', + 'expiresAt?: string;', + 'folderId?: string;', + 'folderPath?: string;', + 'name?: string;', + 'ttl?: string;', + 'url?: string;', + ], + response: '{ id: string; links?: object; }', + markdown: + "## import_from_url_async\n\n`client.files.fileAssets.importFromURLAsync(access: string, duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER', duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING', overwrite: boolean, expiresAt?: string, folderId?: string, folderPath?: string, name?: string, ttl?: string, url?: string): { id: string; links?: object; }`\n\n**post** `/files/2026-03/files/import-from-url/async`\n\nAsynchronously imports the file at the given URL into the file manager.\n\n### Parameters\n\n- `access: string`\n PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines can index the file. PUBLIC_NOT_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines *can't* index the file. PRIVATE: File is NOT publicly accessible. Requires a signed URL to see content. Search engines *can't* index the file.\n\n- `duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER'`\n ENTIRE_PORTAL: Look for a duplicate file in the entire account. EXACT_FOLDER: Look for a duplicate file in the provided folder.\n\n- `duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING'`\n NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.\n\n- `overwrite: boolean`\n If true, will overwrite existing file if one with the same name and extension exists in the given folder. The overwritten file will be deleted and the uploaded file will take its place with a new ID. If unset or set as false, the new file's name will be updated to prevent colliding with existing file if one exists with the same path, name, and extension\n\n- `expiresAt?: string`\n Specifies the date and time when the file will expire.\n\n- `folderId?: string`\n One of folderId or folderPath is required. Destination folderId for the uploaded file.\n\n- `folderPath?: string`\n One of folderPath or folderId is required. Destination folder path for the uploaded file. If the folder path does not exist, there will be an attempt to create the folder path.\n\n- `name?: string`\n Name to give the resulting file in the file manager.\n\n- `ttl?: string`\n Time to live. If specified the file will be deleted after the given time frame. If left unset, the file will exist indefinitely\n\n- `url?: string`\n URL to download the new file from.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst importFromURLTaskLocator = await client.files.fileAssets.importFromURLAsync({\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n});\n\nconsole.log(importFromURLTaskLocator);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.importFromURLAsync', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst importFromURLTaskLocator = await client.files.fileAssets.importFromURLAsync({\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n});\n\nconsole.log(importFromURLTaskLocator.id);", + }, + python: { + method: 'files.file_assets.import_from_url_async', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nimport_from_url_task_locator = client.files.file_assets.import_from_url_async(\n access="HIDDEN_INDEXABLE",\n duplicate_validation_scope="ENTIRE_PORTAL",\n duplicate_validation_strategy="NONE",\n overwrite=True,\n)\nprint(import_from_url_task_locator.id)', + }, + java: { + method: 'files().fileAssets().importFromUrlAsync', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.ImportFromUrlInput;\nimport com.hubspot.sdk.models.files.ImportFromUrlTaskLocator;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportFromUrlInput params = ImportFromUrlInput.builder()\n .access(ImportFromUrlInput.Access.HIDDEN_INDEXABLE)\n .duplicateValidationScope(ImportFromUrlInput.DuplicateValidationScope.ENTIRE_PORTAL)\n .duplicateValidationStrategy(ImportFromUrlInput.DuplicateValidationStrategy.NONE)\n .overwrite(true)\n .build();\n ImportFromUrlTaskLocator importFromUrlTaskLocator = client.files().fileAssets().importFromUrlAsync(params);\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.ImportFromURLAsync', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\timportFromURLTaskLocator, err := client.Files.FileAssets.ImportFromURLAsync(context.TODO(), files.FileAssetImportFromURLAsyncParams{\n\t\tImportFromURLInput: files.ImportFromURLInputParam{\n\t\t\tAccess: files.ImportFromURLInputAccessHiddenIndexable,\n\t\t\tDuplicateValidationScope: files.ImportFromURLInputDuplicateValidationScopeEntirePortal,\n\t\t\tDuplicateValidationStrategy: files.ImportFromURLInputDuplicateValidationStrategyNone,\n\t\t\tOverwrite: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", importFromURLTaskLocator.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.import_from_url_async', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nimport_from_url_task_locator = hubspot.files.file_assets.import_from_url_async(\n access: :HIDDEN_INDEXABLE,\n duplicate_validation_scope: :ENTIRE_PORTAL,\n duplicate_validation_strategy: :NONE,\n overwrite: true\n)\n\nputs(import_from_url_task_locator)', + }, + php: { + method: 'files->fileAssets->importFromURLAsync', + example: + "files->fileAssets->importFromURLAsync(\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n folderID: 'folderId',\n folderPath: 'folderPath',\n name: 'name',\n ttl: 'ttl',\n url: 'url',\n);\n\nvar_dump($importFromURLTaskLocator);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/import-from-url/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "access": "HIDDEN_INDEXABLE",\n "duplicateValidationScope": "ENTIRE_PORTAL",\n "duplicateValidationStrategy": "NONE",\n "overwrite": true\n }\'', + }, + }, + }, + { + name: 'replace', + endpoint: '/files/2026-03/files/{fileId}', + httpMethod: 'put', + summary: 'Replace file', + description: + 'Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.', + stainlessPath: '(resource) files.file_assets > (method) replace', + qualified: 'client.files.fileAssets.replace', + params: ['fileId: string;', 'charsetHunch?: string;', 'file?: string;', 'options?: string;'], + response: + "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", + markdown: + "## replace\n\n`client.files.fileAssets.replace(fileId: string, charsetHunch?: string, file?: string, options?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**put** `/files/2026-03/files/{fileId}`\n\nReplace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.\n\n### Parameters\n\n- `fileId: string`\n\n- `charsetHunch?: string`\n\n- `file?: string`\n\n- `options?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.replace('321669910225');\n\nconsole.log(file);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.replace', + example: + "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.replace('321669910225');\n\nconsole.log(file.id);", + }, + python: { + method: 'files.file_assets.replace', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.replace(\n file_id="321669910225",\n)\nprint(file.id)', + }, + java: { + method: 'files().fileAssets().replace', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetReplaceParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().replace("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Replace', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Replace(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetReplaceParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.replace', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.replace("321669910225")\n\nputs(file)', + }, + php: { + method: 'files->fileAssets->replace', + example: + "files->fileAssets->replace(\n '321669910225',\n charsetHunch: 'charsetHunch',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n options: 'options',\n);\n\nvar_dump($file);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/files/2026-03/files/search', + httpMethod: 'get', + summary: 'Search files', + description: 'Search through files in the file manager. Does not display hidden or archived files.', + stainlessPath: '(resource) files.file_assets > (method) search', + qualified: 'client.files.fileAssets.search', + params: [ + 'after?: string;', + 'allowsAnonymousAccess?: boolean;', + 'before?: string;', + 'createdAt?: string;', + 'createdAtGte?: string;', + 'createdAtLte?: string;', + 'encoding?: string;', + 'expiresAt?: string;', + 'expiresAtGte?: string;', + 'expiresAtLte?: string;', + 'extension?: string;', + 'fileMd5?: string;', + 'height?: number;', + 'heightGte?: number;', + 'heightLte?: number;', + 'idGte?: number;', + 'idLte?: number;', + 'ids?: number[];', + 'isUsableInContent?: boolean;', + 'limit?: number;', + 'name?: string;', + 'parentFolderIds?: number[];', + 'path?: string;', + 'properties?: string[];', + 'size?: number;', + 'sizeGte?: number;', + 'sizeLte?: number;', + 'sort?: string[];', + 'type?: string;', + 'updatedAt?: string;', + 'updatedAtGte?: string;', + 'updatedAtLte?: string;', + 'url?: string;', + 'width?: number;', + 'widthGte?: number;', + 'widthLte?: number;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", + markdown: + "## search\n\n`client.files.fileAssets.search(after?: string, allowsAnonymousAccess?: boolean, before?: string, createdAt?: string, createdAtGte?: string, createdAtLte?: string, encoding?: string, expiresAt?: string, expiresAtGte?: string, expiresAtLte?: string, extension?: string, fileMd5?: string, height?: number, heightGte?: number, heightLte?: number, idGte?: number, idLte?: number, ids?: number[], isUsableInContent?: boolean, limit?: number, name?: string, parentFolderIds?: number[], path?: string, properties?: string[], size?: number, sizeGte?: number, sizeLte?: number, sort?: string[], type?: string, updatedAt?: string, updatedAtGte?: string, updatedAtLte?: string, url?: string, width?: number, widthGte?: number, widthLte?: number): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**get** `/files/2026-03/files/search`\n\nSearch through files in the file manager. Does not display hidden or archived files.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `allowsAnonymousAccess?: boolean`\n\n- `before?: string`\n\n- `createdAt?: string`\n\n- `createdAtGte?: string`\n\n- `createdAtLte?: string`\n\n- `encoding?: string`\n\n- `expiresAt?: string`\n\n- `expiresAtGte?: string`\n\n- `expiresAtLte?: string`\n\n- `extension?: string`\n\n- `fileMd5?: string`\n\n- `height?: number`\n\n- `heightGte?: number`\n\n- `heightLte?: number`\n\n- `idGte?: number`\n\n- `idLte?: number`\n\n- `ids?: number[]`\n\n- `isUsableInContent?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `parentFolderIds?: number[]`\n\n- `path?: string`\n\n- `properties?: string[]`\n\n- `size?: number`\n\n- `sizeGte?: number`\n\n- `sizeLte?: number`\n\n- `sort?: string[]`\n\n- `type?: string`\n\n- `updatedAt?: string`\n\n- `updatedAtGte?: string`\n\n- `updatedAtLte?: string`\n\n- `url?: string`\n\n- `width?: number`\n\n- `widthGte?: number`\n\n- `widthLte?: number`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const file of client.files.fileAssets.search()) {\n console.log(file);\n}\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const file of client.files.fileAssets.search()) {\n console.log(file.id);\n}", + }, + python: { + method: 'files.file_assets.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.files.file_assets.search()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'files().fileAssets().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetSearchPage;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileAssetSearchPage page = client.files().fileAssets().search();\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Files.FileAssets.Search(context.TODO(), files.FileAssetSearchParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'files.file_assets.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.files.file_assets.search\n\nputs(page)', + }, + php: { + method: 'files->fileAssets->search', + example: + "files->fileAssets->search(\n after: 'after',\n allowsAnonymousAccess: true,\n before: 'before',\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n encoding: 'encoding',\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n expiresAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n expiresAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n extension: 'extension',\n fileMd5: 'fileMd5',\n height: 0,\n heightGte: 0,\n heightLte: 0,\n idGte: 0,\n idLte: 0,\n ids: [0],\n isUsableInContent: true,\n limit: 0,\n name: 'name',\n parentFolderIDs: [0],\n path: 'path',\n properties: ['string'],\n size: 0,\n sizeGte: 0,\n sizeLte: 0,\n sort: ['string'],\n type: 'type',\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n url: 'url',\n width: 0,\n widthGte: 0,\n widthLte: 0,\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/files/2026-03/files/{fileId}', + httpMethod: 'patch', + summary: 'Update file properties', + description: 'Update properties of file by ID.', + stainlessPath: '(resource) files.file_assets > (method) update', + qualified: 'client.files.fileAssets.update', + params: [ + 'fileId: string;', + 'clearExpires: boolean;', + 'access?: string;', + 'expiresAt?: string;', + 'isUsableInContent?: boolean;', + 'name?: string;', + 'parentFolderId?: string;', + 'parentFolderPath?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", + markdown: + "## update\n\n`client.files.fileAssets.update(fileId: string, clearExpires: boolean, access?: string, expiresAt?: string, isUsableInContent?: boolean, name?: string, parentFolderId?: string, parentFolderPath?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**patch** `/files/2026-03/files/{fileId}`\n\nUpdate properties of file by ID.\n\n### Parameters\n\n- `fileId: string`\n\n- `clearExpires: boolean`\n\n- `access?: string`\n NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.\n\n- `expiresAt?: string`\n\n- `isUsableInContent?: boolean`\n Mark whether the file should be used in new content or not.\n\n- `name?: string`\n New name for the file.\n\n- `parentFolderId?: string`\n FolderId where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.\n\n- `parentFolderPath?: string`\n Folder path where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.update('321669910225', { clearExpires: true });\n\nconsole.log(file);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.update('321669910225', { clearExpires: true });\n\nconsole.log(file.id);", + }, + python: { + method: 'files.file_assets.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.update(\n file_id="321669910225",\n clear_expires=True,\n)\nprint(file.id)', + }, + java: { + method: 'files().fileAssets().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.FileUpdateInput;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileAssetUpdateParams params = FileAssetUpdateParams.builder()\n .fileId("321669910225")\n .fileUpdateInput(FileUpdateInput.builder()\n .clearExpires(true)\n .build())\n .build();\n File file = client.files().fileAssets().update(params);\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Update(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetUpdateParams{\n\t\t\tFileUpdateInput: files.FileUpdateInputParam{\n\t\t\t\tClearExpires: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.update("321669910225", clear_expires: true)\n\nputs(file)', + }, + php: { + method: 'files->fileAssets->update', + example: + "files->fileAssets->update(\n '321669910225',\n clearExpires: true,\n access: 'HIDDEN_INDEXABLE',\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isUsableInContent: true,\n name: 'name',\n parentFolderID: 'parentFolderId',\n parentFolderPath: 'parentFolderPath',\n);\n\nvar_dump($file);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearExpires": true\n }\'', + }, + }, + }, + { + name: 'upload', + endpoint: '/files/2026-03/files', + httpMethod: 'post', + summary: 'Upload file', + description: 'Upload a single file with content specified in request body.', + stainlessPath: '(resource) files.file_assets > (method) upload', + qualified: 'client.files.fileAssets.upload', + params: [ + 'charsetHunch?: string;', + 'file?: string;', + 'fileName?: string;', + 'folderId?: string;', + 'folderPath?: string;', + 'options?: string;', + ], + response: + "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", + markdown: + "## upload\n\n`client.files.fileAssets.upload(charsetHunch?: string, file?: string, fileName?: string, folderId?: string, folderPath?: string, options?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**post** `/files/2026-03/files`\n\nUpload a single file with content specified in request body.\n\n### Parameters\n\n- `charsetHunch?: string`\n\n- `file?: string`\n\n- `fileName?: string`\n\n- `folderId?: string`\n\n- `folderPath?: string`\n\n- `options?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.upload();\n\nconsole.log(file);\n```", + perLanguage: { + typescript: { + method: 'client.files.fileAssets.upload', + example: + "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.upload();\n\nconsole.log(file.id);", + }, + python: { + method: 'files.file_assets.upload', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.upload()\nprint(file.id)', + }, + java: { + method: 'files().fileAssets().upload', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetUploadParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().upload();\n }\n}', + }, + go: { + method: 'client.Files.FileAssets.Upload', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Upload(context.TODO(), files.FileAssetUploadParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', + }, + ruby: { + method: 'files.file_assets.upload', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.upload\n\nputs(file)', + }, + php: { + method: 'files->fileAssets->upload', + example: + "files->fileAssets->upload(\n charsetHunch: 'charsetHunch',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n fileName: 'fileName',\n folderID: 'folderId',\n folderPath: 'folderPath',\n options: 'options',\n);\n\nvar_dump($file);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/files \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_by_id', + endpoint: '/files/2026-03/folders/{folderId}', + httpMethod: 'delete', + summary: 'Delete folder by ID', + description: 'Delete folder by ID.', + stainlessPath: '(resource) files.folders > (method) delete_by_id', + qualified: 'client.files.folders.deleteByID', + params: ['folderId: string;'], + markdown: + "## delete_by_id\n\n`client.files.folders.deleteByID(folderId: string): void`\n\n**delete** `/files/2026-03/folders/{folderId}`\n\nDelete folder by ID.\n\n### Parameters\n\n- `folderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.folders.deleteByID('321669910225')\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.deleteByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.folders.deleteByID('321669910225');", + }, + python: { + method: 'files.folders.delete_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.folders.delete_by_id(\n "321669910225",\n)', + }, + java: { + method: 'files().folders().deleteById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderDeleteByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().folders().deleteById("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.Folders.DeleteByID', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.Folders.DeleteByID(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'files.folders.delete_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.folders.delete_by_id("321669910225")\n\nputs(result)', + }, + php: { + method: 'files->folders->deleteByID', + example: + "files->folders->deleteByID('321669910225');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_by_path', + endpoint: '/files/2026-03/folders/{folderPath}', + httpMethod: 'delete', + summary: 'Delete folder by path', + description: 'Delete a folder, identified by its path.', + stainlessPath: '(resource) files.folders > (method) delete_by_path', + qualified: 'client.files.folders.deleteByPath', + params: ['folderPath: string;'], + markdown: + "## delete_by_path\n\n`client.files.folders.deleteByPath(folderPath: string): void`\n\n**delete** `/files/2026-03/folders/{folderPath}`\n\nDelete a folder, identified by its path.\n\n### Parameters\n\n- `folderPath: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.folders.deleteByPath('folderPath')\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.deleteByPath', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.folders.deleteByPath('folderPath');", + }, + python: { + method: 'files.folders.delete_by_path', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.folders.delete_by_path(\n "folderPath",\n)', + }, + java: { + method: 'files().folders().deleteByPath', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderDeleteByPathParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().folders().deleteByPath("folderPath");\n }\n}', + }, + go: { + method: 'client.Files.Folders.DeleteByPath', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.Folders.DeleteByPath(context.TODO(), "folderPath")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'files.folders.delete_by_path', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.folders.delete_by_path("folderPath")\n\nputs(result)', + }, + php: { + method: 'files->folders->deleteByPath', + example: + "files->folders->deleteByPath('folderPath');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_PATH \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_id', + endpoint: '/files/2026-03/folders/{folderId}', + httpMethod: 'get', + summary: 'Retrieve folder by ID', + description: 'Retrieve a folder by its ID.', + stainlessPath: '(resource) files.folders > (method) get_by_id', + qualified: 'client.files.folders.getByID', + params: ['folderId: string;', 'properties?: string[];'], + response: + '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', + markdown: + "## get_by_id\n\n`client.files.folders.getByID(folderId: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/{folderId}`\n\nRetrieve a folder by its ID.\n\n### Parameters\n\n- `folderId: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.getByID('321669910225');\n\nconsole.log(folder);\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.getByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.getByID('321669910225');\n\nconsole.log(folder.id);", + }, + python: { + method: 'files.folders.get_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.get_by_id(\n folder_id="321669910225",\n)\nprint(folder.id)', + }, + java: { + method: 'files().folders().getById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.folders.FolderGetByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Folder folder = client.files().folders().getById("321669910225");\n }\n}', + }, + go: { + method: 'client.Files.Folders.GetByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.GetByID(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FolderGetByIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', + }, + ruby: { + method: 'files.folders.get_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.get_by_id("321669910225")\n\nputs(folder)', + }, + php: { + method: 'files->folders->getByID', + example: + "files->folders->getByID(\n '321669910225', properties: ['string']\n);\n\nvar_dump($folder);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_path', + endpoint: '/files/2026-03/folders/{folderPath}', + httpMethod: 'get', + summary: 'Retrieve folder by path', + description: 'Retrieve a folder, identified by its path.', + stainlessPath: '(resource) files.folders > (method) get_by_path', + qualified: 'client.files.folders.getByPath', + params: ['folderPath: string;', 'properties?: string[];'], + response: + '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', + markdown: + "## get_by_path\n\n`client.files.folders.getByPath(folderPath: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/{folderPath}`\n\nRetrieve a folder, identified by its path.\n\n### Parameters\n\n- `folderPath: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.getByPath('folderPath');\n\nconsole.log(folder);\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.getByPath', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.getByPath('folderPath');\n\nconsole.log(folder.id);", + }, + python: { + method: 'files.folders.get_by_path', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.get_by_path(\n folder_path="folderPath",\n)\nprint(folder.id)', + }, + java: { + method: 'files().folders().getByPath', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.folders.FolderGetByPathParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Folder folder = client.files().folders().getByPath("folderPath");\n }\n}', + }, + go: { + method: 'client.Files.Folders.GetByPath', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.GetByPath(\n\t\tcontext.TODO(),\n\t\t"folderPath",\n\t\tfiles.FolderGetByPathParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', + }, + ruby: { + method: 'files.folders.get_by_path', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.get_by_path("folderPath")\n\nputs(folder)', + }, + php: { + method: 'files->folders->getByPath', + example: + "files->folders->getByPath(\n 'folderPath', properties: ['string']\n);\n\nvar_dump($folder);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_PATH \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_update_async_status', + endpoint: '/files/2026-03/folders/update/async/tasks/{taskId}/status', + httpMethod: 'get', + summary: 'Check folder update status', + description: 'Check status of folder update. Folder updates happen asynchronously.', + stainlessPath: '(resource) files.folders > (method) get_update_async_status', + qualified: 'client.files.folders.getUpdateAsyncStatus', + params: ['taskId: string;'], + response: + "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }; }", + markdown: + "## get_update_async_status\n\n`client.files.folders.getUpdateAsyncStatus(taskId: string): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: folder; }`\n\n**get** `/files/2026-03/folders/update/async/tasks/{taskId}/status`\n\nCheck status of folder update. Folder updates happen asynchronously.\n\n### Parameters\n\n- `taskId: string`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `taskId: string`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folderActionResponse = await client.files.folders.getUpdateAsyncStatus('taskId');\n\nconsole.log(folderActionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.getUpdateAsyncStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folderActionResponse = await client.files.folders.getUpdateAsyncStatus('taskId');\n\nconsole.log(folderActionResponse.completedAt);", + }, + python: { + method: 'files.folders.get_update_async_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder_action_response = client.files.folders.get_update_async_status(\n "taskId",\n)\nprint(folder_action_response.completed_at)', + }, + java: { + method: 'files().folders().getUpdateAsyncStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FolderActionResponse;\nimport com.hubspot.sdk.models.files.folders.FolderGetUpdateAsyncStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderActionResponse folderActionResponse = client.files().folders().getUpdateAsyncStatus("taskId");\n }\n}', + }, + go: { + method: 'client.Files.Folders.GetUpdateAsyncStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolderActionResponse, err := client.Files.Folders.GetUpdateAsyncStatus(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folderActionResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'files.folders.get_update_async_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder_action_response = hubspot.files.folders.get_update_async_status("taskId")\n\nputs(folder_action_response)', + }, + php: { + method: 'files->folders->getUpdateAsyncStatus', + example: + "files->folders->getUpdateAsyncStatus('taskId');\n\nvar_dump($folderActionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/update/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search', + endpoint: '/files/2026-03/folders/search', + httpMethod: 'get', + summary: 'Search folders', + description: 'Search for folders. Does not contain hidden or archived folders.', + stainlessPath: '(resource) files.folders > (method) search', + qualified: 'client.files.folders.search', + params: [ + 'after?: string;', + 'before?: string;', + 'createdAt?: string;', + 'createdAtGte?: string;', + 'createdAtLte?: string;', + 'idGte?: number;', + 'idLte?: number;', + 'ids?: number[];', + 'limit?: number;', + 'name?: string;', + 'parentFolderIds?: number[];', + 'path?: string;', + 'properties?: string[];', + 'sort?: string[];', + 'updatedAt?: string;', + 'updatedAtGte?: string;', + 'updatedAtLte?: string;', + ], + response: + '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', + markdown: + "## search\n\n`client.files.folders.search(after?: string, before?: string, createdAt?: string, createdAtGte?: string, createdAtLte?: string, idGte?: number, idLte?: number, ids?: number[], limit?: number, name?: string, parentFolderIds?: number[], path?: string, properties?: string[], sort?: string[], updatedAt?: string, updatedAtGte?: string, updatedAtLte?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/search`\n\nSearch for folders. Does not contain hidden or archived folders.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `createdAt?: string`\n\n- `createdAtGte?: string`\n\n- `createdAtLte?: string`\n\n- `idGte?: number`\n\n- `idLte?: number`\n\n- `ids?: number[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `parentFolderIds?: number[]`\n\n- `path?: string`\n\n- `properties?: string[]`\n\n- `sort?: string[]`\n\n- `updatedAt?: string`\n\n- `updatedAtGte?: string`\n\n- `updatedAtLte?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const folder of client.files.folders.search()) {\n console.log(folder);\n}\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.search', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const folder of client.files.folders.search()) {\n console.log(folder.id);\n}", + }, + python: { + method: 'files.folders.search', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.files.folders.search()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'files().folders().search', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderSearchPage;\nimport com.hubspot.sdk.models.files.folders.FolderSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderSearchPage page = client.files().folders().search();\n }\n}', + }, + go: { + method: 'client.Files.Folders.Search', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Files.Folders.Search(context.TODO(), files.FolderSearchParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'files.folders.search', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.files.folders.search\n\nputs(page)', + }, + php: { + method: 'files->folders->search', + example: + "files->folders->search(\n after: 'after',\n before: 'before',\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n idGte: 0,\n idLte: 0,\n ids: [0],\n limit: 0,\n name: 'name',\n parentFolderIDs: [0],\n path: 'path',\n properties: ['string'],\n sort: ['string'],\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_async_by_id', + endpoint: '/files/2026-03/folders/update/async', + httpMethod: 'post', + summary: 'Update folder properties', + description: + "Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.", + stainlessPath: '(resource) files.folders > (method) update_async_by_id', + qualified: 'client.files.folders.updateAsyncByID', + params: ['id: string;', 'name?: string;', 'parentFolderId?: number;'], + response: '{ id: string; links?: object; }', + markdown: + "## update_async_by_id\n\n`client.files.folders.updateAsyncByID(id: string, name?: string, parentFolderId?: number): { id: string; links?: object; }`\n\n**post** `/files/2026-03/folders/update/async`\n\nUpdate properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.\n\n### Parameters\n\n- `id: string`\n The unique identifier of the folder to be updated.\n\n- `name?: string`\n New name. If specified the folder's name and fullPath will change. All children of the folder will be updated accordingly.\n\n- `parentFolderId?: number`\n New parent folderId. If changed, the folder and all it's children will be moved into the specified folder. parentFolderId and parentFolderPath cannot be specified at the same time.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folderUpdateTaskLocator = await client.files.folders.updateAsyncByID({ id: 'id' });\n\nconsole.log(folderUpdateTaskLocator);\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.updateAsyncByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folderUpdateTaskLocator = await client.files.folders.updateAsyncByID({ id: 'id' });\n\nconsole.log(folderUpdateTaskLocator.id);", + }, + python: { + method: 'files.folders.update_async_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder_update_task_locator = client.files.folders.update_async_by_id(\n id="id",\n)\nprint(folder_update_task_locator.id)', + }, + java: { + method: 'files().folders().updateAsyncById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FolderUpdateInputWithId;\nimport com.hubspot.sdk.models.files.FolderUpdateTaskLocator;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateInputWithId params = FolderUpdateInputWithId.builder()\n .id("id")\n .build();\n FolderUpdateTaskLocator folderUpdateTaskLocator = client.files().folders().updateAsyncById(params);\n }\n}', + }, + go: { + method: 'client.Files.Folders.UpdateAsyncByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolderUpdateTaskLocator, err := client.Files.Folders.UpdateAsyncByID(context.TODO(), files.FolderUpdateAsyncByIDParams{\n\t\tFolderUpdateInputWithID: files.FolderUpdateInputWithIDParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folderUpdateTaskLocator.ID)\n}\n', + }, + ruby: { + method: 'files.folders.update_async_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder_update_task_locator = hubspot.files.folders.update_async_by_id(id: "id")\n\nputs(folder_update_task_locator)', + }, + php: { + method: 'files->folders->updateAsyncByID', + example: + "files->folders->updateAsyncByID(\n id: 'id', name: 'name', parentFolderID: 0\n);\n\nvar_dump($folderUpdateTaskLocator);", + }, + http: { + example: + 'curl https://api.hubapi.com/files/2026-03/folders/update/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'update_by_id', + endpoint: '/files/2026-03/folders/{folderId}', + httpMethod: 'patch', + summary: 'Update folder properties by folder ID', + description: "Update a folder's properties, identified by folder ID.", + stainlessPath: '(resource) files.folders > (method) update_by_id', + qualified: 'client.files.folders.updateByID', + params: ['folderId: string;', 'name?: string;', 'parentFolderId?: number;'], + response: + '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', + markdown: + "## update_by_id\n\n`client.files.folders.updateByID(folderId: string, name?: string, parentFolderId?: number): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**patch** `/files/2026-03/folders/{folderId}`\n\nUpdate a folder's properties, identified by folder ID.\n\n### Parameters\n\n- `folderId: string`\n\n- `name?: string`\n New name. If specified the folder's name and fullPath will change. All children of the folder will be updated accordingly.\n\n- `parentFolderId?: number`\n New parent folderId. If changed, the folder and all it's children will be moved into the specified folder. parentFolderId and parentFolderPath cannot be specified at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.updateByID('321669910225');\n\nconsole.log(folder);\n```", + perLanguage: { + typescript: { + method: 'client.files.folders.updateByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.updateByID('321669910225');\n\nconsole.log(folder.id);", + }, + python: { + method: 'files.folders.update_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.update_by_id(\n folder_id="321669910225",\n)\nprint(folder.id)', + }, + java: { + method: 'files().folders().updateById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.FolderUpdateInput;\nimport com.hubspot.sdk.models.files.folders.FolderUpdateByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateByIdParams params = FolderUpdateByIdParams.builder()\n .folderId("321669910225")\n .folderUpdateInput(FolderUpdateInput.builder().build())\n .build();\n Folder folder = client.files().folders().updateById(params);\n }\n}', + }, + go: { + method: 'client.Files.Folders.UpdateByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.UpdateByID(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FolderUpdateByIDParams{\n\t\t\tFolderUpdateInput: files.FolderUpdateInputParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', + }, + ruby: { + method: 'files.folders.update_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.update_by_id("321669910225")\n\nputs(folder)', + }, + php: { + method: 'files->folders->updateByID', + example: + "files->folders->updateByID(\n '321669910225', name: 'name', parentFolderID: 0\n);\n\nvar_dump($folder);", + }, + http: { + example: + "curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/campaigns/2026-03', + httpMethod: 'post', + summary: 'Create a campaign', + description: + "Create a campaign with the specified properties and receive a copy of the campaign object, including its ID. Note that the 'hs_goal' property is deprecated and will be ignored if provided.", + stainlessPath: '(resource) marketing.campaigns > (method) create', + qualified: 'client.marketing.campaigns.create', + params: ['properties: object;'], + response: + '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', + markdown: + "## create\n\n`client.marketing.campaigns.create(properties: object): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**post** `/marketing/campaigns/2026-03`\n\nCreate a campaign with the specified properties and receive a copy of the campaign object, including its ID. Note that the 'hs_goal' property is deprecated and will be ignored if provided.\n\n### Parameters\n\n- `properties: object`\n A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.\n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaign = await client.marketing.campaigns.create({ properties: { foo: 'string' } });\n\nconsole.log(publicCampaign);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaign = await client.marketing.campaigns.create({ properties: { foo: 'string' } });\n\nconsole.log(publicCampaign.id);", + }, + python: { + method: 'marketing.campaigns.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign = client.marketing.campaigns.create(\n properties={\n "foo": "string"\n },\n)\nprint(public_campaign.id)', + }, + java: { + method: 'marketing().campaigns().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCampaignInput params = PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n PublicCampaign publicCampaign = client.marketing().campaigns().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaign, err := client.Marketing.Campaigns.New(context.TODO(), marketing.CampaignNewParams{\n\t\tPublicCampaignInput: marketing.PublicCampaignInputParam{\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaign.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign = hubspot.marketing.campaigns.create(properties: {foo: "string"})\n\nputs(public_campaign)', + }, + php: { + method: 'marketing->campaigns->create', + example: + "marketing->campaigns->create(\n properties: ['foo' => 'string']\n);\n\nvar_dump($publicCampaign);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', + httpMethod: 'delete', + summary: 'Delete campaign ', + description: + 'Delete a specified campaign from the system.\nThis call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.', + stainlessPath: '(resource) marketing.campaigns > (method) delete', + qualified: 'client.marketing.campaigns.delete', + params: ['campaignGuid: string;'], + markdown: + "## delete\n\n`client.marketing.campaigns.delete(campaignGuid: string): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nDelete a specified campaign from the system.\nThis call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.\n\n### Parameters\n\n- `campaignGuid: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.delete('campaignGuid')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.delete('campaignGuid');", + }, + python: { + method: 'marketing.campaigns.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.delete(\n "campaignGuid",\n)', + }, + java: { + method: 'marketing().campaigns().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().campaigns().delete("campaignGuid");\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Delete(context.TODO(), "campaignGuid")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.delete("campaignGuid")\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->delete', + example: + "marketing->campaigns->delete('campaignGuid');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', + httpMethod: 'get', + summary: 'Read a campaign', + description: + "Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.", + stainlessPath: '(resource) marketing.campaigns > (method) get', + qualified: 'client.marketing.campaigns.get', + params: ['campaignGuid: string;', 'endDate?: string;', 'properties?: string[];', 'startDate?: string;'], + response: + '{ id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', + markdown: + "## get\n\n`client.marketing.campaigns.get(campaignGuid: string, endDate?: string, properties?: string[], startDate?: string): { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nGet a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `endDate?: string`\n The end date for fetching asset metrics, in YYYY-MM-DD format.\nOptional. Example: 2000-01-27\n\n- `properties?: string[]`\n A comma-separated list of properties to include in the response. \n Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes\n\n- `startDate?: string`\n The start date for fetching asset metrics, in YYYY-MM-DD format. \nOptional. Example: 2000-01-20 \n\n### Returns\n\n- `{ id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `assets: object`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaignWithAssets = await client.marketing.campaigns.get('campaignGuid');\n\nconsole.log(publicCampaignWithAssets);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaignWithAssets = await client.marketing.campaigns.get('campaignGuid');\n\nconsole.log(publicCampaignWithAssets.id);", + }, + python: { + method: 'marketing.campaigns.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign_with_assets = client.marketing.campaigns.get(\n campaign_guid="campaignGuid",\n)\nprint(public_campaign_with_assets.id)', + }, + java: { + method: 'marketing().campaigns().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignGetParams;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignWithAssets;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCampaignWithAssets publicCampaignWithAssets = client.marketing().campaigns().get("campaignGuid");\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaignWithAssets, err := client.Marketing.Campaigns.Get(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaignWithAssets.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign_with_assets = hubspot.marketing.campaigns.get("campaignGuid")\n\nputs(public_campaign_with_assets)', + }, + php: { + method: 'marketing->campaigns->get', + example: + "marketing->campaigns->get(\n 'campaignGuid',\n endDate: 'endDate',\n properties: ['string'],\n startDate: 'startDate',\n);\n\nvar_dump($publicCampaignWithAssets);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/campaigns/2026-03', + httpMethod: 'get', + summary: 'Retrieve campaigns', + description: + 'Retrieve a paginated list of campaigns from your HubSpot account. This endpoint allows you to specify sorting, pagination, and filtering options to tailor the results to your needs.', + stainlessPath: '(resource) marketing.campaigns > (method) list', + qualified: 'client.marketing.campaigns.list', + params: [ + 'after?: string;', + 'limit?: number;', + 'name?: string;', + 'properties?: string[];', + 'sort?: string;', + ], + response: + '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', + markdown: + "## list\n\n`client.marketing.campaigns.list(after?: string, limit?: number, name?: string, properties?: string[], sort?: string): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**get** `/marketing/campaigns/2026-03`\n\nRetrieve a paginated list of campaigns from your HubSpot account. This endpoint allows you to specify sorting, pagination, and filtering options to tailor the results to your needs.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n Filter campaigns by name. Optional. \n\n- `properties?: string[]`\n A comma-separated list of properties to include in the response. \n Unrecognized properties are ignored. Optional. Example: \n hs_name, hs_budget,hs_notes\n\n- `sort?: string`\n The property to sort results by. Optional. \n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicCampaign of client.marketing.campaigns.list()) {\n console.log(publicCampaign);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicCampaign of client.marketing.campaigns.list()) {\n console.log(publicCampaign.id);\n}", + }, + python: { + method: 'marketing.campaigns.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.campaigns.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().campaigns().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignListPage;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CampaignListPage page = client.marketing().campaigns().list();\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Campaigns.List(context.TODO(), marketing.CampaignListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.campaigns.list\n\nputs(page)', + }, + php: { + method: 'marketing->campaigns->list', + example: + "marketing->campaigns->list(\n after: 'after', limit: 0, name: 'name', properties: ['string'], sort: 'sort'\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', + httpMethod: 'patch', + summary: 'Update campaign', + description: + "Perform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error.\nIf an empty string is passed for any property in the Batch Update, it will reset that property's value.\n", + stainlessPath: '(resource) marketing.campaigns > (method) update', + qualified: 'client.marketing.campaigns.update', + params: ['campaignGuid: string;', 'properties: object;'], + response: + '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', + markdown: + "## update\n\n`client.marketing.campaigns.update(campaignGuid: string, properties: object): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**patch** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nPerform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error.\nIf an empty string is passed for any property in the Batch Update, it will reset that property's value.\n\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `properties: object`\n A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.\n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaign = await client.marketing.campaigns.update('campaignGuid', { properties: { foo: 'string' } });\n\nconsole.log(publicCampaign);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaign = await client.marketing.campaigns.update('campaignGuid', {\n properties: { foo: 'string' },\n});\n\nconsole.log(publicCampaign.id);", + }, + python: { + method: 'marketing.campaigns.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign = client.marketing.campaigns.update(\n campaign_guid="campaignGuid",\n properties={\n "foo": "string"\n },\n)\nprint(public_campaign.id)', + }, + java: { + method: 'marketing().campaigns().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignUpdateParams;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CampaignUpdateParams params = CampaignUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .publicCampaignInput(PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PublicCampaign publicCampaign = client.marketing().campaigns().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaign, err := client.Marketing.Campaigns.Update(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignUpdateParams{\n\t\t\tPublicCampaignInput: marketing.PublicCampaignInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaign.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign = hubspot.marketing.campaigns.update("campaignGuid", properties: {foo: "string"})\n\nputs(public_campaign)', + }, + php: { + method: 'marketing->campaigns->update', + example: + "marketing->campaigns->update(\n 'campaignGuid', properties: ['foo' => 'string']\n);\n\nvar_dump($publicCampaign);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', + httpMethod: 'delete', + summary: 'Remove asset association', + description: + 'Disassociate a specified asset from a campaign. Using the API, you can remove associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.', + stainlessPath: '(resource) marketing.campaigns.assets > (method) delete', + qualified: 'client.marketing.campaigns.assets.delete', + params: ['campaignGuid: string;', 'assetType: string;', 'assetId: string;'], + markdown: + "## delete\n\n`client.marketing.campaigns.assets.delete(campaignGuid: string, assetType: string, assetId: string): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}`\n\nDisassociate a specified asset from a campaign. Using the API, you can remove associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `assetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.assets.delete('assetId', { campaignGuid: 'campaignGuid', assetType: 'assetType' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.assets.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.assets.delete('assetId', {\n campaignGuid: 'campaignGuid',\n assetType: 'assetType',\n});", + }, + python: { + method: 'marketing.campaigns.assets.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.assets.delete(\n asset_id="assetId",\n campaign_guid="campaignGuid",\n asset_type="assetType",\n)', + }, + java: { + method: 'marketing().campaigns().assets().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetDeleteParams params = AssetDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .assetId("assetId")\n .build();\n client.marketing().campaigns().assets().delete(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Assets.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Assets.Delete(\n\t\tcontext.TODO(),\n\t\t"assetId",\n\t\tmarketing.CampaignAssetDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tAssetType: "assetType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.assets.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.assets.delete(\n "assetId",\n campaign_guid: "campaignGuid",\n asset_type: "assetType"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->assets->delete', + example: + "marketing->campaigns->assets->delete(\n 'assetId', campaignGuid: 'campaignGuid', assetType: 'assetType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE/$ASSET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}', + httpMethod: 'get', + summary: 'List assets', + description: + 'This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type.\nAsset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.', + stainlessPath: '(resource) marketing.campaigns.assets > (method) list', + qualified: 'client.marketing.campaigns.assets.list', + params: [ + 'campaignGuid: string;', + 'assetType: string;', + 'after?: string;', + 'endDate?: string;', + 'limit?: string;', + 'startDate?: string;', + ], + response: + '{ results: { id: string; metrics?: object; name?: string; }[]; paging?: { next?: next_page; }; }', + markdown: + "## list\n\n`client.marketing.campaigns.assets.list(campaignGuid: string, assetType: string, after?: string, endDate?: string, limit?: string, startDate?: string): { results: public_campaign_asset[]; paging?: forward_paging; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}`\n\nThis endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type.\nAsset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `endDate?: string`\n End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2024-01-27\n\n- `limit?: string`\n The maximum number of results to display per page.\n\n- `startDate?: string`\n Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2023-01-20\n\n### Returns\n\n- `{ results: { id: string; metrics?: object; name?: string; }[]; paging?: { next?: next_page; }; }`\n\n - `results: { id: string; metrics?: object; name?: string; }[]`\n - `paging?: { next?: { after: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicCampaignAssetForwardPaging = await client.marketing.campaigns.assets.list('assetType', { campaignGuid: 'campaignGuid' });\n\nconsole.log(collectionResponsePublicCampaignAssetForwardPaging);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.assets.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicCampaignAssetForwardPaging =\n await client.marketing.campaigns.assets.list('assetType', { campaignGuid: 'campaignGuid' });\n\nconsole.log(collectionResponsePublicCampaignAssetForwardPaging.results);", + }, + python: { + method: 'marketing.campaigns.assets.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_campaign_asset_forward_paging = client.marketing.campaigns.assets.list(\n asset_type="assetType",\n campaign_guid="campaignGuid",\n)\nprint(collection_response_public_campaign_asset_forward_paging.results)', + }, + java: { + method: 'marketing().campaigns().assets().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CollectionResponsePublicCampaignAssetForwardPaging;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetListParams params = AssetListParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .build();\n CollectionResponsePublicCampaignAssetForwardPaging collectionResponsePublicCampaignAssetForwardPaging = client.marketing().campaigns().assets().list(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Assets.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicCampaignAssetForwardPaging, err := client.Marketing.Campaigns.Assets.List(\n\t\tcontext.TODO(),\n\t\t"assetType",\n\t\tmarketing.CampaignAssetListParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicCampaignAssetForwardPaging.Results)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.assets.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_campaign_asset_forward_paging = hubspot.marketing.campaigns.assets.list("assetType", campaign_guid: "campaignGuid")\n\nputs(collection_response_public_campaign_asset_forward_paging)', + }, + php: { + method: 'marketing->campaigns->assets->list', + example: + "marketing\n ->campaigns\n ->assets\n ->list(\n 'assetType',\n campaignGuid: 'campaignGuid',\n after: 'after',\n endDate: 'endDate',\n limit: 'limit',\n startDate: 'startDate',\n);\n\nvar_dump($collectionResponsePublicCampaignAssetForwardPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', + httpMethod: 'put', + summary: 'Add asset association', + description: + 'Associate a specified asset with a campaign. Using the API, you can create associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.', + stainlessPath: '(resource) marketing.campaigns.assets > (method) update', + qualified: 'client.marketing.campaigns.assets.update', + params: ['campaignGuid: string;', 'assetType: string;', 'assetId: string;'], + markdown: + "## update\n\n`client.marketing.campaigns.assets.update(campaignGuid: string, assetType: string, assetId: string): void`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}`\n\nAssociate a specified asset with a campaign. Using the API, you can create associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `assetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.assets.update('assetId', { campaignGuid: 'campaignGuid', assetType: 'assetType' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.assets.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.assets.update('assetId', {\n campaignGuid: 'campaignGuid',\n assetType: 'assetType',\n});", + }, + python: { + method: 'marketing.campaigns.assets.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.assets.update(\n asset_id="assetId",\n campaign_guid="campaignGuid",\n asset_type="assetType",\n)', + }, + java: { + method: 'marketing().campaigns().assets().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetUpdateParams params = AssetUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .assetId("assetId")\n .build();\n client.marketing().campaigns().assets().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Assets.Update', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Assets.Update(\n\t\tcontext.TODO(),\n\t\t"assetId",\n\t\tmarketing.CampaignAssetUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tAssetType: "assetType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.assets.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.assets.update(\n "assetId",\n campaign_guid: "campaignGuid",\n asset_type: "assetType"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->assets->update', + example: + "marketing->campaigns->assets->update(\n 'assetId', campaignGuid: 'campaignGuid', assetType: 'assetType'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE/$ASSET_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/campaigns/2026-03/batch/create', + httpMethod: 'post', + summary: 'Create a batch of campaigns', + description: + 'This endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.', + stainlessPath: '(resource) marketing.campaigns.batch > (method) create', + qualified: 'client.marketing.campaigns.batch.create', + params: ['inputs: { properties: object; }[];'], + response: + "{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.marketing.campaigns.batch.create(inputs: { properties: object; }[]): { completedAt: string; results: public_campaign[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/create`\n\nThis endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\n\n### Parameters\n\n- `inputs: { properties: object; }[]`\n An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.create({ inputs: [{ properties: { foo: 'string' } }] });\n\nconsole.log(batchResponsePublicCampaign);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.create({\n inputs: [{ properties: { foo: 'string' } }],\n});\n\nconsole.log(batchResponsePublicCampaign.completedAt);", + }, + python: { + method: 'marketing.campaigns.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign = client.marketing.campaigns.batch.create(\n inputs=[{\n "properties": {\n "foo": "string"\n }\n }],\n)\nprint(batch_response_public_campaign.completed_at)', + }, + java: { + method: 'marketing().campaigns().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignInput;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignInput params = BatchInputPublicCampaignInput.builder()\n .addInput(PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponsePublicCampaign batchResponsePublicCampaign = client.marketing().campaigns().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaign, err := client.Marketing.Campaigns.Batch.New(context.TODO(), marketing.CampaignBatchNewParams{\n\t\tBatchInputPublicCampaignInput: marketing.BatchInputPublicCampaignInputParam{\n\t\t\tInputs: []marketing.PublicCampaignInputParam{{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaign.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign = hubspot.marketing.campaigns.batch.create(inputs: [{properties: {foo: "string"}}])\n\nputs(batch_response_public_campaign)', + }, + php: { + method: 'marketing->campaigns->batch->create', + example: + "marketing->campaigns->batch->create(\n inputs: [['properties' => ['foo' => 'string']]]\n);\n\nvar_dump($batchResponsePublicCampaign);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/campaigns/2026-03/batch/archive', + httpMethod: 'post', + summary: 'Delete a batch of campaigns', + description: + 'This endpoint deletes a batch of campaigns. \nThe maximum number of items in a batch request is 50.\nThe response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.', + stainlessPath: '(resource) marketing.campaigns.batch > (method) delete', + qualified: 'client.marketing.campaigns.batch.delete', + params: ['inputs: { id: string; }[];'], + markdown: + "## delete\n\n`client.marketing.campaigns.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/marketing/campaigns/2026-03/batch/archive`\n\nThis endpoint deletes a batch of campaigns. \nThe maximum number of items in a batch request is 50.\nThe response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.batch.delete({ inputs: [{ id: 'id' }] })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.batch.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.batch.delete({ inputs: [{ id: 'id' }] });", + }, + python: { + method: 'marketing.campaigns.batch.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.batch.delete(\n inputs=[{\n "id": "id"\n }],\n)', + }, + java: { + method: 'marketing().campaigns().batch().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignDeleteInput;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignDeleteInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignDeleteInput params = BatchInputPublicCampaignDeleteInput.builder()\n .addInput(PublicCampaignDeleteInput.builder()\n .id("id")\n .build())\n .build();\n client.marketing().campaigns().batch().delete(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Batch.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Batch.Delete(context.TODO(), marketing.CampaignBatchDeleteParams{\n\t\tBatchInputPublicCampaignDeleteInput: marketing.BatchInputPublicCampaignDeleteInputParam{\n\t\t\tInputs: []marketing.PublicCampaignDeleteInputParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.batch.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.batch.delete(inputs: [{id: "id"}])\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->batch->delete', + example: + "marketing->campaigns->batch->delete(\n inputs: [['id' => 'id']]\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/campaigns/2026-03/batch/read', + httpMethod: 'post', + summary: 'Read a batch of campaigns', + description: + 'This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. \nThe maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\nIf duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.\n', + stainlessPath: '(resource) marketing.campaigns.batch > (method) get', + qualified: 'client.marketing.campaigns.batch.get', + params: [ + 'inputs: { id: string; }[];', + 'endDate?: string;', + 'properties?: string[];', + 'startDate?: string;', + ], + response: + "{ completedAt: string; results: { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.marketing.campaigns.batch.get(inputs: { id: string; }[], endDate?: string, properties?: string[], startDate?: string): { completedAt: string; results: public_campaign_with_assets[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/read`\n\nThis endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. \nThe maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\nIf duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.\n\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.\n\n- `endDate?: string`\n End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2024-01-27\n\n- `properties?: string[]`\n A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map.\nExample: hs_name, hs_campaign_status, hs_notes\n\n- `startDate?: string`\n Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2023-01-20\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaignWithAssets = await client.marketing.campaigns.batch.get({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponsePublicCampaignWithAssets);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaignWithAssets = await client.marketing.campaigns.batch.get({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponsePublicCampaignWithAssets.completedAt);", + }, + python: { + method: 'marketing.campaigns.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign_with_assets = client.marketing.campaigns.batch.get(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_public_campaign_with_assets.completed_at)', + }, + java: { + method: 'marketing().campaigns().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignReadInput;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaignWithAssets;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignReadInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignReadInput params = BatchInputPublicCampaignReadInput.builder()\n .addInput(PublicCampaignReadInput.builder()\n .id("id")\n .build())\n .build();\n BatchResponsePublicCampaignWithAssets batchResponsePublicCampaignWithAssets = client.marketing().campaigns().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaignWithAssets, err := client.Marketing.Campaigns.Batch.Get(context.TODO(), marketing.CampaignBatchGetParams{\n\t\tBatchInputPublicCampaignReadInput: marketing.BatchInputPublicCampaignReadInputParam{\n\t\t\tInputs: []marketing.PublicCampaignReadInputParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaignWithAssets.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign_with_assets = hubspot.marketing.campaigns.batch.get(inputs: [{id: "id"}])\n\nputs(batch_response_public_campaign_with_assets)', + }, + php: { + method: 'marketing->campaigns->batch->get', + example: + "marketing\n ->campaigns\n ->batch\n ->get(\n inputs: [['id' => 'id']],\n endDate: 'endDate',\n properties: ['string'],\n startDate: 'startDate',\n);\n\nvar_dump($batchResponsePublicCampaignWithAssets);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/campaigns/2026-03/batch/update', + httpMethod: 'post', + summary: 'Update a batch of campaigns', + description: + 'This endpoint updates a batch of campaigns based on the provided input data.\nThe maximum number of items in a batch request is 50.\nIf an empty string ("") is passed for any property in the Batch Update, it will reset that property\'s value.', + stainlessPath: '(resource) marketing.campaigns.batch > (method) update', + qualified: 'client.marketing.campaigns.batch.update', + params: ['inputs: { id: string; properties: object; }[];'], + response: + "{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.marketing.campaigns.batch.update(inputs: { id: string; properties: object; }[]): { completedAt: string; results: public_campaign[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/update`\n\nThis endpoint updates a batch of campaigns based on the provided input data.\nThe maximum number of items in a batch request is 50.\nIf an empty string (\"\") is passed for any property in the Batch Update, it will reset that property's value.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; }[]`\n An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponsePublicCampaign);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponsePublicCampaign.completedAt);", + }, + python: { + method: 'marketing.campaigns.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign = client.marketing.campaigns.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_public_campaign.completed_at)', + }, + java: { + method: 'marketing().campaigns().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignBatchUpdateItem;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignBatchUpdateItem;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignBatchUpdateItem params = BatchInputPublicCampaignBatchUpdateItem.builder()\n .addInput(PublicCampaignBatchUpdateItem.builder()\n .id("id")\n .properties(PublicCampaignBatchUpdateItem.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponsePublicCampaign batchResponsePublicCampaign = client.marketing().campaigns().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaign, err := client.Marketing.Campaigns.Batch.Update(context.TODO(), marketing.CampaignBatchUpdateParams{\n\t\tBatchInputPublicCampaignBatchUpdateItem: marketing.BatchInputPublicCampaignBatchUpdateItemParam{\n\t\t\tInputs: []marketing.PublicCampaignBatchUpdateItemParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaign.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign = hubspot.marketing.campaigns.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_public_campaign)', + }, + php: { + method: 'marketing->campaigns->batch->update', + example: + "marketing->campaigns->batch->update(\n inputs: [['id' => 'id', 'properties' => ['foo' => 'string']]]\n);\n\nvar_dump($batchResponsePublicCampaign);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget', + httpMethod: 'post', + summary: 'Add budget item', + description: 'Add a new budget item to the campaign', + stainlessPath: '(resource) marketing.campaigns.budget > (method) create', + qualified: 'client.marketing.campaigns.budget.create', + params: [ + 'campaignGuid: string;', + 'amount: number;', + 'name: string;', + 'order: number;', + 'description?: string;', + ], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## create\n\n`client.marketing.campaigns.budget.create(campaignGuid: string, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**post** `/marketing/campaigns/2026-03/{campaignGuid}/budget`\n\nAdd a new budget item to the campaign\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `amount: number`\n The monetary value assigned to the budget item.\n\n- `name: string`\n The name of the budget item.\n\n- `order: number`\n The sequence number indicating the order of the budget item.\n\n- `description?: string`\n A detailed explanation or notes about the budget item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.budget.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem.id);", + }, + python: { + method: 'marketing.campaigns.budget.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.create(\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_budget_item.id)', + }, + java: { + method: 'marketing().campaigns().budget().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetCreateParams params = BudgetCreateParams.builder()\n .campaignGuid("campaignGuid")\n .publicBudgetItemInput(PublicBudgetItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Budget.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.New(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignBudgetNewParams{\n\t\t\tPublicBudgetItemInput: marketing.PublicBudgetItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.budget.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.create("campaignGuid", amount: 0, name: "name", order: 0)\n\nputs(public_budget_item)', + }, + php: { + method: 'marketing->campaigns->budget->create', + example: + "marketing->campaigns->budget->create(\n 'campaignGuid', amount: 0, name: 'name', order: 0, description: 'description'\n);\n\nvar_dump($publicBudgetItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + httpMethod: 'delete', + summary: 'Delete budget item', + description: 'Delete a specific budget item by ID', + stainlessPath: '(resource) marketing.campaigns.budget > (method) delete', + qualified: 'client.marketing.campaigns.budget.delete', + params: ['campaignGuid: string;', 'budgetId: number;'], + markdown: + "## delete\n\n`client.marketing.campaigns.budget.delete(campaignGuid: string, budgetId: number): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nDelete a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.budget.delete(0, { campaignGuid: 'campaignGuid' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.budget.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.budget.delete(0, { campaignGuid: 'campaignGuid' });", + }, + python: { + method: 'marketing.campaigns.budget.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.budget.delete(\n budget_id=0,\n campaign_guid="campaignGuid",\n)', + }, + java: { + method: 'marketing().campaigns().budget().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetDeleteParams params = BudgetDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .build();\n client.marketing().campaigns().budget().delete(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Budget.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Budget.Delete(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.budget.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.budget.delete(0, campaign_guid: "campaignGuid")\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->budget->delete', + example: + "marketing->campaigns->budget->delete(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + httpMethod: 'get', + summary: 'Get budget item', + description: 'Get a specific budget item by ID', + stainlessPath: '(resource) marketing.campaigns.budget > (method) get', + qualified: 'client.marketing.campaigns.budget.get', + params: ['campaignGuid: string;', 'budgetId: number;'], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## get\n\n`client.marketing.campaigns.budget.get(campaignGuid: string, budgetId: number): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nGet a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.get(0, { campaignGuid: 'campaignGuid' });\n\nconsole.log(publicBudgetItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.budget.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.get(0, {\n campaignGuid: 'campaignGuid',\n});\n\nconsole.log(publicBudgetItem.id);", + }, + python: { + method: 'marketing.campaigns.budget.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.get(\n budget_id=0,\n campaign_guid="campaignGuid",\n)\nprint(public_budget_item.id)', + }, + java: { + method: 'marketing().campaigns().budget().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetGetParams params = BudgetGetParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().get(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Budget.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetGetParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.budget.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.get(0, campaign_guid: "campaignGuid")\n\nputs(public_budget_item)', + }, + php: { + method: 'marketing->campaigns->budget->get', + example: + "marketing->campaigns->budget->get(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($publicBudgetItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_totals', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/totals', + httpMethod: 'get', + summary: 'Read budget', + description: + 'Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.\nBudget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer', + stainlessPath: '(resource) marketing.campaigns.budget > (method) get_totals', + qualified: 'client.marketing.campaigns.budget.getTotals', + params: ['campaignGuid: string;'], + response: + '{ budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; currencyCode: string; spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }', + markdown: + "## get_totals\n\n`client.marketing.campaigns.budget.getTotals(campaignGuid: string): { budgetItems: public_budget_item[]; currencyCode: string; spendItems: public_spend_item[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/budget/totals`\n\nRetrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.\nBudget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer\n\n### Parameters\n\n- `campaignGuid: string`\n\n### Returns\n\n- `{ budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; currencyCode: string; spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }`\n\n - `budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]`\n - `currencyCode: string`\n - `spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]`\n - `budgetTotal?: number`\n - `remainingBudget?: number`\n - `spendTotal?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetTotals = await client.marketing.campaigns.budget.getTotals('campaignGuid');\n\nconsole.log(publicBudgetTotals);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.budget.getTotals', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetTotals = await client.marketing.campaigns.budget.getTotals('campaignGuid');\n\nconsole.log(publicBudgetTotals.budgetItems);", + }, + python: { + method: 'marketing.campaigns.budget.get_totals', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_totals = client.marketing.campaigns.budget.get_totals(\n "campaignGuid",\n)\nprint(public_budget_totals.budget_items)', + }, + java: { + method: 'marketing().campaigns().budget().getTotals', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetTotals;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetGetTotalsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicBudgetTotals publicBudgetTotals = client.marketing().campaigns().budget().getTotals("campaignGuid");\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Budget.GetTotals', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetTotals, err := client.Marketing.Campaigns.Budget.GetTotals(context.TODO(), "campaignGuid")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetTotals.BudgetItems)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.budget.get_totals', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_totals = hubspot.marketing.campaigns.budget.get_totals("campaignGuid")\n\nputs(public_budget_totals)', + }, + php: { + method: 'marketing->campaigns->budget->getTotals', + example: + "marketing->campaigns->budget->getTotals(\n 'campaignGuid'\n);\n\nvar_dump($publicBudgetTotals);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/totals \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + httpMethod: 'put', + summary: 'Update budget item', + description: 'Update a specific budget item by ID', + stainlessPath: '(resource) marketing.campaigns.budget > (method) update', + qualified: 'client.marketing.campaigns.budget.update', + params: [ + 'campaignGuid: string;', + 'budgetId: number;', + 'amount: number;', + 'name: string;', + 'order: number;', + 'description?: string;', + ], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## update\n\n`client.marketing.campaigns.budget.update(campaignGuid: string, budgetId: number, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nUpdate a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n- `amount: number`\n The monetary value assigned to the budget item.\n\n- `name: string`\n The name of the budget item.\n\n- `order: number`\n The sequence number indicating the order of the budget item.\n\n- `description?: string`\n A detailed explanation or notes about the budget item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.budget.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem.id);", + }, + python: { + method: 'marketing.campaigns.budget.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.update(\n budget_id=0,\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_budget_item.id)', + }, + java: { + method: 'marketing().campaigns().budget().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetUpdateParams params = BudgetUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .publicBudgetItemInput(PublicBudgetItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Budget.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tPublicBudgetItemInput: marketing.PublicBudgetItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.budget.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.update(\n 0,\n campaign_guid: "campaignGuid",\n amount: 0,\n name: "name",\n order: 0\n)\n\nputs(public_budget_item)', + }, + php: { + method: 'marketing->campaigns->budget->update', + example: + "marketing->campaigns->budget->update(\n 0,\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n description: 'description',\n);\n\nvar_dump($publicBudgetItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', + }, + }, + }, + { + name: 'get_attribution_metrics', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics', + httpMethod: 'get', + summary: 'Get Campaign Metrics\n', + description: + 'This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.', + stainlessPath: '(resource) marketing.campaigns.metrics > (method) get_attribution_metrics', + qualified: 'client.marketing.campaigns.metrics.getAttributionMetrics', + params: ['campaignGuid: string;', 'endDate?: string;', 'startDate?: string;'], + response: + '{ influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }', + markdown: + "## get_attribution_metrics\n\n`client.marketing.campaigns.metrics.getAttributionMetrics(campaignGuid: string, endDate?: string, startDate?: string): { influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics`\n\nThis endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `endDate?: string`\n The end date for fetching attribution data, in YYYY-MM-DD format.\nOptional. Example: 2000-01-27 \n\n- `startDate?: string`\n The start date for fetching attribution data, in YYYY-MM-DD format.\nOptional. Example: 2000-01-20\n\n### Returns\n\n- `{ influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }`\n\n - `influencedContacts: number`\n - `newContactsFirstTouch: number`\n - `newContactsLastTouch: number`\n - `sessions: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst metricsCounters = await client.marketing.campaigns.metrics.getAttributionMetrics('campaignGuid');\n\nconsole.log(metricsCounters);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.metrics.getAttributionMetrics', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst metricsCounters = await client.marketing.campaigns.metrics.getAttributionMetrics(\n 'campaignGuid',\n);\n\nconsole.log(metricsCounters.influencedContacts);", + }, + python: { + method: 'marketing.campaigns.metrics.get_attribution_metrics', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmetrics_counters = client.marketing.campaigns.metrics.get_attribution_metrics(\n campaign_guid="campaignGuid",\n)\nprint(metrics_counters.influenced_contacts)', + }, + java: { + method: 'marketing().campaigns().metrics().getAttributionMetrics', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.MetricsCounters;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricGetAttributionMetricsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MetricsCounters metricsCounters = client.marketing().campaigns().metrics().getAttributionMetrics("campaignGuid");\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Metrics.GetAttributionMetrics', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmetricsCounters, err := client.Marketing.Campaigns.Metrics.GetAttributionMetrics(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignMetricGetAttributionMetricsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", metricsCounters.InfluencedContacts)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.metrics.get_attribution_metrics', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmetrics_counters = hubspot.marketing.campaigns.metrics.get_attribution_metrics("campaignGuid")\n\nputs(metrics_counters)', + }, + php: { + method: 'marketing->campaigns->metrics->getAttributionMetrics', + example: + "marketing\n ->campaigns\n ->metrics\n ->getAttributionMetrics(\n 'campaignGuid', endDate: 'endDate', startDate: 'startDate'\n);\n\nvar_dump($metricsCounters);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/metrics \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_revenue_attribution', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue', + httpMethod: 'get', + summary: 'Fetch revenue', + description: 'Fetch revenue attribution report data for a specified campaign\n', + stainlessPath: '(resource) marketing.campaigns.metrics > (method) get_revenue_attribution', + qualified: 'client.marketing.campaigns.metrics.getRevenueAttribution', + params: [ + 'campaignGuid: string;', + 'attributionModel?: string;', + 'endDate?: string;', + 'startDate?: string;', + ], + response: + '{ contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }', + markdown: + "## get_revenue_attribution\n\n`client.marketing.campaigns.metrics.getRevenueAttribution(campaignGuid: string, attributionModel?: string, endDate?: string, startDate?: string): { contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue`\n\nFetch revenue attribution report data for a specified campaign\n\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `attributionModel?: string`\n The revenue attribution model used to calculate deal revenue credit. Defaults to LINEAR if not specified. Enum values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED\n\n- `endDate?: string`\n End date to fetch attribution data, YYYY-MM-DD\n\n- `startDate?: string`\n Start date to fetch attribution data, YYYY-MM-DD\n\n### Returns\n\n- `{ contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }`\n\n - `contactsNumber?: number`\n - `currencyCode?: string`\n - `dealAmount?: number`\n - `dealsNumber?: number`\n - `revenueAmount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst revenueAttributionAggregate = await client.marketing.campaigns.metrics.getRevenueAttribution('campaignGuid');\n\nconsole.log(revenueAttributionAggregate);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.metrics.getRevenueAttribution', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst revenueAttributionAggregate = await client.marketing.campaigns.metrics.getRevenueAttribution(\n 'campaignGuid',\n);\n\nconsole.log(revenueAttributionAggregate.contactsNumber);", + }, + python: { + method: 'marketing.campaigns.metrics.get_revenue_attribution', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrevenue_attribution_aggregate = client.marketing.campaigns.metrics.get_revenue_attribution(\n campaign_guid="campaignGuid",\n)\nprint(revenue_attribution_aggregate.contacts_number)', + }, + java: { + method: 'marketing().campaigns().metrics().getRevenueAttribution', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.RevenueAttributionAggregate;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricGetRevenueAttributionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevenueAttributionAggregate revenueAttributionAggregate = client.marketing().campaigns().metrics().getRevenueAttribution("campaignGuid");\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Metrics.GetRevenueAttribution', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trevenueAttributionAggregate, err := client.Marketing.Campaigns.Metrics.GetRevenueAttribution(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignMetricGetRevenueAttributionParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", revenueAttributionAggregate.ContactsNumber)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.metrics.get_revenue_attribution', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrevenue_attribution_aggregate = hubspot.marketing.campaigns.metrics.get_revenue_attribution("campaignGuid")\n\nputs(revenue_attribution_aggregate)', + }, + php: { + method: 'marketing->campaigns->metrics->getRevenueAttribution', + example: + "marketing\n ->campaigns\n ->metrics\n ->getRevenueAttribution(\n 'campaignGuid',\n attributionModel: 'attributionModel',\n endDate: 'endDate',\n startDate: 'startDate',\n);\n\nvar_dump($revenueAttributionAggregate);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/revenue \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_contact_ids_by_type', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}', + httpMethod: 'get', + summary: 'Fetch contact IDs', + description: 'Fetch the list of contact IDs for the specified campaign and contact type', + stainlessPath: '(resource) marketing.campaigns.metrics > (method) list_contact_ids_by_type', + qualified: 'client.marketing.campaigns.metrics.listContactIDsByType', + params: [ + 'campaignGuid: string;', + 'contactType: string;', + 'after?: string;', + 'endDate?: string;', + 'limit?: number;', + 'startDate?: string;', + ], + response: '{ id: string; }', + markdown: + "## list_contact_ids_by_type\n\n`client.marketing.campaigns.metrics.listContactIDsByType(campaignGuid: string, contactType: string, after?: string, endDate?: string, limit?: number, startDate?: string): { id: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}`\n\nFetch the list of contact IDs for the specified campaign and contact type\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `contactType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `endDate?: string`\n The end date for fetching contact data, in YYYY-MM-DD format. \nOptional. Example: 2000-01-27 \n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `startDate?: string`\n The start date for fetching contact data, in YYYY-MM-DD format. \nOptional. Example: 2000-01-20\n\n### Returns\n\n- `{ id: string; }`\n\n - `id: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contactReference of client.marketing.campaigns.metrics.listContactIDsByType('contactType', { campaignGuid: 'campaignGuid' })) {\n console.log(contactReference);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.metrics.listContactIDsByType', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contactReference of client.marketing.campaigns.metrics.listContactIDsByType(\n 'contactType',\n { campaignGuid: 'campaignGuid' },\n)) {\n console.log(contactReference.id);\n}", + }, + python: { + method: 'marketing.campaigns.metrics.list_contact_ids_by_type', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.campaigns.metrics.list_contact_ids_by_type(\n contact_type="contactType",\n campaign_guid="campaignGuid",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().campaigns().metrics().listContactIdsByType', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricListContactIdsByTypePage;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricListContactIdsByTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MetricListContactIdsByTypeParams params = MetricListContactIdsByTypeParams.builder()\n .campaignGuid("campaignGuid")\n .contactType("contactType")\n .build();\n MetricListContactIdsByTypePage page = client.marketing().campaigns().metrics().listContactIdsByType(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Metrics.ListContactIDsByType', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Campaigns.Metrics.ListContactIDsByType(\n\t\tcontext.TODO(),\n\t\t"contactType",\n\t\tmarketing.CampaignMetricListContactIDsByTypeParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.metrics.list_contact_ids_by_type', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.campaigns.metrics.list_contact_ids_by_type("contactType", campaign_guid: "campaignGuid")\n\nputs(page)', + }, + php: { + method: 'marketing->campaigns->metrics->listContactIDsByType', + example: + "marketing->campaigns->metrics->listContactIDsByType(\n 'contactType',\n campaignGuid: 'campaignGuid',\n after: 'after',\n endDate: 'endDate',\n limit: 0,\n startDate: 'startDate',\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/contacts/$CONTACT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend', + httpMethod: 'post', + summary: 'Create campaign spend item', + description: 'Create a new campaign spend item', + stainlessPath: '(resource) marketing.campaigns.spend > (method) create', + qualified: 'client.marketing.campaigns.spend.create', + params: [ + 'campaignGuid: string;', + 'amount: number;', + 'name: string;', + 'order: number;', + 'description?: string;', + ], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## create\n\n`client.marketing.campaigns.spend.create(campaignGuid: string, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**post** `/marketing/campaigns/2026-03/{campaignGuid}/spend`\n\nCreate a new campaign spend item\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `amount: number`\n The monetary value of the spend item.\n\n- `name: string`\n The name of the spend item.\n\n- `order: number`\n The sequence number indicating the order of the spend item.\n\n- `description?: string`\n A brief description of the spend item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.spend.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem.id);", + }, + python: { + method: 'marketing.campaigns.spend.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.create(\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_spend_item.id)', + }, + java: { + method: 'marketing().campaigns().spend().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendCreateParams params = SpendCreateParams.builder()\n .campaignGuid("campaignGuid")\n .publicSpendItemInput(PublicSpendItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Spend.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.New(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignSpendNewParams{\n\t\t\tPublicSpendItemInput: marketing.PublicSpendItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.spend.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.create("campaignGuid", amount: 0, name: "name", order: 0)\n\nputs(public_spend_item)', + }, + php: { + method: 'marketing->campaigns->spend->create', + example: + "marketing->campaigns->spend->create(\n 'campaignGuid', amount: 0, name: 'name', order: 0, description: 'description'\n);\n\nvar_dump($publicSpendItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + httpMethod: 'delete', + summary: 'Delete campaign spend item', + description: 'Delete a specific campaign spend item by ID', + stainlessPath: '(resource) marketing.campaigns.spend > (method) delete', + qualified: 'client.marketing.campaigns.spend.delete', + params: ['campaignGuid: string;', 'spendId: number;'], + markdown: + "## delete\n\n`client.marketing.campaigns.spend.delete(campaignGuid: string, spendId: number): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nDelete a specific campaign spend item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.spend.delete(0, { campaignGuid: 'campaignGuid' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.spend.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.spend.delete(0, { campaignGuid: 'campaignGuid' });", + }, + python: { + method: 'marketing.campaigns.spend.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.spend.delete(\n spend_id=0,\n campaign_guid="campaignGuid",\n)', + }, + java: { + method: 'marketing().campaigns().spend().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendDeleteParams params = SpendDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .build();\n client.marketing().campaigns().spend().delete(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Spend.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Spend.Delete(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.campaigns.spend.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.spend.delete(0, campaign_guid: "campaignGuid")\n\nputs(result)', + }, + php: { + method: 'marketing->campaigns->spend->delete', + example: + "marketing->campaigns->spend->delete(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + httpMethod: 'get', + summary: 'Read campaign spend item', + description: 'Read a campaign spend item by its spendId', + stainlessPath: '(resource) marketing.campaigns.spend > (method) get', + qualified: 'client.marketing.campaigns.spend.get', + params: ['campaignGuid: string;', 'spendId: number;'], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## get\n\n`client.marketing.campaigns.spend.get(campaignGuid: string, spendId: number): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nRead a campaign spend item by its spendId\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.get(0, { campaignGuid: 'campaignGuid' });\n\nconsole.log(publicSpendItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.spend.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.get(0, {\n campaignGuid: 'campaignGuid',\n});\n\nconsole.log(publicSpendItem.id);", + }, + python: { + method: 'marketing.campaigns.spend.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.get(\n spend_id=0,\n campaign_guid="campaignGuid",\n)\nprint(public_spend_item.id)', + }, + java: { + method: 'marketing().campaigns().spend().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendGetParams params = SpendGetParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().get(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Spend.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendGetParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.spend.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.get(0, campaign_guid: "campaignGuid")\n\nputs(public_spend_item)', + }, + php: { + method: 'marketing->campaigns->spend->get', + example: + "marketing->campaigns->spend->get(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($publicSpendItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + httpMethod: 'put', + summary: 'Update campaign spend item', + description: 'Update a specific campaign spend item by ID', + stainlessPath: '(resource) marketing.campaigns.spend > (method) update', + qualified: 'client.marketing.campaigns.spend.update', + params: [ + 'campaignGuid: string;', + 'spendId: number;', + 'amount: number;', + 'name: string;', + 'order: number;', + 'description?: string;', + ], + response: + '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', + markdown: + "## update\n\n`client.marketing.campaigns.spend.update(campaignGuid: string, spendId: number, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nUpdate a specific campaign spend item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n- `amount: number`\n The monetary value of the spend item.\n\n- `name: string`\n The name of the spend item.\n\n- `order: number`\n The sequence number indicating the order of the spend item.\n\n- `description?: string`\n A brief description of the spend item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.campaigns.spend.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem.id);", + }, + python: { + method: 'marketing.campaigns.spend.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.update(\n spend_id=0,\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_spend_item.id)', + }, + java: { + method: 'marketing().campaigns().spend().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendUpdateParams params = SpendUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .publicSpendItemInput(PublicSpendItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Campaigns.Spend.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tPublicSpendItemInput: marketing.PublicSpendItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', + }, + ruby: { + method: 'marketing.campaigns.spend.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.update(\n 0,\n campaign_guid: "campaignGuid",\n amount: 0,\n name: "name",\n order: 0\n)\n\nputs(public_spend_item)', + }, + php: { + method: 'marketing->campaigns->spend->update', + example: + "marketing->campaigns->spend->update(\n 0,\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n description: 'description',\n);\n\nvar_dump($publicSpendItem);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', + }, + }, + }, + { + name: 'clone', + endpoint: '/marketing/emails/2026-03/clone', + httpMethod: 'post', + summary: 'Clone a marketing email', + description: + 'This will create a duplicate email with the same properties as the original, with the exception of a unique ID.', + stainlessPath: '(resource) marketing.emails > (method) clone', + qualified: 'client.marketing.emails.clone', + params: ['id: string;', 'cloneName?: string;', 'language?: string;'], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## clone\n\n`client.marketing.emails.clone(id: string, cloneName?: string, language?: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/clone`\n\nThis will create a duplicate email with the same properties as the original, with the exception of a unique ID.\n\n### Parameters\n\n- `id: string`\n The email ID.\n\n- `cloneName?: string`\n The name to assign to the cloned email.\n\n- `language?: string`\n The language code for the cloned email, such as 'en' for English.\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.clone({ id: 'id' });\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.clone', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.clone({ id: 'id' });\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.clone', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.clone(\n id="id",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().clone', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailCloneRequestVNext;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailCloneRequestVNext params = EmailCloneRequestVNext.builder()\n .id("id")\n .build();\n PublicEmail publicEmail = client.marketing().emails().clone(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Clone', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.Clone(context.TODO(), marketing.EmailCloneParams{\n\t\tEmailCloneRequestVNext: marketing.EmailCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.clone_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.clone_(id: "id")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->clone', + example: + "marketing->emails->clone(\n id: 'id', cloneName: 'cloneName', language: 'language'\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/emails/2026-03', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) marketing.emails > (method) create', + qualified: 'client.marketing.emails.create', + params: [ + 'activeDomain?: string;', + 'archived?: boolean;', + 'businessUnitId?: number;', + 'campaign?: string;', + "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", + 'feedbackSurveyId?: string;', + 'folderIdV2?: number;', + 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', + 'jitterSendTime?: boolean;', + 'language?: string;', + 'name?: string;', + 'publishDate?: string;', + "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", + 'sendOnPublish?: boolean;', + 'state?: string;', + 'subcategory?: string;', + 'subject?: string;', + 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', + "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", + 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', + 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', + ], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## create\n\n`client.marketing.emails.create(activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, feedbackSurveyId?: string, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03`\n\n### Parameters\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `feedbackSurveyId?: string`\n The ID of the feedback survey linked to the email.\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.create();\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.create();\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.create()\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailCreateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailCreateRequest params = EmailCreateRequest.builder().build();\n PublicEmail publicEmail = client.marketing().emails().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.New(context.TODO(), marketing.EmailNewParams{\n\t\tEmailCreateRequest: marketing.EmailCreateRequestParam{},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.create\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->create', + example: + "marketing->emails->create(\n activeDomain: 'activeDomain',\n archived: true,\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n feedbackSurveyID: 'feedbackSurveyId',\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + "curl https://api.hubapi.com/marketing/emails/2026-03 \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create_ab_test_variation', + endpoint: '/marketing/emails/2026-03/ab-test/create-variation', + httpMethod: 'post', + summary: 'Create an A/B test variation of a marketing email', + description: + "Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.", + stainlessPath: '(resource) marketing.emails > (method) create_ab_test_variation', + qualified: 'client.marketing.emails.createAbTestVariation', + params: ['contentId: string;', 'variationName: string;'], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## create_ab_test_variation\n\n`client.marketing.emails.createAbTestVariation(contentId: string, variationName: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/ab-test/create-variation`\n\nCreate a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.createAbTestVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.createAbTestVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.createAbTestVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.create_ab_test_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.create_ab_test_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().createAbTestVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PublicEmail publicEmail = client.marketing().emails().createAbTestVariation(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.NewAbTestVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.NewAbTestVariation(context.TODO(), marketing.EmailNewAbTestVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.create_ab_test_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.create_ab_test_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->createAbTestVariation', + example: + "marketing->emails->createAbTestVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/ab-test/create-variation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/emails/2026-03/{emailId}', + httpMethod: 'delete', + summary: 'Delete a marketing email', + description: 'Delete a marketing email by its ID', + stainlessPath: '(resource) marketing.emails > (method) delete', + qualified: 'client.marketing.emails.delete', + params: ['emailId: string;', 'archived?: boolean;'], + markdown: + "## delete\n\n`client.marketing.emails.delete(emailId: string, archived?: boolean): void`\n\n**delete** `/marketing/emails/2026-03/{emailId}`\n\nDelete a marketing email by its ID\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.delete('emailId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.delete('emailId');", + }, + python: { + method: 'marketing.emails.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.delete(\n email_id="emailId",\n)', + }, + java: { + method: 'marketing().emails().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().delete("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Delete(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.emails.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.delete("emailId")\n\nputs(result)', + }, + php: { + method: 'marketing->emails->delete', + example: + "marketing->emails->delete('emailId', archived: true);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/emails/2026-03/statistics/list', + httpMethod: 'get', + summary: 'Get aggregated statistics', + description: + 'Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.', + stainlessPath: '(resource) marketing.emails > (method) get', + qualified: 'client.marketing.emails.get', + params: [ + 'emailIds?: number[];', + 'endTimestamp?: string;', + 'property?: string;', + 'startTimestamp?: string;', + ], + response: + '{ aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; campaignAggregations: object; emails: number[]; }', + markdown: + "## get\n\n`client.marketing.emails.get(emailIds?: number[], endTimestamp?: string, property?: string, startTimestamp?: string): { aggregate: email_statistics_data; campaignAggregations: object; emails: number[]; }`\n\n**get** `/marketing/emails/2026-03/statistics/list`\n\nUse this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.\n\n### Parameters\n\n- `emailIds?: number[]`\n\n- `endTimestamp?: string`\n\n- `property?: string`\n\n- `startTimestamp?: string`\n\n### Returns\n\n- `{ aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; campaignAggregations: object; emails: number[]; }`\n\n - `aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `campaignAggregations: object`\n - `emails: number[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst aggregateEmailStatistics = await client.marketing.emails.get();\n\nconsole.log(aggregateEmailStatistics);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst aggregateEmailStatistics = await client.marketing.emails.get();\n\nconsole.log(aggregateEmailStatistics.aggregate);", + }, + python: { + method: 'marketing.emails.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naggregate_email_statistics = client.marketing.emails.get()\nprint(aggregate_email_statistics.aggregate)', + }, + java: { + method: 'marketing().emails().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.AggregateEmailStatistics;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AggregateEmailStatistics aggregateEmailStatistics = client.marketing().emails().get();\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taggregateEmailStatistics, err := client.Marketing.Emails.Get(context.TODO(), marketing.EmailGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", aggregateEmailStatistics.Aggregate)\n}\n', + }, + ruby: { + method: 'marketing.emails.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naggregate_email_statistics = hubspot.marketing.emails.get\n\nputs(aggregate_email_statistics)', + }, + php: { + method: 'marketing->emails->get', + example: + "marketing->emails->get(\n emailIDs: [0],\n endTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n property: 'property',\n startTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($aggregateEmailStatistics);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/statistics/list \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_ab_test_variation', + endpoint: '/marketing/emails/2026-03/{emailId}/ab-test/get-variation', + httpMethod: 'get', + summary: 'Get the variation of a an A/B marketing email', + description: + 'This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa.', + stainlessPath: '(resource) marketing.emails > (method) get_ab_test_variation', + qualified: 'client.marketing.emails.getAbTestVariation', + params: [ + 'emailId: string;', + 'archived?: boolean;', + 'includedProperties?: string[];', + 'includeStats?: boolean;', + 'marketingCampaignNames?: boolean;', + 'variantStats?: boolean;', + 'workflowNames?: boolean;', + ], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## get_ab_test_variation\n\n`client.marketing.emails.getAbTestVariation(emailId: string, archived?: boolean, includedProperties?: string[], includeStats?: boolean, marketingCampaignNames?: boolean, variantStats?: boolean, workflowNames?: boolean): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/ab-test/get-variation`\n\nThis endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includedProperties?: string[]`\n\n- `includeStats?: boolean`\n\n- `marketingCampaignNames?: boolean`\n\n- `variantStats?: boolean`\n\n- `workflowNames?: boolean`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.getAbTestVariation('emailId');\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.getAbTestVariation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.getAbTestVariation('emailId');\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.get_ab_test_variation', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.get_ab_test_variation(\n email_id="emailId",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().getAbTestVariation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetAbTestVariationParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicEmail publicEmail = client.marketing().emails().getAbTestVariation("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.GetAbTestVariation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.GetAbTestVariation(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailGetAbTestVariationParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.get_ab_test_variation', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.get_ab_test_variation("emailId")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->getAbTestVariation', + example: + "marketing->emails->getAbTestVariation(\n 'emailId',\n archived: true,\n includedProperties: ['string'],\n includeStats: true,\n marketingCampaignNames: true,\n variantStats: true,\n workflowNames: true,\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/ab-test/get-variation \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_draft', + endpoint: '/marketing/emails/2026-03/{emailId}/draft', + httpMethod: 'get', + summary: 'Get draft version of a marketing email', + description: + 'Get the draft version of an email (if it exists). If no draft version exists, the published email is returned.', + stainlessPath: '(resource) marketing.emails > (method) get_draft', + qualified: 'client.marketing.emails.getDraft', + params: ['emailId: string;'], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## get_draft\n\n`client.marketing.emails.getDraft(emailId: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/draft`\n\nGet the draft version of an email (if it exists). If no draft version exists, the published email is returned.\n\n### Parameters\n\n- `emailId: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.getDraft('emailId');\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.getDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.getDraft('emailId');\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.get_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.get_draft(\n "emailId",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().getDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicEmail publicEmail = client.marketing().emails().getDraft("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.GetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.GetDraft(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.get_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.get_draft("emailId")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->getDraft', + example: + "marketing->emails->getDraft('emailId');\n\nvar_dump($publicEmail);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_histogram', + endpoint: '/marketing/emails/2026-03/statistics/histogram', + httpMethod: 'get', + summary: 'Get aggregated statistic intervals', + description: + 'Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.', + stainlessPath: '(resource) marketing.emails > (method) get_histogram', + qualified: 'client.marketing.emails.getHistogram', + params: [ + 'emailIds?: number[];', + 'endTimestamp?: string;', + "interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR';", + 'startTimestamp?: string;', + ], + response: + '{ results: { aggregations: email_statistics_data; interval: interval; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## get_histogram\n\n`client.marketing.emails.getHistogram(emailIds?: number[], endTimestamp?: string, interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR', startTimestamp?: string): { results: email_statistic_interval[]; total: number; paging?: paging; }`\n\n**get** `/marketing/emails/2026-03/statistics/histogram`\n\nGet aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.\n\n### Parameters\n\n- `emailIds?: number[]`\n\n- `endTimestamp?: string`\n\n- `interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR'`\n\n- `startTimestamp?: string`\n\n### Returns\n\n- `{ results: { aggregations: email_statistics_data; interval: interval; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { aggregations: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; interval: { end: string; start: string; }; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalEmailStatisticInterval = await client.marketing.emails.getHistogram();\n\nconsole.log(collectionResponseWithTotalEmailStatisticInterval);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.getHistogram', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalEmailStatisticInterval =\n await client.marketing.emails.getHistogram();\n\nconsole.log(collectionResponseWithTotalEmailStatisticInterval.results);", + }, + python: { + method: 'marketing.emails.get_histogram', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_email_statistic_interval = client.marketing.emails.get_histogram()\nprint(collection_response_with_total_email_statistic_interval.results)', + }, + java: { + method: 'marketing().emails().getHistogram', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.CollectionResponseWithTotalEmailStatisticInterval;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetHistogramParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalEmailStatisticInterval collectionResponseWithTotalEmailStatisticInterval = client.marketing().emails().getHistogram();\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.GetHistogram', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalEmailStatisticInterval, err := client.Marketing.Emails.GetHistogram(context.TODO(), marketing.EmailGetHistogramParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalEmailStatisticInterval.Results)\n}\n', + }, + ruby: { + method: 'marketing.emails.get_histogram', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_email_statistic_interval = hubspot.marketing.emails.get_histogram\n\nputs(collection_response_with_total_email_statistic_interval)', + }, + php: { + method: 'marketing->emails->getHistogram', + example: + "marketing\n ->emails\n ->getHistogram(\n emailIDs: [0],\n endTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n interval: 'DAY',\n startTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($collectionResponseWithTotalEmailStatisticInterval);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/statistics/histogram \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_revision', + endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}', + httpMethod: 'get', + summary: 'Get a revision of a marketing email', + description: 'Get a specific revision of a marketing email.', + stainlessPath: '(resource) marketing.emails > (method) get_revision', + qualified: 'client.marketing.emails.getRevision', + params: ['emailId: string;', 'revisionId: string;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## get_revision\n\n`client.marketing.emails.getRevision(emailId: string, revisionId: string): { id: string; object: public_email; updatedAt: string; user: version_user; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}`\n\nGet a specific revision of a marketing email.\n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmailVersion = await client.marketing.emails.getRevision('revisionId', { emailId: 'emailId' });\n\nconsole.log(publicEmailVersion);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.getRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmailVersion = await client.marketing.emails.getRevision('revisionId', {\n emailId: 'emailId',\n});\n\nconsole.log(publicEmailVersion.id);", + }, + python: { + method: 'marketing.emails.get_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email_version = client.marketing.emails.get_revision(\n revision_id="revisionId",\n email_id="emailId",\n)\nprint(public_email_version.id)', + }, + java: { + method: 'marketing().emails().getRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetRevisionParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmailVersion;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailGetRevisionParams params = EmailGetRevisionParams.builder()\n .emailId("emailId")\n .revisionId("revisionId")\n .build();\n PublicEmailVersion publicEmailVersion = client.marketing().emails().getRevision(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.GetRevision', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmailVersion, err := client.Marketing.Emails.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tmarketing.EmailGetRevisionParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmailVersion.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.get_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email_version = hubspot.marketing.emails.get_revision("revisionId", email_id: "emailId")\n\nputs(public_email_version)', + }, + php: { + method: 'marketing->emails->getRevision', + example: + "marketing->emails->getRevision(\n 'revisionId', emailID: 'emailId'\n);\n\nvar_dump($publicEmailVersion);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/emails/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) marketing.emails > (method) list', + qualified: 'client.marketing.emails.list', + params: [ + 'after?: string;', + 'archived?: boolean;', + 'campaign?: string;', + 'createdAfter?: string;', + 'createdAt?: string;', + 'createdBefore?: string;', + 'includedProperties?: string[];', + 'includeStats?: boolean;', + 'isPublished?: boolean;', + 'limit?: number;', + 'marketingCampaignNames?: boolean;', + 'publishedAfter?: string;', + 'publishedAt?: string;', + 'publishedBefore?: string;', + 'sort?: string[];', + 'type?: string;', + 'updatedAfter?: string;', + 'updatedAt?: string;', + 'updatedBefore?: string;', + 'variantStats?: boolean;', + 'workflowNames?: boolean;', + ], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## list\n\n`client.marketing.emails.list(after?: string, archived?: boolean, campaign?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, includedProperties?: string[], includeStats?: boolean, isPublished?: boolean, limit?: number, marketingCampaignNames?: boolean, publishedAfter?: string, publishedAt?: string, publishedBefore?: string, sort?: string[], type?: string, updatedAfter?: string, updatedAt?: string, updatedBefore?: string, variantStats?: boolean, workflowNames?: boolean): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `campaign?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `includedProperties?: string[]`\n\n- `includeStats?: boolean`\n\n- `isPublished?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `marketingCampaignNames?: boolean`\n\n- `publishedAfter?: string`\n\n- `publishedAt?: string`\n\n- `publishedBefore?: string`\n\n- `sort?: string[]`\n\n- `type?: string`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n- `variantStats?: boolean`\n\n- `workflowNames?: boolean`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicEmail of client.marketing.emails.list()) {\n console.log(publicEmail);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicEmail of client.marketing.emails.list()) {\n console.log(publicEmail.id);\n}", + }, + python: { + method: 'marketing.emails.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.emails.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().emails().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailListPage;\nimport com.hubspot.sdk.models.marketing.emails.EmailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListPage page = client.marketing().emails().list();\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Emails.List(context.TODO(), marketing.EmailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.emails.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.emails.list\n\nputs(page)', + }, + php: { + method: 'marketing->emails->list', + example: + "marketing->emails->list(\n after: 'after',\n archived: true,\n campaign: 'campaign',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n includedProperties: ['string'],\n includeStats: true,\n isPublished: true,\n limit: 0,\n marketingCampaignNames: true,\n publishedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n sort: ['string'],\n type: 'AB_EMAIL',\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n variantStats: true,\n workflowNames: true,\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_revisions', + endpoint: '/marketing/emails/2026-03/{emailId}/revisions', + httpMethod: 'get', + summary: 'Get revisions of a marketing email', + description: + 'Get a list of all versions of a marketing email, with each entry including the full state of that particular version. To view the most recent version, sort by the updatedAt parameter. ', + stainlessPath: '(resource) marketing.emails > (method) list_revisions', + qualified: 'client.marketing.emails.listRevisions', + params: ['emailId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], + response: '{ id: string; object: object; updatedAt: string; user: object; }', + markdown: + "## list_revisions\n\n`client.marketing.emails.listRevisions(emailId: string, after?: string, before?: string, limit?: number): { id: string; object: public_email; updatedAt: string; user: version_user; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/revisions`\n\nGet a list of all versions of a marketing email, with each entry including the full state of that particular version. To view the most recent version, sort by the updatedAt parameter. \n\n### Parameters\n\n- `emailId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const versionPublicEmail of client.marketing.emails.listRevisions('emailId')) {\n console.log(versionPublicEmail);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.listRevisions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const versionPublicEmail of client.marketing.emails.listRevisions('emailId')) {\n console.log(versionPublicEmail.id);\n}", + }, + python: { + method: 'marketing.emails.list_revisions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.emails.list_revisions(\n email_id="emailId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().emails().listRevisions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailListRevisionsPage;\nimport com.hubspot.sdk.models.marketing.emails.EmailListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListRevisionsPage page = client.marketing().emails().listRevisions("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.ListRevisions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Emails.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.emails.list_revisions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.emails.list_revisions("emailId")\n\nputs(page)', + }, + php: { + method: 'marketing->emails->listRevisions', + example: + "marketing->emails->listRevisions(\n 'emailId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'publish', + endpoint: '/marketing/emails/2026-03/{emailId}/publish', + httpMethod: 'post', + summary: 'Publish or send a marketing email', + description: + 'If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.', + stainlessPath: '(resource) marketing.emails > (method) publish', + qualified: 'client.marketing.emails.publish', + params: ['emailId: string;'], + markdown: + "## publish\n\n`client.marketing.emails.publish(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/publish`\n\nIf you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.publish('emailId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.publish', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.publish('emailId');", + }, + python: { + method: 'marketing.emails.publish', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.publish(\n "emailId",\n)', + }, + java: { + method: 'marketing().emails().publish', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailPublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().publish("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Publish', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Publish(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.emails.publish', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.publish("emailId")\n\nputs(result)', + }, + php: { + method: 'marketing->emails->publish', + example: + "marketing->emails->publish('emailId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/publish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset_draft', + endpoint: '/marketing/emails/2026-03/{emailId}/draft/reset', + httpMethod: 'post', + summary: 'Reset the draft version', + description: 'Resets the draft back to a copy of the live object.', + stainlessPath: '(resource) marketing.emails > (method) reset_draft', + qualified: 'client.marketing.emails.resetDraft', + params: ['emailId: string;'], + markdown: + "## reset_draft\n\n`client.marketing.emails.resetDraft(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/draft/reset`\n\nResets the draft back to a copy of the live object.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.resetDraft('emailId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.resetDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.resetDraft('emailId');", + }, + python: { + method: 'marketing.emails.reset_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.reset_draft(\n "emailId",\n)', + }, + java: { + method: 'marketing().emails().resetDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().resetDraft("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.ResetDraft', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.ResetDraft(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.emails.reset_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.reset_draft("emailId")\n\nputs(result)', + }, + php: { + method: 'marketing->emails->resetDraft', + example: + "marketing->emails->resetDraft('emailId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_revision', + endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore', + httpMethod: 'post', + summary: 'Restore a revision of a marketing email', + description: + 'Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.', + stainlessPath: '(resource) marketing.emails > (method) restore_revision', + qualified: 'client.marketing.emails.restoreRevision', + params: ['emailId: string;', 'revisionId: string;'], + markdown: + "## restore_revision\n\n`client.marketing.emails.restoreRevision(emailId: string, revisionId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore`\n\nRestores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.\n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.restoreRevision('revisionId', { emailId: 'emailId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.restoreRevision', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.restoreRevision('revisionId', { emailId: 'emailId' });", + }, + python: { + method: 'marketing.emails.restore_revision', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.restore_revision(\n revision_id="revisionId",\n email_id="emailId",\n)', + }, + java: { + method: 'marketing().emails().restoreRevision', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailRestoreRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailRestoreRevisionParams params = EmailRestoreRevisionParams.builder()\n .emailId("emailId")\n .revisionId("revisionId")\n .build();\n client.marketing().emails().restoreRevision(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.RestoreRevision', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.RestoreRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tmarketing.EmailRestoreRevisionParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.emails.restore_revision', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.restore_revision("revisionId", email_id: "emailId")\n\nputs(result)', + }, + php: { + method: 'marketing->emails->restoreRevision', + example: + "marketing->emails->restoreRevision(\n 'revisionId', emailID: 'emailId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'restore_revision_to_draft', + endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft', + httpMethod: 'post', + summary: 'Restore a revision of a marketing email to DRAFT state', + description: + 'Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. ', + stainlessPath: '(resource) marketing.emails > (method) restore_revision_to_draft', + qualified: 'client.marketing.emails.restoreRevisionToDraft', + params: ['emailId: string;', 'revisionId: number;'], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## restore_revision_to_draft\n\n`client.marketing.emails.restoreRevisionToDraft(emailId: string, revisionId: number): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft`\n\nRestores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. \n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.restoreRevisionToDraft(0, { emailId: 'emailId' });\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.restoreRevisionToDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.restoreRevisionToDraft(0, { emailId: 'emailId' });\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.restore_revision_to_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.restore_revision_to_draft(\n revision_id=0,\n email_id="emailId",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().restoreRevisionToDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailRestoreRevisionToDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailRestoreRevisionToDraftParams params = EmailRestoreRevisionToDraftParams.builder()\n .emailId("emailId")\n .revisionId(0L)\n .build();\n PublicEmail publicEmail = client.marketing().emails().restoreRevisionToDraft(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.RestoreRevisionToDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.RestoreRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.EmailRestoreRevisionToDraftParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.restore_revision_to_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.restore_revision_to_draft(0, email_id: "emailId")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->restoreRevisionToDraft', + example: + "marketing->emails->restoreRevisionToDraft(\n 0, emailID: 'emailId'\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'unpublish', + endpoint: '/marketing/emails/2026-03/{emailId}/unpublish', + httpMethod: 'post', + summary: 'Unpublish or cancel a marketing email', + description: + 'If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.', + stainlessPath: '(resource) marketing.emails > (method) unpublish', + qualified: 'client.marketing.emails.unpublish', + params: ['emailId: string;'], + markdown: + "## unpublish\n\n`client.marketing.emails.unpublish(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/unpublish`\n\nIf you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.unpublish('emailId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.unpublish', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.unpublish('emailId');", + }, + python: { + method: 'marketing.emails.unpublish', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.unpublish(\n "emailId",\n)', + }, + java: { + method: 'marketing().emails().unpublish', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUnpublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().unpublish("emailId");\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Unpublish', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Unpublish(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.emails.unpublish', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.unpublish("emailId")\n\nputs(result)', + }, + php: { + method: 'marketing->emails->unpublish', + example: + "marketing->emails->unpublish('emailId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/unpublish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/emails/2026-03/{emailId}', + httpMethod: 'patch', + summary: 'Update a marketing email', + description: 'Change properties of a marketing email.', + stainlessPath: '(resource) marketing.emails > (method) update', + qualified: 'client.marketing.emails.update', + params: [ + 'emailId: string;', + 'archived?: boolean;', + 'activeDomain?: string;', + 'archived?: boolean;', + 'businessUnitId?: number;', + 'campaign?: string;', + "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", + 'folderIdV2?: number;', + 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', + 'jitterSendTime?: boolean;', + 'language?: string;', + 'name?: string;', + 'publishDate?: string;', + "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", + 'sendOnPublish?: boolean;', + 'state?: string;', + 'subcategory?: string;', + 'subject?: string;', + 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', + "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", + 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', + 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', + ], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## update\n\n`client.marketing.emails.update(emailId: string, archived?: boolean, activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**patch** `/marketing/emails/2026-03/{emailId}`\n\nChange properties of a marketing email.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.update('emailId');\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.update('emailId');\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.update(\n email_id="emailId",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateParams;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateParams params = EmailUpdateParams.builder()\n .emailId("emailId")\n .emailUpdateRequest(EmailUpdateRequest.builder().build())\n .build();\n PublicEmail publicEmail = client.marketing().emails().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.Update(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailUpdateParams{\n\t\t\tEmailUpdateRequest: marketing.EmailUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.update("emailId")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->update', + example: + "marketing->emails->update(\n 'emailId',\n archived: true,\n activeDomain: 'activeDomain',\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + "curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_draft', + endpoint: '/marketing/emails/2026-03/{emailId}/draft', + httpMethod: 'patch', + summary: 'Create or update draft version', + description: + 'Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.', + stainlessPath: '(resource) marketing.emails > (method) update_draft', + qualified: 'client.marketing.emails.updateDraft', + params: [ + 'emailId: string;', + 'activeDomain?: string;', + 'archived?: boolean;', + 'businessUnitId?: number;', + 'campaign?: string;', + "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", + 'folderIdV2?: number;', + 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', + 'jitterSendTime?: boolean;', + 'language?: string;', + 'name?: string;', + 'publishDate?: string;', + "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", + 'sendOnPublish?: boolean;', + 'state?: string;', + 'subcategory?: string;', + 'subject?: string;', + 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', + "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", + 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', + 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', + ], + response: + "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", + markdown: + "## update_draft\n\n`client.marketing.emails.updateDraft(emailId: string, activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**patch** `/marketing/emails/2026-03/{emailId}/draft`\n\nCreate or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.\n\n### Parameters\n\n- `emailId: string`\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.updateDraft('emailId');\n\nconsole.log(publicEmail);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.emails.updateDraft', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.updateDraft('emailId');\n\nconsole.log(publicEmail.id);", + }, + python: { + method: 'marketing.emails.update_draft', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.update_draft(\n email_id="emailId",\n)\nprint(public_email.id)', + }, + java: { + method: 'marketing().emails().updateDraft', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateDraftParams params = EmailUpdateDraftParams.builder()\n .emailId("emailId")\n .emailUpdateRequest(EmailUpdateRequest.builder().build())\n .build();\n PublicEmail publicEmail = client.marketing().emails().updateDraft(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Emails.UpdateDraft', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailUpdateDraftParams{\n\t\t\tEmailUpdateRequest: marketing.EmailUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', + }, + ruby: { + method: 'marketing.emails.update_draft', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.update_draft("emailId")\n\nputs(public_email)', + }, + php: { + method: 'marketing->emails->updateDraft', + example: + "marketing->emails->updateDraft(\n 'emailId',\n activeDomain: 'activeDomain',\n archived: true,\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", + }, + http: { + example: + "curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/marketing-events/2026-03/events', + httpMethod: 'post', + summary: 'Create a marketing event', + description: 'Creates a new marketing event in HubSpot', + stainlessPath: '(resource) marketing.marketing_events > (method) create', + qualified: 'client.marketing.marketingEvents.create', + params: [ + "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", + 'eventName: string;', + 'eventOrganizer: string;', + 'externalAccountId: string;', + 'externalEventId: string;', + 'endDateTime?: string;', + 'eventCancelled?: boolean;', + 'eventCompleted?: boolean;', + 'eventDescription?: string;', + 'eventType?: string;', + 'eventUrl?: string;', + 'startDateTime?: string;', + ], + response: + "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## create\n\n`client.marketing.marketingEvents.create(customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], eventName: string, eventOrganizer: string, externalAccountId: string, externalEventId: string, endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events`\n\nCreates a new marketing event in HubSpot\n\n### Parameters\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `eventName: string`\n The name of the marketing event.\n\n- `eventOrganizer: string`\n The name of the organizer of the marketing event.\n\n- `externalAccountId: string`\n The accountId that is associated with this marketing event in the external event application.\n\n- `externalEventId: string`\n The id of the marketing event in the external event application.\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.create({\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.create({\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventDefaultResponse.customProperties);", + }, + python: { + method: 'marketing.marketing_events.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.create(\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n event_name="eventName",\n event_organizer="eventOrganizer",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)\nprint(marketing_event_default_response.custom_properties)', + }, + java: { + method: 'marketing().marketingEvents().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventCreateRequestParams params = MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.New(context.TODO(), marketing.MarketingEventNewParams{\n\t\tMarketingEventCreateRequestParams: marketing.MarketingEventCreateRequestParams{\n\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\tIsEncrypted: true,\n\t\t\t\tIsLargeValue: true,\n\t\t\t\tName: "name",\n\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\tRequestID: "requestId",\n\t\t\t\tSelectedByUser: true,\n\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\tSourceID: "sourceId",\n\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\tSourceVid: []int64{0},\n\t\t\t\tTimestamp: 0,\n\t\t\t\tUnit: "unit",\n\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\tValue: "value",\n\t\t\t}},\n\t\t\tEventName: "eventName",\n\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.create(\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n event_name: "eventName",\n event_organizer: "eventOrganizer",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(marketing_event_default_response)', + }, + php: { + method: 'marketing->marketingEvents->create', + example: + "marketing->marketingEvents->create(\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/marketing-events/2026-03/{objectId}', + httpMethod: 'delete', + summary: 'Delete Marketing Event by objectId', + description: 'Deletes the existing Marketing Event with the specified objectId, if it exists.', + stainlessPath: '(resource) marketing.marketing_events > (method) delete', + qualified: 'client.marketing.marketingEvents.delete', + params: ['objectId: string;'], + markdown: + "## delete\n\n`client.marketing.marketingEvents.delete(objectId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/{objectId}`\n\nDeletes the existing Marketing Event with the specified objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.delete('objectId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.delete('objectId');", + }, + python: { + method: 'marketing.marketing_events.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.delete(\n "objectId",\n)', + }, + java: { + method: 'marketing().marketingEvents().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().marketingEvents().delete("objectId");\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.Delete(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.delete("objectId")\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->delete', + example: + "marketing->marketingEvents->delete('objectId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_batch', + endpoint: '/marketing/marketing-events/2026-03/batch/archive', + httpMethod: 'post', + summary: 'Delete Multiple Marketing Events by ObjectId', + description: + 'Deletes multiple Marketing Events from the portal based on their objectId, if they exist.\n\nResponses:\n204: Returned if all specified Marketing Events were successfully deleted.\n207: Returned if some objectIds did not correspond to any existing Marketing Events.', + stainlessPath: '(resource) marketing.marketing_events > (method) delete_batch', + qualified: 'client.marketing.marketingEvents.deleteBatch', + params: ['inputs: { objectId: string; }[];'], + response: 'string', + markdown: + "## delete_batch\n\n`client.marketing.marketingEvents.deleteBatch(inputs: { objectId: string; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/batch/archive`\n\nDeletes multiple Marketing Events from the portal based on their objectId, if they exist.\n\nResponses:\n204: Returned if all specified Marketing Events were successfully deleted.\n207: Returned if some objectIds did not correspond to any existing Marketing Events.\n\n### Parameters\n\n- `inputs: { objectId: string; }[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.deleteBatch({ inputs: [{ objectId: 'objectId' }] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.deleteBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.deleteBatch({\n inputs: [{ objectId: 'objectId' }],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'marketing.marketing_events.delete_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.delete_batch(\n inputs=[{\n "object_id": "objectId"\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'marketing().marketingEvents().deleteBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventPublicObjectIdDeleteRequest;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicObjectIdDeleteRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventPublicObjectIdDeleteRequest params = BatchInputMarketingEventPublicObjectIdDeleteRequest.builder()\n .addInput(MarketingEventPublicObjectIdDeleteRequest.builder()\n .objectId("objectId")\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().deleteBatch(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.DeleteBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.DeleteBatch(context.TODO(), marketing.MarketingEventDeleteBatchParams{\n\t\tBatchInputMarketingEventPublicObjectIDDeleteRequest: marketing.BatchInputMarketingEventPublicObjectIDDeleteRequestParam{\n\t\t\tInputs: []marketing.MarketingEventPublicObjectIDDeleteRequestParam{{\n\t\t\t\tObjectID: "objectId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.delete_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.delete_batch(inputs: [{objectId: "objectId"}])\n\nputs(response)', + }, + php: { + method: 'marketing->marketingEvents->deleteBatch', + example: + "marketing->marketingEvents->deleteBatch(\n inputs: [['objectID' => 'objectId']]\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "objectId": "objectId"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_batch_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/delete', + httpMethod: 'post', + summary: 'Delete Multiple Marketing Events by External Ids', + description: + 'Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId.\n\nOnly Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. ', + stainlessPath: '(resource) marketing.marketing_events > (method) delete_batch_by_external_event_id', + qualified: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', + params: ['inputs: { appId: number; externalAccountId: string; externalEventId: string; }[];'], + response: 'string', + markdown: + "## delete_batch_by_external_event_id\n\n`client.marketing.marketingEvents.deleteBatchByExternalEventID(inputs: { appId: number; externalAccountId: string; externalEventId: string; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/delete`\n\nDeletes multiple Marketing Events based on externalAccountId, externalEventId, and appId.\n\nOnly Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. \n\n### Parameters\n\n- `inputs: { appId: number; externalAccountId: string; externalEventId: string; }[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.deleteBatchByExternalEventID({ inputs: [{\n appId: 0,\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.deleteBatchByExternalEventID({\n inputs: [\n {\n appId: 0,\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n },\n ],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'marketing.marketing_events.delete_batch_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.delete_batch_by_external_event_id(\n inputs=[{\n "app_id": 0,\n "external_account_id": "externalAccountId",\n "external_event_id": "externalEventId",\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'marketing().marketingEvents().deleteBatchByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventExternalUniqueIdentifier;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventExternalUniqueIdentifier;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventExternalUniqueIdentifier params = BatchInputMarketingEventExternalUniqueIdentifier.builder()\n .addInput(MarketingEventExternalUniqueIdentifier.builder()\n .appId(0)\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().deleteBatchByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.DeleteBatchByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.DeleteBatchByExternalEventID(context.TODO(), marketing.MarketingEventDeleteBatchByExternalEventIDParams{\n\t\tBatchInputMarketingEventExternalUniqueIdentifier: marketing.BatchInputMarketingEventExternalUniqueIdentifierParam{\n\t\t\tInputs: []marketing.MarketingEventExternalUniqueIdentifierParam{{\n\t\t\t\tAppID: 0,\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.delete_batch_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.delete_batch_by_external_event_id(\n inputs: [{appId: 0, externalAccountId: "externalAccountId", externalEventId: "externalEventId"}]\n)\n\nputs(response)', + }, + php: { + method: 'marketing->marketingEvents->deleteBatchByExternalEventID', + example: + "marketing->marketingEvents->deleteBatchByExternalEventID(\n inputs: [\n [\n 'appID' => 0,\n 'externalAccountID' => 'externalAccountId',\n 'externalEventID' => 'externalEventId',\n ],\n ],\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "appId": 0,\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'delete_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', + httpMethod: 'delete', + summary: 'Delete Marketing Event by External Ids', + description: + 'Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app can be deleted.', + stainlessPath: '(resource) marketing.marketing_events > (method) delete_by_external_event_id', + qualified: 'client.marketing.marketingEvents.deleteByExternalEventID', + params: ['externalEventId: string;', 'externalAccountId: string;'], + markdown: + "## delete_by_external_event_id\n\n`client.marketing.marketingEvents.deleteByExternalEventID(externalEventId: string, externalAccountId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nDeletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app can be deleted.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.deleteByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.deleteByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.deleteByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n});", + }, + python: { + method: 'marketing.marketing_events.delete_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.delete_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)', + }, + java: { + method: 'marketing().marketingEvents().deleteByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDeleteByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventDeleteByExternalEventIdParams params = MarketingEventDeleteByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n client.marketing().marketingEvents().deleteByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.DeleteByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.DeleteByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventDeleteByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.delete_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.delete_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->deleteByExternalEventID', + example: + "marketing->marketingEvents->deleteByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/marketing-events/2026-03/{objectId}', + httpMethod: 'get', + summary: 'Get Marketing Event by objectId', + description: 'Returns the details of a Marketing Event with the specified objectId, if it exists.', + stainlessPath: '(resource) marketing.marketing_events > (method) get', + qualified: 'client.marketing.marketingEvents.get', + params: ['objectId: string;'], + response: + '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }', + markdown: + "## get\n\n`client.marketing.marketingEvents.get(objectId: string): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03/{objectId}`\n\nReturns the details of a Marketing Event with the specified objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `attendees?: number`\n - `cancellations?: number`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventStatus?: string`\n - `eventStatusV2?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `externalEventId?: string`\n - `noShows?: number`\n - `registrants?: number`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicReadResponseV2 = await client.marketing.marketingEvents.get('objectId');\n\nconsole.log(marketingEventPublicReadResponseV2);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicReadResponseV2 = await client.marketing.marketingEvents.get('objectId');\n\nconsole.log(marketingEventPublicReadResponseV2.createdAt);", + }, + python: { + method: 'marketing.marketing_events.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_read_response_v2 = client.marketing.marketing_events.get(\n "objectId",\n)\nprint(marketing_event_public_read_response_v2.created_at)', + }, + java: { + method: 'marketing().marketingEvents().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventGetParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicReadResponseV2;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventPublicReadResponseV2 marketingEventPublicReadResponseV2 = client.marketing().marketingEvents().get("objectId");\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicReadResponseV2, err := client.Marketing.MarketingEvents.Get(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicReadResponseV2.CreatedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_read_response_v2 = hubspot.marketing.marketing_events.get("objectId")\n\nputs(marketing_event_public_read_response_v2)', + }, + php: { + method: 'marketing->marketingEvents->get', + example: + "marketing->marketingEvents->get(\n 'objectId'\n);\n\nvar_dump($marketingEventPublicReadResponseV2);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', + httpMethod: 'get', + summary: 'Get Marketing Event by External IDs', + description: + 'Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app making the request can be retrieved.', + stainlessPath: '(resource) marketing.marketing_events > (method) get_by_external_event_id', + qualified: 'client.marketing.marketingEvents.getByExternalEventID', + params: ['externalEventId: string;', 'externalAccountId: string;'], + response: + "{ id: string; attendees: number; cancellations: number; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## get_by_external_event_id\n\n`client.marketing.marketingEvents.getByExternalEventID(externalEventId: string, externalAccountId: string): { id: string; attendees: number; cancellations: number; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nReturns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app making the request can be retrieved.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Returns\n\n- `{ id: string; attendees: number; cancellations: number; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `attendees: number`\n - `cancellations: number`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `externalEventId: string`\n - `noShows: number`\n - `registrants: number`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicReadResponse = await client.marketing.marketingEvents.getByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(marketingEventPublicReadResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.getByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicReadResponse =\n await client.marketing.marketingEvents.getByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(marketingEventPublicReadResponse.id);", + }, + python: { + method: 'marketing.marketing_events.get_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_read_response = client.marketing.marketing_events.get_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(marketing_event_public_read_response.id)', + }, + java: { + method: 'marketing().marketingEvents().getByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventGetByExternalEventIdParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicReadResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventGetByExternalEventIdParams params = MarketingEventGetByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n MarketingEventPublicReadResponse marketingEventPublicReadResponse = client.marketing().marketingEvents().getByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.GetByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicReadResponse, err := client.Marketing.MarketingEvents.GetByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventGetByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicReadResponse.ID)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.get_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_read_response = hubspot.marketing.marketing_events.get_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(marketing_event_public_read_response)', + }, + php: { + method: 'marketing->marketingEvents->getByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->getByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($marketingEventPublicReadResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/marketing-events/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) marketing.marketing_events > (method) list', + qualified: 'client.marketing.marketingEvents.list', + params: ['after?: string;', 'limit?: number;'], + response: + '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }', + markdown: + "## list\n\n`client.marketing.marketingEvents.list(after?: string, limit?: number): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03`\n\n### Parameters\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `attendees?: number`\n - `cancellations?: number`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventStatus?: string`\n - `eventStatusV2?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `externalEventId?: string`\n - `noShows?: number`\n - `registrants?: number`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const marketingEventPublicReadResponseV2 of client.marketing.marketingEvents.list()) {\n console.log(marketingEventPublicReadResponseV2);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const marketingEventPublicReadResponseV2 of client.marketing.marketingEvents.list()) {\n console.log(marketingEventPublicReadResponseV2.createdAt);\n}", + }, + python: { + method: 'marketing.marketing_events.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.list()\npage = page.results[0]\nprint(page.created_at)', + }, + java: { + method: 'marketing().marketingEvents().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventListPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventListPage page = client.marketing().marketingEvents().list();\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.List(context.TODO(), marketing.MarketingEventListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.list\n\nputs(page)', + }, + php: { + method: 'marketing->marketingEvents->list', + example: + "marketing->marketingEvents->list(after: 'after', limit: 0);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/search', + httpMethod: 'get', + summary: 'Find App-Specific Marketing Events by External Event Id', + description: + 'Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.\n\nMarketing Events created by other apps will not be included in the results.', + stainlessPath: '(resource) marketing.marketing_events > (method) search_by_external_event_id', + qualified: 'client.marketing.marketingEvents.searchByExternalEventID', + params: ['q: string;'], + response: + '{ results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]; }', + markdown: + "## search_by_external_event_id\n\n`client.marketing.marketingEvents.searchByExternalEventID(q: string): { results: search_public_response_wrapper[]; }`\n\n**get** `/marketing/marketing-events/2026-03/events/search`\n\nRetrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.\n\nMarketing Events created by other apps will not be included in the results.\n\n### Parameters\n\n- `q: string`\n\n### Returns\n\n- `{ results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]; }`\n\n - `results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseSearchPublicResponseWrapperNoPaging = await client.marketing.marketingEvents.searchByExternalEventID({ q: 'q' });\n\nconsole.log(collectionResponseSearchPublicResponseWrapperNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.searchByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseSearchPublicResponseWrapperNoPaging =\n await client.marketing.marketingEvents.searchByExternalEventID({ q: 'q' });\n\nconsole.log(collectionResponseSearchPublicResponseWrapperNoPaging.results);", + }, + python: { + method: 'marketing.marketing_events.search_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_search_public_response_wrapper_no_paging = client.marketing.marketing_events.search_by_external_event_id(\n q="q",\n)\nprint(collection_response_search_public_response_wrapper_no_paging.results)', + }, + java: { + method: 'marketing().marketingEvents().searchByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseSearchPublicResponseWrapperNoPaging;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSearchByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventSearchByExternalEventIdParams params = MarketingEventSearchByExternalEventIdParams.builder()\n .q("q")\n .build();\n CollectionResponseSearchPublicResponseWrapperNoPaging collectionResponseSearchPublicResponseWrapperNoPaging = client.marketing().marketingEvents().searchByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.SearchByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseSearchPublicResponseWrapperNoPaging, err := client.Marketing.MarketingEvents.SearchByExternalEventID(context.TODO(), marketing.MarketingEventSearchByExternalEventIDParams{\n\t\tQ: "q",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseSearchPublicResponseWrapperNoPaging.Results)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.search_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_search_public_response_wrapper_no_paging = hubspot.marketing.marketing_events.search_by_external_event_id(q: "q")\n\nputs(collection_response_search_public_response_wrapper_no_paging)', + }, + php: { + method: 'marketing->marketingEvents->searchByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->searchByExternalEventID(q: 'q');\n\nvar_dump($collectionResponseSearchPublicResponseWrapperNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'search_identifiers_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/{externalEventId}/identifiers', + httpMethod: 'get', + summary: 'Find Marketing Events by External Event Id', + description: + 'This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request.\n\nIt retrieves the objectId and additional event details for each matching Marketing Event.\n\nSince multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results.\n\nNote: Marketing Events become searchable by externalEventId a few minutes after creation.', + stainlessPath: '(resource) marketing.marketing_events > (method) search_identifiers_by_external_event_id', + qualified: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', + params: ['externalEventId: string;'], + response: + '{ results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: app_info; externalAccountId?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## search_identifiers_by_external_event_id\n\n`client.marketing.marketingEvents.searchIdentifiersByExternalEventID(externalEventId: string): { results: marketing_event_identifiers_response[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/{externalEventId}/identifiers`\n\nThis endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request.\n\nIt retrieves the objectId and additional event details for each matching Marketing Event.\n\nSince multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results.\n\nNote: Marketing Events become searchable by externalEventId a few minutes after creation.\n\n### Parameters\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: app_info; externalAccountId?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: { id: string; name: string; }; externalAccountId?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalMarketingEventIdentifiersResponse = await client.marketing.marketingEvents.searchIdentifiersByExternalEventID('externalEventId');\n\nconsole.log(collectionResponseWithTotalMarketingEventIdentifiersResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalMarketingEventIdentifiersResponse =\n await client.marketing.marketingEvents.searchIdentifiersByExternalEventID('externalEventId');\n\nconsole.log(collectionResponseWithTotalMarketingEventIdentifiersResponse.results);", + }, + python: { + method: 'marketing.marketing_events.search_identifiers_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_marketing_event_identifiers_response = client.marketing.marketing_events.search_identifiers_by_external_event_id(\n "externalEventId",\n)\nprint(collection_response_with_total_marketing_event_identifiers_response.results)', + }, + java: { + method: 'marketing().marketingEvents().searchIdentifiersByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalMarketingEventIdentifiersResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSearchIdentifiersByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalMarketingEventIdentifiersResponse collectionResponseWithTotalMarketingEventIdentifiersResponse = client.marketing().marketingEvents().searchIdentifiersByExternalEventId("externalEventId");\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.SearchIdentifiersByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalMarketingEventIdentifiersResponse, err := client.Marketing.MarketingEvents.SearchIdentifiersByExternalEventID(context.TODO(), "externalEventId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalMarketingEventIdentifiersResponse.Results)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.search_identifiers_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_marketing_event_identifiers_response = hubspot.marketing.marketing_events.search_identifiers_by_external_event_id("externalEventId")\n\nputs(collection_response_with_total_marketing_event_identifiers_response)', + }, + php: { + method: 'marketing->marketingEvents->searchIdentifiersByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->searchIdentifiersByExternalEventID('externalEventId');\n\nvar_dump($collectionResponseWithTotalMarketingEventIdentifiersResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$EXTERNAL_EVENT_ID/identifiers \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/marketing/marketing-events/2026-03/{objectId}', + httpMethod: 'patch', + summary: 'Update Marketing Event by objectId', + description: + 'Updates the details of an existing Marketing Event identified by its objectId, if it exists.', + stainlessPath: '(resource) marketing.marketing_events > (method) update', + qualified: 'client.marketing.marketingEvents.update', + params: [ + 'objectId: string;', + "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", + 'endDateTime?: string;', + 'eventCancelled?: boolean;', + 'eventDescription?: string;', + 'eventName?: string;', + 'eventOrganizer?: string;', + 'eventType?: string;', + 'eventUrl?: string;', + 'startDateTime?: string;', + ], + response: + '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }', + markdown: + "## update\n\n`client.marketing.marketingEvents.update(objectId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], endDateTime?: string, eventCancelled?: boolean, eventDescription?: string, eventName?: string, eventOrganizer?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }`\n\n**patch** `/marketing/marketing-events/2026-03/{objectId}`\n\nUpdates the details of an existing Marketing Event identified by its objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n\n- `endDateTime?: string`\n The end date and time of the marketing event\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled\n\n- `eventDescription?: string`\n The description of the marketing event\n\n- `eventName?: string`\n The name of the marketing event\n\n- `eventOrganizer?: string`\n The name of the organizer of the marketing event\n\n- `eventType?: string`\n The type of the marketing event\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed\n\n- `startDateTime?: string`\n The start date and time of the marketing event\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.update('objectId', { customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}] });\n\nconsole.log(marketingEventPublicDefaultResponseV2);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.update(\n 'objectId',\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n },\n);\n\nconsole.log(marketingEventPublicDefaultResponseV2.createdAt);", + }, + python: { + method: 'marketing.marketing_events.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response_v2 = client.marketing.marketing_events.update(\n object_id="objectId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n)\nprint(marketing_event_public_default_response_v2.created_at)', + }, + java: { + method: 'marketing().marketingEvents().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponseV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicUpdateRequestV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpdateParams params = MarketingEventUpdateParams.builder()\n .objectId("objectId")\n .marketingEventPublicUpdateRequestV2(MarketingEventPublicUpdateRequestV2.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .build())\n .build();\n MarketingEventPublicDefaultResponseV2 marketingEventPublicDefaultResponseV2 = client.marketing().marketingEvents().update(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponseV2, err := client.Marketing.MarketingEvents.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tmarketing.MarketingEventUpdateParams{\n\t\t\tMarketingEventPublicUpdateRequestV2: marketing.MarketingEventPublicUpdateRequestV2Param{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponseV2.CreatedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response_v2 = hubspot.marketing.marketing_events.update(\n "objectId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ]\n)\n\nputs(marketing_event_public_default_response_v2)', + }, + php: { + method: 'marketing->marketingEvents->update', + example: + "marketing\n ->marketingEvents\n ->update(\n 'objectId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventDescription: 'eventDescription',\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponseV2);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update_batch', + endpoint: '/marketing/marketing-events/2026-03/batch/update', + httpMethod: 'post', + summary: 'Update Multiple Marketing Events by ObjectId', + description: 'Updates multiple Marketing Events on the portal based on their objectId, if they exist.', + stainlessPath: '(resource) marketing.marketing_events > (method) update_batch', + qualified: 'client.marketing.marketingEvents.updateBatch', + params: [ + "inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[];", + ], + response: + "{ completedAt: string; results: { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update_batch\n\n`client.marketing.marketingEvents.updateBatch(inputs: { customProperties: property_value[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]): { completedAt: string; results: marketing_event_public_default_response_v2[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/batch/update`\n\nUpdates multiple Marketing Events on the portal based on their objectId, if they exist.\n\n### Parameters\n\n- `inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseMarketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.updateBatch({ inputs: [{ customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}], objectId: 'objectId' }] });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponseV2);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.updateBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseMarketingEventPublicDefaultResponseV2 =\n await client.marketing.marketingEvents.updateBatch({\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n objectId: 'objectId',\n },\n ],\n });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponseV2.completedAt);", + }, + python: { + method: 'marketing.marketing_events.update_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_marketing_event_public_default_response_v2 = client.marketing.marketing_events.update_batch(\n inputs=[{\n "custom_properties": [{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n "object_id": "objectId",\n }],\n)\nprint(batch_response_marketing_event_public_default_response_v2.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().updateBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventPublicUpdateRequestFullV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseMarketingEventPublicDefaultResponseV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicUpdateRequestFullV2;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventPublicUpdateRequestFullV2 params = BatchInputMarketingEventPublicUpdateRequestFullV2.builder()\n .addInput(MarketingEventPublicUpdateRequestFullV2.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .objectId("objectId")\n .build())\n .build();\n BatchResponseMarketingEventPublicDefaultResponseV2 batchResponseMarketingEventPublicDefaultResponseV2 = client.marketing().marketingEvents().updateBatch(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.UpdateBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseMarketingEventPublicDefaultResponseV2, err := client.Marketing.MarketingEvents.UpdateBatch(context.TODO(), marketing.MarketingEventUpdateBatchParams{\n\t\tBatchInputMarketingEventPublicUpdateRequestFullV2: marketing.BatchInputMarketingEventPublicUpdateRequestFullV2Param{\n\t\t\tInputs: []marketing.MarketingEventPublicUpdateRequestFullV2Param{{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tObjectID: "objectId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseMarketingEventPublicDefaultResponseV2.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.update_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_marketing_event_public_default_response_v2 = hubspot.marketing.marketing_events.update_batch(\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n objectId: "objectId"\n }\n ]\n)\n\nputs(batch_response_marketing_event_public_default_response_v2)', + }, + php: { + method: 'marketing->marketingEvents->updateBatch', + example: + "marketing\n ->marketingEvents\n ->updateBatch(\n inputs: [\n [\n 'customProperties' => [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n 'objectID' => 'objectId',\n 'endDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'eventCancelled' => true,\n 'eventDescription' => 'eventDescription',\n 'eventName' => 'eventName',\n 'eventOrganizer' => 'eventOrganizer',\n 'eventType' => 'eventType',\n 'eventURL' => 'eventUrl',\n 'startDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseMarketingEventPublicDefaultResponseV2);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "objectId": "objectId"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', + httpMethod: 'patch', + summary: 'Update Marketing Event by External IDs', + description: + 'Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists.\n\nOnly Marketing Events created by the same app can be updated.', + stainlessPath: '(resource) marketing.marketing_events > (method) update_by_external_event_id', + qualified: 'client.marketing.marketingEvents.updateByExternalEventID', + params: [ + 'externalEventId: string;', + 'externalAccountId: string;', + "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", + 'endDateTime?: string;', + 'eventCancelled?: boolean;', + 'eventCompleted?: boolean;', + 'eventDescription?: string;', + 'eventName?: string;', + 'eventOrganizer?: string;', + 'eventType?: string;', + 'eventUrl?: string;', + 'startDateTime?: string;', + ], + response: + "{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## update_by_external_event_id\n\n`client.marketing.marketingEvents.updateByExternalEventID(externalEventId: string, externalAccountId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventName?: string, eventOrganizer?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**patch** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nUpdates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists.\n\nOnly Marketing Events created by the same app can be updated.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventName?: string`\n The name of the marketing event.\n\n- `eventOrganizer?: string`\n The name of the organizer of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponse = await client.marketing.marketingEvents.updateByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId', customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}] });\n\nconsole.log(marketingEventPublicDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.updateByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.updateByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n });\n\nconsole.log(marketingEventPublicDefaultResponse.id);", + }, + python: { + method: 'marketing.marketing_events.update_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response = client.marketing.marketing_events.update_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n)\nprint(marketing_event_public_default_response.id)', + }, + java: { + method: 'marketing().marketingEvents().updateByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateByExternalEventIdParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateRequestParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpdateByExternalEventIdParams params = MarketingEventUpdateByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .marketingEventUpdateRequestParams(MarketingEventUpdateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .build())\n .build();\n MarketingEventPublicDefaultResponse marketingEventPublicDefaultResponse = client.marketing().marketingEvents().updateByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.UpdateByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpdateByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventUpdateByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tMarketingEventUpdateRequestParams: marketing.MarketingEventUpdateRequestParams{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponse.ID)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.update_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response = hubspot.marketing.marketing_events.update_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ]\n)\n\nputs(marketing_event_public_default_response)', + }, + php: { + method: 'marketing->marketingEvents->updateByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->updateByExternalEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert_batch', + endpoint: '/marketing/marketing-events/2026-03/events/upsert', + httpMethod: 'post', + summary: 'Create or Update Multiple Marketing Events', + description: + 'Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.\n\nOnly Marketing Events originally created by the same app can be updated.', + stainlessPath: '(resource) marketing.marketing_events > (method) upsert_batch', + qualified: 'client.marketing.marketingEvents.upsertBatch', + params: [ + "inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[];", + ], + response: + "{ completedAt: string; results: { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## upsert_batch\n\n`client.marketing.marketingEvents.upsertBatch(inputs: { customProperties: property_value[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]): { completedAt: string; results: marketing_event_public_default_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/upsert`\n\nUpserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.\n\nOnly Marketing Events originally created by the same app can be updated.\n\n### Parameters\n\n- `inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseMarketingEventPublicDefaultResponse = await client.marketing.marketingEvents.upsertBatch({ inputs: [{\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n}] });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.upsertBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseMarketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.upsertBatch({\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n },\n ],\n });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponse.completedAt);", + }, + python: { + method: 'marketing.marketing_events.upsert_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_marketing_event_public_default_response = client.marketing.marketing_events.upsert_batch(\n inputs=[{\n "custom_properties": [{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n "event_name": "eventName",\n "event_organizer": "eventOrganizer",\n "external_account_id": "externalAccountId",\n "external_event_id": "externalEventId",\n }],\n)\nprint(batch_response_marketing_event_public_default_response.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().upsertBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseMarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventCreateRequestParams params = BatchInputMarketingEventCreateRequestParams.builder()\n .addInput(MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n BatchResponseMarketingEventPublicDefaultResponse batchResponseMarketingEventPublicDefaultResponse = client.marketing().marketingEvents().upsertBatch(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.UpsertBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseMarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpsertBatch(context.TODO(), marketing.MarketingEventUpsertBatchParams{\n\t\tBatchInputMarketingEventCreateRequestParams: marketing.BatchInputMarketingEventCreateRequestParams{\n\t\t\tInputs: []marketing.MarketingEventCreateRequestParams{{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tEventName: "eventName",\n\t\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseMarketingEventPublicDefaultResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.upsert_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_marketing_event_public_default_response = hubspot.marketing.marketing_events.upsert_batch(\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n eventName: "eventName",\n eventOrganizer: "eventOrganizer",\n externalAccountId: "externalAccountId",\n externalEventId: "externalEventId"\n }\n ]\n)\n\nputs(batch_response_marketing_event_public_default_response)', + }, + php: { + method: 'marketing->marketingEvents->upsertBatch', + example: + "marketing\n ->marketingEvents\n ->upsertBatch(\n inputs: [\n [\n 'customProperties' => [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n 'eventName' => 'eventName',\n 'eventOrganizer' => 'eventOrganizer',\n 'externalAccountID' => 'externalAccountId',\n 'externalEventID' => 'externalEventId',\n 'endDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'eventCancelled' => true,\n 'eventCompleted' => true,\n 'eventDescription' => 'eventDescription',\n 'eventType' => 'eventType',\n 'eventURL' => 'eventUrl',\n 'startDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseMarketingEventPublicDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'upsert_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', + httpMethod: 'put', + summary: 'Create or update a marketing event', + description: + 'Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.', + stainlessPath: '(resource) marketing.marketing_events > (method) upsert_by_external_event_id', + qualified: 'client.marketing.marketingEvents.upsertByExternalEventID', + params: [ + 'externalEventId: string;', + "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", + 'eventName: string;', + 'eventOrganizer: string;', + 'externalAccountId: string;', + 'externalEventId: string;', + 'endDateTime?: string;', + 'eventCancelled?: boolean;', + 'eventCompleted?: boolean;', + 'eventDescription?: string;', + 'eventType?: string;', + 'eventUrl?: string;', + 'startDateTime?: string;', + ], + response: + "{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## upsert_by_external_event_id\n\n`client.marketing.marketingEvents.upsertByExternalEventID(externalEventId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], eventName: string, eventOrganizer: string, externalAccountId: string, externalEventId: string, endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**put** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nUpserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `eventName: string`\n The name of the marketing event.\n\n- `eventOrganizer: string`\n The name of the organizer of the marketing event.\n\n- `externalAccountId: string`\n The accountId that is associated with this marketing event in the external event application.\n\n- `externalEventId: string`\n The id of the marketing event in the external event application.\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponse = await client.marketing.marketingEvents.upsertByExternalEventID('externalEventId', {\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventPublicDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.upsertByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.upsertByExternalEventID('externalEventId', {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n });\n\nconsole.log(marketingEventPublicDefaultResponse.id);", + }, + python: { + method: 'marketing.marketing_events.upsert_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response = client.marketing.marketing_events.upsert_by_external_event_id(\n path_external_event_id="externalEventId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n event_name="eventName",\n event_organizer="eventOrganizer",\n external_account_id="externalAccountId",\n body_external_event_id="externalEventId",\n)\nprint(marketing_event_public_default_response.id)', + }, + java: { + method: 'marketing().marketingEvents().upsertByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpsertByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpsertByExternalEventIdParams params = MarketingEventUpsertByExternalEventIdParams.builder()\n .pathExternalEventId("externalEventId")\n .marketingEventCreateRequestParams(MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n MarketingEventPublicDefaultResponse marketingEventPublicDefaultResponse = client.marketing().marketingEvents().upsertByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.UpsertByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpsertByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventUpsertByExternalEventIDParams{\n\t\t\tMarketingEventCreateRequestParams: marketing.MarketingEventCreateRequestParams{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tEventName: "eventName",\n\t\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponse.ID)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.upsert_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response = hubspot.marketing.marketing_events.upsert_by_external_event_id(\n "externalEventId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n event_name: "eventName",\n event_organizer: "eventOrganizer",\n external_account_id: "externalAccountId",\n body_external_event_id: "externalEventId"\n)\n\nputs(marketing_event_public_default_response)', + }, + php: { + method: 'marketing->marketingEvents->upsertByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->upsertByExternalEventID(\n 'externalEventId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\'', + }, + }, + }, + { + name: 'create_by_event_id_and_contact_id', + endpoint: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create', + httpMethod: 'post', + summary: 'Record Participants by ContactId with Marketing Event Object Id', + description: + 'Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', + stainlessPath: + '(resource) marketing.marketing_events.attendance > (method) create_by_event_id_and_contact_id', + qualified: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', + params: [ + 'objectId: string;', + 'subscriberState: string;', + 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', + ], + response: + "{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create_by_event_id_and_contact_id\n\n`client.marketing.marketingEvents.attendance.createByEventIDAndContactID(objectId: string, subscriberState: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[]): { completedAt: string; results: subscriber_vid_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `objectId: string`\n\n- `subscriberState: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n### Returns\n\n- `{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberVidResponse = await client.marketing.marketingEvents.attendance.createByEventIDAndContactID('subscriberState', { objectId: 'objectId', inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}] });\n\nconsole.log(batchResponseSubscriberVidResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberVidResponse =\n await client.marketing.marketingEvents.attendance.createByEventIDAndContactID('subscriberState', {\n objectId: 'objectId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n });\n\nconsole.log(batchResponseSubscriberVidResponse.completedAt);", + }, + python: { + method: 'marketing.marketing_events.attendance.create_by_event_id_and_contact_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_vid_response = client.marketing.marketing_events.attendance.create_by_event_id_and_contact_id(\n subscriber_state="subscriberState",\n object_id="objectId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(batch_response_subscriber_vid_response.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().attendance().createByEventIdAndContactId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberVidResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByEventIdAndContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByEventIdAndContactIdParams params = AttendanceCreateByEventIdAndContactIdParams.builder()\n .objectId("objectId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n BatchResponseSubscriberVidResponse batchResponseSubscriberVidResponse = client.marketing().marketingEvents().attendance().createByEventIdAndContactId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Attendance.NewByEventIDAndContactID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberVidResponse, err := client.Marketing.MarketingEvents.Attendance.NewByEventIDAndContactID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByEventIDAndContactIDParams{\n\t\t\tObjectID: "objectId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberVidResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.attendance.create_by_event_id_and_contact_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_vid_response = hubspot.marketing.marketing_events.attendance.create_by_event_id_and_contact_id(\n "subscriberState",\n object_id_: "objectId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(batch_response_subscriber_vid_response)', + }, + php: { + method: 'marketing->marketingEvents->attendance->createByEventIDAndContactID', + example: + "marketing\n ->marketingEvents\n ->attendance\n ->createByEventIDAndContactID(\n 'subscriberState',\n objectID: 'objectId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n);\n\nvar_dump($batchResponseSubscriberVidResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID/attendance/$SUBSCRIBER_STATE/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_by_event_id_and_email', + endpoint: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create', + httpMethod: 'post', + summary: 'Record Participants by Email with Marketing Event Object Id', + description: + 'Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', + stainlessPath: '(resource) marketing.marketing_events.attendance > (method) create_by_event_id_and_email', + qualified: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', + params: [ + 'objectId: string;', + 'subscriberState: string;', + 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', + ], + response: + "{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create_by_event_id_and_email\n\n`client.marketing.marketingEvents.attendance.createByEventIDAndEmail(objectId: string, subscriberState: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]): { completedAt: string; results: subscriber_email_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `objectId: string`\n\n- `subscriberState: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n### Returns\n\n- `{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { email: string; vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberEmailResponse = await client.marketing.marketingEvents.attendance.createByEventIDAndEmail('subscriberState', { objectId: 'objectId', inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSubscriberEmailResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberEmailResponse =\n await client.marketing.marketingEvents.attendance.createByEventIDAndEmail('subscriberState', {\n objectId: 'objectId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n });\n\nconsole.log(batchResponseSubscriberEmailResponse.completedAt);", + }, + python: { + method: 'marketing.marketing_events.attendance.create_by_event_id_and_email', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_email_response = client.marketing.marketing_events.attendance.create_by_event_id_and_email(\n subscriber_state="subscriberState",\n object_id="objectId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_subscriber_email_response.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().attendance().createByEventIdAndEmail', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberEmailResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByEventIdAndEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByEventIdAndEmailParams params = AttendanceCreateByEventIdAndEmailParams.builder()\n .objectId("objectId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSubscriberEmailResponse batchResponseSubscriberEmailResponse = client.marketing().marketingEvents().attendance().createByEventIdAndEmail(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Attendance.NewByEventIDAndEmail', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberEmailResponse, err := client.Marketing.MarketingEvents.Attendance.NewByEventIDAndEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByEventIDAndEmailParams{\n\t\t\tObjectID: "objectId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberEmailResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.attendance.create_by_event_id_and_email', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_email_response = hubspot.marketing.marketing_events.attendance.create_by_event_id_and_email(\n "subscriberState",\n object_id_: "objectId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(batch_response_subscriber_email_response)', + }, + php: { + method: 'marketing->marketingEvents->attendance->createByEventIDAndEmail', + example: + "marketing\n ->marketingEvents\n ->attendance\n ->createByEventIDAndEmail(\n 'subscriberState',\n objectID: 'objectId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n);\n\nvar_dump($batchResponseSubscriberEmailResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID/attendance/$SUBSCRIBER_STATE/email-create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_by_external_event_id_and_contact_id', + endpoint: '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create', + httpMethod: 'post', + summary: 'Record Participants by ContactId with Marketing Event External Ids', + description: + 'Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', + stainlessPath: + '(resource) marketing.marketing_events.attendance > (method) create_by_external_event_id_and_contact_id', + qualified: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', + params: [ + 'externalEventId: string;', + 'subscriberState: string;', + 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', + 'externalAccountId?: string;', + ], + response: + "{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create_by_external_event_id_and_contact_id\n\n`client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID(externalEventId: string, subscriberState: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[], externalAccountId?: string): { completedAt: string; results: subscriber_vid_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n- `externalAccountId?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberVidResponse = await client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID('subscriberState', { externalEventId: 'externalEventId', inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}] });\n\nconsole.log(batchResponseSubscriberVidResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberVidResponse =\n await client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n },\n );\n\nconsole.log(batchResponseSubscriberVidResponse.completedAt);", + }, + python: { + method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_vid_response = client.marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(batch_response_subscriber_vid_response.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().attendance().createByExternalEventIdAndContactId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberVidResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByExternalEventIdAndContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByExternalEventIdAndContactIdParams params = AttendanceCreateByExternalEventIdAndContactIdParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n BatchResponseSubscriberVidResponse batchResponseSubscriberVidResponse = client.marketing().marketingEvents().attendance().createByExternalEventIdAndContactId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndContactID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberVidResponse, err := client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndContactID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByExternalEventIDAndContactIDParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberVidResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_vid_response = hubspot.marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id(\n "subscriberState",\n external_event_id: "externalEventId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(batch_response_subscriber_vid_response)', + }, + php: { + method: 'marketing->marketingEvents->attendance->createByExternalEventIDAndContactID', + example: + "marketing\n ->marketingEvents\n ->attendance\n ->createByExternalEventIDAndContactID(\n 'subscriberState',\n externalEventID: 'externalEventId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n externalAccountID: 'externalAccountId',\n);\n\nvar_dump($batchResponseSubscriberVidResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/attendance/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_by_external_event_id_and_email', + endpoint: + '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create', + httpMethod: 'post', + summary: 'Record Participants by Email with Marketing Event External Ids', + description: + 'Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', + stainlessPath: + '(resource) marketing.marketing_events.attendance > (method) create_by_external_event_id_and_email', + qualified: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', + params: [ + 'externalEventId: string;', + 'subscriberState: string;', + 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', + 'externalAccountId?: string;', + ], + response: + "{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", + markdown: + "## create_by_external_event_id_and_email\n\n`client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail(externalEventId: string, subscriberState: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[], externalAccountId?: string): { completedAt: string; results: subscriber_email_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n- `externalAccountId?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { email: string; vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberEmailResponse = await client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail('subscriberState', { externalEventId: 'externalEventId', inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSubscriberEmailResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberEmailResponse =\n await client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n },\n );\n\nconsole.log(batchResponseSubscriberEmailResponse.completedAt);", + }, + python: { + method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_email', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_email_response = client.marketing.marketing_events.attendance.create_by_external_event_id_and_email(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_subscriber_email_response.completed_at)', + }, + java: { + method: 'marketing().marketingEvents().attendance().createByExternalEventIdAndEmail', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberEmailResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByExternalEventIdAndEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByExternalEventIdAndEmailParams params = AttendanceCreateByExternalEventIdAndEmailParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSubscriberEmailResponse batchResponseSubscriberEmailResponse = client.marketing().marketingEvents().attendance().createByExternalEventIdAndEmail(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndEmail', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberEmailResponse, err := client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByExternalEventIDAndEmailParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberEmailResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_email', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_email_response = hubspot.marketing.marketing_events.attendance.create_by_external_event_id_and_email(\n "subscriberState",\n external_event_id: "externalEventId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(batch_response_subscriber_email_response)', + }, + php: { + method: 'marketing->marketingEvents->attendance->createByExternalEventIDAndEmail', + example: + "marketing\n ->marketingEvents\n ->attendance\n ->createByExternalEventIDAndEmail(\n 'subscriberState',\n externalEventID: 'externalEventId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n externalAccountID: 'externalAccountId',\n);\n\nvar_dump($batchResponseSubscriberEmailResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/attendance/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/email-create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'cancel_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/cancel', + httpMethod: 'post', + summary: 'Mark a marketing event as cancelled', + description: 'Mark a marketing event as cancelled.', + stainlessPath: '(resource) marketing.marketing_events.events > (method) cancel_by_external_event_id', + qualified: 'client.marketing.marketingEvents.events.cancelByExternalEventID', + params: ['externalEventId: string;', 'externalAccountId: string;'], + response: + "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## cancel_by_external_event_id\n\n`client.marketing.marketingEvents.events.cancelByExternalEventID(externalEventId: string, externalAccountId: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/cancel`\n\nMark a marketing event as cancelled.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.events.cancelByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(marketingEventDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.events.cancelByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse =\n await client.marketing.marketingEvents.events.cancelByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(marketingEventDefaultResponse.customProperties);", + }, + python: { + method: 'marketing.marketing_events.events.cancel_by_external_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.events.cancel_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(marketing_event_default_response.custom_properties)', + }, + java: { + method: 'marketing().marketingEvents().events().cancelByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.events.EventCancelByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventCancelByExternalEventIdParams params = EventCancelByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().events().cancelByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Events.CancelByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.Events.CancelByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventEventCancelByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.events.cancel_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.events.cancel_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(marketing_event_default_response)', + }, + php: { + method: 'marketing->marketingEvents->events->cancelByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->events\n ->cancelByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($marketingEventDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/cancel \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'complete_by_external_event_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/complete', + httpMethod: 'post', + summary: 'Mark a marketing event as completed', + description: 'Mark a marketing event as completed', + stainlessPath: '(resource) marketing.marketing_events.events > (method) complete_by_external_event_id', + qualified: 'client.marketing.marketingEvents.events.completeByExternalEventID', + params: [ + 'externalEventId: string;', + 'externalAccountId: string;', + 'endDateTime: string;', + 'startDateTime: string;', + ], + response: + "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", + markdown: + "## complete_by_external_event_id\n\n`client.marketing.marketingEvents.events.completeByExternalEventID(externalEventId: string, externalAccountId: string, endDateTime: string, startDateTime: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/complete`\n\nMark a marketing event as completed\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n- `endDateTime: string`\n The end date and time of the marketing event in ISO 8601 format\n\n- `startDateTime: string`\n The start date and time of the marketing event in ISO 8601 format\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.events.completeByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n endDateTime: '2019-12-27T18:11:19.117Z',\n startDateTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(marketingEventDefaultResponse);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.events.completeByExternalEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse =\n await client.marketing.marketingEvents.events.completeByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n endDateTime: '2019-12-27T18:11:19.117Z',\n startDateTime: '2019-12-27T18:11:19.117Z',\n });\n\nconsole.log(marketingEventDefaultResponse.customProperties);", + }, + python: { + method: 'marketing.marketing_events.events.complete_by_external_event_id', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.events.complete_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n end_date_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n start_date_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(marketing_event_default_response.custom_properties)', + }, + java: { + method: 'marketing().marketingEvents().events().completeByExternalEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCompleteRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.events.EventCompleteByExternalEventIdParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventCompleteByExternalEventIdParams params = EventCompleteByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .marketingEventCompleteRequestParams(MarketingEventCompleteRequestParams.builder()\n .endDateTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .startDateTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().events().completeByExternalEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Events.CompleteByExternalEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.Events.CompleteByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventEventCompleteByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tMarketingEventCompleteRequestParams: marketing.MarketingEventCompleteRequestParams{\n\t\t\t\tEndDateTime: time.Now(),\n\t\t\t\tStartDateTime: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.events.complete_by_external_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.events.complete_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId",\n end_date_time: "2019-12-27T18:11:19.117Z",\n start_date_time: "2019-12-27T18:11:19.117Z"\n)\n\nputs(marketing_event_default_response)', + }, + php: { + method: 'marketing->marketingEvents->events->completeByExternalEventID', + example: + "marketing\n ->marketingEvents\n ->events\n ->completeByExternalEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventDefaultResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endDateTime": "2019-12-27T18:11:19.117Z",\n "startDateTime": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'associate', + endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', + httpMethod: 'put', + summary: 'Associate a list with a marketing event', + description: 'Associates a list with a marketing event by marketing event id and ILS list id', + stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) associate', + qualified: 'client.marketing.marketingEvents.listAssociations.associate', + params: ['marketingEventId: string;', 'listId: string;'], + markdown: + "## associate\n\n`client.marketing.marketingEvents.listAssociations.associate(marketingEventId: string, listId: string): void`\n\n**put** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}`\n\nAssociates a list with a marketing event by marketing event id and ILS list id\n\n### Parameters\n\n- `marketingEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.associate('listId', { marketingEventId: 'marketingEventId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.associate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.associate('listId', {\n marketingEventId: 'marketingEventId',\n});", + }, + python: { + method: 'marketing.marketing_events.list_associations.associate', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.associate(\n list_id="listId",\n marketing_event_id="marketingEventId",\n)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().associate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationAssociateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationAssociateParams params = ListAssociationAssociateParams.builder()\n .marketingEventId("marketingEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().associate(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.Associate', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.Associate(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationAssociateParams{\n\t\t\tMarketingEventID: "marketingEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.associate', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.associate(\n "listId",\n marketing_event_id: "marketingEventId"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->associate', + example: + "marketing->marketingEvents->listAssociations->associate(\n 'listId', marketingEventID: 'marketingEventId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists/$LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'associate_by_external_account', + endpoint: + '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', + httpMethod: 'put', + summary: 'Associate a list with a marketing event', + description: + 'Associates a list with a marketing event by external account id, external event id, and ILS list id', + stainlessPath: + '(resource) marketing.marketing_events.list_associations > (method) associate_by_external_account', + qualified: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', + params: ['externalAccountId: string;', 'externalEventId: string;', 'listId: string;'], + markdown: + "## associate_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.associateByExternalAccount(externalAccountId: string, externalEventId: string, listId: string): void`\n\n**put** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}`\n\nAssociates a list with a marketing event by external account id, external event id, and ILS list id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.associateByExternalAccount('listId', { externalAccountId: 'externalAccountId', externalEventId: 'externalEventId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.associateByExternalAccount('listId', {\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});", + }, + python: { + method: 'marketing.marketing_events.list_associations.associate_by_external_account', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.associate_by_external_account(\n list_id="listId",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().associateByExternalAccount', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationAssociateByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationAssociateByExternalAccountParams params = ListAssociationAssociateByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().associateByExternalAccount(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.AssociateByExternalAccount', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.AssociateByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationAssociateByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.associate_by_external_account', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.associate_by_external_account(\n "listId",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->associateByExternalAccount', + example: + "marketing\n ->marketingEvents\n ->listAssociations\n ->associateByExternalAccount(\n 'listId',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists/$LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', + httpMethod: 'delete', + summary: 'Disassociate a list from a marketing event', + description: 'Disassociates a list from a marketing event by marketing event id and ILS list id', + stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) delete', + qualified: 'client.marketing.marketingEvents.listAssociations.delete', + params: ['marketingEventId: string;', 'listId: string;'], + markdown: + "## delete\n\n`client.marketing.marketingEvents.listAssociations.delete(marketingEventId: string, listId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}`\n\nDisassociates a list from a marketing event by marketing event id and ILS list id\n\n### Parameters\n\n- `marketingEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.delete('listId', { marketingEventId: 'marketingEventId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.delete('listId', {\n marketingEventId: 'marketingEventId',\n});", + }, + python: { + method: 'marketing.marketing_events.list_associations.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.delete(\n list_id="listId",\n marketing_event_id="marketingEventId",\n)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationDeleteParams params = ListAssociationDeleteParams.builder()\n .marketingEventId("marketingEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().delete(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.Delete(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationDeleteParams{\n\t\t\tMarketingEventID: "marketingEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.delete(\n "listId",\n marketing_event_id: "marketingEventId"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->delete', + example: + "marketing->marketingEvents->listAssociations->delete(\n 'listId', marketingEventID: 'marketingEventId'\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_by_external_account', + endpoint: + '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', + httpMethod: 'delete', + summary: 'Disassociate a list from a marketing event', + description: + 'Disassociates a list from a marketing event by external account id, external event id, and ILS list id', + stainlessPath: + '(resource) marketing.marketing_events.list_associations > (method) delete_by_external_account', + qualified: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', + params: ['externalAccountId: string;', 'externalEventId: string;', 'listId: string;'], + markdown: + "## delete_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.deleteByExternalAccount(externalAccountId: string, externalEventId: string, listId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}`\n\nDisassociates a list from a marketing event by external account id, external event id, and ILS list id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.deleteByExternalAccount('listId', { externalAccountId: 'externalAccountId', externalEventId: 'externalEventId' })\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.deleteByExternalAccount('listId', {\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});", + }, + python: { + method: 'marketing.marketing_events.list_associations.delete_by_external_account', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.delete_by_external_account(\n list_id="listId",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().deleteByExternalAccount', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationDeleteByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationDeleteByExternalAccountParams params = ListAssociationDeleteByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().deleteByExternalAccount(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.DeleteByExternalAccount', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.DeleteByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationDeleteByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.delete_by_external_account', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.delete_by_external_account(\n "listId",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(result)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->deleteByExternalAccount', + example: + "marketing\n ->marketingEvents\n ->listAssociations\n ->deleteByExternalAccount(\n 'listId',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists', + httpMethod: 'get', + summary: 'Get lists associated with a marketing event', + description: 'Gets lists associated with a marketing event by marketing event id', + stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) list', + qualified: 'client.marketing.marketingEvents.listAssociations.list', + params: ['marketingEventId: string;'], + response: + '{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## list\n\n`client.marketing.marketingEvents.listAssociations.list(marketingEventId: string): { results: public_list[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists`\n\nGets lists associated with a marketing event by marketing event id\n\n### Parameters\n\n- `marketingEventId: string`\n\n### Returns\n\n- `{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalPublicList = await client.marketing.marketingEvents.listAssociations.list('marketingEventId');\n\nconsole.log(collectionResponseWithTotalPublicList);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalPublicList =\n await client.marketing.marketingEvents.listAssociations.list('marketingEventId');\n\nconsole.log(collectionResponseWithTotalPublicList.results);", + }, + python: { + method: 'marketing.marketing_events.list_associations.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_public_list = client.marketing.marketing_events.list_associations.list(\n "marketingEventId",\n)\nprint(collection_response_with_total_public_list.results)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalPublicList;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalPublicList collectionResponseWithTotalPublicList = client.marketing().marketingEvents().listAssociations().list("marketingEventId");\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalPublicList, err := client.Marketing.MarketingEvents.ListAssociations.List(context.TODO(), "marketingEventId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalPublicList.Results)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_public_list = hubspot.marketing.marketing_events.list_associations.list("marketingEventId")\n\nputs(collection_response_with_total_public_list)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->list', + example: + "marketing\n ->marketingEvents\n ->listAssociations\n ->list('marketingEventId');\n\nvar_dump($collectionResponseWithTotalPublicList);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_by_external_account', + endpoint: '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists', + httpMethod: 'get', + summary: 'Get lists associated with a marketing event', + description: 'Gets lists associated with a marketing event by external account id and external event id', + stainlessPath: + '(resource) marketing.marketing_events.list_associations > (method) list_by_external_account', + qualified: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', + params: ['externalAccountId: string;', 'externalEventId: string;'], + response: + '{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', + markdown: + "## list_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.listByExternalAccount(externalAccountId: string, externalEventId: string): { results: public_list[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists`\n\nGets lists associated with a marketing event by external account id and external event id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalPublicList = await client.marketing.marketingEvents.listAssociations.listByExternalAccount('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(collectionResponseWithTotalPublicList);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalPublicList =\n await client.marketing.marketingEvents.listAssociations.listByExternalAccount('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(collectionResponseWithTotalPublicList.results);", + }, + python: { + method: 'marketing.marketing_events.list_associations.list_by_external_account', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_public_list = client.marketing.marketing_events.list_associations.list_by_external_account(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(collection_response_with_total_public_list.results)', + }, + java: { + method: 'marketing().marketingEvents().listAssociations().listByExternalAccount', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalPublicList;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationListByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationListByExternalAccountParams params = ListAssociationListByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n CollectionResponseWithTotalPublicList collectionResponseWithTotalPublicList = client.marketing().marketingEvents().listAssociations().listByExternalAccount(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.ListAssociations.ListByExternalAccount', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalPublicList, err := client.Marketing.MarketingEvents.ListAssociations.ListByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventListAssociationListByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalPublicList.Results)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.list_associations.list_by_external_account', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_public_list = hubspot.marketing.marketing_events.list_associations.list_by_external_account(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(collection_response_with_total_public_list)', + }, + php: { + method: 'marketing->marketingEvents->listAssociations->listByExternalAccount', + example: + "marketing\n ->marketingEvents\n ->listAssociations\n ->listByExternalAccount(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($collectionResponseWithTotalPublicList);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_external_account_and_event_id', + endpoint: '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}', + httpMethod: 'get', + summary: 'Read participations counters by Marketing Event external identifier', + description: + "Read Marketing event's participations counters by externalAccountId and externalEventId pair.", + stainlessPath: + '(resource) marketing.marketing_events.participations > (method) get_by_external_account_and_event_id', + qualified: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', + params: ['externalAccountId: string;', 'externalEventId: string;'], + response: '{ attended: number; cancelled: number; noShows: number; registered: number; }', + markdown: + "## get_by_external_account_and_event_id\n\n`client.marketing.marketingEvents.participations.getByExternalAccountAndEventID(externalAccountId: string, externalEventId: string): { attended: number; cancelled: number; noShows: number; registered: number; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}`\n\nRead Marketing event's participations counters by externalAccountId and externalEventId pair.\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ attended: number; cancelled: number; noShows: number; registered: number; }`\n\n - `attended: number`\n - `cancelled: number`\n - `noShows: number`\n - `registered: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByExternalAccountAndEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(attendanceCounters);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attendanceCounters =\n await client.marketing.marketingEvents.participations.getByExternalAccountAndEventID(\n 'externalEventId',\n { externalAccountId: 'externalAccountId' },\n );\n\nconsole.log(attendanceCounters.attended);", + }, + python: { + method: 'marketing.marketing_events.participations.get_by_external_account_and_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattendance_counters = client.marketing.marketing_events.participations.get_by_external_account_and_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(attendance_counters.attended)', + }, + java: { + method: 'marketing().marketingEvents().participations().getByExternalAccountAndEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.AttendanceCounters;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationGetByExternalAccountAndEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationGetByExternalAccountAndEventIdParams params = ParticipationGetByExternalAccountAndEventIdParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n AttendanceCounters attendanceCounters = client.marketing().marketingEvents().participations().getByExternalAccountAndEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Participations.GetByExternalAccountAndEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattendanceCounters, err := client.Marketing.MarketingEvents.Participations.GetByExternalAccountAndEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventParticipationGetByExternalAccountAndEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attendanceCounters.Attended)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.participations.get_by_external_account_and_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattendance_counters = hubspot.marketing.marketing_events.participations.get_by_external_account_and_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(attendance_counters)', + }, + php: { + method: 'marketing->marketingEvents->participations->getByExternalAccountAndEventID', + example: + "marketing\n ->marketingEvents\n ->participations\n ->getByExternalAccountAndEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($attendanceCounters);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_by_id', + endpoint: '/marketing/marketing-events/2026-03/participations/{marketingEventId}', + httpMethod: 'get', + summary: 'Read participations counters by Marketing Event internal identifier', + description: "Read Marketing event's participations counters by internal identifier marketingEventId.", + stainlessPath: '(resource) marketing.marketing_events.participations > (method) get_by_id', + qualified: 'client.marketing.marketingEvents.participations.getByID', + params: ['marketingEventId: number;'], + response: '{ attended: number; cancelled: number; noShows: number; registered: number; }', + markdown: + "## get_by_id\n\n`client.marketing.marketingEvents.participations.getByID(marketingEventId: number): { attended: number; cancelled: number; noShows: number; registered: number; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{marketingEventId}`\n\nRead Marketing event's participations counters by internal identifier marketingEventId.\n\n### Parameters\n\n- `marketingEventId: number`\n\n### Returns\n\n- `{ attended: number; cancelled: number; noShows: number; registered: number; }`\n\n - `attended: number`\n - `cancelled: number`\n - `noShows: number`\n - `registered: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByID(0);\n\nconsole.log(attendanceCounters);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.participations.getByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByID(0);\n\nconsole.log(attendanceCounters.attended);", + }, + python: { + method: 'marketing.marketing_events.participations.get_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattendance_counters = client.marketing.marketing_events.participations.get_by_id(\n 0,\n)\nprint(attendance_counters.attended)', + }, + java: { + method: 'marketing().marketingEvents().participations().getById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.AttendanceCounters;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationGetByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCounters attendanceCounters = client.marketing().marketingEvents().participations().getById(0L);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Participations.GetByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattendanceCounters, err := client.Marketing.MarketingEvents.Participations.GetByID(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attendanceCounters.Attended)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.participations.get_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattendance_counters = hubspot.marketing.marketing_events.participations.get_by_id(0)\n\nputs(attendance_counters)', + }, + php: { + method: 'marketing->marketingEvents->participations->getByID', + example: + "marketing\n ->marketingEvents\n ->participations\n ->getByID(0);\n\nvar_dump($attendanceCounters);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$MARKETING_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_breakdown_by_contact', + endpoint: '/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown', + httpMethod: 'get', + summary: 'Read participations breakdown by Contact identifier', + description: "Read Contact's participations by identifier - email or internal id.", + stainlessPath: + '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_contact', + qualified: 'client.marketing.marketingEvents.participations.listBreakdownByContact', + params: ['contactIdentifier: string;', 'after?: string;', 'limit?: number;', 'state?: string;'], + response: + "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", + markdown: + "## list_breakdown_by_contact\n\n`client.marketing.marketingEvents.participations.listBreakdownByContact(contactIdentifier: string, after?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown`\n\nRead Contact's participations by identifier - email or internal id.\n\n### Parameters\n\n- `contactIdentifier: string`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByContact('contactIdentifier')) {\n console.log(participationBreakdown);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.participations.listBreakdownByContact', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByContact(\n 'contactIdentifier',\n)) {\n console.log(participationBreakdown.id);\n}", + }, + python: { + method: 'marketing.marketing_events.participations.list_breakdown_by_contact', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_contact(\n contact_identifier="contactIdentifier",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().marketingEvents().participations().listBreakdownByContact', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByContactPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByContactParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByContactPage page = client.marketing().marketingEvents().participations().listBreakdownByContact("contactIdentifier");\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByContact', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByContact(\n\t\tcontext.TODO(),\n\t\t"contactIdentifier",\n\t\tmarketing.MarketingEventParticipationListBreakdownByContactParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.participations.list_breakdown_by_contact', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_contact("contactIdentifier")\n\nputs(page)', + }, + php: { + method: 'marketing->marketingEvents->participations->listBreakdownByContact', + example: + "marketing\n ->marketingEvents\n ->participations\n ->listBreakdownByContact(\n 'contactIdentifier', after: 'after', limit: 0, state: 'state'\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/contacts/$CONTACT_IDENTIFIER/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_breakdown_by_external_account_and_event_id', + endpoint: + '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown', + httpMethod: 'get', + summary: 'Read participations breakdown by Marketing Event external identifier', + description: + "Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.", + stainlessPath: + '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_external_account_and_event_id', + qualified: 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', + params: [ + 'externalAccountId: string;', + 'externalEventId: string;', + 'after?: string;', + 'contactIdentifier?: string;', + 'limit?: number;', + 'state?: string;', + ], + response: + "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", + markdown: + "## list_breakdown_by_external_account_and_event_id\n\n`client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID(externalAccountId: string, externalEventId: string, after?: string, contactIdentifier?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown`\n\nRead Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `contactIdentifier?: string`\n The identifier of the Contact. It may be email or internal id.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID('externalEventId', { externalAccountId: 'externalAccountId' })) {\n console.log(participationBreakdown);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID(\n 'externalEventId',\n { externalAccountId: 'externalAccountId' },\n)) {\n console.log(participationBreakdown.id);\n}", + }, + python: { + method: 'marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().marketingEvents().participations().listBreakdownByExternalAccountAndEventId', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByExternalAccountAndEventIdPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByExternalAccountAndEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByExternalAccountAndEventIdParams params = ParticipationListBreakdownByExternalAccountAndEventIdParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n ParticipationListBreakdownByExternalAccountAndEventIdPage page = client.marketing().marketingEvents().participations().listBreakdownByExternalAccountAndEventId(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByExternalAccountAndEventID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByExternalAccountAndEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventParticipationListBreakdownByExternalAccountAndEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(page)', + }, + php: { + method: 'marketing->marketingEvents->participations->listBreakdownByExternalAccountAndEventID', + example: + "marketing\n ->marketingEvents\n ->participations\n ->listBreakdownByExternalAccountAndEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n after: 'after',\n contactIdentifier: 'contactIdentifier',\n limit: 0,\n state: 'state',\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_breakdown_by_id', + endpoint: '/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown', + httpMethod: 'get', + summary: 'Read participations breakdown by Marketing Event internal identifier', + description: + "Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.", + stainlessPath: '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_id', + qualified: 'client.marketing.marketingEvents.participations.listBreakdownByID', + params: [ + 'marketingEventId: number;', + 'after?: string;', + 'contactIdentifier?: string;', + 'limit?: number;', + 'state?: string;', + ], + response: + "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", + markdown: + "## list_breakdown_by_id\n\n`client.marketing.marketingEvents.participations.listBreakdownByID(marketingEventId: number, after?: string, contactIdentifier?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown`\n\nRead Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.\n\n### Parameters\n\n- `marketingEventId: number`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `contactIdentifier?: string`\n The identifier of the Contact. It may be email or internal id.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByID(0)) {\n console.log(participationBreakdown);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.participations.listBreakdownByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByID(\n 0,\n)) {\n console.log(participationBreakdown.id);\n}", + }, + python: { + method: 'marketing.marketing_events.participations.list_breakdown_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_id(\n marketing_event_id=0,\n)\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().marketingEvents().participations().listBreakdownById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByIdPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByIdPage page = client.marketing().marketingEvents().participations().listBreakdownById(0L);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByID(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.MarketingEventParticipationListBreakdownByIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.participations.list_breakdown_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_id(0)\n\nputs(page)', + }, + php: { + method: 'marketing->marketingEvents->participations->listBreakdownByID', + example: + "marketing->marketingEvents->participations->listBreakdownByID(\n 0,\n after: 'after',\n contactIdentifier: 'contactIdentifier',\n limit: 0,\n state: 'state',\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$MARKETING_EVENT_ID/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create_or_update', + endpoint: '/marketing/marketing-events/2026-03/{appId}/settings', + httpMethod: 'post', + summary: 'Update the application settings', + description: 'Create or update the current settings for the application.', + stainlessPath: '(resource) marketing.marketing_events.settings > (method) create_or_update', + qualified: 'client.marketing.marketingEvents.settings.createOrUpdate', + params: ['appId: number;', 'eventDetailsUrl: string;'], + response: '{ appId: number; eventDetailsUrl: string; }', + markdown: + "## create_or_update\n\n`client.marketing.marketingEvents.settings.createOrUpdate(appId: number, eventDetailsUrl: string): { appId: number; eventDetailsUrl: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{appId}/settings`\n\nCreate or update the current settings for the application.\n\n### Parameters\n\n- `appId: number`\n\n- `eventDetailsUrl: string`\n The url that will be used to fetch marketing event details by id. Must contain a `%s` character sequence that will be substituted with the event id. For example: `https://my.event.app/events/%s`\n\n### Returns\n\n- `{ appId: number; eventDetailsUrl: string; }`\n\n - `appId: number`\n - `eventDetailsUrl: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.createOrUpdate(0, { eventDetailsUrl: 'eventDetailsUrl' });\n\nconsole.log(eventDetailSettings);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.settings.createOrUpdate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.createOrUpdate(0, {\n eventDetailsUrl: 'eventDetailsUrl',\n});\n\nconsole.log(eventDetailSettings.appId);", + }, + python: { + method: 'marketing.marketing_events.settings.create_or_update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_detail_settings = client.marketing.marketing_events.settings.create_or_update(\n app_id=0,\n event_details_url="eventDetailsUrl",\n)\nprint(event_detail_settings.app_id)', + }, + java: { + method: 'marketing().marketingEvents().settings().createOrUpdate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettings;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettingsUrl;\nimport com.hubspot.sdk.models.marketing.marketingevents.settings.SettingCreateOrUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingCreateOrUpdateParams params = SettingCreateOrUpdateParams.builder()\n .appId(0)\n .eventDetailSettingsUrl(EventDetailSettingsUrl.builder()\n .eventDetailsUrl("eventDetailsUrl")\n .build())\n .build();\n EventDetailSettings eventDetailSettings = client.marketing().marketingEvents().settings().createOrUpdate(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Settings.NewOrUpdate', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventDetailSettings, err := client.Marketing.MarketingEvents.Settings.NewOrUpdate(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.MarketingEventSettingNewOrUpdateParams{\n\t\t\tEventDetailSettingsURL: marketing.EventDetailSettingsURLParam{\n\t\t\t\tEventDetailsURL: "eventDetailsUrl",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventDetailSettings.AppID)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.settings.create_or_update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_detail_settings = hubspot.marketing.marketing_events.settings.create_or_update(0, event_details_url: "eventDetailsUrl")\n\nputs(event_detail_settings)', + }, + php: { + method: 'marketing->marketingEvents->settings->createOrUpdate', + example: + "marketing\n ->marketingEvents\n ->settings\n ->createOrUpdate(0, eventDetailsURL: 'eventDetailsUrl');\n\nvar_dump($eventDetailSettings);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$APP_ID/settings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventDetailsUrl": "eventDetailsUrl"\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/marketing-events/2026-03/{appId}/settings', + httpMethod: 'get', + summary: 'Retrieve the application settings', + description: 'Retrieve the current settings for the application.', + stainlessPath: '(resource) marketing.marketing_events.settings > (method) get', + qualified: 'client.marketing.marketingEvents.settings.get', + params: ['appId: number;'], + response: '{ appId: number; eventDetailsUrl: string; }', + markdown: + "## get\n\n`client.marketing.marketingEvents.settings.get(appId: number): { appId: number; eventDetailsUrl: string; }`\n\n**get** `/marketing/marketing-events/2026-03/{appId}/settings`\n\nRetrieve the current settings for the application.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ appId: number; eventDetailsUrl: string; }`\n\n - `appId: number`\n - `eventDetailsUrl: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.get(0);\n\nconsole.log(eventDetailSettings);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.settings.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.get(0);\n\nconsole.log(eventDetailSettings.appId);", + }, + python: { + method: 'marketing.marketing_events.settings.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_detail_settings = client.marketing.marketing_events.settings.get(\n 0,\n)\nprint(event_detail_settings.app_id)', + }, + java: { + method: 'marketing().marketingEvents().settings().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettings;\nimport com.hubspot.sdk.models.marketing.marketingevents.settings.SettingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventDetailSettings eventDetailSettings = client.marketing().marketingEvents().settings().get(0);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.Settings.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventDetailSettings, err := client.Marketing.MarketingEvents.Settings.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventDetailSettings.AppID)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.settings.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_detail_settings = hubspot.marketing.marketing_events.settings.get(0)\n\nputs(event_detail_settings)', + }, + php: { + method: 'marketing->marketingEvents->settings->get', + example: + "marketing->marketingEvents->settings->get(0);\n\nvar_dump($eventDetailSettings);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'record_by_email', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert', + httpMethod: 'post', + summary: 'Record a subscriber state by contact email', + description: + 'Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. ', + stainlessPath: '(resource) marketing.marketing_events.subscriber_state > (method) record_by_email', + qualified: 'client.marketing.marketingEvents.subscriberState.recordByEmail', + params: [ + 'externalEventId: string;', + 'subscriberState: string;', + 'externalAccountId: string;', + 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', + ], + response: 'string', + markdown: + "## record_by_email\n\n`client.marketing.marketingEvents.subscriberState.recordByEmail(externalEventId: string, subscriberState: string, externalAccountId: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert`\n\nRecord a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. \n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `externalAccountId: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByEmail('subscriberState', {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}],\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.subscriberState.recordByEmail', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByEmail(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'marketing.marketing_events.subscriber_state.record_by_email', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.subscriber_state.record_by_email(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'marketing().marketingEvents().subscriberState().recordByEmail', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.subscriberstate.SubscriberStateRecordByEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriberStateRecordByEmailParams params = SubscriberStateRecordByEmailParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .externalAccountId("externalAccountId")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().subscriberState().recordByEmail(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.SubscriberState.RecordByEmail', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.SubscriberState.RecordByEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventSubscriberStateRecordByEmailParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.subscriber_state.record_by_email', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.subscriber_state.record_by_email(\n "subscriberState",\n external_event_id: "externalEventId",\n external_account_id: "externalAccountId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(response)', + }, + php: { + method: 'marketing->marketingEvents->subscriberState->recordByEmail', + example: + "marketing->marketingEvents->subscriberState->recordByEmail(\n 'subscriberState',\n externalEventID: 'externalEventId',\n externalAccountID: 'externalAccountId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/email-upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', + }, + }, + }, + { + name: 'record_by_id', + endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert', + httpMethod: 'post', + summary: 'Record a subscriber state by contact ID', + description: + 'Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.', + stainlessPath: '(resource) marketing.marketing_events.subscriber_state > (method) record_by_id', + qualified: 'client.marketing.marketingEvents.subscriberState.recordByID', + params: [ + 'externalEventId: string;', + 'subscriberState: string;', + 'externalAccountId: string;', + 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', + ], + response: 'string', + markdown: + "## record_by_id\n\n`client.marketing.marketingEvents.subscriberState.recordByID(externalEventId: string, subscriberState: string, externalAccountId: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert`\n\nRecord a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `externalAccountId: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByID('subscriberState', {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}],\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.marketing.marketingEvents.subscriberState.recordByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByID(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n },\n);\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'marketing.marketing_events.subscriber_state.record_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.subscriber_state.record_by_id(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'marketing().marketingEvents().subscriberState().recordById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.subscriberstate.SubscriberStateRecordByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriberStateRecordByIdParams params = SubscriberStateRecordByIdParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .externalAccountId("externalAccountId")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().subscriberState().recordById(params);\n }\n}', + }, + go: { + method: 'client.Marketing.MarketingEvents.SubscriberState.RecordByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.SubscriberState.RecordByID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventSubscriberStateRecordByIDParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'marketing.marketing_events.subscriber_state.record_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.subscriber_state.record_by_id(\n "subscriberState",\n external_event_id: "externalEventId",\n external_account_id: "externalAccountId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(response)', + }, + php: { + method: 'marketing->marketingEvents->subscriberState->recordByID', + example: + "marketing->marketingEvents->subscriberState->recordByID(\n 'subscriberState',\n externalEventID: 'externalEventId',\n externalAccountID: 'externalAccountId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/email-campaigns/2026-03/single-send', + httpMethod: 'post', + summary: 'Send an email', + description: 'Send a template email to a specific recipient.', + stainlessPath: '(resource) marketing.single_send > (method) create', + qualified: 'client.marketing.singleSend.create', + params: [ + 'contactProperties: object;', + 'customProperties: object;', + 'emailId: number;', + 'message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; };', + ], + response: + "{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }", + markdown: + "## create\n\n`client.marketing.singleSend.create(contactProperties: object, customProperties: object, emailId: number, message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }): { status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: event_id_view; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n**post** `/marketing/email-campaigns/2026-03/single-send`\n\nSend a template email to a specific recipient.\n\n### Parameters\n\n- `contactProperties: object`\n The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.\n\n- `customProperties: object`\n The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.\n\n- `emailId: number`\n The content ID for the email, which can be found in email tool UI.\n\n- `message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }`\n - `bcc: string[]`\n List of email addresses to send as Bcc.\n - `cc: string[]`\n List of email addresses to send as Cc.\n - `replyTo: string[]`\n List of Reply-To header values for the email.\n - `from?: string`\n The From header for the email.\n - `sendId?: string`\n ID for a particular send. No more than one email will be sent per sendId.\n - `to?: string`\n The recipient of the email.\n\n### Returns\n\n- `{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `statusId: string`\n - `completedAt?: string`\n - `eventId?: { id: string; created: string; }`\n - `message?: string`\n - `requestedAt?: string`\n - `sendResult?: string`\n - `startedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst emailSendStatusView = await client.marketing.singleSend.create({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n},\n});\n\nconsole.log(emailSendStatusView);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.singleSend.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst emailSendStatusView = await client.marketing.singleSend.create({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n },\n});\n\nconsole.log(emailSendStatusView.status);", + }, + python: { + method: 'marketing.single_send.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nemail_send_status_view = client.marketing.single_send.create(\n contact_properties={\n "foo": "string"\n },\n custom_properties={\n "foo": {}\n },\n email_id=0,\n message={\n "bcc": ["string"],\n "cc": ["string"],\n "reply_to": ["string"],\n },\n)\nprint(email_send_status_view.status)', + }, + java: { + method: 'marketing().singleSend().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.EmailSendStatusView;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendEmail;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendRequestEgg;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSingleSendRequestEgg params = PublicSingleSendRequestEgg.builder()\n .contactProperties(PublicSingleSendRequestEgg.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .customProperties(PublicSingleSendRequestEgg.CustomProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .emailId(0L)\n .message(PublicSingleSendEmail.builder()\n .addBcc("string")\n .addCc("string")\n .addReplyTo("string")\n .build())\n .build();\n EmailSendStatusView emailSendStatusView = client.marketing().singleSend().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.SingleSend.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temailSendStatusView, err := client.Marketing.SingleSend.New(context.TODO(), marketing.SingleSendNewParams{\n\t\tPublicSingleSendRequestEgg: marketing.PublicSingleSendRequestEggParam{\n\t\t\tContactProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tCustomProperties: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tEmailID: 0,\n\t\t\tMessage: marketing.PublicSingleSendEmailParam{\n\t\t\t\tBcc: []string{"string"},\n\t\t\t\tCc: []string{"string"},\n\t\t\t\tReplyTo: []string{"string"},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", emailSendStatusView.Status)\n}\n', + }, + ruby: { + method: 'marketing.single_send.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nemail_send_status_view = hubspot.marketing.single_send.create(\n contact_properties: {foo: "string"},\n custom_properties: {foo: {}},\n email_id: 0,\n message: {bcc: ["string"], cc: ["string"], replyTo: ["string"]}\n)\n\nputs(email_send_status_view)', + }, + php: { + method: 'marketing->singleSend->create', + example: + "marketing->singleSend->create(\n contactProperties: ['foo' => 'string'],\n customProperties: ['foo' => (object) []],\n emailID: 0,\n message: [\n 'bcc' => ['string'],\n 'cc' => ['string'],\n 'replyTo' => ['string'],\n 'from' => 'from',\n 'sendID' => 'sendId',\n 'to' => 'to',\n ],\n);\n\nvar_dump($emailSendStatusView);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/email-campaigns/2026-03/single-send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactProperties": {\n "foo": "string"\n },\n "customProperties": {\n "foo": {}\n },\n "emailId": 0,\n "message": {\n "bcc": [\n "string"\n ],\n "cc": [\n "string"\n ],\n "replyTo": [\n "string"\n ]\n }\n }\'', + }, + }, + }, + { + name: 'send', + endpoint: '/marketing/transactional/2026-03/single-email/send', + httpMethod: 'post', + summary: 'Send a single send transactional email asynchronously.', + description: + 'Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.', + stainlessPath: '(resource) marketing.transactional.single_email > (method) send', + qualified: 'client.marketing.transactional.singleEmail.send', + params: [ + 'contactProperties: object;', + 'customProperties: object;', + 'emailId: number;', + 'message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; };', + ], + response: + "{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }", + markdown: + "## send\n\n`client.marketing.transactional.singleEmail.send(contactProperties: object, customProperties: object, emailId: number, message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }): { status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: event_id_view; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n**post** `/marketing/transactional/2026-03/single-email/send`\n\nAsynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.\n\n### Parameters\n\n- `contactProperties: object`\n The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.\n\n- `customProperties: object`\n The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.\n\n- `emailId: number`\n The content ID for the email, which can be found in email tool UI.\n\n- `message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }`\n - `bcc: string[]`\n List of email addresses to send as Bcc.\n - `cc: string[]`\n List of email addresses to send as Cc.\n - `replyTo: string[]`\n List of Reply-To header values for the email.\n - `from?: string`\n The From header for the email.\n - `sendId?: string`\n ID for a particular send. No more than one email will be sent per sendId.\n - `to?: string`\n The recipient of the email.\n\n### Returns\n\n- `{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `statusId: string`\n - `completedAt?: string`\n - `eventId?: { id: string; created: string; }`\n - `message?: string`\n - `requestedAt?: string`\n - `sendResult?: string`\n - `startedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst emailSendStatusView = await client.marketing.transactional.singleEmail.send({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n},\n});\n\nconsole.log(emailSendStatusView);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.singleEmail.send', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst emailSendStatusView = await client.marketing.transactional.singleEmail.send({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n },\n});\n\nconsole.log(emailSendStatusView.status);", + }, + python: { + method: 'marketing.transactional.single_email.send', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nemail_send_status_view = client.marketing.transactional.single_email.send(\n contact_properties={\n "foo": "string"\n },\n custom_properties={\n "foo": {}\n },\n email_id=0,\n message={\n "bcc": ["string"],\n "cc": ["string"],\n "reply_to": ["string"],\n },\n)\nprint(email_send_status_view.status)', + }, + java: { + method: 'marketing().transactional().singleEmail().send', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.EmailSendStatusView;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendEmail;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendRequestEgg;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSingleSendRequestEgg params = PublicSingleSendRequestEgg.builder()\n .contactProperties(PublicSingleSendRequestEgg.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .customProperties(PublicSingleSendRequestEgg.CustomProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .emailId(0L)\n .message(PublicSingleSendEmail.builder()\n .addBcc("string")\n .addCc("string")\n .addReplyTo("string")\n .build())\n .build();\n EmailSendStatusView emailSendStatusView = client.marketing().transactional().singleEmail().send(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SingleEmail.Send', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temailSendStatusView, err := client.Marketing.Transactional.SingleEmail.Send(context.TODO(), marketing.TransactionalSingleEmailSendParams{\n\t\tPublicSingleSendRequestEgg: marketing.PublicSingleSendRequestEggParam{\n\t\t\tContactProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tCustomProperties: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tEmailID: 0,\n\t\t\tMessage: marketing.PublicSingleSendEmailParam{\n\t\t\t\tBcc: []string{"string"},\n\t\t\t\tCc: []string{"string"},\n\t\t\t\tReplyTo: []string{"string"},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", emailSendStatusView.Status)\n}\n', + }, + ruby: { + method: 'marketing.transactional.single_email.send_', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nemail_send_status_view = hubspot.marketing.transactional.single_email.send_(\n contact_properties: {foo: "string"},\n custom_properties: {foo: {}},\n email_id: 0,\n message: {bcc: ["string"], cc: ["string"], replyTo: ["string"]}\n)\n\nputs(email_send_status_view)', + }, + php: { + method: 'marketing->transactional->singleEmail->send', + example: + "marketing->transactional->singleEmail->send(\n contactProperties: ['foo' => 'string'],\n customProperties: ['foo' => (object) []],\n emailID: 0,\n message: [\n 'bcc' => ['string'],\n 'cc' => ['string'],\n 'replyTo' => ['string'],\n 'from' => 'from',\n 'sendID' => 'sendId',\n 'to' => 'to',\n ],\n);\n\nvar_dump($emailSendStatusView);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/single-email/send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactProperties": {\n "foo": "string"\n },\n "customProperties": {\n "foo": {}\n },\n "emailId": 0,\n "message": {\n "bcc": [\n "string"\n ],\n "cc": [\n "string"\n ],\n "replyTo": [\n "string"\n ]\n }\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/marketing/transactional/2026-03/smtp-tokens', + httpMethod: 'post', + summary: 'Create a SMTP API token.', + description: 'Create a SMTP API token.', + stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) create', + qualified: 'client.marketing.transactional.smtpTokens.create', + params: ['campaignName: string;', 'createContact: boolean;'], + response: + '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', + markdown: + "## create\n\n`client.marketing.transactional.smtpTokens.create(campaignName: string, createContact: boolean): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**post** `/marketing/transactional/2026-03/smtp-tokens`\n\nCreate a SMTP API token.\n\n### Parameters\n\n- `campaignName: string`\n A name for the campaign tied to the SMTP API token.\n\n- `createContact: boolean`\n Indicates whether a contact should be created for email recipients.\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.create({ campaignName: 'campaignName', createContact: true });\n\nconsole.log(smtpAPITokenView);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.smtpTokens.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.create({\n campaignName: 'campaignName',\n createContact: true,\n});\n\nconsole.log(smtpAPITokenView.id);", + }, + python: { + method: 'marketing.transactional.smtp_tokens.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.create(\n campaign_name="campaignName",\n create_contact=True,\n)\nprint(smtp_api_token_view.id)', + }, + java: { + method: 'marketing().transactional().smtpTokens().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenRequestEgg;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenRequestEgg params = SmtpApiTokenRequestEgg.builder()\n .campaignName("campaignName")\n .createContact(true)\n .build();\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().create(params);\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SmtpTokens.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.New(context.TODO(), marketing.TransactionalSmtpTokenNewParams{\n\t\tSmtpAPITokenRequestEgg: marketing.SmtpAPITokenRequestEggParam{\n\t\t\tCampaignName: "campaignName",\n\t\t\tCreateContact: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', + }, + ruby: { + method: 'marketing.transactional.smtp_tokens.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.create(campaign_name: "campaignName", create_contact: true)\n\nputs(smtp_api_token_view)', + }, + php: { + method: 'marketing->transactional->smtpTokens->create', + example: + "marketing->transactional->smtpTokens->create(\n campaignName: 'campaignName', createContact: true\n);\n\nvar_dump($smtpAPITokenView);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "campaignName": "campaignName",\n "createContact": true\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', + httpMethod: 'delete', + summary: 'Delete a single token by ID.', + description: 'Delete a single token by ID.', + stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) delete', + qualified: 'client.marketing.transactional.smtpTokens.delete', + params: ['tokenId: string;'], + markdown: + "## delete\n\n`client.marketing.transactional.smtpTokens.delete(tokenId: string): void`\n\n**delete** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}`\n\nDelete a single token by ID.\n\n### Parameters\n\n- `tokenId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.transactional.smtpTokens.delete('tokenId')\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.smtpTokens.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.transactional.smtpTokens.delete('tokenId');", + }, + python: { + method: 'marketing.transactional.smtp_tokens.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.transactional.smtp_tokens.delete(\n "tokenId",\n)', + }, + java: { + method: 'marketing().transactional().smtpTokens().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().transactional().smtpTokens().delete("tokenId");\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SmtpTokens.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Transactional.SmtpTokens.Delete(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'marketing.transactional.smtp_tokens.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.transactional.smtp_tokens.delete("tokenId")\n\nputs(result)', + }, + php: { + method: 'marketing->transactional->smtpTokens->delete', + example: + "marketing->transactional->smtpTokens->delete('tokenId');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', + httpMethod: 'get', + summary: 'Query a single token by ID.', + description: 'Query a single token by ID.', + stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) get', + qualified: 'client.marketing.transactional.smtpTokens.get', + params: ['tokenId: string;'], + response: + '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', + markdown: + "## get\n\n`client.marketing.transactional.smtpTokens.get(tokenId: string): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**get** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}`\n\nQuery a single token by ID.\n\n### Parameters\n\n- `tokenId: string`\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.get('tokenId');\n\nconsole.log(smtpAPITokenView);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.smtpTokens.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.get('tokenId');\n\nconsole.log(smtpAPITokenView.id);", + }, + python: { + method: 'marketing.transactional.smtp_tokens.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.get(\n "tokenId",\n)\nprint(smtp_api_token_view.id)', + }, + java: { + method: 'marketing().transactional().smtpTokens().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().get("tokenId");\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SmtpTokens.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.Get(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', + }, + ruby: { + method: 'marketing.transactional.smtp_tokens.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.get("tokenId")\n\nputs(smtp_api_token_view)', + }, + php: { + method: 'marketing->transactional->smtpTokens->get', + example: + "marketing->transactional->smtpTokens->get(\n 'tokenId'\n);\n\nvar_dump($smtpAPITokenView);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/marketing/transactional/2026-03/smtp-tokens', + httpMethod: 'get', + summary: 'Query SMTP API tokens by campaign name or an emailCampaignId.', + description: 'Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.', + stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) list', + qualified: 'client.marketing.transactional.smtpTokens.list', + params: ['after?: string;', 'campaignName?: string;', 'emailCampaignId?: string;', 'limit?: number;'], + response: + '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', + markdown: + "## list\n\n`client.marketing.transactional.smtpTokens.list(after?: string, campaignName?: string, emailCampaignId?: string, limit?: number): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**get** `/marketing/transactional/2026-03/smtp-tokens`\n\nQuery multiple SMTP API tokens by campaign name or a single token by emailCampaignId.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `campaignName?: string`\n\n- `emailCampaignId?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const smtpAPITokenView of client.marketing.transactional.smtpTokens.list()) {\n console.log(smtpAPITokenView);\n}\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.smtpTokens.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const smtpAPITokenView of client.marketing.transactional.smtpTokens.list()) {\n console.log(smtpAPITokenView.id);\n}", + }, + python: { + method: 'marketing.transactional.smtp_tokens.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.transactional.smtp_tokens.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'marketing().transactional().smtpTokens().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenListPage;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpTokenListPage page = client.marketing().transactional().smtpTokens().list();\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SmtpTokens.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Transactional.SmtpTokens.List(context.TODO(), marketing.TransactionalSmtpTokenListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'marketing.transactional.smtp_tokens.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.transactional.smtp_tokens.list\n\nputs(page)', + }, + php: { + method: 'marketing->transactional->smtpTokens->list', + example: + "marketing->transactional->smtpTokens->list(\n after: 'after',\n campaignName: 'campaignName',\n emailCampaignID: 'emailCampaignId',\n limit: 0,\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'reset_password', + endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset', + httpMethod: 'post', + summary: 'Reset the password of an existing token.', + description: + 'Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.', + stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) reset_password', + qualified: 'client.marketing.transactional.smtpTokens.resetPassword', + params: ['tokenId: string;'], + response: + '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', + markdown: + "## reset_password\n\n`client.marketing.transactional.smtpTokens.resetPassword(tokenId: string): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**post** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset`\n\nAllows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.\n\n### Parameters\n\n- `tokenId: string`\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.resetPassword('tokenId');\n\nconsole.log(smtpAPITokenView);\n```", + perLanguage: { + typescript: { + method: 'client.marketing.transactional.smtpTokens.resetPassword', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.resetPassword('tokenId');\n\nconsole.log(smtpAPITokenView.id);", + }, + python: { + method: 'marketing.transactional.smtp_tokens.reset_password', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.reset_password(\n "tokenId",\n)\nprint(smtp_api_token_view.id)', + }, + java: { + method: 'marketing().transactional().smtpTokens().resetPassword', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenResetPasswordParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().resetPassword("tokenId");\n }\n}', + }, + go: { + method: 'client.Marketing.Transactional.SmtpTokens.ResetPassword', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.ResetPassword(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', + }, + ruby: { + method: 'marketing.transactional.smtp_tokens.reset_password', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.reset_password("tokenId")\n\nputs(smtp_api_token_view)', + }, + php: { + method: 'marketing->transactional->smtpTokens->resetPassword', + example: + "marketing\n ->transactional\n ->smtpTokens\n ->resetPassword('tokenId');\n\nvar_dump($smtpAPITokenView);", + }, + http: { + example: + 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID/password-reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/meta/network-origins/2026-03/ip-ranges', + httpMethod: 'get', + summary: 'Retrieve IP ranges', + description: + 'Retrieve a collection of IP ranges associated with specific services and directions, such as `EMAIL`, `API`, `DNS`, or `WEB_SCRAPING`. The response includes details like CIDR notation, description, and the direction of IP traffic.', + stainlessPath: '(resource) meta.origins.ip_ranges > (method) list', + qualified: 'client.meta.origins.ipRanges.list', + params: [ + "direction?: 'INGRESS' | 'EGRESS'[];", + "service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[];", + ], + response: + "{ results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]; }", + markdown: + "## list\n\n`client.meta.origins.ipRanges.list(direction?: 'INGRESS' | 'EGRESS'[], service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]): { results: ip_range[]; }`\n\n**get** `/meta/network-origins/2026-03/ip-ranges`\n\nRetrieve a collection of IP ranges associated with specific services and directions, such as `EMAIL`, `API`, `DNS`, or `WEB_SCRAPING`. The response includes details like CIDR notation, description, and the direction of IP traffic.\n\n### Parameters\n\n- `direction?: 'INGRESS' | 'EGRESS'[]`\n\n- `service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]`\n\n### Returns\n\n- `{ results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]; }`\n\n - `results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseIPRangeNoPaging = await client.meta.origins.ipRanges.list();\n\nconsole.log(collectionResponseIPRangeNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.meta.origins.ipRanges.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseIPRangeNoPaging = await client.meta.origins.ipRanges.list();\n\nconsole.log(collectionResponseIPRangeNoPaging.results);", + }, + python: { + method: 'meta.origins.ip_ranges.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_ip_range_no_paging = client.meta.origins.ip_ranges.list()\nprint(collection_response_ip_range_no_paging.results)', + }, + java: { + method: 'meta().origins().ipRanges().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.meta.origins.CollectionResponseIpRangeNoPaging;\nimport com.hubspot.sdk.models.meta.origins.ipranges.IpRangeListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseIpRangeNoPaging collectionResponseIpRangeNoPaging = client.meta().origins().ipRanges().list();\n }\n}', + }, + go: { + method: 'client.Meta.Origins.IPRanges.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/meta"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseIPRangeNoPaging, err := client.Meta.Origins.IPRanges.List(context.TODO(), meta.OriginIPRangeListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseIPRangeNoPaging.Results)\n}\n', + }, + ruby: { + method: 'meta.origins.ip_ranges.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_ip_range_no_paging = hubspot.meta.origins.ip_ranges.list\n\nputs(collection_response_ip_range_no_paging)', + }, + php: { + method: 'meta->origins->ipRanges->list', + example: + "meta->origins->ipRanges->list(\n direction: ['INGRESS'], service: ['EMAIL']\n);\n\nvar_dump($collectionResponseIPRangeNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/meta/network-origins/2026-03/ip-ranges \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_simple', + endpoint: '/meta/network-origins/2026-03/ip-ranges/simple', + httpMethod: 'get', + summary: 'Retrieve simple list', + description: + 'Retrieve a simplified list of IP ranges for specified services and directions in plain text format. This endpoint provides a straightforward representation of IP ranges without additional metadata.', + stainlessPath: '(resource) meta.origins.ip_ranges > (method) list_simple', + qualified: 'client.meta.origins.ipRanges.listSimple', + params: [ + "direction?: 'INGRESS' | 'EGRESS'[];", + "service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[];", + ], + response: 'string', + markdown: + "## list_simple\n\n`client.meta.origins.ipRanges.listSimple(direction?: 'INGRESS' | 'EGRESS'[], service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]): string`\n\n**get** `/meta/network-origins/2026-03/ip-ranges/simple`\n\nRetrieve a simplified list of IP ranges for specified services and directions in plain text format. This endpoint provides a straightforward representation of IP ranges without additional metadata.\n\n### Parameters\n\n- `direction?: 'INGRESS' | 'EGRESS'[]`\n\n- `service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.meta.origins.ipRanges.listSimple();\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.meta.origins.ipRanges.listSimple', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.meta.origins.ipRanges.listSimple();\n\nconsole.log(response);", + }, + python: { + method: 'meta.origins.ip_ranges.list_simple', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.meta.origins.ip_ranges.list_simple()\nprint(response)', + }, + java: { + method: 'meta().origins().ipRanges().listSimple', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.meta.origins.ipranges.IpRangeListSimpleParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n String response = client.meta().origins().ipRanges().listSimple();\n }\n}', + }, + go: { + method: 'client.Meta.Origins.IPRanges.ListSimple', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/meta"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Meta.Origins.IPRanges.ListSimple(context.TODO(), meta.OriginIPRangeListSimpleParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'meta.origins.ip_ranges.list_simple', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.meta.origins.ip_ranges.list_simple\n\nputs(response)', + }, + php: { + method: 'meta->origins->ipRanges->listSimple', + example: + "meta->origins->ipRanges->listSimple(\n direction: ['INGRESS'], service: ['EMAIL']\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/meta/network-origins/2026-03/ip-ranges/simple \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'book', + endpoint: '/scheduler/2026-03/meetings/meeting-links/book', + httpMethod: 'post', + summary: 'Book a meeting\n', + description: 'Book a meeting for a specified meeting page.', + stainlessPath: '(resource) scheduler.meetings.advanced > (method) book', + qualified: 'client.scheduler.meetings.advanced.book', + params: [ + 'duration: number;', + 'email: string;', + 'firstName: string;', + 'formFields: { name: string; value: string; }[];', + 'lastName: string;', + 'legalConsentResponses: { communicationTypeId: string; consented: boolean; }[];', + 'likelyAvailableUserIds: string[];', + 'slug: string;', + 'startTime: string;', + 'locale?: string;', + 'timezone?: string;', + ], + response: + '{ bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }', + markdown: + "## book\n\n`client.scheduler.meetings.advanced.book(duration: number, email: string, firstName: string, formFields: { name: string; value: string; }[], lastName: string, legalConsentResponses: { communicationTypeId: string; consented: boolean; }[], likelyAvailableUserIds: string[], slug: string, startTime: string, locale?: string, timezone?: string): { bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: external_validated_form_field[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: external_legal_consent_response[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }`\n\n**post** `/scheduler/2026-03/meetings/meeting-links/book`\n\nBook a meeting for a specified meeting page.\n\n### Parameters\n\n- `duration: number`\n The duration of the meeting in milliseconds.\n\n- `email: string`\n The email address of the person booking the meeting.\n\n- `firstName: string`\n The first name of the person booking the meeting.\n\n- `formFields: { name: string; value: string; }[]`\n\n- `lastName: string`\n The last name of the person booking the meeting.\n\n- `legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]`\n\n- `likelyAvailableUserIds: string[]`\n\n- `slug: string`\n The unique path identifier for the meeting page.\n\n- `startTime: string`\n The date and time when the meeting is scheduled to start, in ISO 8601 format.\n\n- `locale?: string`\n The locale used for formatting dates and times in the meeting booking.\n\n- `timezone?: string`\n The timezone in which the meeting is scheduled.\n\n### Returns\n\n- `{ bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }`\n\n - `bookingTimezone: string`\n - `calendarEventId: string`\n - `contactId: string`\n - `duration: number`\n - `end: string`\n - `formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]`\n - `guestEmails: string[]`\n - `isOffline: boolean`\n - `legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]`\n - `start: string`\n - `subject: string`\n - `locale?: string`\n - `location?: string`\n - `webConferenceMeetingId?: string`\n - `webConferenceUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalMeetingBookingResponse = await client.scheduler.meetings.advanced.book({\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [{ name: 'name', value: 'value' }],\n lastName: 'lastName',\n legalConsentResponses: [{ communicationTypeId: 'communicationTypeId', consented: true }],\n likelyAvailableUserIds: ['string'],\n slug: 'slug',\n startTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(externalMeetingBookingResponse);\n```", + perLanguage: { + typescript: { + method: 'client.scheduler.meetings.advanced.book', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalMeetingBookingResponse = await client.scheduler.meetings.advanced.book({\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [{ name: 'name', value: 'value' }],\n lastName: 'lastName',\n legalConsentResponses: [{ communicationTypeId: 'communicationTypeId', consented: true }],\n likelyAvailableUserIds: ['string'],\n slug: 'slug',\n startTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(externalMeetingBookingResponse.bookingTimezone);", + }, + python: { + method: 'scheduler.meetings.advanced.book', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_meeting_booking_response = client.scheduler.meetings.advanced.book(\n duration=0,\n email="email",\n first_name="firstName",\n form_fields=[{\n "name": "name",\n "value": "value",\n }],\n last_name="lastName",\n legal_consent_responses=[{\n "communication_type_id": "communicationTypeId",\n "consented": True,\n }],\n likely_available_user_ids=["string"],\n slug="slug",\n start_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(external_meeting_booking_response.booking_timezone)', + }, + java: { + method: 'scheduler().meetings().advanced().book', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalBookingFormField;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalLegalConsentResponse;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalMeetingBooking;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalMeetingBookingResponse;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalMeetingBooking params = ExternalMeetingBooking.builder()\n .duration(0L)\n .email("email")\n .firstName("firstName")\n .addFormField(ExternalBookingFormField.builder()\n .name("name")\n .value("value")\n .build())\n .lastName("lastName")\n .addLegalConsentResponse(ExternalLegalConsentResponse.builder()\n .communicationTypeId("communicationTypeId")\n .consented(true)\n .build())\n .addLikelyAvailableUserId("string")\n .slug("slug")\n .startTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n ExternalMeetingBookingResponse externalMeetingBookingResponse = client.scheduler().meetings().advanced().book(params);\n }\n}', + }, + go: { + method: 'client.Scheduler.Meetings.Advanced.Book', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalMeetingBookingResponse, err := client.Scheduler.Meetings.Advanced.Book(context.TODO(), scheduler.MeetingAdvancedBookParams{\n\t\tExternalMeetingBooking: scheduler.ExternalMeetingBookingParam{\n\t\t\tDuration: 0,\n\t\t\tEmail: "email",\n\t\t\tFirstName: "firstName",\n\t\t\tFormFields: []scheduler.ExternalBookingFormFieldParam{{\n\t\t\t\tName: "name",\n\t\t\t\tValue: "value",\n\t\t\t}},\n\t\t\tLastName: "lastName",\n\t\t\tLegalConsentResponses: []scheduler.ExternalLegalConsentResponseParam{{\n\t\t\t\tCommunicationTypeID: "communicationTypeId",\n\t\t\t\tConsented: true,\n\t\t\t}},\n\t\t\tLikelyAvailableUserIDs: []string{"string"},\n\t\t\tSlug: "slug",\n\t\t\tStartTime: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalMeetingBookingResponse.BookingTimezone)\n}\n', + }, + ruby: { + method: 'scheduler.meetings.advanced.book', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_meeting_booking_response = hubspot.scheduler.meetings.advanced.book(\n duration: 0,\n email: "email",\n first_name: "firstName",\n form_fields: [{name: "name", value: "value"}],\n last_name: "lastName",\n legal_consent_responses: [{communicationTypeId: "communicationTypeId", consented: true}],\n likely_available_user_ids: ["string"],\n slug: "slug",\n start_time: "2019-12-27T18:11:19.117Z"\n)\n\nputs(external_meeting_booking_response)', + }, + php: { + method: 'scheduler->meetings->advanced->book', + example: + "scheduler->meetings->advanced->book(\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [['name' => 'name', 'value' => 'value']],\n lastName: 'lastName',\n legalConsentResponses: [\n ['communicationTypeID' => 'communicationTypeId', 'consented' => true]\n ],\n likelyAvailableUserIDs: ['string'],\n slug: 'slug',\n startTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n locale: 'locale',\n timezone: 'timezone',\n);\n\nvar_dump($externalMeetingBookingResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "duration": 0,\n "email": "email",\n "firstName": "firstName",\n "formFields": [\n {\n "name": "name",\n "value": "value"\n }\n ],\n "lastName": "lastName",\n "legalConsentResponses": [\n {\n "communicationTypeId": "communicationTypeId",\n "consented": true\n }\n ],\n "likelyAvailableUserIds": [\n "string"\n ],\n "slug": "slug",\n "startTime": "2019-12-27T18:11:19.117Z"\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/scheduler/2026-03/meetings/calendar', + httpMethod: 'post', + summary: 'Create a new calendar meeting event.', + description: + 'Create a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone.', + stainlessPath: '(resource) scheduler.meetings.advanced > (method) create', + qualified: 'client.scheduler.meetings.advanced.create', + params: [ + 'organizerUserId: string;', + "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", + "emailReminderSchedule: { reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]; shouldIncludeInviteDescription: boolean; };", + "properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; };", + 'timezone: string;', + ], + response: + "{ id: string; createdAt: string; lastUpdatedAt: string; properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }; }", + markdown: + "## create\n\n`client.scheduler.meetings.advanced.create(organizerUserId: string, associations: { to: public_object_id; types: association_spec[]; }[], emailReminderSchedule: { reminders: external_reminder[]; shouldIncludeInviteDescription: boolean; }, properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; }, timezone: string): { id: string; createdAt: string; lastUpdatedAt: string; properties: external_calendar_meeting_event_response_properties; }`\n\n**post** `/scheduler/2026-03/meetings/calendar`\n\nCreate a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone.\n\n### Parameters\n\n- `organizerUserId: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `emailReminderSchedule: { reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]; shouldIncludeInviteDescription: boolean; }`\n - `reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]`\n - `shouldIncludeInviteDescription: boolean`\n Whether the invite description should be included in the reminder.\n\n- `properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; }`\n - `hs_meeting_end_time: string`\n The time that the meeting should end in ISO 8601 format.\n - `hs_meeting_outcome: string`\n The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.\n - `hs_meeting_start_time: string`\n The time that the meeting should start in ISO 8601 format.\n - `hs_meeting_title: string`\n The title of the meeting and calendar event.\n - `hs_timestamp: string`\n The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.\n - `hubspot_owner_id: string`\n The ownerId of the HubSpot user who will host the meeting.\n - `hs_activity_type?: string`\n The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.\n - `hs_attachment_ids?: string[]`\n - `hs_attendee_owner_ids?: string[]`\n - `hs_internal_meeting_notes?: string`\n Internal notes related to the meeting.\n - `hs_meeting_body?: string`\n The description of the meeting and calendar event.\n - `hs_meeting_location?: string`\n The physical address, virtual location, or phone number where the meeting will take place.\n - `hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'`\n The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.\n\n- `timezone: string`\n The timezone property that will be set on the meeting event.\n\n### Returns\n\n- `{ id: string; createdAt: string; lastUpdatedAt: string; properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `lastUpdatedAt: string`\n - `properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalCalenderMeetingEventResponse = await client.scheduler.meetings.advanced.create({\n organizerUserId: 'organizerUserId',\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n emailReminderSchedule: { reminders: [{ numberOfTimeUnits: 0, timeUnit: 'DAYS' }], shouldIncludeInviteDescription: true },\n properties: {\n hs_meeting_end_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_outcome: 'hs_meeting_outcome',\n hs_meeting_start_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_title: 'hs_meeting_title',\n hs_timestamp: '2019-12-27T18:11:19.117Z',\n hubspot_owner_id: 'hubspot_owner_id',\n},\n timezone: 'timezone',\n});\n\nconsole.log(externalCalenderMeetingEventResponse);\n```", + perLanguage: { + typescript: { + method: 'client.scheduler.meetings.advanced.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalCalenderMeetingEventResponse = await client.scheduler.meetings.advanced.create({\n organizerUserId: 'organizerUserId',\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n emailReminderSchedule: {\n reminders: [{ numberOfTimeUnits: 0, timeUnit: 'DAYS' }],\n shouldIncludeInviteDescription: true,\n },\n properties: {\n hs_meeting_end_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_outcome: 'hs_meeting_outcome',\n hs_meeting_start_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_title: 'hs_meeting_title',\n hs_timestamp: '2019-12-27T18:11:19.117Z',\n hubspot_owner_id: 'hubspot_owner_id',\n },\n timezone: 'timezone',\n});\n\nconsole.log(externalCalenderMeetingEventResponse.id);", + }, + python: { + method: 'scheduler.meetings.advanced.create', + example: + 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_calender_meeting_event_response = client.scheduler.meetings.advanced.create(\n organizer_user_id="organizerUserId",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n email_reminder_schedule={\n "reminders": [{\n "number_of_time_units": 0,\n "time_unit": "DAYS",\n }],\n "should_include_invite_description": True,\n },\n properties={\n "hs_meeting_end_time": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hs_meeting_outcome": "hs_meeting_outcome",\n "hs_meeting_start_time": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hs_meeting_title": "hs_meeting_title",\n "hs_timestamp": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hubspot_owner_id": "hubspot_owner_id",\n },\n timezone="timezone",\n)\nprint(external_calender_meeting_event_response.id)', + }, + java: { + method: 'scheduler().meetings().advanced().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalAssociationCreateRequest;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalendarMeetingEventCreateProperties;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalendarMeetingEventCreateRequest;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalenderMeetingEventResponse;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalEmailReminderSchedule;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalReminder;\nimport com.hubspot.sdk.models.scheduler.meetings.advanced.AdvancedCreateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AdvancedCreateParams params = AdvancedCreateParams.builder()\n .organizerUserId("organizerUserId")\n .externalCalendarMeetingEventCreateRequest(ExternalCalendarMeetingEventCreateRequest.builder()\n .addAssociation(ExternalAssociationCreateRequest.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .emailReminderSchedule(ExternalEmailReminderSchedule.builder()\n .addReminder(ExternalReminder.builder()\n .numberOfTimeUnits(0)\n .timeUnit(ExternalReminder.TimeUnit.DAYS)\n .build())\n .shouldIncludeInviteDescription(true)\n .build())\n .properties(ExternalCalendarMeetingEventCreateProperties.builder()\n .hsMeetingEndTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hsMeetingOutcome("hs_meeting_outcome")\n .hsMeetingStartTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hsMeetingTitle("hs_meeting_title")\n .hsTimestamp(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hubSpotOwnerId("hubspot_owner_id")\n .build())\n .timezone("timezone")\n .build())\n .build();\n ExternalCalenderMeetingEventResponse externalCalenderMeetingEventResponse = client.scheduler().meetings().advanced().create(params);\n }\n}', + }, + go: { + method: 'client.Scheduler.Meetings.Advanced.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalCalenderMeetingEventResponse, err := client.Scheduler.Meetings.Advanced.New(context.TODO(), scheduler.MeetingAdvancedNewParams{\n\t\tOrganizerUserID: "organizerUserId",\n\t\tExternalCalendarMeetingEventCreateRequest: scheduler.ExternalCalendarMeetingEventCreateRequestParam{\n\t\t\tAssociations: []scheduler.ExternalAssociationCreateRequestParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tEmailReminderSchedule: scheduler.ExternalEmailReminderScheduleParam{\n\t\t\t\tReminders: []scheduler.ExternalReminderParam{{\n\t\t\t\t\tNumberOfTimeUnits: 0,\n\t\t\t\t\tTimeUnit: scheduler.ExternalReminderTimeUnitDays,\n\t\t\t\t}},\n\t\t\t\tShouldIncludeInviteDescription: true,\n\t\t\t},\n\t\t\tProperties: scheduler.ExternalCalendarMeetingEventCreatePropertiesParam{\n\t\t\t\tHsMeetingEndTime: time.Now(),\n\t\t\t\tHsMeetingOutcome: "hs_meeting_outcome",\n\t\t\t\tHsMeetingStartTime: time.Now(),\n\t\t\t\tHsMeetingTitle: "hs_meeting_title",\n\t\t\t\tHsTimestamp: time.Now(),\n\t\t\t\tHubSpotOwnerID: "hubspot_owner_id",\n\t\t\t},\n\t\t\tTimezone: "timezone",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalCalenderMeetingEventResponse.ID)\n}\n', + }, + ruby: { + method: 'scheduler.meetings.advanced.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_calender_meeting_event_response = hubspot.scheduler.meetings.advanced.create(\n organizer_user_id: "organizerUserId",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n email_reminder_schedule: {reminders: [{numberOfTimeUnits: 0, timeUnit: :DAYS}], shouldIncludeInviteDescription: true},\n properties: {\n hs_meeting_end_time: "2019-12-27T18:11:19.117Z",\n hs_meeting_outcome: "hs_meeting_outcome",\n hs_meeting_start_time: "2019-12-27T18:11:19.117Z",\n hs_meeting_title: "hs_meeting_title",\n hs_timestamp: "2019-12-27T18:11:19.117Z",\n hubspot_owner_id: "hubspot_owner_id"\n },\n timezone: "timezone"\n)\n\nputs(external_calender_meeting_event_response)', + }, + php: { + method: 'scheduler->meetings->advanced->create', + example: + "scheduler\n ->meetings\n ->advanced\n ->create(\n organizerUserID: 'organizerUserId',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n emailReminderSchedule: [\n 'reminders' => [['numberOfTimeUnits' => 0, 'timeUnit' => 'DAYS']],\n 'shouldIncludeInviteDescription' => true,\n ],\n properties: [\n 'hsMeetingEndTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hsMeetingOutcome' => 'hs_meeting_outcome',\n 'hsMeetingStartTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hsMeetingTitle' => 'hs_meeting_title',\n 'hsTimestamp' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hubSpotOwnerID' => 'hubspot_owner_id',\n 'hsActivityType' => 'hs_activity_type',\n 'hsAttachmentIDs' => ['string'],\n 'hsAttendeeOwnerIDs' => ['string'],\n 'hsInternalMeetingNotes' => 'hs_internal_meeting_notes',\n 'hsMeetingBody' => 'hs_meeting_body',\n 'hsMeetingLocation' => 'hs_meeting_location',\n 'hsMeetingLocationType' => 'ADDRESS',\n ],\n timezone: 'timezone',\n);\n\nvar_dump($externalCalenderMeetingEventResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/scheduler/2026-03/meetings/calendar \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "emailReminderSchedule": {\n "reminders": [\n {\n "numberOfTimeUnits": 0,\n "timeUnit": "DAYS"\n }\n ],\n "shouldIncludeInviteDescription": true\n },\n "properties": {\n "hs_meeting_end_time": "2019-12-27T18:11:19.117Z",\n "hs_meeting_outcome": "hs_meeting_outcome",\n "hs_meeting_start_time": "2019-12-27T18:11:19.117Z",\n "hs_meeting_title": "hs_meeting_title",\n "hs_timestamp": "2019-12-27T18:11:19.117Z",\n "hubspot_owner_id": "hubspot_owner_id"\n },\n "timezone": "timezone"\n }\'', + }, + }, + }, + { + name: 'get_availability_by_slug', + endpoint: '/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}', + httpMethod: 'get', + summary: 'Get the availability for a meeting', + description: 'Get the next availability times for a meeting page.', + stainlessPath: '(resource) scheduler.meetings.basic > (method) get_availability_by_slug', + qualified: 'client.scheduler.meetings.basic.getAvailabilityBySlug', + params: ['slug: string;', 'timezone: string;', 'monthOffset?: number;'], + response: + '{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }', + markdown: + "## get_availability_by_slug\n\n`client.scheduler.meetings.basic.getAvailabilityBySlug(slug: string, timezone: string, monthOffset?: number): { allUsersBusyTimes: external_user_busy_times[]; linkAvailability?: external_link_availability; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}`\n\nGet the next availability times for a meeting page.\n\n### Parameters\n\n- `slug: string`\n\n- `timezone: string`\n\n- `monthOffset?: number`\n\n### Returns\n\n- `{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }`\n\n - `allUsersBusyTimes: { busyTimes: { end: number; start: number; }[]; isOffline: boolean; meetingsUser: { id: string; calendarProvider: 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN'; isSalesStarter: boolean; userId: string; userProfile: external_user_profile; }; }[]`\n - `linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalLinkAvailabilityAndBusyTimes = await client.scheduler.meetings.basic.getAvailabilityBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalLinkAvailabilityAndBusyTimes);\n```", + perLanguage: { + typescript: { + method: 'client.scheduler.meetings.basic.getAvailabilityBySlug', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalLinkAvailabilityAndBusyTimes =\n await client.scheduler.meetings.basic.getAvailabilityBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalLinkAvailabilityAndBusyTimes.allUsersBusyTimes);", + }, + python: { + method: 'scheduler.meetings.basic.get_availability_by_slug', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_link_availability_and_busy_times = client.scheduler.meetings.basic.get_availability_by_slug(\n slug="slug",\n timezone="timezone",\n)\nprint(external_link_availability_and_busy_times.all_users_busy_times)', + }, + java: { + method: 'scheduler().meetings().basic().getAvailabilityBySlug', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalLinkAvailabilityAndBusyTimes;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicGetAvailabilityBySlugParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicGetAvailabilityBySlugParams params = BasicGetAvailabilityBySlugParams.builder()\n .slug("slug")\n .timezone("timezone")\n .build();\n ExternalLinkAvailabilityAndBusyTimes externalLinkAvailabilityAndBusyTimes = client.scheduler().meetings().basic().getAvailabilityBySlug(params);\n }\n}', + }, + go: { + method: 'client.Scheduler.Meetings.Basic.GetAvailabilityBySlug', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalLinkAvailabilityAndBusyTimes, err := client.Scheduler.Meetings.Basic.GetAvailabilityBySlug(\n\t\tcontext.TODO(),\n\t\t"slug",\n\t\tscheduler.MeetingBasicGetAvailabilityBySlugParams{\n\t\t\tTimezone: "timezone",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalLinkAvailabilityAndBusyTimes.AllUsersBusyTimes)\n}\n', + }, + ruby: { + method: 'scheduler.meetings.basic.get_availability_by_slug', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_link_availability_and_busy_times = hubspot.scheduler.meetings.basic.get_availability_by_slug("slug", timezone: "timezone")\n\nputs(external_link_availability_and_busy_times)', + }, + php: { + method: 'scheduler->meetings->basic->getAvailabilityBySlug', + example: + "scheduler\n ->meetings\n ->basic\n ->getAvailabilityBySlug('slug', timezone: 'timezone', monthOffset: 0);\n\nvar_dump($externalLinkAvailabilityAndBusyTimes);", + }, + http: { + example: + 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book/availability-page/$SLUG \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_booking_info_by_slug', + endpoint: '/scheduler/2026-03/meetings/meeting-links/book/{slug}', + httpMethod: 'get', + summary: 'List booking information', + description: 'Get details about the initial information necessary for a meeting scheduler.', + stainlessPath: '(resource) scheduler.meetings.basic > (method) get_booking_info_by_slug', + qualified: 'client.scheduler.meetings.basic.getBookingInfoBySlug', + params: ['slug: string;', 'timezone: string;'], + response: + "{ allUsersBusyTimes: object[]; customParams: object; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: object; linkAvailability?: object; }", + markdown: + "## get_booking_info_by_slug\n\n`client.scheduler.meetings.basic.getBookingInfoBySlug(slug: string, timezone: string): { allUsersBusyTimes: external_user_busy_times[]; customParams: external_meetings_link_settings; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: external_branding_metadata; linkAvailability?: external_link_availability; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links/book/{slug}`\n\nGet details about the initial information necessary for a meeting scheduler.\n\n### Parameters\n\n- `slug: string`\n\n- `timezone: string`\n\n### Returns\n\n- `{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; customParams: { availability: object; durations: number[]; formFields: external_link_form_field[]; legalConsentEnabled: boolean; meetingBufferTime: number; ownerPrioritized: boolean; startTimeIncrementMinutes: string; weeksToAdvertise: number; customAvailabilityEndDate?: number; customAvailabilityStartDate?: number; displayInfo?: external_link_display_info; guestSettings?: external_guest_settings; language?: string; legalConsentOptions?: external_legal_consent_options; locale?: string; location?: string; redirectUrl?: string; welcomeScreenInfo?: external_meetings_welcome_screen_info; }; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: { logoAltText: string; showMarketingAd: boolean; showSalesAd: boolean; accent2Color?: string; accentColor?: string; companyAddressLine1?: string; companyAddressLine2?: string; companyAvatar?: string; companyCity?: string; companyCountry?: string; companyDomain?: string; companyName?: string; companyState?: string; companyZip?: string; logoHeight?: number; logoUrl?: string; logoWidth?: number; primaryColor?: string; secondaryColor?: string; }; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }`\n\n - `allUsersBusyTimes: { busyTimes: { end: number; start: number; }[]; isOffline: boolean; meetingsUser: { id: string; calendarProvider: 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN'; isSalesStarter: boolean; userId: string; userProfile: external_user_profile; }; }[]`\n - `customParams: { availability: object; durations: number[]; formFields: { fieldType: string; isCustom: boolean; isRequired: boolean; label: string; name: string; options: external_option[]; type: string; }[]; legalConsentEnabled: boolean; meetingBufferTime: number; ownerPrioritized: boolean; startTimeIncrementMinutes: string; weeksToAdvertise: number; customAvailabilityEndDate?: number; customAvailabilityStartDate?: number; displayInfo?: { avatar?: string; companyAvatar?: string; headline?: string; publicDisplayAvatarOption?: 'COMPANY_LOGO' | 'CUSTOM_AVATAR' | 'PROFILE_IMAGE'; }; guestSettings?: { canAddGuests: boolean; maxGuestCount: number; }; language?: string; legalConsentOptions?: { communicationConsentCheckboxes: external_communication_consent_checkbox[]; communicationConsentText: string; isLegitimateInterest: boolean; legitimateInterestSubscriptionTypes: number[]; privacyPolicyText: string; processingConsentCheckboxLabel: string; processingConsentFooterText: string; processingConsentText: string; processingConsentType: 'IMPLICIT' | 'REQUIRED_CHECKBOX'; legitimateInterestLegalBasis?: string; }; locale?: string; location?: string; redirectUrl?: string; welcomeScreenInfo?: { description?: string; logoUrl?: string; showWelcomeScreen?: boolean; title?: string; useCompanyLogo?: boolean; }; }`\n - `isOffline: boolean`\n - `linkId: string`\n - `linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n - `brandingMetadata?: { logoAltText: string; showMarketingAd: boolean; showSalesAd: boolean; accent2Color?: string; accentColor?: string; companyAddressLine1?: string; companyAddressLine2?: string; companyAvatar?: string; companyCity?: string; companyCountry?: string; companyDomain?: string; companyName?: string; companyState?: string; companyZip?: string; logoHeight?: number; logoUrl?: string; logoWidth?: number; primaryColor?: string; secondaryColor?: string; }`\n - `linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBookingInfo = await client.scheduler.meetings.basic.getBookingInfoBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalBookingInfo);\n```", + perLanguage: { + typescript: { + method: 'client.scheduler.meetings.basic.getBookingInfoBySlug', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBookingInfo = await client.scheduler.meetings.basic.getBookingInfoBySlug('slug', {\n timezone: 'timezone',\n});\n\nconsole.log(externalBookingInfo.allUsersBusyTimes);", + }, + python: { + method: 'scheduler.meetings.basic.get_booking_info_by_slug', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_booking_info = client.scheduler.meetings.basic.get_booking_info_by_slug(\n slug="slug",\n timezone="timezone",\n)\nprint(external_booking_info.all_users_busy_times)', + }, + java: { + method: 'scheduler().meetings().basic().getBookingInfoBySlug', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalBookingInfo;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicGetBookingInfoBySlugParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicGetBookingInfoBySlugParams params = BasicGetBookingInfoBySlugParams.builder()\n .slug("slug")\n .timezone("timezone")\n .build();\n ExternalBookingInfo externalBookingInfo = client.scheduler().meetings().basic().getBookingInfoBySlug(params);\n }\n}', + }, + go: { + method: 'client.Scheduler.Meetings.Basic.GetBookingInfoBySlug', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBookingInfo, err := client.Scheduler.Meetings.Basic.GetBookingInfoBySlug(\n\t\tcontext.TODO(),\n\t\t"slug",\n\t\tscheduler.MeetingBasicGetBookingInfoBySlugParams{\n\t\t\tTimezone: "timezone",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBookingInfo.AllUsersBusyTimes)\n}\n', + }, + ruby: { + method: 'scheduler.meetings.basic.get_booking_info_by_slug', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_booking_info = hubspot.scheduler.meetings.basic.get_booking_info_by_slug("slug", timezone: "timezone")\n\nputs(external_booking_info)', + }, + php: { + method: 'scheduler->meetings->basic->getBookingInfoBySlug', + example: + "scheduler\n ->meetings\n ->basic\n ->getBookingInfoBySlug('slug', timezone: 'timezone');\n\nvar_dump($externalBookingInfo);", + }, + http: { + example: + 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book/$SLUG \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/scheduler/2026-03/meetings/meeting-links', + httpMethod: 'get', + summary: 'Get meeting scheduling pages', + description: 'Get a paged list meeting scheduling pages', + stainlessPath: '(resource) scheduler.meetings.basic > (method) list', + qualified: 'client.scheduler.meetings.basic.list', + params: [ + 'after?: string;', + 'limit?: number;', + 'name?: string;', + 'organizerUserId?: string;', + "type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR';", + ], + response: + "{ id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }", + markdown: + "## list\n\n`client.scheduler.meetings.basic.list(after?: string, limit?: number, name?: string, organizerUserId?: string, type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'): { id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links`\n\nGet a paged list meeting scheduling pages\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `organizerUserId?: string`\n\n- `type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n\n### Returns\n\n- `{ id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `defaultLink: boolean`\n - `link: string`\n - `organizerUserId: string`\n - `slug: string`\n - `type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n - `userIdsOfLinkMembers: string[]`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalLinkMetadata of client.scheduler.meetings.basic.list()) {\n console.log(externalLinkMetadata);\n}\n```", + perLanguage: { + typescript: { + method: 'client.scheduler.meetings.basic.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalLinkMetadata of client.scheduler.meetings.basic.list()) {\n console.log(externalLinkMetadata.id);\n}", + }, + python: { + method: 'scheduler.meetings.basic.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.scheduler.meetings.basic.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'scheduler().meetings().basic().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicListPage;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicListPage page = client.scheduler().meetings().basic().list();\n }\n}', + }, + go: { + method: 'client.Scheduler.Meetings.Basic.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Scheduler.Meetings.Basic.List(context.TODO(), scheduler.MeetingBasicListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'scheduler.meetings.basic.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.scheduler.meetings.basic.list\n\nputs(page)', + }, + php: { + method: 'scheduler->meetings->basic->list', + example: + "scheduler->meetings->basic->list(\n after: 'after',\n limit: 0,\n name: 'name',\n organizerUserID: 'organizerUserId',\n type: 'GROUP_CALENDAR',\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_company_currency', + endpoint: '/settings/currencies/2026-03/company-currency', + httpMethod: 'get', + summary: 'Get the company currency', + description: + 'Get the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals.', + stainlessPath: '(resource) settings.currencies > (method) get_company_currency', + qualified: 'client.settings.currencies.getCompanyCurrency', + response: '{ id: string; createdAt: string; }', + markdown: + "## get_company_currency\n\n`client.settings.currencies.getCompanyCurrency(): { id: string; createdAt: string; }`\n\n**get** `/settings/currencies/2026-03/company-currency`\n\nGet the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals.\n\n### Returns\n\n- `{ id: string; createdAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst companyCurrency = await client.settings.currencies.getCompanyCurrency();\n\nconsole.log(companyCurrency);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.getCompanyCurrency', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst companyCurrency = await client.settings.currencies.getCompanyCurrency();\n\nconsole.log(companyCurrency.id);", + }, + python: { + method: 'settings.currencies.get_company_currency', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompany_currency = client.settings.currencies.get_company_currency()\nprint(company_currency.id)', + }, + java: { + method: 'settings().currencies().getCompanyCurrency', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrency;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyGetCompanyCurrencyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyCurrency companyCurrency = client.settings().currencies().getCompanyCurrency();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.GetCompanyCurrency', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyCurrency, err := client.Settings.Currencies.GetCompanyCurrency(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyCurrency.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.get_company_currency', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompany_currency = hubspot.settings.currencies.get_company_currency\n\nputs(company_currency)', + }, + php: { + method: 'settings->currencies->getCompanyCurrency', + example: + "settings->currencies->getCompanyCurrency();\n\nvar_dump($companyCurrency);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/company-currency \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_codes', + endpoint: '/settings/currencies/2026-03/codes', + httpMethod: 'get', + summary: 'Get all currency codes', + description: 'Retrieve a list of all available currency codes and their names.', + stainlessPath: '(resource) settings.currencies > (method) list_codes', + qualified: 'client.settings.currencies.listCodes', + response: '{ results: { currencyCode: string; currencyName: string; }[]; }', + markdown: + "## list_codes\n\n`client.settings.currencies.listCodes(): { results: currency_code_info[]; }`\n\n**get** `/settings/currencies/2026-03/codes`\n\nRetrieve a list of all available currency codes and their names.\n\n### Returns\n\n- `{ results: { currencyCode: string; currencyName: string; }[]; }`\n\n - `results: { currencyCode: string; currencyName: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.listCodes();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.listCodes', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.listCodes();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging.results);", + }, + python: { + method: 'settings.currencies.list_codes', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_currency_code_info_no_paging = client.settings.currencies.list_codes()\nprint(collection_response_currency_code_info_no_paging.results)', + }, + java: { + method: 'settings().currencies().listCodes', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseCurrencyCodeInfoNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyListCodesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseCurrencyCodeInfoNoPaging collectionResponseCurrencyCodeInfoNoPaging = client.settings().currencies().listCodes();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ListCodes', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseCurrencyCodeInfoNoPaging, err := client.Settings.Currencies.ListCodes(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseCurrencyCodeInfoNoPaging.Results)\n}\n', + }, + ruby: { + method: 'settings.currencies.list_codes', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_currency_code_info_no_paging = hubspot.settings.currencies.list_codes\n\nputs(collection_response_currency_code_info_no_paging)', + }, + php: { + method: 'settings->currencies->listCodes', + example: + "settings\n ->currencies\n ->listCodes();\n\nvar_dump($collectionResponseCurrencyCodeInfoNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/codes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_company_currency', + endpoint: '/settings/currencies/2026-03/company-currency', + httpMethod: 'put', + summary: 'Set or update the company currency.', + description: 'Set or update the primary company currency.', + stainlessPath: '(resource) settings.currencies > (method) update_company_currency', + qualified: 'client.settings.currencies.updateCompanyCurrency', + params: ['currencyCode: string;'], + response: '{ id: string; createdAt: string; }', + markdown: + "## update_company_currency\n\n`client.settings.currencies.updateCompanyCurrency(currencyCode: string): { id: string; createdAt: string; }`\n\n**put** `/settings/currencies/2026-03/company-currency`\n\nSet or update the primary company currency.\n\n### Parameters\n\n- `currencyCode: string`\n The three-letter code representing a specific currency (ex. USD).\n\n### Returns\n\n- `{ id: string; createdAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst companyCurrency = await client.settings.currencies.updateCompanyCurrency({ currencyCode: 'AED' });\n\nconsole.log(companyCurrency);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.updateCompanyCurrency', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst companyCurrency = await client.settings.currencies.updateCompanyCurrency({\n currencyCode: 'AED',\n});\n\nconsole.log(companyCurrency.id);", + }, + python: { + method: 'settings.currencies.update_company_currency', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompany_currency = client.settings.currencies.update_company_currency(\n currency_code="AED",\n)\nprint(company_currency.id)', + }, + java: { + method: 'settings().currencies().updateCompanyCurrency', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrency;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrencyUpdateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyCurrencyUpdateRequest params = CompanyCurrencyUpdateRequest.builder()\n .currencyCode(CompanyCurrencyUpdateRequest.CurrencyCode.AED)\n .build();\n CompanyCurrency companyCurrency = client.settings().currencies().updateCompanyCurrency(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.UpdateCompanyCurrency', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyCurrency, err := client.Settings.Currencies.UpdateCompanyCurrency(context.TODO(), settings.CurrencyUpdateCompanyCurrencyParams{\n\t\tCompanyCurrencyUpdateRequest: settings.CompanyCurrencyUpdateRequestParam{\n\t\t\tCurrencyCode: settings.CompanyCurrencyUpdateRequestCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyCurrency.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.update_company_currency', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompany_currency = hubspot.settings.currencies.update_company_currency(currency_code: :AED)\n\nputs(company_currency)', + }, + php: { + method: 'settings->currencies->updateCompanyCurrency', + example: + "settings->currencies->updateCompanyCurrency(\n currencyCode: 'AED'\n);\n\nvar_dump($companyCurrency);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/company-currency \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "currencyCode": "AED"\n }\'', + }, + }, + }, + { + name: 'create_currency', + endpoint: '/settings/currencies/2026-03/central-fx-rates/add-currency', + httpMethod: 'post', + summary: 'Add a new currency with central exchange rates.', + description: + 'Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here.', + stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) create_currency', + qualified: 'client.settings.currencies.centralFxRates.createCurrency', + params: ['currencyCode: string;'], + response: + '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', + markdown: + "## create_currency\n\n`client.settings.currencies.centralFxRates.createCurrency(currencyCode: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**post** `/settings/currencies/2026-03/central-fx-rates/add-currency`\n\nCreate a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here.\n\n### Parameters\n\n- `currencyCode: string`\n The currency code being added to the HubSpot portal for use with central exchange rates.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.centralFxRates.createCurrency({ currencyCode: 'AED' });\n\nconsole.log(exchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.centralFxRates.createCurrency', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.centralFxRates.createCurrency({\n currencyCode: 'AED',\n});\n\nconsole.log(exchangeRate.id);", + }, + python: { + method: 'settings.currencies.central_fx_rates.create_currency', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.central_fx_rates.create_currency(\n currency_code="AED",\n)\nprint(exchange_rate.id)', + }, + java: { + method: 'settings().currencies().centralFxRates().createCurrency', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyCreateRequest;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CurrencyCreateRequest params = CurrencyCreateRequest.builder()\n .currencyCode(CurrencyCreateRequest.CurrencyCode.AED)\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().centralFxRates().createCurrency(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.CentralFxRates.NewCurrency', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.CentralFxRates.NewCurrency(context.TODO(), settings.CurrencyCentralFxRateNewCurrencyParams{\n\t\tCurrencyCreateRequest: settings.CurrencyCreateRequestParam{\n\t\t\tCurrencyCode: settings.CurrencyCreateRequestCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.central_fx_rates.create_currency', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.central_fx_rates.create_currency(currency_code: :AED)\n\nputs(exchange_rate)', + }, + php: { + method: 'settings->currencies->centralFxRates->createCurrency', + example: + "settings->currencies->centralFxRates->createCurrency(\n currencyCode: 'AED'\n);\n\nvar_dump($exchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/add-currency \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "currencyCode": "AED"\n }\'', + }, + }, + }, + { + name: 'get_information', + endpoint: '/settings/currencies/2026-03/central-fx-rates/information', + httpMethod: 'get', + summary: 'Retrieve information about the central exchange rates feature.', + description: 'Retrieve details on whether the central exchange rates feature is enabled for the portal.', + stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) get_information', + qualified: 'client.settings.currencies.centralFxRates.getInformation', + response: '{ centralExchangeRatesEnabled: boolean; }', + markdown: + "## get_information\n\n`client.settings.currencies.centralFxRates.getInformation(): { centralExchangeRatesEnabled: boolean; }`\n\n**get** `/settings/currencies/2026-03/central-fx-rates/information`\n\nRetrieve details on whether the central exchange rates feature is enabled for the portal.\n\n### Returns\n\n- `{ centralExchangeRatesEnabled: boolean; }`\n\n - `centralExchangeRatesEnabled: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst centralExchangeRatesInformation = await client.settings.currencies.centralFxRates.getInformation();\n\nconsole.log(centralExchangeRatesInformation);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.centralFxRates.getInformation', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst centralExchangeRatesInformation =\n await client.settings.currencies.centralFxRates.getInformation();\n\nconsole.log(centralExchangeRatesInformation.centralExchangeRatesEnabled);", + }, + python: { + method: 'settings.currencies.central_fx_rates.get_information', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncentral_exchange_rates_information = client.settings.currencies.central_fx_rates.get_information()\nprint(central_exchange_rates_information.central_exchange_rates_enabled)', + }, + java: { + method: 'settings().currencies().centralFxRates().getInformation', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CentralExchangeRatesInformation;\nimport com.hubspot.sdk.models.settings.currencies.centralfxrates.CentralFxRateGetInformationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CentralExchangeRatesInformation centralExchangeRatesInformation = client.settings().currencies().centralFxRates().getInformation();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.CentralFxRates.GetInformation', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcentralExchangeRatesInformation, err := client.Settings.Currencies.CentralFxRates.GetInformation(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", centralExchangeRatesInformation.CentralExchangeRatesEnabled)\n}\n', + }, + ruby: { + method: 'settings.currencies.central_fx_rates.get_information', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncentral_exchange_rates_information = hubspot.settings.currencies.central_fx_rates.get_information\n\nputs(central_exchange_rates_information)', + }, + php: { + method: 'settings->currencies->centralFxRates->getInformation', + example: + "settings\n ->currencies\n ->centralFxRates\n ->getInformation();\n\nvar_dump($centralExchangeRatesInformation);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/information \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_unsupported_currencies', + endpoint: '/settings/currencies/2026-03/central-fx-rates/unsupported-currencies', + httpMethod: 'get', + summary: 'Retrieve currencies not supported by central exchange rates.', + description: + 'Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated.', + stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) get_unsupported_currencies', + qualified: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', + response: '{ results: { currencyCode: string; currencyName: string; }[]; }', + markdown: + "## get_unsupported_currencies\n\n`client.settings.currencies.centralFxRates.getUnsupportedCurrencies(): { results: currency_code_info[]; }`\n\n**get** `/settings/currencies/2026-03/central-fx-rates/unsupported-currencies`\n\nRetrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated.\n\n### Returns\n\n- `{ results: { currencyCode: string; currencyName: string; }[]; }`\n\n - `results: { currencyCode: string; currencyName: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.centralFxRates.getUnsupportedCurrencies();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseCurrencyCodeInfoNoPaging =\n await client.settings.currencies.centralFxRates.getUnsupportedCurrencies();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging.results);", + }, + python: { + method: 'settings.currencies.central_fx_rates.get_unsupported_currencies', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_currency_code_info_no_paging = client.settings.currencies.central_fx_rates.get_unsupported_currencies()\nprint(collection_response_currency_code_info_no_paging.results)', + }, + java: { + method: 'settings().currencies().centralFxRates().getUnsupportedCurrencies', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseCurrencyCodeInfoNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.centralfxrates.CentralFxRateGetUnsupportedCurrenciesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseCurrencyCodeInfoNoPaging collectionResponseCurrencyCodeInfoNoPaging = client.settings().currencies().centralFxRates().getUnsupportedCurrencies();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.CentralFxRates.GetUnsupportedCurrencies', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseCurrencyCodeInfoNoPaging, err := client.Settings.Currencies.CentralFxRates.GetUnsupportedCurrencies(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseCurrencyCodeInfoNoPaging.Results)\n}\n', + }, + ruby: { + method: 'settings.currencies.central_fx_rates.get_unsupported_currencies', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_currency_code_info_no_paging = hubspot.settings.currencies.central_fx_rates.get_unsupported_currencies\n\nputs(collection_response_currency_code_info_no_paging)', + }, + php: { + method: 'settings->currencies->centralFxRates->getUnsupportedCurrencies', + example: + "settings\n ->currencies\n ->centralFxRates\n ->getUnsupportedCurrencies();\n\nvar_dump($collectionResponseCurrencyCodeInfoNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/unsupported-currencies \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create_exchange_rate', + endpoint: '/settings/currencies/2026-03/exchange-rates', + httpMethod: 'post', + summary: 'Add a new exchange rate', + description: 'Create a new exchange rate with specified conversion rate and currency codes.', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) create_exchange_rate', + qualified: 'client.settings.currencies.exchangeRates.createExchangeRate', + params: ['conversionRate: number;', 'fromCurrencyCode: string;', 'effectiveAt?: string;'], + response: + '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', + markdown: + "## create_exchange_rate\n\n`client.settings.currencies.exchangeRates.createExchangeRate(conversionRate: number, fromCurrencyCode: string, effectiveAt?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates`\n\nCreate a new exchange rate with specified conversion rate and currency codes.\n\n### Parameters\n\n- `conversionRate: number`\n The conversion rate between the to and from currency code of this exchange rate.\n\n- `fromCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from.\n\n- `effectiveAt?: string`\n The date the exchange rate is in effect.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.createExchangeRate({ conversionRate: 0, fromCurrencyCode: 'AED' });\n\nconsole.log(exchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.createExchangeRate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.createExchangeRate({\n conversionRate: 0,\n fromCurrencyCode: 'AED',\n});\n\nconsole.log(exchangeRate.id);", + }, + python: { + method: 'settings.currencies.exchange_rates.create_exchange_rate', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.create_exchange_rate(\n conversion_rate=0,\n from_currency_code="AED",\n)\nprint(exchange_rate.id)', + }, + java: { + method: 'settings().currencies().exchangeRates().createExchangeRate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateCreateRequest params = ExchangeRateCreateRequest.builder()\n .conversionRate(0.0)\n .fromCurrencyCode(ExchangeRateCreateRequest.FromCurrencyCode.AED)\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().createExchangeRate(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.NewExchangeRate', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.NewExchangeRate(context.TODO(), settings.CurrencyExchangeRateNewExchangeRateParams{\n\t\tExchangeRateCreateRequest: settings.ExchangeRateCreateRequestParam{\n\t\t\tConversionRate: 0,\n\t\t\tFromCurrencyCode: settings.ExchangeRateCreateRequestFromCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.create_exchange_rate', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.create_exchange_rate(\n conversion_rate: 0,\n from_currency_code: :AED\n)\n\nputs(exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->createExchangeRate', + example: + "settings\n ->currencies\n ->exchangeRates\n ->createExchangeRate(\n conversionRate: 0,\n fromCurrencyCode: 'AED',\n effectiveAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($exchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionRate": 0,\n "fromCurrencyCode": "AED"\n }\'', + }, + }, + }, + { + name: 'get_exchange_rate_by_id', + endpoint: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', + httpMethod: 'get', + summary: 'Get the details for a specific exchange rate', + description: 'Retrieve the details for a specific exchange rate specified by its ID.', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) get_exchange_rate_by_id', + qualified: 'client.settings.currencies.exchangeRates.getExchangeRateByID', + params: ['exchangeRateId: string;'], + response: + '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', + markdown: + "## get_exchange_rate_by_id\n\n`client.settings.currencies.exchangeRates.getExchangeRateByID(exchangeRateId: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates/{exchangeRateId}`\n\nRetrieve the details for a specific exchange rate specified by its ID.\n\n### Parameters\n\n- `exchangeRateId: string`\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.getExchangeRateByID('exchangeRateId');\n\nconsole.log(exchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.getExchangeRateByID', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.getExchangeRateByID(\n 'exchangeRateId',\n);\n\nconsole.log(exchangeRate.id);", + }, + python: { + method: 'settings.currencies.exchange_rates.get_exchange_rate_by_id', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.get_exchange_rate_by_id(\n "exchangeRateId",\n)\nprint(exchange_rate.id)', + }, + java: { + method: 'settings().currencies().exchangeRates().getExchangeRateById', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateGetExchangeRateByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().getExchangeRateById("exchangeRateId");\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.GetExchangeRateByID', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.GetExchangeRateByID(context.TODO(), "exchangeRateId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.get_exchange_rate_by_id', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.get_exchange_rate_by_id("exchangeRateId")\n\nputs(exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->getExchangeRateByID', + example: + "settings\n ->currencies\n ->exchangeRates\n ->getExchangeRateByID('exchangeRateId');\n\nvar_dump($exchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/$EXCHANGE_RATE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_current_exchange_rates', + endpoint: '/settings/currencies/2026-03/exchange-rates/current', + httpMethod: 'get', + summary: 'Get all current exchange rates', + description: 'Retrieve all current exchange rates for all currency pairs.', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) list_current_exchange_rates', + qualified: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', + response: + '{ results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; }', + markdown: + "## list_current_exchange_rates\n\n`client.settings.currencies.exchangeRates.listCurrentExchangeRates(): { results: exchange_rate[]; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates/current`\n\nRetrieve all current exchange rates for all currency pairs.\n\n### Returns\n\n- `{ results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; }`\n\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseExchangeRateNoPaging = await client.settings.currencies.exchangeRates.listCurrentExchangeRates();\n\nconsole.log(collectionResponseExchangeRateNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseExchangeRateNoPaging =\n await client.settings.currencies.exchangeRates.listCurrentExchangeRates();\n\nconsole.log(collectionResponseExchangeRateNoPaging.results);", + }, + python: { + method: 'settings.currencies.exchange_rates.list_current_exchange_rates', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_exchange_rate_no_paging = client.settings.currencies.exchange_rates.list_current_exchange_rates()\nprint(collection_response_exchange_rate_no_paging.results)', + }, + java: { + method: 'settings().currencies().exchangeRates().listCurrentExchangeRates', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseExchangeRateNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListCurrentExchangeRatesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseExchangeRateNoPaging collectionResponseExchangeRateNoPaging = client.settings().currencies().exchangeRates().listCurrentExchangeRates();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.ListCurrentExchangeRates', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseExchangeRateNoPaging, err := client.Settings.Currencies.ExchangeRates.ListCurrentExchangeRates(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseExchangeRateNoPaging.Results)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.list_current_exchange_rates', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_exchange_rate_no_paging = hubspot.settings.currencies.exchange_rates.list_current_exchange_rates\n\nputs(collection_response_exchange_rate_no_paging)', + }, + php: { + method: 'settings->currencies->exchangeRates->listCurrentExchangeRates', + example: + "settings\n ->currencies\n ->exchangeRates\n ->listCurrentExchangeRates();\n\nvar_dump($collectionResponseExchangeRateNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/current \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_exchange_rates', + endpoint: '/settings/currencies/2026-03/exchange-rates', + httpMethod: 'get', + summary: 'Get exchange rates', + description: 'Get a list of exchange rates', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) list_exchange_rates', + qualified: 'client.settings.currencies.exchangeRates.listExchangeRates', + params: ['after?: string;', 'fromCurrencyCode?: string;', 'limit?: number;', 'toCurrencyCode?: string;'], + response: + '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', + markdown: + "## list_exchange_rates\n\n`client.settings.currencies.exchangeRates.listExchangeRates(after?: string, fromCurrencyCode?: string, limit?: number, toCurrencyCode?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates`\n\nGet a list of exchange rates\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fromCurrencyCode?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `toCurrencyCode?: string`\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const exchangeRate of client.settings.currencies.exchangeRates.listExchangeRates()) {\n console.log(exchangeRate);\n}\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.listExchangeRates', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const exchangeRate of client.settings.currencies.exchangeRates.listExchangeRates()) {\n console.log(exchangeRate.id);\n}", + }, + python: { + method: 'settings.currencies.exchange_rates.list_exchange_rates', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.currencies.exchange_rates.list_exchange_rates()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'settings().currencies().exchangeRates().listExchangeRates', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListExchangeRatesPage;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListExchangeRatesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateListExchangeRatesPage page = client.settings().currencies().exchangeRates().listExchangeRates();\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.ListExchangeRates', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.Currencies.ExchangeRates.ListExchangeRates(context.TODO(), settings.CurrencyExchangeRateListExchangeRatesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.list_exchange_rates', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.currencies.exchange_rates.list_exchange_rates\n\nputs(page)', + }, + php: { + method: 'settings->currencies->exchangeRates->listExchangeRates', + example: + "settings->currencies->exchangeRates->listExchangeRates(\n after: 'after', fromCurrencyCode: 'AED', limit: 0, toCurrencyCode: 'AED'\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_exchange_rate', + endpoint: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', + httpMethod: 'patch', + summary: 'Update a conversion rate', + description: 'Update an existing conversion rate, specified by its ID.', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) update_exchange_rate', + qualified: 'client.settings.currencies.exchangeRates.updateExchangeRate', + params: ['exchangeRateId: string;', 'conversionRate: number;', 'effectiveAt?: string;'], + response: + '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', + markdown: + "## update_exchange_rate\n\n`client.settings.currencies.exchangeRates.updateExchangeRate(exchangeRateId: string, conversionRate: number, effectiveAt?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**patch** `/settings/currencies/2026-03/exchange-rates/{exchangeRateId}`\n\nUpdate an existing conversion rate, specified by its ID.\n\n### Parameters\n\n- `exchangeRateId: string`\n\n- `conversionRate: number`\n The updated conversion rate between the to and from currency code of this exchange rate.\n\n- `effectiveAt?: string`\n The date the exchange rate is in effect.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.updateExchangeRate('exchangeRateId', { conversionRate: 0 });\n\nconsole.log(exchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.updateExchangeRate', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.updateExchangeRate(\n 'exchangeRateId',\n { conversionRate: 0 },\n);\n\nconsole.log(exchangeRate.id);", + }, + python: { + method: 'settings.currencies.exchange_rates.update_exchange_rate', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.update_exchange_rate(\n exchange_rate_id="exchangeRateId",\n conversion_rate=0,\n)\nprint(exchange_rate.id)', + }, + java: { + method: 'settings().currencies().exchangeRates().updateExchangeRate', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateMultiplier;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateUpdateExchangeRateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateUpdateExchangeRateParams params = ExchangeRateUpdateExchangeRateParams.builder()\n .exchangeRateId("exchangeRateId")\n .exchangeRateMultiplier(ExchangeRateMultiplier.builder()\n .conversionRate(0.0)\n .build())\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().updateExchangeRate(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.UpdateExchangeRate', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.UpdateExchangeRate(\n\t\tcontext.TODO(),\n\t\t"exchangeRateId",\n\t\tsettings.CurrencyExchangeRateUpdateExchangeRateParams{\n\t\t\tExchangeRateMultiplier: settings.ExchangeRateMultiplierParam{\n\t\t\t\tConversionRate: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.update_exchange_rate', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.update_exchange_rate("exchangeRateId", conversion_rate: 0)\n\nputs(exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->updateExchangeRate', + example: + "settings\n ->currencies\n ->exchangeRates\n ->updateExchangeRate(\n 'exchangeRateId',\n conversionRate: 0,\n effectiveAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($exchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/$EXCHANGE_RATE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionRate": 0\n }\'', + }, + }, + }, + { + name: 'update_visibility', + endpoint: '/settings/currencies/2026-03/exchange-rates/update-visibility', + httpMethod: 'post', + summary: 'Change the visibility of a specific currency pairs', + description: + 'Change the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app.', + stainlessPath: '(resource) settings.currencies.exchange_rates > (method) update_visibility', + qualified: 'client.settings.currencies.exchangeRates.updateVisibility', + params: ['fromCurrencyCode: string;', 'toCurrencyCode: string;', 'visibleInUI: boolean;'], + markdown: + "## update_visibility\n\n`client.settings.currencies.exchangeRates.updateVisibility(fromCurrencyCode: string, toCurrencyCode: string, visibleInUI: boolean): void`\n\n**post** `/settings/currencies/2026-03/exchange-rates/update-visibility`\n\nChange the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app.\n\n### Parameters\n\n- `fromCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from.\n\n- `toCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert to.\n\n- `visibleInUI: boolean`\n This indicates if the currency pair is shown in the MultiCurrency settings page. Setting this to false will remove the currency pair from the settings page.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.settings.currencies.exchangeRates.updateVisibility({\n fromCurrencyCode: 'AED',\n toCurrencyCode: 'AED',\n visibleInUI: true,\n})\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.updateVisibility', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.settings.currencies.exchangeRates.updateVisibility({\n fromCurrencyCode: 'AED',\n toCurrencyCode: 'AED',\n visibleInUI: true,\n});", + }, + python: { + method: 'settings.currencies.exchange_rates.update_visibility', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.settings.currencies.exchange_rates.update_visibility(\n from_currency_code="AED",\n to_currency_code="AED",\n visible_in_ui=True,\n)', + }, + java: { + method: 'settings().currencies().exchangeRates().updateVisibility', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyPairUpdate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CurrencyPairUpdate params = CurrencyPairUpdate.builder()\n .fromCurrencyCode(CurrencyPairUpdate.FromCurrencyCode.AED)\n .toCurrencyCode(CurrencyPairUpdate.ToCurrencyCode.AED)\n .visibleInUi(true)\n .build();\n client.settings().currencies().exchangeRates().updateVisibility(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.UpdateVisibility', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Settings.Currencies.ExchangeRates.UpdateVisibility(context.TODO(), settings.CurrencyExchangeRateUpdateVisibilityParams{\n\t\tCurrencyPairUpdate: settings.CurrencyPairUpdateParam{\n\t\t\tFromCurrencyCode: settings.CurrencyPairUpdateFromCurrencyCodeAed,\n\t\t\tToCurrencyCode: settings.CurrencyPairUpdateToCurrencyCodeAed,\n\t\t\tVisibleInUi: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.update_visibility', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.settings.currencies.exchange_rates.update_visibility(\n from_currency_code: :AED,\n to_currency_code: :AED,\n visible_in_ui: true\n)\n\nputs(result)', + }, + php: { + method: 'settings->currencies->exchangeRates->updateVisibility', + example: + "settings->currencies->exchangeRates->updateVisibility(\n fromCurrencyCode: 'AED', toCurrencyCode: 'AED', visibleInUi: true\n);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/update-visibility \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromCurrencyCode": "AED",\n "toCurrencyCode": "AED",\n "visibleInUI": true\n }\'', + }, + }, + }, + { + name: 'create', + endpoint: '/settings/currencies/2026-03/exchange-rates/batch/create', + httpMethod: 'post', + summary: 'Create multiple exchange rates', + description: 'Create multiple exchange rates in a single request.', + stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) create', + qualified: 'client.settings.currencies.exchangeRates.batch.create', + params: ['inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[];'], + response: + "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create\n\n`client.settings.currencies.exchangeRates.batch.create(inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/create`\n\nCreate multiple exchange rates in a single request.\n\n### Parameters\n\n- `inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.create({ inputs: [{ conversionRate: 0, fromCurrencyCode: 'AED' }] });\n\nconsole.log(batchResponseExchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.batch.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.create({\n inputs: [{ conversionRate: 0, fromCurrencyCode: 'AED' }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", + }, + python: { + method: 'settings.currencies.exchange_rates.batch.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.create(\n inputs=[{\n "conversion_rate": 0,\n "from_currency_code": "AED",\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', + }, + java: { + method: 'settings().currencies().exchangeRates().batch().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.BatchInputExchangeRateCreateRequest;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputExchangeRateCreateRequest params = BatchInputExchangeRateCreateRequest.builder()\n .addInput(ExchangeRateCreateRequest.builder()\n .conversionRate(0.0)\n .fromCurrencyCode(ExchangeRateCreateRequest.FromCurrencyCode.AED)\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().create(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.Batch.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.New(context.TODO(), settings.CurrencyExchangeRateBatchNewParams{\n\t\tBatchInputExchangeRateCreateRequest: settings.BatchInputExchangeRateCreateRequestParam{\n\t\t\tInputs: []settings.ExchangeRateCreateRequestParam{{\n\t\t\t\tConversionRate: 0,\n\t\t\t\tFromCurrencyCode: settings.ExchangeRateCreateRequestFromCurrencyCodeAed,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.batch.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.create(\n inputs: [{conversionRate: 0, fromCurrencyCode: :AED}]\n)\n\nputs(batch_response_exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->batch->create', + example: + "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->create(\n inputs: [\n [\n 'conversionRate' => 0,\n 'fromCurrencyCode' => 'AED',\n 'effectiveAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseExchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "conversionRate": 0,\n "fromCurrencyCode": "AED"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/settings/currencies/2026-03/exchange-rates/batch/read', + httpMethod: 'post', + summary: 'Retrieve multiple rates', + description: + 'Retrieve the details of multiple exchange rates in a single request, specified by their IDs.', + stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) get', + qualified: 'client.settings.currencies.exchangeRates.batch.get', + params: ['inputs: { id: string; }[];'], + response: + "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get\n\n`client.settings.currencies.exchangeRates.batch.get(inputs: { id: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/read`\n\nRetrieve the details of multiple exchange rates in a single request, specified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.get({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseExchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.batch.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.get({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", + }, + python: { + method: 'settings.currencies.exchange_rates.batch.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.get(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', + }, + java: { + method: 'settings().currencies().exchangeRates().batch().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPublicObjectId;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicObjectId params = BatchInputPublicObjectId.builder()\n .addInput(PublicObjectId.builder()\n .id("id")\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().get(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.Batch.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.Get(context.TODO(), settings.CurrencyExchangeRateBatchGetParams{\n\t\tBatchInputPublicObjectID: shared.BatchInputPublicObjectIDParam{\n\t\t\tInputs: []shared.PublicObjectIDParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.batch.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.get(inputs: [{id: "id"}])\n\nputs(batch_response_exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->batch->get', + example: + "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->get(inputs: [['id' => 'id']]);\n\nvar_dump($batchResponseExchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', + }, + }, + }, + { + name: 'update', + endpoint: '/settings/currencies/2026-03/exchange-rates/batch/update', + httpMethod: 'post', + summary: 'Update multiple exchange rates', + description: 'Update the conversion rates for multiple exchange rates in a batch operation.', + stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) update', + qualified: 'client.settings.currencies.exchangeRates.batch.update', + params: ['inputs: { id: string; conversionRate: number; effectiveAt?: string; }[];'], + response: + "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## update\n\n`client.settings.currencies.exchangeRates.batch.update(inputs: { id: string; conversionRate: number; effectiveAt?: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/update`\n\nUpdate the conversion rates for multiple exchange rates in a batch operation.\n\n### Parameters\n\n- `inputs: { id: string; conversionRate: number; effectiveAt?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.update({ inputs: [{ id: 'id', conversionRate: 0 }] });\n\nconsole.log(batchResponseExchangeRate);\n```", + perLanguage: { + typescript: { + method: 'client.settings.currencies.exchangeRates.batch.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.update({\n inputs: [{ id: 'id', conversionRate: 0 }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", + }, + python: { + method: 'settings.currencies.exchange_rates.batch.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.update(\n inputs=[{\n "id": "id",\n "conversion_rate": 0,\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', + }, + java: { + method: 'settings().currencies().exchangeRates().batch().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.BatchInputExchangeRateUpdateRequest;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateUpdateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputExchangeRateUpdateRequest params = BatchInputExchangeRateUpdateRequest.builder()\n .addInput(ExchangeRateUpdateRequest.builder()\n .id("id")\n .conversionRate(0.0)\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().update(params);\n }\n}', + }, + go: { + method: 'client.Settings.Currencies.ExchangeRates.Batch.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.Update(context.TODO(), settings.CurrencyExchangeRateBatchUpdateParams{\n\t\tBatchInputExchangeRateUpdateRequest: settings.BatchInputExchangeRateUpdateRequestParam{\n\t\t\tInputs: []settings.ExchangeRateUpdateRequestParam{{\n\t\t\t\tID: "id",\n\t\t\t\tConversionRate: 0,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', + }, + ruby: { + method: 'settings.currencies.exchange_rates.batch.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.update(inputs: [{id: "id", conversionRate: 0}])\n\nputs(batch_response_exchange_rate)', + }, + php: { + method: 'settings->currencies->exchangeRates->batch->update', + example: + "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'conversionRate' => 0,\n 'effectiveAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseExchangeRate);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "conversionRate": 0\n }\n ]\n }\'', + }, + }, + }, + { + name: 'get', + endpoint: '/tax-rates/2026-03/tax-rates/{taxRateGroupId}', + httpMethod: 'get', + summary: 'Get a specific tax rate', + description: 'Retrieve a specific tax rate by its `taxRateGroupId`.', + stainlessPath: '(resource) settings.tax_rates > (method) get', + qualified: 'client.settings.taxRates.get', + params: ['taxRateGroupId: string;'], + response: + '{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }', + markdown: + "## get\n\n`client.settings.taxRates.get(taxRateGroupId: string): { id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n**get** `/tax-rates/2026-03/tax-rates/{taxRateGroupId}`\n\nRetrieve a specific tax rate by its `taxRateGroupId`.\n\n### Parameters\n\n- `taxRateGroupId: string`\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `label: string`\n - `name: string`\n - `percentageRate: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicTaxRateGroup = await client.settings.taxRates.get('taxRateGroupId');\n\nconsole.log(publicTaxRateGroup);\n```", + perLanguage: { + typescript: { + method: 'client.settings.taxRates.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicTaxRateGroup = await client.settings.taxRates.get('taxRateGroupId');\n\nconsole.log(publicTaxRateGroup.id);", + }, + python: { + method: 'settings.tax_rates.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_tax_rate_group = client.settings.tax_rates.get(\n "taxRateGroupId",\n)\nprint(public_tax_rate_group.id)', + }, + java: { + method: 'settings().taxRates().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.taxrates.PublicTaxRateGroup;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicTaxRateGroup publicTaxRateGroup = client.settings().taxRates().get("taxRateGroupId");\n }\n}', + }, + go: { + method: 'client.Settings.TaxRates.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicTaxRateGroup, err := client.Settings.TaxRates.Get(context.TODO(), "taxRateGroupId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicTaxRateGroup.ID)\n}\n', + }, + ruby: { + method: 'settings.tax_rates.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_tax_rate_group = hubspot.settings.tax_rates.get("taxRateGroupId")\n\nputs(public_tax_rate_group)', + }, + php: { + method: 'settings->taxRates->get', + example: + "settings->taxRates->get('taxRateGroupId');\n\nvar_dump($publicTaxRateGroup);", + }, + http: { + example: + 'curl https://api.hubapi.com/tax-rates/2026-03/tax-rates/$TAX_RATE_GROUP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/tax-rates/2026-03/tax-rates', + httpMethod: 'get', + summary: 'Get all tax rates', + description: 'Retrieve a paginated list of all tax rates set up in the account tax rate library', + stainlessPath: '(resource) settings.tax_rates > (method) list', + qualified: 'client.settings.taxRates.list', + params: ['active?: boolean;', 'after?: string;', 'limit?: number;'], + response: + '{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }', + markdown: + "## list\n\n`client.settings.taxRates.list(active?: boolean, after?: string, limit?: number): { id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n**get** `/tax-rates/2026-03/tax-rates`\n\nRetrieve a paginated list of all tax rates set up in the account tax rate library\n\n### Parameters\n\n- `active?: boolean`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `label: string`\n - `name: string`\n - `percentageRate: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicTaxRateGroup of client.settings.taxRates.list()) {\n console.log(publicTaxRateGroup);\n}\n```", + perLanguage: { + typescript: { + method: 'client.settings.taxRates.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicTaxRateGroup of client.settings.taxRates.list()) {\n console.log(publicTaxRateGroup.id);\n}", + }, + python: { + method: 'settings.tax_rates.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.tax_rates.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'settings().taxRates().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateListPage;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxRateListPage page = client.settings().taxRates().list();\n }\n}', + }, + go: { + method: 'client.Settings.TaxRates.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.TaxRates.List(context.TODO(), settings.TaxRateListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'settings.tax_rates.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.tax_rates.list\n\nputs(page)', + }, + php: { + method: 'settings->taxRates->list', + example: + "settings->taxRates->list(\n active: true, after: 'after', limit: 0\n);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/tax-rates/2026-03/tax-rates \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'create', + endpoint: '/settings/users/2026-03', + httpMethod: 'post', + summary: '', + description: '', + stainlessPath: '(resource) settings.users > (method) create', + qualified: 'client.settings.users.create', + params: [ + 'email: string;', + 'sendWelcomeEmail: boolean;', + 'firstName?: string;', + 'lastName?: string;', + 'primaryTeamId?: string;', + 'roleId?: string;', + 'secondaryTeamIds?: string[];', + ], + response: + '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', + markdown: + "## create\n\n`client.settings.users.create(email: string, sendWelcomeEmail: boolean, firstName?: string, lastName?: string, primaryTeamId?: string, roleId?: string, secondaryTeamIds?: string[]): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**post** `/settings/users/2026-03`\n\n### Parameters\n\n- `email: string`\n The user's email.\n\n- `sendWelcomeEmail: boolean`\n Whether to send a welcome email.\n\n- `firstName?: string`\n The user's first name.\n\n- `lastName?: string`\n The user's last name.\n\n- `primaryTeamId?: string`\n The user's primary team.\n\n- `roleId?: string`\n The user's role.\n\n- `secondaryTeamIds?: string[]`\n The user's additional teams.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.create({ email: 'email', sendWelcomeEmail: true });\n\nconsole.log(publicUser);\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.create', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.create({ email: 'email', sendWelcomeEmail: true });\n\nconsole.log(publicUser.id);", + }, + python: { + method: 'settings.users.create', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.create(\n email="email",\n send_welcome_email=True,\n)\nprint(public_user.id)', + }, + java: { + method: 'settings().users().create', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.UserProvisionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserProvisionRequest params = UserProvisionRequest.builder()\n .email("email")\n .sendWelcomeEmail(true)\n .build();\n PublicUser publicUser = client.settings().users().create(params);\n }\n}', + }, + go: { + method: 'client.Settings.Users.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.New(context.TODO(), settings.UserNewParams{\n\t\tUserProvisionRequest: settings.UserProvisionRequestParam{\n\t\t\tEmail: "email",\n\t\t\tSendWelcomeEmail: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', + }, + ruby: { + method: 'settings.users.create', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.create(email: "email", send_welcome_email: true)\n\nputs(public_user)', + }, + php: { + method: 'settings->users->create', + example: + "settings->users->create(\n email: 'email',\n sendWelcomeEmail: true,\n firstName: 'firstName',\n lastName: 'lastName',\n primaryTeamID: 'primaryTeamId',\n roleID: 'roleId',\n secondaryTeamIDs: ['string'],\n);\n\nvar_dump($publicUser);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email",\n "sendWelcomeEmail": true\n }\'', + }, + }, + }, + { + name: 'delete', + endpoint: '/settings/users/2026-03/{userId}', + httpMethod: 'delete', + summary: 'Removes a user', + description: + "Removes a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", + stainlessPath: '(resource) settings.users > (method) delete', + qualified: 'client.settings.users.delete', + params: ['userId: string;', "idProperty?: 'EMAIL' | 'USER_ID';"], + markdown: + "## delete\n\n`client.settings.users.delete(userId: string, idProperty?: 'EMAIL' | 'USER_ID'): void`\n\n**delete** `/settings/users/2026-03/{userId}`\n\nRemoves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.settings.users.delete('userId')\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.delete', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.settings.users.delete('userId');", + }, + python: { + method: 'settings.users.delete', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.settings.users.delete(\n user_id="userId",\n)', + }, + java: { + method: 'settings().users().delete', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.UserDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.settings().users().delete("userId");\n }\n}', + }, + go: { + method: 'client.Settings.Users.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Settings.Users.Delete(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'settings.users.delete', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.settings.users.delete("userId")\n\nputs(result)', + }, + php: { + method: 'settings->users->delete', + example: + "settings->users->delete('userId', idProperty: 'EMAIL');\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get', + endpoint: '/settings/users/2026-03/{userId}', + httpMethod: 'get', + summary: 'Retrieves a user', + description: + "Retrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", + stainlessPath: '(resource) settings.users > (method) get', + qualified: 'client.settings.users.get', + params: ['userId: string;', "idProperty?: 'EMAIL' | 'USER_ID';"], + response: + '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', + markdown: + "## get\n\n`client.settings.users.get(userId: string, idProperty?: 'EMAIL' | 'USER_ID'): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**get** `/settings/users/2026-03/{userId}`\n\nRetrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.get('userId');\n\nconsole.log(publicUser);\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.get', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.get('userId');\n\nconsole.log(publicUser.id);", + }, + python: { + method: 'settings.users.get', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.get(\n user_id="userId",\n)\nprint(public_user.id)', + }, + java: { + method: 'settings().users().get', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.UserGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicUser publicUser = client.settings().users().get("userId");\n }\n}', + }, + go: { + method: 'client.Settings.Users.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.Get(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', + }, + ruby: { + method: 'settings.users.get', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.get("userId")\n\nputs(public_user)', + }, + php: { + method: 'settings->users->get', + example: + "settings->users->get('userId', idProperty: 'EMAIL');\n\nvar_dump($publicUser);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list', + endpoint: '/settings/users/2026-03', + httpMethod: 'get', + summary: '', + description: '', + stainlessPath: '(resource) settings.users > (method) list', + qualified: 'client.settings.users.list', + params: ['after?: string;', 'limit?: number;'], + response: + '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', + markdown: + "## list\n\n`client.settings.users.list(after?: string, limit?: number): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**get** `/settings/users/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicUser of client.settings.users.list()) {\n console.log(publicUser);\n}\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.list', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicUser of client.settings.users.list()) {\n console.log(publicUser.id);\n}", + }, + python: { + method: 'settings.users.list', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.users.list()\npage = page.results[0]\nprint(page.id)', + }, + java: { + method: 'settings().users().list', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.UserListPage;\nimport com.hubspot.sdk.models.settings.users.UserListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserListPage page = client.settings().users().list();\n }\n}', + }, + go: { + method: 'client.Settings.Users.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.Users.List(context.TODO(), settings.UserListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'settings.users.list', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.users.list\n\nputs(page)', + }, + php: { + method: 'settings->users->list', + example: + "settings->users->list(after: 'after', limit: 0);\n\nvar_dump($page);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_roles', + endpoint: '/settings/users/2026-03/roles', + httpMethod: 'get', + summary: 'Retrieves the roles on an account', + description: 'Retrieves the roles on an account', + stainlessPath: '(resource) settings.users > (method) list_roles', + qualified: 'client.settings.users.listRoles', + response: '{ results: { id: string; name: string; requiresBillingWrite: boolean; }[]; }', + markdown: + "## list_roles\n\n`client.settings.users.listRoles(): { results: public_permission_set[]; }`\n\n**get** `/settings/users/2026-03/roles`\n\nRetrieves the roles on an account\n\n### Returns\n\n- `{ results: { id: string; name: string; requiresBillingWrite: boolean; }[]; }`\n\n - `results: { id: string; name: string; requiresBillingWrite: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPermissionSetNoPaging = await client.settings.users.listRoles();\n\nconsole.log(collectionResponsePublicPermissionSetNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.listRoles', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPermissionSetNoPaging = await client.settings.users.listRoles();\n\nconsole.log(collectionResponsePublicPermissionSetNoPaging.results);", + }, + python: { + method: 'settings.users.list_roles', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_permission_set_no_paging = client.settings.users.list_roles()\nprint(collection_response_public_permission_set_no_paging.results)', + }, + java: { + method: 'settings().users().listRoles', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.CollectionResponsePublicPermissionSetNoPaging;\nimport com.hubspot.sdk.models.settings.users.UserListRolesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicPermissionSetNoPaging collectionResponsePublicPermissionSetNoPaging = client.settings().users().listRoles();\n }\n}', + }, + go: { + method: 'client.Settings.Users.ListRoles', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPermissionSetNoPaging, err := client.Settings.Users.ListRoles(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPermissionSetNoPaging.Results)\n}\n', + }, + ruby: { + method: 'settings.users.list_roles', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_permission_set_no_paging = hubspot.settings.users.list_roles\n\nputs(collection_response_public_permission_set_no_paging)', + }, + php: { + method: 'settings->users->listRoles', + example: + "settings\n ->users\n ->listRoles();\n\nvar_dump($collectionResponsePublicPermissionSetNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03/roles \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_teams', + endpoint: '/settings/users/2026-03/teams', + httpMethod: 'get', + summary: "See details about this account's teams", + description: 'View teams for this account', + stainlessPath: '(resource) settings.users > (method) list_teams', + qualified: 'client.settings.users.listTeams', + response: '{ results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]; }', + markdown: + "## list_teams\n\n`client.settings.users.listTeams(): { results: public_team[]; }`\n\n**get** `/settings/users/2026-03/teams`\n\nView teams for this account\n\n### Returns\n\n- `{ results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]; }`\n\n - `results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicTeamNoPaging = await client.settings.users.listTeams();\n\nconsole.log(collectionResponsePublicTeamNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.listTeams', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicTeamNoPaging = await client.settings.users.listTeams();\n\nconsole.log(collectionResponsePublicTeamNoPaging.results);", + }, + python: { + method: 'settings.users.list_teams', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_team_no_paging = client.settings.users.list_teams()\nprint(collection_response_public_team_no_paging.results)', + }, + java: { + method: 'settings().users().listTeams', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.CollectionResponsePublicTeamNoPaging;\nimport com.hubspot.sdk.models.settings.users.UserListTeamsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicTeamNoPaging collectionResponsePublicTeamNoPaging = client.settings().users().listTeams();\n }\n}', + }, + go: { + method: 'client.Settings.Users.ListTeams', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicTeamNoPaging, err := client.Settings.Users.ListTeams(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicTeamNoPaging.Results)\n}\n', + }, + ruby: { + method: 'settings.users.list_teams', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_team_no_paging = hubspot.settings.users.list_teams\n\nputs(collection_response_public_team_no_paging)', + }, + php: { + method: 'settings->users->listTeams', + example: + "settings->users->listTeams();\n\nvar_dump($collectionResponsePublicTeamNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/settings/users/2026-03/teams \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update', + endpoint: '/settings/users/2026-03/{userId}', + httpMethod: 'put', + summary: 'Modifies a user', + description: + "Modifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", + stainlessPath: '(resource) settings.users > (method) update', + qualified: 'client.settings.users.update', + params: [ + 'userId: string;', + "idProperty?: 'EMAIL' | 'USER_ID';", + 'firstName?: string;', + 'lastName?: string;', + 'primaryTeamId?: string;', + 'roleId?: string;', + 'secondaryTeamIds?: string[];', + ], + response: + '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', + markdown: + "## update\n\n`client.settings.users.update(userId: string, idProperty?: 'EMAIL' | 'USER_ID', firstName?: string, lastName?: string, primaryTeamId?: string, roleId?: string, secondaryTeamIds?: string[]): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**put** `/settings/users/2026-03/{userId}`\n\nModifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n- `firstName?: string`\n The first name of the user.\n\n- `lastName?: string`\n The last name of the user.\n\n- `primaryTeamId?: string`\n The user's primary team.\n\n- `roleId?: string`\n The user's role.\n\n- `secondaryTeamIds?: string[]`\n The user's additional teams.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.update('userId');\n\nconsole.log(publicUser);\n```", + perLanguage: { + typescript: { + method: 'client.settings.users.update', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.update('userId');\n\nconsole.log(publicUser.id);", + }, + python: { + method: 'settings.users.update', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.update(\n user_id="userId",\n)\nprint(public_user.id)', + }, + java: { + method: 'settings().users().update', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.PublicUserUpdate;\nimport com.hubspot.sdk.models.settings.users.UserUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserUpdateParams params = UserUpdateParams.builder()\n .userId("userId")\n .publicUserUpdate(PublicUserUpdate.builder().build())\n .build();\n PublicUser publicUser = client.settings().users().update(params);\n }\n}', + }, + go: { + method: 'client.Settings.Users.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.Update(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserUpdateParams{\n\t\t\tPublicUserUpdate: settings.PublicUserUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', + }, + ruby: { + method: 'settings.users.update', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.update("userId")\n\nputs(public_user)', + }, + php: { + method: 'settings->users->update', + example: + "settings->users->update(\n 'userId',\n idProperty: 'EMAIL',\n firstName: 'firstName',\n lastName: 'lastName',\n primaryTeamID: 'primaryTeamId',\n roleID: 'roleId',\n secondaryTeamIDs: ['string'],\n);\n\nvar_dump($publicUser);", + }, + http: { + example: + "curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create_batch_event_subscriptions', + endpoint: '/webhooks/2026-03/{appId}/subscriptions/batch/update', + httpMethod: 'post', + summary: 'Batch create event subscriptions', + description: 'Batch create event subscriptions for the specified app.', + stainlessPath: '(resource) webhooks > (method) create_batch_event_subscriptions', + qualified: 'client.webhooks.createBatchEventSubscriptions', + params: ['appId: number;', 'inputs: { id: number; active: boolean; }[];'], + response: + "{ completedAt: string; results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## create_batch_event_subscriptions\n\n`client.webhooks.createBatchEventSubscriptions(appId: number, inputs: { id: number; active: boolean; }[]): { completedAt: string; results: subscription_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks/2026-03/{appId}/subscriptions/batch/update`\n\nBatch create event subscriptions for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `inputs: { id: number; active: boolean; }[]`\n An array of SubscriptionBatchUpdateRequest objects, each representing a subscription to be updated. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriptionResponse = await client.webhooks.createBatchEventSubscriptions(0, { inputs: [{ id: 0, active: true }] });\n\nconsole.log(batchResponseSubscriptionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.createBatchEventSubscriptions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriptionResponse = await client.webhooks.createBatchEventSubscriptions(0, {\n inputs: [{ id: 0, active: true }],\n});\n\nconsole.log(batchResponseSubscriptionResponse.completedAt);", + }, + python: { + method: 'webhooks.create_batch_event_subscriptions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscription_response = client.webhooks.create_batch_event_subscriptions(\n app_id=0,\n inputs=[{\n "id": 0,\n "active": True,\n }],\n)\nprint(batch_response_subscription_response.completed_at)', + }, + java: { + method: 'webhooks().createBatchEventSubscriptions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchInputSubscriptionBatchUpdateRequest;\nimport com.hubspot.sdk.models.webhooks.BatchResponseSubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.SubscriptionBatchUpdateRequest;\nimport com.hubspot.sdk.models.webhooks.WebhookCreateBatchEventSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookCreateBatchEventSubscriptionsParams params = WebhookCreateBatchEventSubscriptionsParams.builder()\n .appId(0)\n .batchInputSubscriptionBatchUpdateRequest(BatchInputSubscriptionBatchUpdateRequest.builder()\n .addInput(SubscriptionBatchUpdateRequest.builder()\n .id(0)\n .active(true)\n .build())\n .build())\n .build();\n BatchResponseSubscriptionResponse batchResponseSubscriptionResponse = client.webhooks().createBatchEventSubscriptions(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.NewBatchEventSubscriptions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriptionResponse, err := client.Webhooks.NewBatchEventSubscriptions(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookNewBatchEventSubscriptionsParams{\n\t\t\tBatchInputSubscriptionBatchUpdateRequest: webhooks.BatchInputSubscriptionBatchUpdateRequestParam{\n\t\t\t\tInputs: []webhooks.SubscriptionBatchUpdateRequestParam{{\n\t\t\t\t\tID: 0,\n\t\t\t\t\tActive: true,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriptionResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.create_batch_event_subscriptions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscription_response = hubspot.webhooks.create_batch_event_subscriptions(0, inputs: [{id: 0, active: true}])\n\nputs(batch_response_subscription_response)', + }, + php: { + method: 'webhooks->createBatchEventSubscriptions', + example: + "webhooks\n ->createBatchEventSubscriptions(0, inputs: [['id' => 0, 'active' => true]]);\n\nvar_dump($batchResponseSubscriptionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": 0,\n "active": true\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_crm_snapshots', + endpoint: '/webhooks-journal/snapshots/2026-03/crm', + httpMethod: 'post', + summary: 'Create Snapshot', + description: + 'Create a batch of CRM object snapshots for the specified portal. This endpoint allows you to capture the state of CRM objects at a specific point in time, which can be useful for auditing or historical analysis. The request requires a list of CRM object snapshot requests, each specifying the portal ID, object ID, object type ID, and properties to include in the snapshot.', + stainlessPath: '(resource) webhooks > (method) create_crm_snapshots', + qualified: 'client.webhooks.createCrmSnapshots', + params: [ + 'snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[];', + ], + response: + '{ snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]; }', + markdown: + "## create_crm_snapshots\n\n`client.webhooks.createCrmSnapshots(snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[]): { snapshotResponses: crm_object_snapshot_response[]; }`\n\n**post** `/webhooks-journal/snapshots/2026-03/crm`\n\nCreate a batch of CRM object snapshots for the specified portal. This endpoint allows you to capture the state of CRM objects at a specific point in time, which can be useful for auditing or historical analysis. The request requires a list of CRM object snapshot requests, each specifying the portal ID, object ID, object type ID, and properties to include in the snapshot.\n\n### Parameters\n\n- `snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[]`\n An array of CrmObjectSnapshotRequest objects, each representing a request to create a snapshot for a specific CRM object. This property is required.\n\n### Returns\n\n- `{ snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]; }`\n\n - `snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst crmObjectSnapshotBatchResponse = await client.webhooks.createCrmSnapshots({ snapshotRequests: [{\n objectId: 0,\n objectTypeId: 'objectTypeId',\n portalId: 0,\n properties: ['string'],\n}] });\n\nconsole.log(crmObjectSnapshotBatchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.createCrmSnapshots', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst crmObjectSnapshotBatchResponse = await client.webhooks.createCrmSnapshots({\n snapshotRequests: [\n {\n objectId: 0,\n objectTypeId: 'objectTypeId',\n portalId: 0,\n properties: ['string'],\n },\n ],\n});\n\nconsole.log(crmObjectSnapshotBatchResponse.snapshotResponses);", + }, + python: { + method: 'webhooks.create_crm_snapshots', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncrm_object_snapshot_batch_response = client.webhooks.create_crm_snapshots(\n snapshot_requests=[{\n "object_id": 0,\n "object_type_id": "objectTypeId",\n "portal_id": 0,\n "properties": ["string"],\n }],\n)\nprint(crm_object_snapshot_batch_response.snapshot_responses)', + }, + java: { + method: 'webhooks().createCrmSnapshots', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotBatchRequest;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotBatchResponse;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CrmObjectSnapshotBatchRequest params = CrmObjectSnapshotBatchRequest.builder()\n .addSnapshotRequest(CrmObjectSnapshotRequest.builder()\n .objectId(0L)\n .objectTypeId("objectTypeId")\n .portalId(0L)\n .addProperty("string")\n .build())\n .build();\n CrmObjectSnapshotBatchResponse crmObjectSnapshotBatchResponse = client.webhooks().createCrmSnapshots(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.NewCrmSnapshots', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcrmObjectSnapshotBatchResponse, err := client.Webhooks.NewCrmSnapshots(context.TODO(), webhooks.WebhookNewCrmSnapshotsParams{\n\t\tCrmObjectSnapshotBatchRequest: webhooks.CrmObjectSnapshotBatchRequestParam{\n\t\t\tSnapshotRequests: []webhooks.CrmObjectSnapshotRequestParam{{\n\t\t\t\tObjectID: 0,\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tPortalID: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", crmObjectSnapshotBatchResponse.SnapshotResponses)\n}\n', + }, + ruby: { + method: 'webhooks.create_crm_snapshots', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncrm_object_snapshot_batch_response = hubspot.webhooks.create_crm_snapshots(\n snapshot_requests: [{objectId: 0, objectTypeId: "objectTypeId", portalId: 0, properties: ["string"]}]\n)\n\nputs(crm_object_snapshot_batch_response)', + }, + php: { + method: 'webhooks->createCrmSnapshots', + example: + "webhooks->createCrmSnapshots(\n snapshotRequests: [\n [\n 'objectID' => 0,\n 'objectTypeID' => 'objectTypeId',\n 'portalID' => 0,\n 'properties' => ['string'],\n ],\n ],\n);\n\nvar_dump($crmObjectSnapshotBatchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/snapshots/2026-03/crm \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "snapshotRequests": [\n {\n "objectId": 0,\n "objectTypeId": "objectTypeId",\n "portalId": 0,\n "properties": [\n "string"\n ]\n }\n ]\n }\'', + }, + }, + }, + { + name: 'create_event_subscription', + endpoint: '/webhooks/2026-03/{appId}/subscriptions', + httpMethod: 'post', + summary: 'Create an event subscription', + description: 'Create new event subscription for the specified app.', + stainlessPath: '(resource) webhooks > (method) create_event_subscription', + qualified: 'client.webhooks.createEventSubscription', + params: [ + 'appId: number;', + 'active: boolean;', + 'eventType: string;', + 'eventTypeName?: string;', + 'objectTypeId?: string;', + 'propertyName?: string;', + ], + response: + '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', + markdown: + "## create_event_subscription\n\n`client.webhooks.createEventSubscription(appId: number, active: boolean, eventType: string, eventTypeName?: string, objectTypeId?: string, propertyName?: string): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**post** `/webhooks/2026-03/{appId}/subscriptions`\n\nCreate new event subscription for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `active: boolean`\n A boolean indicating whether the subscription is active.\n\n- `eventType: string`\n A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.\n\n- `eventTypeName?: string`\n A string providing a human-readable name for the event type.\n\n- `objectTypeId?: string`\n A string representing the ID of the object type associated with the subscription.\n\n- `propertyName?: string`\n A string indicating the specific property name related to the event type, if applicable.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.createEventSubscription(0, { active: true, eventType: 'company.associationChange' });\n\nconsole.log(subscriptionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.createEventSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.createEventSubscription(0, {\n active: true,\n eventType: 'company.associationChange',\n});\n\nconsole.log(subscriptionResponse.id);", + }, + python: { + method: 'webhooks.create_event_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.create_event_subscription(\n app_id=0,\n active=True,\n event_type="company.associationChange",\n)\nprint(subscription_response.id)', + }, + java: { + method: 'webhooks().createEventSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionCreateRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookCreateEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookCreateEventSubscriptionParams params = WebhookCreateEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionCreateRequest(SubscriptionCreateRequest.builder()\n .active(true)\n .eventType(SubscriptionCreateRequest.EventType.COMPANY_ASSOCIATION_CHANGE)\n .build())\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().createEventSubscription(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.NewEventSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.NewEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookNewEventSubscriptionParams{\n\t\t\tSubscriptionCreateRequest: webhooks.SubscriptionCreateRequestParam{\n\t\t\t\tActive: true,\n\t\t\t\tEventType: webhooks.SubscriptionCreateRequestEventTypeCompanyAssociationChange,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.create_event_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.create_event_subscription(0, active: true, event_type: :"company.associationChange")\n\nputs(subscription_response)', + }, + php: { + method: 'webhooks->createEventSubscription', + example: + "webhooks->createEventSubscription(\n 0,\n active: true,\n eventType: 'company.associationChange',\n eventTypeName: 'eventTypeName',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n);\n\nvar_dump($subscriptionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "active": true,\n "eventType": "company.associationChange"\n }\'', + }, + }, + }, + { + name: 'create_journal_subscription', + endpoint: '/webhooks-journal/subscriptions/2026-03', + httpMethod: 'post', + summary: 'Create Subscription', + description: + 'Create a new webhook subscription for the specified portal in the HubSpot account. This endpoint allows you to define the subscription details, including the types of events you want to subscribe to. The request body must include the necessary subscription information as defined by the SubscriptionUpsertRequest schema.', + stainlessPath: '(resource) webhooks > (method) create_journal_subscription', + qualified: 'client.webhooks.createJournalSubscription', + params: [ + 'subscription_upsert_request: { actions: string[]; objectIds: number[]; objectTypeId: string; portalId: number; properties: string[]; subscriptionType: string; } | { actions: string[]; associatedObjectTypeIds: string[]; objectIds: number[]; objectTypeId: string; portalId: number; subscriptionType: string; } | { eventTypeId: string; properties: string[]; subscriptionType: string; } | { actions: string[]; listIds: number[]; objectIds: number[]; portalId: number; subscriptionType: string; } | { actions: string[]; objectTypeId: string; portalId: number; subscriptionType: string; };', + ], + response: + '{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }', + perLanguage: { + typescript: { + method: 'client.webhooks.createJournalSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse1 = await client.webhooks.createJournalSubscription();\n\nconsole.log(subscriptionResponse1.id);", + }, + python: { + method: 'webhooks.create_journal_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response_1 = client.webhooks.create_journal_subscription()\nprint(subscription_response_1.id)', + }, + java: { + method: 'webhooks().createJournalSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.AppLifecycleEventSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.AssociationSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.GdprPrivacyDeletionSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.ListMembershipSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.ObjectSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse1;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSubscriptionUpsertRequest params = ObjectSubscriptionUpsertRequest.builder()\n .addAction(ObjectSubscriptionUpsertRequest.Action.CREATE)\n .addObjectId(0L)\n .objectTypeId("objectTypeId")\n .portalId(0L)\n .addProperty("string")\n .subscriptionType(ObjectSubscriptionUpsertRequest.SubscriptionType.OBJECT)\n .build();\n SubscriptionResponse1 subscriptionResponse1 = client.webhooks().createJournalSubscription(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.NewJournalSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse1, err := client.Webhooks.NewJournalSubscription(context.TODO(), webhooks.WebhookNewJournalSubscriptionParams{\n\t\tSubscriptionUpsertRequest: webhooks.SubscriptionUpsertRequestUnionParam{\n\t\t\tOfObjectSubscriptionUpsertRequest: &webhooks.ObjectSubscriptionUpsertRequestParam{\n\t\t\t\tActions: []string{"CREATE"},\n\t\t\t\tObjectIDs: []int64{0},\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tPortalID: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSubscriptionType: webhooks.ObjectSubscriptionUpsertRequestSubscriptionTypeObject,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse1.ID)\n}\n', + }, + ruby: { + method: 'webhooks.create_journal_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response_1 = hubspot.webhooks.create_journal_subscription(\n subscription_upsert_request: {\n actions: [:CREATE],\n objectIds: [0],\n objectTypeId: "objectTypeId",\n portalId: 0,\n properties: ["string"],\n subscriptionType: :OBJECT\n }\n)\n\nputs(subscription_response_1)', + }, + php: { + method: 'webhooks->createJournalSubscription', + example: + "webhooks->createJournalSubscription();\n\nvar_dump($subscriptionResponse1);", + }, + http: { + example: + "curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03 \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'create_subscription_filter', + endpoint: '/webhooks-journal/subscriptions/2026-03/filters', + httpMethod: 'post', + summary: 'Create Filter', + description: + 'Create a new filter for a webhook subscription in your HubSpot account. This endpoint allows you to define specific conditions that a webhook event must meet to trigger the subscription. It is useful for managing and customizing the behavior of webhook subscriptions based on specific criteria.', + stainlessPath: '(resource) webhooks > (method) create_subscription_filter', + qualified: 'client.webhooks.createSubscriptionFilter', + params: [ + "filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; };", + 'subscriptionId: number;', + ], + response: '{ filterId: number; }', + markdown: + "## create_subscription_filter\n\n`client.webhooks.createSubscriptionFilter(filter: { conditions: condition[]; }, subscriptionId: number): { filterId: number; }`\n\n**post** `/webhooks-journal/subscriptions/2026-03/filters`\n\nCreate a new filter for a webhook subscription in your HubSpot account. This endpoint allows you to define specific conditions that a webhook event must meet to trigger the subscription. It is useful for managing and customizing the behavior of webhook subscriptions based on specific criteria.\n\n### Parameters\n\n- `filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; }`\n Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. \n - `conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]`\n An array of conditions that define the criteria for the filter. Each condition specifies a property, an operator, and optionally a value or values.\n\n- `subscriptionId: number`\n The unique identifier of the subscription to which the filter will be applied. It is an integer formatted as int64.\n\n### Returns\n\n- `{ filterId: number; }`\n\n - `filterId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterCreateResponse = await client.webhooks.createSubscriptionFilter({\n filter: { conditions: [{\n filterType: 'CRM_OBJECT_PROPERTY',\n operator: 'CONTAINS',\n property: 'property',\n}] },\n subscriptionId: 0,\n});\n\nconsole.log(filterCreateResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.createSubscriptionFilter', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterCreateResponse = await client.webhooks.createSubscriptionFilter({\n filter: {\n conditions: [\n {\n filterType: 'CRM_OBJECT_PROPERTY',\n operator: 'CONTAINS',\n property: 'property',\n },\n ],\n },\n subscriptionId: 0,\n});\n\nconsole.log(filterCreateResponse.filterId);", + }, + python: { + method: 'webhooks.create_subscription_filter', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_create_response = client.webhooks.create_subscription_filter(\n filter={\n "conditions": [{\n "filter_type": "CRM_OBJECT_PROPERTY",\n "operator": "CONTAINS",\n "property": "property",\n }]\n },\n subscription_id=0,\n)\nprint(filter_create_response.filter_id)', + }, + java: { + method: 'webhooks().createSubscriptionFilter', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.Condition;\nimport com.hubspot.sdk.models.webhooks.Filter;\nimport com.hubspot.sdk.models.webhooks.FilterCreateRequest;\nimport com.hubspot.sdk.models.webhooks.FilterCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FilterCreateRequest params = FilterCreateRequest.builder()\n .filter(Filter.builder()\n .addCondition(Condition.builder()\n .filterType(Condition.FilterType.CRM_OBJECT_PROPERTY)\n .operator(Condition.Operator.CONTAINS)\n .property("property")\n .build())\n .build())\n .subscriptionId(0L)\n .build();\n FilterCreateResponse filterCreateResponse = client.webhooks().createSubscriptionFilter(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.NewSubscriptionFilter', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterCreateResponse, err := client.Webhooks.NewSubscriptionFilter(context.TODO(), webhooks.WebhookNewSubscriptionFilterParams{\n\t\tFilterCreateRequest: webhooks.FilterCreateRequestParam{\n\t\t\tFilter: webhooks.FilterParam{\n\t\t\t\tConditions: []webhooks.ConditionParam{{\n\t\t\t\t\tFilterType: webhooks.ConditionFilterTypeCrmObjectProperty,\n\t\t\t\t\tOperator: webhooks.ConditionOperatorContains,\n\t\t\t\t\tProperty: "property",\n\t\t\t\t}},\n\t\t\t},\n\t\t\tSubscriptionID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterCreateResponse.FilterID)\n}\n', + }, + ruby: { + method: 'webhooks.create_subscription_filter', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_create_response = hubspot.webhooks.create_subscription_filter(\n filter: {conditions: [{filterType: :CRM_OBJECT_PROPERTY, operator: :CONTAINS, property: "property"}]},\n subscription_id: 0\n)\n\nputs(filter_create_response)', + }, + php: { + method: 'webhooks->createSubscriptionFilter', + example: + "webhooks->createSubscriptionFilter(\n filter: [\n 'conditions' => [\n [\n 'filterType' => 'CRM_OBJECT_PROPERTY',\n 'operator' => 'CONTAINS',\n 'property' => 'property',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n subscriptionID: 0,\n);\n\nvar_dump($filterCreateResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "filter": {\n "conditions": [\n {\n "filterType": "CRM_OBJECT_PROPERTY",\n "operator": "CONTAINS",\n "property": "property"\n }\n ]\n },\n "subscriptionId": 0\n }\'', + }, + }, + }, + { + name: 'delete_event_subscription', + endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + httpMethod: 'delete', + summary: 'Delete event subscription', + description: 'Delete an existing event subscription by ID.', + stainlessPath: '(resource) webhooks > (method) delete_event_subscription', + qualified: 'client.webhooks.deleteEventSubscription', + params: ['appId: number;', 'subscriptionId: number;'], + markdown: + "## delete_event_subscription\n\n`client.webhooks.deleteEventSubscription(appId: number, subscriptionId: number): void`\n\n**delete** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nDelete an existing event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteEventSubscription(0, { appId: 0 })\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.deleteEventSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteEventSubscription(0, { appId: 0 });", + }, + python: { + method: 'webhooks.delete_event_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_event_subscription(\n subscription_id=0,\n app_id=0,\n)', + }, + java: { + method: 'webhooks().deleteEventSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookDeleteEventSubscriptionParams params = WebhookDeleteEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .build();\n client.webhooks().deleteEventSubscription(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.DeleteEventSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookDeleteEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'webhooks.delete_event_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_event_subscription(0, app_id: 0)\n\nputs(result)', + }, + php: { + method: 'webhooks->deleteEventSubscription', + example: + "webhooks->deleteEventSubscription(0, appID: 0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_journal_subscription', + endpoint: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', + httpMethod: 'delete', + summary: 'Delete subscription', + description: + 'Delete a specific webhook journal subscription using its unique identifier. This operation is useful for managing and cleaning up subscriptions that are no longer needed or relevant.', + stainlessPath: '(resource) webhooks > (method) delete_journal_subscription', + qualified: 'client.webhooks.deleteJournalSubscription', + params: ['subscriptionId: number;'], + markdown: + "## delete_journal_subscription\n\n`client.webhooks.deleteJournalSubscription(subscriptionId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/{subscriptionId}`\n\nDelete a specific webhook journal subscription using its unique identifier. This operation is useful for managing and cleaning up subscriptions that are no longer needed or relevant.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteJournalSubscription(0)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.deleteJournalSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteJournalSubscription(0);", + }, + python: { + method: 'webhooks.delete_journal_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_journal_subscription(\n 0,\n)', + }, + java: { + method: 'webhooks().deleteJournalSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteJournalSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteJournalSubscription(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.DeleteJournalSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteJournalSubscription(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'webhooks.delete_journal_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_journal_subscription(0)\n\nputs(result)', + }, + php: { + method: 'webhooks->deleteJournalSubscription', + example: + "webhooks->deleteJournalSubscription(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_journal_subscription_for_portal', + endpoint: '/webhooks-journal/subscriptions/2026-03/portals/{portalId}', + httpMethod: 'delete', + summary: 'Delete subscription', + description: + 'Delete a webhook journal subscription for a specific portal. This operation removes the subscription associated with the given portalId, and no content is returned upon successful deletion.', + stainlessPath: '(resource) webhooks > (method) delete_journal_subscription_for_portal', + qualified: 'client.webhooks.deleteJournalSubscriptionForPortal', + params: ['portalId: number;'], + markdown: + "## delete_journal_subscription_for_portal\n\n`client.webhooks.deleteJournalSubscriptionForPortal(portalId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/portals/{portalId}`\n\nDelete a webhook journal subscription for a specific portal. This operation removes the subscription associated with the given portalId, and no content is returned upon successful deletion.\n\n### Parameters\n\n- `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteJournalSubscriptionForPortal(0)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.deleteJournalSubscriptionForPortal', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteJournalSubscriptionForPortal(0);", + }, + python: { + method: 'webhooks.delete_journal_subscription_for_portal', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_journal_subscription_for_portal(\n 0,\n)', + }, + java: { + method: 'webhooks().deleteJournalSubscriptionForPortal', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteJournalSubscriptionForPortalParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteJournalSubscriptionForPortal(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.DeleteJournalSubscriptionForPortal', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteJournalSubscriptionForPortal(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'webhooks.delete_journal_subscription_for_portal', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_journal_subscription_for_portal(0)\n\nputs(result)', + }, + php: { + method: 'webhooks->deleteJournalSubscriptionForPortal', + example: + "webhooks->deleteJournalSubscriptionForPortal(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/portals/$PORTAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_settings', + endpoint: '/webhooks/2026-03/{appId}/settings', + httpMethod: 'delete', + summary: 'Delete webhook settings', + description: + 'Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.', + stainlessPath: '(resource) webhooks > (method) delete_settings', + qualified: 'client.webhooks.deleteSettings', + params: ['appId: number;'], + markdown: + "## delete_settings\n\n`client.webhooks.deleteSettings(appId: number): void`\n\n**delete** `/webhooks/2026-03/{appId}/settings`\n\nDelete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteSettings(0)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.deleteSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteSettings(0);", + }, + python: { + method: 'webhooks.delete_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_settings(\n 0,\n)', + }, + java: { + method: 'webhooks().deleteSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteSettings(0);\n }\n}', + }, + go: { + method: 'client.Webhooks.DeleteSettings', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'webhooks.delete_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_settings(0)\n\nputs(result)', + }, + php: { + method: 'webhooks->deleteSettings', + example: + "webhooks->deleteSettings(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'delete_subscription_filter', + endpoint: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', + httpMethod: 'delete', + summary: 'Delete filter', + description: + 'Delete a specific filter associated with a webhook journal subscription. This operation is useful for managing and cleaning up filters that are no longer needed in your subscription setup. The endpoint requires the unique identifier of the filter to be deleted.', + stainlessPath: '(resource) webhooks > (method) delete_subscription_filter', + qualified: 'client.webhooks.deleteSubscriptionFilter', + params: ['filterId: number;'], + markdown: + "## delete_subscription_filter\n\n`client.webhooks.deleteSubscriptionFilter(filterId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/filters/{filterId}`\n\nDelete a specific filter associated with a webhook journal subscription. This operation is useful for managing and cleaning up filters that are no longer needed in your subscription setup. The endpoint requires the unique identifier of the filter to be deleted.\n\n### Parameters\n\n- `filterId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteSubscriptionFilter(0)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.deleteSubscriptionFilter', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteSubscriptionFilter(0);", + }, + python: { + method: 'webhooks.delete_subscription_filter', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_subscription_filter(\n 0,\n)', + }, + java: { + method: 'webhooks().deleteSubscriptionFilter', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteSubscriptionFilterParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteSubscriptionFilter(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.DeleteSubscriptionFilter', + example: + 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteSubscriptionFilter(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', + }, + ruby: { + method: 'webhooks.delete_subscription_filter', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_subscription_filter(0)\n\nputs(result)', + }, + php: { + method: 'webhooks->deleteSubscriptionFilter', + example: + "webhooks->deleteSubscriptionFilter(0);\n\nvar_dump($result);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/$FILTER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_earliest_journal_batch', + endpoint: '/webhooks-journal/journal/2026-03/batch/earliest/{count}', + httpMethod: 'get', + summary: 'Retrieve Batch', + description: + 'Retrieve the earliest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching historical webhook data in batches, allowing you to process or analyze the earliest entries first.', + stainlessPath: '(resource) webhooks > (method) get_earliest_journal_batch', + qualified: 'client.webhooks.getEarliestJournalBatch', + params: ['count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_earliest_journal_batch\n\n`client.webhooks.getEarliestJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/earliest/{count}`\n\nRetrieve the earliest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching historical webhook data in batches, allowing you to process or analyze the earliest entries first.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the webhook journal entries by. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getEarliestJournalBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_earliest_journal_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_earliest_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getEarliestJournalBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getEarliestJournalBatch(1);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetEarliestJournalBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetEarliestJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetEarliestJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_earliest_journal_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_earliest_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getEarliestJournalBatch', + example: + "webhooks->getEarliestJournalBatch(\n 1, installPortalID: 0\n);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/earliest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_earliest_journal_entry', + endpoint: '/webhooks-journal/journal/2026-03/earliest', + httpMethod: 'get', + summary: 'Retrieve earliest', + description: + 'Retrieve the earliest entry from the webhooks journal for the specified version. This endpoint is useful for accessing the oldest records available in the journal, which can be helpful for auditing or historical data analysis.', + stainlessPath: '(resource) webhooks > (method) get_earliest_journal_entry', + qualified: 'client.webhooks.getEarliestJournalEntry', + params: ['installPortalId?: number;'], + response: 'string', + markdown: + "## get_earliest_journal_entry\n\n`client.webhooks.getEarliestJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/earliest`\n\nRetrieve the earliest entry from the webhooks journal for the specified version. This endpoint is useful for accessing the oldest records available in the journal, which can be helpful for auditing or historical data analysis.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries. It is an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getEarliestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getEarliestJournalEntry', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getEarliestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_earliest_journal_entry', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_earliest_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getEarliestJournalEntry', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getEarliestJournalEntry();\n }\n}', + }, + go: { + method: 'client.Webhooks.GetEarliestJournalEntry', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetEarliestJournalEntry(context.TODO(), webhooks.WebhookGetEarliestJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_earliest_journal_entry', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_earliest_journal_entry\n\nputs(response)', + }, + php: { + method: 'webhooks->getEarliestJournalEntry', + example: + "webhooks->getEarliestJournalEntry(installPortalID: 0);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/earliest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_earliest_local_journal_batch', + endpoint: '/webhooks-journal/journal-local/2026-03/batch/earliest/{count}', + httpMethod: 'get', + summary: 'Retrieve Batch', + description: + 'Retrieve the earliest batch of webhook journal entries based on the specified count. This endpoint is useful for fetching a specific number of the earliest entries in the webhook journal for analysis or processing.', + stainlessPath: '(resource) webhooks > (method) get_earliest_local_journal_batch', + qualified: 'client.webhooks.getEarliestLocalJournalBatch', + params: ['count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_earliest_local_journal_batch\n\n`client.webhooks.getEarliestLocalJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/earliest/{count}`\n\nRetrieve the earliest batch of webhook journal entries based on the specified count. This endpoint is useful for fetching a specific number of the earliest entries in the webhook journal for analysis or processing.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getEarliestLocalJournalBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_earliest_local_journal_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_earliest_local_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getEarliestLocalJournalBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestLocalJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getEarliestLocalJournalBatch(1);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetEarliestLocalJournalBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetEarliestLocalJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetEarliestLocalJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_earliest_local_journal_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_earliest_local_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getEarliestLocalJournalBatch', + example: + "webhooks\n ->getEarliestLocalJournalBatch(1, installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/earliest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_earliest_local_journal_entry', + endpoint: '/webhooks-journal/journal-local/2026-03/earliest', + httpMethod: 'get', + summary: 'Retrieve earliest', + description: + 'Retrieve the earliest entry from the webhooks journal for the specified portal. This endpoint is useful for accessing the oldest records in the journal, which can be helpful for auditing or tracking purposes.', + stainlessPath: '(resource) webhooks > (method) get_earliest_local_journal_entry', + qualified: 'client.webhooks.getEarliestLocalJournalEntry', + params: ['installPortalId?: number;'], + response: 'string', + markdown: + "## get_earliest_local_journal_entry\n\n`client.webhooks.getEarliestLocalJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/earliest`\n\nRetrieve the earliest entry from the webhooks journal for the specified portal. This endpoint is useful for accessing the oldest records in the journal, which can be helpful for auditing or tracking purposes.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries by. This parameter is optional and should be an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getEarliestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getEarliestLocalJournalEntry', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getEarliestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_earliest_local_journal_entry', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_earliest_local_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getEarliestLocalJournalEntry', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestLocalJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getEarliestLocalJournalEntry();\n }\n}', + }, + go: { + method: 'client.Webhooks.GetEarliestLocalJournalEntry', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetEarliestLocalJournalEntry(context.TODO(), webhooks.WebhookGetEarliestLocalJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_earliest_local_journal_entry', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_earliest_local_journal_entry\n\nputs(response)', + }, + php: { + method: 'webhooks->getEarliestLocalJournalEntry', + example: + "webhooks->getEarliestLocalJournalEntry(installPortalID: 0);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/earliest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_event_subscription', + endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + httpMethod: 'get', + summary: 'Read an event subscription', + description: 'Retrieve a specific event subscription by ID.', + stainlessPath: '(resource) webhooks > (method) get_event_subscription', + qualified: 'client.webhooks.getEventSubscription', + params: ['appId: number;', 'subscriptionId: number;'], + response: + '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', + markdown: + "## get_event_subscription\n\n`client.webhooks.getEventSubscription(appId: number, subscriptionId: number): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**get** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nRetrieve a specific event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.getEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getEventSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.getEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse.id);", + }, + python: { + method: 'webhooks.get_event_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.get_event_subscription(\n subscription_id=0,\n app_id=0,\n)\nprint(subscription_response.id)', + }, + java: { + method: 'webhooks().getEventSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetEventSubscriptionParams params = WebhookGetEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().getEventSubscription(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetEventSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.GetEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookGetEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.get_event_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.get_event_subscription(0, app_id: 0)\n\nputs(subscription_response)', + }, + php: { + method: 'webhooks->getEventSubscription', + example: + "webhooks->getEventSubscription(0, appID: 0);\n\nvar_dump($subscriptionResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_journal_batch_by_request', + endpoint: '/webhooks-journal/journal/2026-03/batch/read', + httpMethod: 'post', + summary: 'Batch read', + description: + 'Perform a batch read operation on the webhooks journal for the specified date. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently.', + stainlessPath: '(resource) webhooks > (method) get_journal_batch_by_request', + qualified: 'client.webhooks.getJournalBatchByRequest', + params: ['inputs: string[];', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_journal_batch_by_request\n\n`client.webhooks.getJournalBatchByRequest(inputs: string[], installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks-journal/journal/2026-03/batch/read`\n\nPerform a batch read operation on the webhooks journal for the specified date. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchByRequest({ inputs: ['string'] });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getJournalBatchByRequest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchByRequest({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_journal_batch_by_request', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_journal_batch_by_request(\n inputs=["string"],\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getJournalBatchByRequest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getJournalBatchByRequest(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetJournalBatchByRequest', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetJournalBatchByRequest(context.TODO(), webhooks.WebhookGetJournalBatchByRequestParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_journal_batch_by_request', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_journal_batch_by_request(inputs: ["string"])\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getJournalBatchByRequest', + example: + "webhooks\n ->getJournalBatchByRequest(inputs: ['string'], installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_journal_batch_from_offset', + endpoint: '/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}', + httpMethod: 'get', + summary: 'Fetch Batch Entries', + description: + 'Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a specified number of entries, making it useful for paginating through large sets of webhook journal data.', + stainlessPath: '(resource) webhooks > (method) get_journal_batch_from_offset', + qualified: 'client.webhooks.getJournalBatchFromOffset', + params: ['offset: string;', 'count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_journal_batch_from_offset\n\n`client.webhooks.getJournalBatchFromOffset(offset: string, count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}`\n\nRetrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a specified number of entries, making it useful for paginating through large sets of webhook journal data.\n\n### Parameters\n\n- `offset: string`\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to specify the portal context for the request.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchFromOffset(1, { offset: 'offset' });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getJournalBatchFromOffset', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchFromOffset(1, {\n offset: 'offset',\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_journal_batch_from_offset', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_journal_batch_from_offset(\n count=1,\n offset="offset",\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getJournalBatchFromOffset', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalBatchFromOffsetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetJournalBatchFromOffsetParams params = WebhookGetJournalBatchFromOffsetParams.builder()\n .offset("offset")\n .count(1)\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getJournalBatchFromOffset(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetJournalBatchFromOffset', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetJournalBatchFromOffset(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetJournalBatchFromOffsetParams{\n\t\t\tOffset: "offset",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_journal_batch_from_offset', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_journal_batch_from_offset(1, offset: "offset")\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getJournalBatchFromOffset', + example: + "webhooks\n ->getJournalBatchFromOffset(1, offset: 'offset', installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/$OFFSET/next/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_journal_status', + endpoint: '/webhooks-journal/journal/2026-03/status/{statusId}', + httpMethod: 'get', + summary: 'Retrieve status', + description: + 'Retrieve the status of a specific webhook journal entry using its status ID. This endpoint is useful for checking the current state of a webhook process, such as whether it is pending, in progress, completed, failed, or expired.', + stainlessPath: '(resource) webhooks > (method) get_journal_status', + qualified: 'client.webhooks.getJournalStatus', + params: ['statusId: string;'], + response: + "{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }", + markdown: + "## get_journal_status\n\n`client.webhooks.getJournalStatus(statusId: string): { id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/status/{statusId}`\n\nRetrieve the status of a specific webhook journal entry using its status ID. This endpoint is useful for checking the current state of a webhook process, such as whether it is pending, in progress, completed, failed, or expired.\n\n### Parameters\n\n- `statusId: string`\n\n### Returns\n\n- `{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n - `id: string`\n - `initiatedAt: number`\n - `status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'`\n - `completedAt?: number`\n - `errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'`\n - `message?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst snapshotStatusResponse = await client.webhooks.getJournalStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(snapshotStatusResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getJournalStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst snapshotStatusResponse = await client.webhooks.getJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(snapshotStatusResponse.id);", + }, + python: { + method: 'webhooks.get_journal_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsnapshot_status_response = client.webhooks.get_journal_status(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(snapshot_status_response.id)', + }, + java: { + method: 'webhooks().getJournalStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SnapshotStatusResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SnapshotStatusResponse snapshotStatusResponse = client.webhooks().getJournalStatus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}', + }, + go: { + method: 'client.Webhooks.GetJournalStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsnapshotStatusResponse, err := client.Webhooks.GetJournalStatus(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", snapshotStatusResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.get_journal_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsnapshot_status_response = hubspot.webhooks.get_journal_status("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\nputs(snapshot_status_response)', + }, + php: { + method: 'webhooks->getJournalStatus', + example: + "webhooks->getJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n);\n\nvar_dump($snapshotStatusResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/status/$STATUS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_journal_subscription', + endpoint: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', + httpMethod: 'get', + summary: 'Retrieve subscription', + description: + "Retrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription's configuration and status within the HubSpot account.", + stainlessPath: '(resource) webhooks > (method) get_journal_subscription', + qualified: 'client.webhooks.getJournalSubscription', + params: ['subscriptionId: number;'], + response: + '{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }', + markdown: + "## get_journal_subscription\n\n`client.webhooks.getJournalSubscription(subscriptionId: number): { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03/{subscriptionId}`\n\nRetrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription's configuration and status within the HubSpot account.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }`\n\n - `id: number`\n - `actions: string[]`\n - `appId: number`\n - `createdAt: string`\n - `objectTypeId: string`\n - `subscriptionType: string`\n - `updatedAt: string`\n - `actionOverrides?: object`\n - `associatedObjectTypeIds?: string[]`\n - `createdBy?: number`\n - `deletedAt?: string`\n - `listIds?: number[]`\n - `objectIds?: number[]`\n - `portalId?: number`\n - `properties?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse1 = await client.webhooks.getJournalSubscription(0);\n\nconsole.log(subscriptionResponse1);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getJournalSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse1 = await client.webhooks.getJournalSubscription(0);\n\nconsole.log(subscriptionResponse1.id);", + }, + python: { + method: 'webhooks.get_journal_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response_1 = client.webhooks.get_journal_subscription(\n 0,\n)\nprint(subscription_response_1.id)', + }, + java: { + method: 'webhooks().getJournalSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse1;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionResponse1 subscriptionResponse1 = client.webhooks().getJournalSubscription(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetJournalSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse1, err := client.Webhooks.GetJournalSubscription(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse1.ID)\n}\n', + }, + ruby: { + method: 'webhooks.get_journal_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response_1 = hubspot.webhooks.get_journal_subscription(0)\n\nputs(subscription_response_1)', + }, + php: { + method: 'webhooks->getJournalSubscription', + example: + "webhooks->getJournalSubscription(0);\n\nvar_dump($subscriptionResponse1);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_latest_journal_batch', + endpoint: '/webhooks-journal/journal/2026-03/batch/latest/{count}', + httpMethod: 'get', + summary: 'Retrieve latest batch', + description: + 'Retrieve the latest batch of webhook journal entries. This endpoint allows you to specify the number of entries to fetch, providing a way to access recent webhook activity within your HubSpot account.', + stainlessPath: '(resource) webhooks > (method) get_latest_journal_batch', + qualified: 'client.webhooks.getLatestJournalBatch', + params: ['count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_latest_journal_batch\n\n`client.webhooks.getLatestJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/latest/{count}`\n\nRetrieve the latest batch of webhook journal entries. This endpoint allows you to specify the number of entries to fetch, providing a way to access recent webhook activity within your HubSpot account.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to identify the specific portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLatestJournalBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_latest_journal_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_latest_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getLatestJournalBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLatestJournalBatch(1);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLatestJournalBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLatestJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLatestJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_latest_journal_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_latest_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getLatestJournalBatch', + example: + "webhooks->getLatestJournalBatch(\n 1, installPortalID: 0\n);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/latest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_latest_journal_entry', + endpoint: '/webhooks-journal/journal/2026-03/latest', + httpMethod: 'get', + summary: 'Retrieve latest journal', + description: + 'Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events processed by your HubSpot account. It allows you to filter the results by the portal ID to ensure you are retrieving data relevant to a specific installation.', + stainlessPath: '(resource) webhooks > (method) get_latest_journal_entry', + qualified: 'client.webhooks.getLatestJournalEntry', + params: ['installPortalId?: number;'], + response: 'string', + markdown: + "## get_latest_journal_entry\n\n`client.webhooks.getLatestJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/latest`\n\nRetrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events processed by your HubSpot account. It allows you to filter the results by the portal ID to ensure you are retrieving data relevant to a specific installation.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries. It is an integer value.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getLatestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLatestJournalEntry', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getLatestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_latest_journal_entry', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_latest_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getLatestJournalEntry', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getLatestJournalEntry();\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLatestJournalEntry', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetLatestJournalEntry(context.TODO(), webhooks.WebhookGetLatestJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_latest_journal_entry', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_latest_journal_entry\n\nputs(response)', + }, + php: { + method: 'webhooks->getLatestJournalEntry', + example: + "webhooks->getLatestJournalEntry(installPortalID: 0);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/latest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_latest_local_journal_batch', + endpoint: '/webhooks-journal/journal-local/2026-03/batch/latest/{count}', + httpMethod: 'get', + summary: 'Retrieve latest batch', + description: + 'Retrieve the latest batch of webhook journal entries. This endpoint is useful for accessing the most recent data entries processed by the webhook journal. It requires specifying the number of entries to retrieve.', + stainlessPath: '(resource) webhooks > (method) get_latest_local_journal_batch', + qualified: 'client.webhooks.getLatestLocalJournalBatch', + params: ['count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_latest_local_journal_batch\n\n`client.webhooks.getLatestLocalJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/latest/{count}`\n\nRetrieve the latest batch of webhook journal entries. This endpoint is useful for accessing the most recent data entries processed by the webhook journal. It requires specifying the number of entries to retrieve.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This parameter is optional and used to filter the journal entries by a specific portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLatestLocalJournalBatch', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_latest_local_journal_batch', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_latest_local_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getLatestLocalJournalBatch', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestLocalJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLatestLocalJournalBatch(1);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLatestLocalJournalBatch', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLatestLocalJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLatestLocalJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_latest_local_journal_batch', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_latest_local_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getLatestLocalJournalBatch', + example: + "webhooks\n ->getLatestLocalJournalBatch(1, installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/latest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_latest_local_journal_entry', + endpoint: '/webhooks-journal/journal-local/2026-03/latest', + httpMethod: 'get', + summary: 'Retrieve latest journal', + description: + 'Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events that have been logged, allowing you to process or analyze them as needed.', + stainlessPath: '(resource) webhooks > (method) get_latest_local_journal_entry', + qualified: 'client.webhooks.getLatestLocalJournalEntry', + params: ['installPortalId?: number;'], + response: 'string', + markdown: + "## get_latest_local_journal_entry\n\n`client.webhooks.getLatestLocalJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/latest`\n\nRetrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events that have been logged, allowing you to process or analyze them as needed.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal for which to retrieve the latest journal entries. This parameter is optional and should be an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getLatestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLatestLocalJournalEntry', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getLatestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_latest_local_journal_entry', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_latest_local_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getLatestLocalJournalEntry', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestLocalJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getLatestLocalJournalEntry();\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLatestLocalJournalEntry', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetLatestLocalJournalEntry(context.TODO(), webhooks.WebhookGetLatestLocalJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_latest_local_journal_entry', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_latest_local_journal_entry\n\nputs(response)', + }, + php: { + method: 'webhooks->getLatestLocalJournalEntry', + example: + "webhooks->getLatestLocalJournalEntry(installPortalID: 0);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/latest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_local_journal_batch_by_request', + endpoint: '/webhooks-journal/journal-local/2026-03/batch/read', + httpMethod: 'post', + summary: 'Batch read', + description: + 'Perform a batch read operation on the webhooks journal. This endpoint allows you to read multiple entries from the journal in a single request. It requires a JSON request body specifying the inputs to be read. The response includes the results of the batch read operation, and may return multiple statuses if there are errors.', + stainlessPath: '(resource) webhooks > (method) get_local_journal_batch_by_request', + qualified: 'client.webhooks.getLocalJournalBatchByRequest', + params: ['inputs: string[];', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_local_journal_batch_by_request\n\n`client.webhooks.getLocalJournalBatchByRequest(inputs: string[], installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks-journal/journal-local/2026-03/batch/read`\n\nPerform a batch read operation on the webhooks journal. This endpoint allows you to read multiple entries from the journal in a single request. It requires a JSON request body specifying the inputs to be read. The response includes the results of the batch read operation, and may return multiple statuses if there are errors.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchByRequest({ inputs: ['string'] });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLocalJournalBatchByRequest', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchByRequest({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_local_journal_batch_by_request', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_local_journal_batch_by_request(\n inputs=["string"],\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getLocalJournalBatchByRequest', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLocalJournalBatchByRequest(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLocalJournalBatchByRequest', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLocalJournalBatchByRequest(context.TODO(), webhooks.WebhookGetLocalJournalBatchByRequestParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_local_journal_batch_by_request', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_local_journal_batch_by_request(inputs: ["string"])\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getLocalJournalBatchByRequest', + example: + "webhooks\n ->getLocalJournalBatchByRequest(inputs: ['string'], installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', + }, + }, + }, + { + name: 'get_local_journal_batch_from_offset', + endpoint: '/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}', + httpMethod: 'get', + summary: 'Retrieve batch', + description: + 'Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, facilitating the processing of webhook data in manageable chunks.', + stainlessPath: '(resource) webhooks > (method) get_local_journal_batch_from_offset', + qualified: 'client.webhooks.getLocalJournalBatchFromOffset', + params: ['offset: string;', 'count: number;', 'installPortalId?: number;'], + response: + "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", + markdown: + "## get_local_journal_batch_from_offset\n\n`client.webhooks.getLocalJournalBatchFromOffset(offset: string, count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}`\n\nRetrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, facilitating the processing of webhook data in manageable chunks.\n\n### Parameters\n\n- `offset: string`\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to specify the portal context for the request.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchFromOffset(1, { offset: 'offset' });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLocalJournalBatchFromOffset', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchFromOffset(1, {\n offset: 'offset',\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", + }, + python: { + method: 'webhooks.get_local_journal_batch_from_offset', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_local_journal_batch_from_offset(\n count=1,\n offset="offset",\n)\nprint(batch_response_journal_fetch_response.completed_at)', + }, + java: { + method: 'webhooks().getLocalJournalBatchFromOffset', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLocalJournalBatchFromOffsetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetLocalJournalBatchFromOffsetParams params = WebhookGetLocalJournalBatchFromOffsetParams.builder()\n .offset("offset")\n .count(1)\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLocalJournalBatchFromOffset(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLocalJournalBatchFromOffset', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLocalJournalBatchFromOffset(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLocalJournalBatchFromOffsetParams{\n\t\t\tOffset: "offset",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_local_journal_batch_from_offset', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_local_journal_batch_from_offset(1, offset: "offset")\n\nputs(batch_response_journal_fetch_response)', + }, + php: { + method: 'webhooks->getLocalJournalBatchFromOffset', + example: + "webhooks\n ->getLocalJournalBatchFromOffset(1, offset: 'offset', installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/$OFFSET/next/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_local_journal_status', + endpoint: '/webhooks-journal/journal-local/2026-03/status/{statusId}', + httpMethod: 'get', + summary: 'Retrieve status', + description: + 'Retrieve the status of a specific webhook journal entry using its unique status ID. This endpoint is useful for monitoring the progress or completion of webhook processing tasks.', + stainlessPath: '(resource) webhooks > (method) get_local_journal_status', + qualified: 'client.webhooks.getLocalJournalStatus', + params: ['statusId: string;'], + response: + "{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }", + markdown: + "## get_local_journal_status\n\n`client.webhooks.getLocalJournalStatus(statusId: string): { id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/status/{statusId}`\n\nRetrieve the status of a specific webhook journal entry using its unique status ID. This endpoint is useful for monitoring the progress or completion of webhook processing tasks.\n\n### Parameters\n\n- `statusId: string`\n\n### Returns\n\n- `{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n - `id: string`\n - `initiatedAt: number`\n - `status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'`\n - `completedAt?: number`\n - `errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'`\n - `message?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst snapshotStatusResponse = await client.webhooks.getLocalJournalStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(snapshotStatusResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getLocalJournalStatus', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst snapshotStatusResponse = await client.webhooks.getLocalJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(snapshotStatusResponse.id);", + }, + python: { + method: 'webhooks.get_local_journal_status', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsnapshot_status_response = client.webhooks.get_local_journal_status(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(snapshot_status_response.id)', + }, + java: { + method: 'webhooks().getLocalJournalStatus', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SnapshotStatusResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLocalJournalStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SnapshotStatusResponse snapshotStatusResponse = client.webhooks().getLocalJournalStatus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}', + }, + go: { + method: 'client.Webhooks.GetLocalJournalStatus', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsnapshotStatusResponse, err := client.Webhooks.GetLocalJournalStatus(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", snapshotStatusResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.get_local_journal_status', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsnapshot_status_response = hubspot.webhooks.get_local_journal_status("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\nputs(snapshot_status_response)', + }, + php: { + method: 'webhooks->getLocalJournalStatus', + example: + "webhooks->getLocalJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n);\n\nvar_dump($snapshotStatusResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/status/$STATUS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_next_journal_entries', + endpoint: '/webhooks-journal/journal/2026-03/offset/{offset}/next', + httpMethod: 'get', + summary: 'Retrieve Next Batch', + description: + 'Retrieve the next batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data, allowing you to continue fetching entries from where you last left off.', + stainlessPath: '(resource) webhooks > (method) get_next_journal_entries', + qualified: 'client.webhooks.getNextJournalEntries', + params: ['offset: string;', 'installPortalId?: number;'], + response: 'string', + markdown: + "## get_next_journal_entries\n\n`client.webhooks.getNextJournalEntries(offset: string, installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/offset/{offset}/next`\n\nRetrieve the next batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data, allowing you to continue fetching entries from where you last left off.\n\n### Parameters\n\n- `offset: string`\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the webhook journal entries. This is an optional parameter.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getNextJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getNextJournalEntries', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getNextJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_next_journal_entries', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_next_journal_entries(\n offset="offset",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getNextJournalEntries', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetNextJournalEntriesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getNextJournalEntries("offset");\n }\n}', + }, + go: { + method: 'client.Webhooks.GetNextJournalEntries', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetNextJournalEntries(\n\t\tcontext.TODO(),\n\t\t"offset",\n\t\twebhooks.WebhookGetNextJournalEntriesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_next_journal_entries', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_next_journal_entries("offset")\n\nputs(response)', + }, + php: { + method: 'webhooks->getNextJournalEntries', + example: + "webhooks->getNextJournalEntries(\n 'offset', installPortalID: 0\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/offset/$OFFSET/next \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_next_local_journal_entries', + endpoint: '/webhooks-journal/journal-local/2026-03/offset/{offset}/next', + httpMethod: 'get', + summary: 'Retrieve Next Batch', + description: + 'Retrieve the next set of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through webhook journal data in a sequential manner, allowing you to fetch entries beyond a given point.', + stainlessPath: '(resource) webhooks > (method) get_next_local_journal_entries', + qualified: 'client.webhooks.getNextLocalJournalEntries', + params: ['offset: string;', 'installPortalId?: number;'], + response: 'string', + markdown: + "## get_next_local_journal_entries\n\n`client.webhooks.getNextLocalJournalEntries(offset: string, installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/offset/{offset}/next`\n\nRetrieve the next set of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through webhook journal data in a sequential manner, allowing you to fetch entries beyond a given point.\n\n### Parameters\n\n- `offset: string`\n\n- `installPortalId?: number`\n The ID of the portal where the webhook is installed. This is an integer value.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getNextLocalJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getNextLocalJournalEntries', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getNextLocalJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", + }, + python: { + method: 'webhooks.get_next_local_journal_entries', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_next_local_journal_entries(\n offset="offset",\n)\nprint(response)\ncontent = response.read()\nprint(content)', + }, + java: { + method: 'webhooks().getNextLocalJournalEntries', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetNextLocalJournalEntriesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getNextLocalJournalEntries("offset");\n }\n}', + }, + go: { + method: 'client.Webhooks.GetNextLocalJournalEntries', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetNextLocalJournalEntries(\n\t\tcontext.TODO(),\n\t\t"offset",\n\t\twebhooks.WebhookGetNextLocalJournalEntriesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'webhooks.get_next_local_journal_entries', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_next_local_journal_entries("offset")\n\nputs(response)', + }, + php: { + method: 'webhooks->getNextLocalJournalEntries', + example: + "webhooks->getNextLocalJournalEntries(\n 'offset', installPortalID: 0\n);\n\nvar_dump($response);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/offset/$OFFSET/next \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_settings', + endpoint: '/webhooks/2026-03/{appId}/settings', + httpMethod: 'get', + summary: 'Read webhook settings', + description: + 'Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.', + stainlessPath: '(resource) webhooks > (method) get_settings', + qualified: 'client.webhooks.getSettings', + params: ['appId: number;'], + response: + '{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }', + markdown: + "## get_settings\n\n`client.webhooks.getSettings(appId: number): { createdAt: string; targetUrl: string; throttling: throttling_settings; updatedAt?: string; }`\n\n**get** `/webhooks/2026-03/{appId}/settings`\n\nRetrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }`\n\n - `createdAt: string`\n - `targetUrl: string`\n - `throttling: { maxConcurrentRequests: number; }`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.webhooks.getSettings(0);\n\nconsole.log(settingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.webhooks.getSettings(0);\n\nconsole.log(settingsResponse.createdAt);", + }, + python: { + method: 'webhooks.get_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.webhooks.get_settings(\n 0,\n)\nprint(settings_response.created_at)', + }, + java: { + method: 'webhooks().getSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SettingsResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingsResponse settingsResponse = client.webhooks().getSettings(0);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Webhooks.GetSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'webhooks.get_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.webhooks.get_settings(0)\n\nputs(settings_response)', + }, + php: { + method: 'webhooks->getSettings', + example: + "webhooks->getSettings(0);\n\nvar_dump($settingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'get_subscription_filter', + endpoint: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', + httpMethod: 'get', + summary: 'Retrieve filter', + description: + 'Retrieve details of a specific filter associated with a webhook subscription in the HubSpot account. This endpoint is useful for accessing the configuration and conditions of a filter by its unique identifier.', + stainlessPath: '(resource) webhooks > (method) get_subscription_filter', + qualified: 'client.webhooks.getSubscriptionFilter', + params: ['filterId: number;'], + response: '{ id: number; createdAt: number; filter: { conditions: condition[]; }; }', + markdown: + "## get_subscription_filter\n\n`client.webhooks.getSubscriptionFilter(filterId: number): { id: number; createdAt: number; filter: filter; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03/filters/{filterId}`\n\nRetrieve details of a specific filter associated with a webhook subscription in the HubSpot account. This endpoint is useful for accessing the configuration and conditions of a filter by its unique identifier.\n\n### Parameters\n\n- `filterId: number`\n\n### Returns\n\n- `{ id: number; createdAt: number; filter: { conditions: condition[]; }; }`\n\n - `id: number`\n - `createdAt: number`\n - `filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterResponse = await client.webhooks.getSubscriptionFilter(0);\n\nconsole.log(filterResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.getSubscriptionFilter', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterResponse = await client.webhooks.getSubscriptionFilter(0);\n\nconsole.log(filterResponse.id);", + }, + python: { + method: 'webhooks.get_subscription_filter', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_response = client.webhooks.get_subscription_filter(\n 0,\n)\nprint(filter_response.id)', + }, + java: { + method: 'webhooks().getSubscriptionFilter', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.FilterResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetSubscriptionFilterParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FilterResponse filterResponse = client.webhooks().getSubscriptionFilter(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.GetSubscriptionFilter', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterResponse, err := client.Webhooks.GetSubscriptionFilter(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.get_subscription_filter', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_response = hubspot.webhooks.get_subscription_filter(0)\n\nputs(filter_response)', + }, + php: { + method: 'webhooks->getSubscriptionFilter', + example: + "webhooks->getSubscriptionFilter(0);\n\nvar_dump($filterResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/$FILTER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_event_subscriptions', + endpoint: '/webhooks/2026-03/{appId}/subscriptions', + httpMethod: 'get', + summary: 'Read event subscriptions', + description: 'Retrieve event subscriptions for the specified app.', + stainlessPath: '(resource) webhooks > (method) list_event_subscriptions', + qualified: 'client.webhooks.listEventSubscriptions', + params: ['appId: number;'], + response: + '{ results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; }', + markdown: + "## list_event_subscriptions\n\n`client.webhooks.listEventSubscriptions(appId: number): { results: subscription_response[]; }`\n\n**get** `/webhooks/2026-03/{appId}/subscriptions`\n\nRetrieve event subscriptions for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; }`\n\n - `results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionListResponse = await client.webhooks.listEventSubscriptions(0);\n\nconsole.log(subscriptionListResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.listEventSubscriptions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionListResponse = await client.webhooks.listEventSubscriptions(0);\n\nconsole.log(subscriptionListResponse.results);", + }, + python: { + method: 'webhooks.list_event_subscriptions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_list_response = client.webhooks.list_event_subscriptions(\n 0,\n)\nprint(subscription_list_response.results)', + }, + java: { + method: 'webhooks().listEventSubscriptions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionListResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookListEventSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionListResponse subscriptionListResponse = client.webhooks().listEventSubscriptions(0);\n }\n}', + }, + go: { + method: 'client.Webhooks.ListEventSubscriptions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionListResponse, err := client.Webhooks.ListEventSubscriptions(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionListResponse.Results)\n}\n', + }, + ruby: { + method: 'webhooks.list_event_subscriptions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_list_response = hubspot.webhooks.list_event_subscriptions(0)\n\nputs(subscription_list_response)', + }, + php: { + method: 'webhooks->listEventSubscriptions', + example: + "webhooks->listEventSubscriptions(0);\n\nvar_dump($subscriptionListResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_journal_subscriptions', + endpoint: '/webhooks-journal/subscriptions/2026-03', + httpMethod: 'get', + summary: 'List subscriptions', + description: + 'Retrieve a list of webhook journal subscriptions for the specified API version. This endpoint provides details about each subscription, including actions, object types, and associated properties. It is useful for managing and reviewing current webhook subscriptions.', + stainlessPath: '(resource) webhooks > (method) list_journal_subscriptions', + qualified: 'client.webhooks.listJournalSubscriptions', + response: + '{ results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]; }', + markdown: + "## list_journal_subscriptions\n\n`client.webhooks.listJournalSubscriptions(): { results: subscription_response_1[]; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03`\n\nRetrieve a list of webhook journal subscriptions for the specified API version. This endpoint provides details about each subscription, including actions, object types, and associated properties. It is useful for managing and reviewing current webhook subscriptions.\n\n### Returns\n\n- `{ results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]; }`\n\n - `results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseSubscriptionResponseNoPaging = await client.webhooks.listJournalSubscriptions();\n\nconsole.log(collectionResponseSubscriptionResponseNoPaging);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.listJournalSubscriptions', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseSubscriptionResponseNoPaging =\n await client.webhooks.listJournalSubscriptions();\n\nconsole.log(collectionResponseSubscriptionResponseNoPaging.results);", + }, + python: { + method: 'webhooks.list_journal_subscriptions', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_subscription_response_no_paging = client.webhooks.list_journal_subscriptions()\nprint(collection_response_subscription_response_no_paging.results)', + }, + java: { + method: 'webhooks().listJournalSubscriptions', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.CollectionResponseSubscriptionResponseNoPaging;\nimport com.hubspot.sdk.models.webhooks.WebhookListJournalSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseSubscriptionResponseNoPaging collectionResponseSubscriptionResponseNoPaging = client.webhooks().listJournalSubscriptions();\n }\n}', + }, + go: { + method: 'client.Webhooks.ListJournalSubscriptions', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseSubscriptionResponseNoPaging, err := client.Webhooks.ListJournalSubscriptions(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseSubscriptionResponseNoPaging.Results)\n}\n', + }, + ruby: { + method: 'webhooks.list_journal_subscriptions', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_subscription_response_no_paging = hubspot.webhooks.list_journal_subscriptions\n\nputs(collection_response_subscription_response_no_paging)', + }, + php: { + method: 'webhooks->listJournalSubscriptions', + example: + "webhooks\n ->listJournalSubscriptions();\n\nvar_dump($collectionResponseSubscriptionResponseNoPaging);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'list_subscription_filters', + endpoint: '/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}', + httpMethod: 'get', + summary: 'Retrieve Filters', + description: + 'Retrieve the filters associated with a specific webhook subscription in the HubSpot account. This endpoint is useful for obtaining detailed information about the filters applied to a given subscription, identified by its subscription ID.', + stainlessPath: '(resource) webhooks > (method) list_subscription_filters', + qualified: 'client.webhooks.listSubscriptionFilters', + params: ['subscriptionId: number;'], + response: '{ id: number; createdAt: number; filter: object; }[]', + markdown: + "## list_subscription_filters\n\n`client.webhooks.listSubscriptionFilters(subscriptionId: number): object[]`\n\n**get** `/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}`\n\nRetrieve the filters associated with a specific webhook subscription in the HubSpot account. This endpoint is useful for obtaining detailed information about the filters applied to a given subscription, identified by its subscription ID.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: number; createdAt: number; filter: object; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterResponses = await client.webhooks.listSubscriptionFilters(0);\n\nconsole.log(filterResponses);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.listSubscriptionFilters', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterResponses = await client.webhooks.listSubscriptionFilters(0);\n\nconsole.log(filterResponses);", + }, + python: { + method: 'webhooks.list_subscription_filters', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_responses = client.webhooks.list_subscription_filters(\n 0,\n)\nprint(filter_responses)', + }, + java: { + method: 'webhooks().listSubscriptionFilters', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.FilterResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookListSubscriptionFiltersParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List filterResponses = client.webhooks().listSubscriptionFilters(0L);\n }\n}', + }, + go: { + method: 'client.Webhooks.ListSubscriptionFilters', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterResponses, err := client.Webhooks.ListSubscriptionFilters(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterResponses)\n}\n', + }, + ruby: { + method: 'webhooks.list_subscription_filters', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_responses = hubspot.webhooks.list_subscription_filters(0)\n\nputs(filter_responses)', + }, + php: { + method: 'webhooks->listSubscriptionFilters', + example: + "webhooks->listSubscriptionFilters(0);\n\nvar_dump($filterResponses);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/subscription/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, + }, + { + name: 'update_event_subscription', + endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + httpMethod: 'patch', + summary: 'Update an event subscription', + description: 'Update an existing event subscription by ID.', + stainlessPath: '(resource) webhooks > (method) update_event_subscription', + qualified: 'client.webhooks.updateEventSubscription', + params: ['appId: number;', 'subscriptionId: number;', 'active?: boolean;'], + response: + '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', + markdown: + "## update_event_subscription\n\n`client.webhooks.updateEventSubscription(appId: number, subscriptionId: number, active?: boolean): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**patch** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nUpdate an existing event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n- `active?: boolean`\n A boolean indicating whether the subscription is active. If true, the subscription is active; if false, it is inactive.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.updateEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.updateEventSubscription', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.updateEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse.id);", + }, + python: { + method: 'webhooks.update_event_subscription', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.update_event_subscription(\n subscription_id=0,\n app_id=0,\n)\nprint(subscription_response.id)', + }, + java: { + method: 'webhooks().updateEventSubscription', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionPatchRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookUpdateEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookUpdateEventSubscriptionParams params = WebhookUpdateEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .subscriptionPatchRequest(SubscriptionPatchRequest.builder().build())\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().updateEventSubscription(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.UpdateEventSubscription', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.UpdateEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookUpdateEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t\tSubscriptionPatchRequest: webhooks.SubscriptionPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', + }, + ruby: { + method: 'webhooks.update_event_subscription', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.update_event_subscription(0, app_id: 0)\n\nputs(subscription_response)', + }, + php: { + method: 'webhooks->updateEventSubscription', + example: + "webhooks->updateEventSubscription(\n 0, appID: 0, active: true\n);\n\nvar_dump($subscriptionResponse);", + }, + http: { + example: + "curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", + }, + }, + }, + { + name: 'update_settings', + endpoint: '/webhooks/2026-03/{appId}/settings', + httpMethod: 'put', + summary: 'Update webhook settings', + description: 'Update webhook settings for the specified app.', + stainlessPath: '(resource) webhooks > (method) update_settings', + qualified: 'client.webhooks.updateSettings', + params: ['appId: number;', 'targetUrl: string;', 'throttling: { maxConcurrentRequests: number; };'], + response: + '{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }', + markdown: + "## update_settings\n\n`client.webhooks.updateSettings(appId: number, targetUrl: string, throttling: { maxConcurrentRequests: number; }): { createdAt: string; targetUrl: string; throttling: throttling_settings; updatedAt?: string; }`\n\n**put** `/webhooks/2026-03/{appId}/settings`\n\nUpdate webhook settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `targetUrl: string`\n The URL to which webhook events will be sent. It is a string.\n\n- `throttling: { maxConcurrentRequests: number; }`\n - `maxConcurrentRequests: number`\n The maximum number of concurrent requests allowed. This is an integer value.\n\n### Returns\n\n- `{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }`\n\n - `createdAt: string`\n - `targetUrl: string`\n - `throttling: { maxConcurrentRequests: number; }`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.webhooks.updateSettings(0, {\n targetUrl: 'targetUrl',\n throttling: { maxConcurrentRequests: 0 },\n});\n\nconsole.log(settingsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.webhooks.updateSettings', + example: + "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.webhooks.updateSettings(0, {\n targetUrl: 'targetUrl',\n throttling: { maxConcurrentRequests: 0 },\n});\n\nconsole.log(settingsResponse.createdAt);", + }, + python: { + method: 'webhooks.update_settings', + example: + 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.webhooks.update_settings(\n app_id=0,\n target_url="targetUrl",\n throttling={\n "max_concurrent_requests": 0\n },\n)\nprint(settings_response.created_at)', + }, + java: { + method: 'webhooks().updateSettings', + example: + 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SettingsChangeRequest;\nimport com.hubspot.sdk.models.webhooks.SettingsResponse;\nimport com.hubspot.sdk.models.webhooks.ThrottlingSettings;\nimport com.hubspot.sdk.models.webhooks.WebhookUpdateSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookUpdateSettingsParams params = WebhookUpdateSettingsParams.builder()\n .appId(0)\n .settingsChangeRequest(SettingsChangeRequest.builder()\n .targetUrl("targetUrl")\n .throttling(ThrottlingSettings.builder()\n .maxConcurrentRequests(0)\n .build())\n .build())\n .build();\n SettingsResponse settingsResponse = client.webhooks().updateSettings(params);\n }\n}', + }, + go: { + method: 'client.Webhooks.UpdateSettings', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Webhooks.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookUpdateSettingsParams{\n\t\t\tSettingsChangeRequest: webhooks.SettingsChangeRequestParam{\n\t\t\t\tTargetURL: "targetUrl",\n\t\t\t\tThrottling: webhooks.ThrottlingSettingsParam{\n\t\t\t\t\tMaxConcurrentRequests: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.CreatedAt)\n}\n', + }, + ruby: { + method: 'webhooks.update_settings', + example: + 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.webhooks.update_settings(0, target_url: "targetUrl", throttling: {maxConcurrentRequests: 0})\n\nputs(settings_response)', + }, + php: { + method: 'webhooks->updateSettings', + example: + "webhooks->updateSettings(\n 0, targetURL: 'targetUrl', throttling: ['maxConcurrentRequests' => 0]\n);\n\nvar_dump($settingsResponse);", + }, + http: { + example: + 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "targetUrl": "targetUrl",\n "throttling": {\n "maxConcurrentRequests": 0\n }\n }\'', + }, + }, + }, +]; + +const EMBEDDED_READMES: { language: string; content: string }[] = [ + { + language: 'go', + content: + '# HubSpot Go API Library\n\nGo Reference\n\nThe HubSpot Go library provides convenient access to the [HubSpot REST API](https://developers.hubspot.com/docs/api-reference/overview)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/HubSpot/hubspot-sdk-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/HubSpot/hubspot-sdk-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresult, err := client.Crm.Objects.Contacts.Get(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", result.ID)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.Crm.Objects.Contacts.New(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/HubSpot/hubspot-sdk-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.Crm.Objects.Contacts.ListAutoPaging(context.TODO(), crm.ObjectContactListParams{\n\tLimit: hubspotsdk.Int(100),\n})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tsimplePublicObjectWithAssociations := iter.Current()\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.Crm.Objects.Contacts.List(context.TODO(), crm.ObjectContactListParams{\n\tLimit: hubspotsdk.Int(100),\n})\nfor page != nil {\n\tfor _, contact := range page.Results {\n\t\tfmt.Printf("%+v\\n", contact)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.Crm.Objects.Contacts.New(context.TODO(), crm.ObjectContactNewParams{\n\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\tID: "id",\n\t\t\t},\n\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t}},\n\t\t}},\n\t\tProperties: map[string]string{\n\t\t\t"foo": "string",\n\t\t},\n\t},\n})\nif err != nil {\n\tvar apierr *hubspotsdk.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/crm/objects/2026-03/contacts": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.Crm.Objects.Contacts.New(\n\tctx,\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n```go\n// A file from the file system\nfile, err := os.Open("/path/to/file")\ncms.HubdbTableImportDraftParams{\n\tFile: file,\n}\n\n// A file from a string\ncms.HubdbTableImportDraftParams{\n\tFile: strings.NewReader("my file contents"),\n}\n\n// With a custom filename and contentType\ncms.HubdbTableImportDraftParams{\n\tFile: hubspotsdk.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),\n}\n```\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := hubspotsdk.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.Crm.Objects.Contacts.New(\n\tcontext.TODO(),\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\nsimplePublicObject, err := client.Crm.Objects.Contacts.New(\n\tcontext.TODO(),\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", simplePublicObject)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + }, + { + language: 'java', + content: + '# HubSpot Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.hubspot.sdk/hubspot-java)](https://central.sonatype.com/artifact/com.hubspot.sdk/hubspot-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.hubspot.sdk/hubspot-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.hubspot.sdk/hubspot-java/0.0.1)\n\n\nThe HubSpot Java SDK provides convenient access to the [HubSpot REST API](https://developers.hubspot.com/docs/api-reference/overview) from applications written in Java.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.hubspot.sdk/hubspot-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.hubspot.sdk:hubspot-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.hubspot.sdk\n hubspot-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get("contactId");\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------- | ----------------- | -------------------- | -------- | -------------------------- |\n| `baseUrl` | `hubspot.baseUrl` | `HUBSPOT_BASE_URL` | true | `"https://api.hubapi.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\n\nHubSpotClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the HubSpot API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.crm().objects().contacts().get(...)` should be called with an instance of `ContactGetParams`, and it will return an instance of `SimplePublicObjectWithAssociations`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\nimport java.util.concurrent.CompletableFuture;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture result = client.async().crm().objects().contacts().get("contactId");\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClientAsync;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClientAsync;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\nimport java.util.concurrent.CompletableFuture;\n\nHubSpotClientAsync client = HubSpotOkHttpClientAsync.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture result = client.crm().objects().contacts().get("contactId");\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n## File uploads\n\nThe SDK defines methods that accept files.\n\nTo upload a file, pass a [`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html):\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.nio.file.Paths;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(Paths.get("/path/to/file"))\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nOr an arbitrary [`InputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html):\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.net.URL;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(new URL("https://example.com//path/to/file").openStream())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nOr a `byte[]` array:\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file("content".getBytes())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nNote that when passing a non-`Path` its filename is unknown so it will not be included in the request. To manually set a filename, pass a [`MultipartField`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt):\n\n```java\nimport com.hubspot.sdk.core.MultipartField;\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.io.InputStream;\nimport java.net.URL;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(MultipartField.builder()\n .value(new URL("https://example.com//path/to/file").openStream())\n .filename("/path/to/file")\n .build())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\n## Binary responses\n\nThe SDK defines methods that return binary responses, which are used for API responses that shouldn\'t necessarily be parsed, like non-JSON data.\n\nThese methods return [`HttpResponse`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/HttpResponse.kt):\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthCreateTokenParams;\n\nHttpResponse response = client.auth().oauth().createToken();\n```\n\nTo save the response content to a file, use the [`Files.copy(...)`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html#copy-java.io.InputStream-java.nio.file.Path-java.nio.file.CopyOption...-) method:\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\nimport java.nio.file.StandardCopyOption;\n\ntry (HttpResponse response = client.auth().oauth().createToken(params)) {\n Files.copy(\n response.body(),\n Paths.get(path),\n StandardCopyOption.REPLACE_EXISTING\n );\n} catch (Exception e) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(e);\n}\n```\n\nOr transfer the response content to any [`OutputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html):\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\ntry (HttpResponse response = client.auth().oauth().createToken(params)) {\n response.body().transferTo(Files.newOutputStream(Paths.get(path)));\n} catch (Exception e) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(e);\n}\n```\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.Headers;\nimport com.hubspot.sdk.core.http.HttpResponseFor;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\nSimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\nHttpResponseFor simplePublicObject = client.crm().objects().contacts().withRawResponse().create(params);\n\nint statusCode = simplePublicObject.statusCode();\nHeaders headers = simplePublicObject.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\n\nSimplePublicObject parsedSimplePublicObject = simplePublicObject.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`HubSpotServiceException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnexpectedStatusCodeException.kt) |\n\n- [`HubSpotIoException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotIoException.kt): I/O networking errors.\n\n- [`HubSpotRetryableException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`HubSpotInvalidDataException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`HubSpotException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\n\nContactListPage page = client.crm().objects().contacts().list();\n\n// Process as an Iterable\nfor (SimplePublicObjectWithAssociations contact : page.autoPager()) {\n System.out.println(contact);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(contact -> System.out.println(contact));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.hubspot.sdk.core.http.AsyncStreamResponse;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPageAsync;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().crm().objects().contacts().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(contact -> {\n System.out.println(contact);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(SimplePublicObjectWithAssociations contact) {\n System.out.println(contact);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(contact -> {\n System.out.println(contact);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\n\nContactListPage page = client.crm().objects().contacts().list();\nwhile (true) {\n for (SimplePublicObjectWithAssociations contact : page.items()) {\n System.out.println(contact);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nEnable logging by setting the `HUBSPOT_LOG` environment variable to `info`:\n\n```sh\nexport HUBSPOT_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport HUBSPOT_LOG=debug\n```\n\nOr configure the client manually using the `logLevel` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.LogLevel;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .logLevel(LogLevel.INFO)\n .accessToken("My Access Token")\n .build();\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `hubspot-java-core` is published with a [configuration file](hubspot-java-core/src/main/resources/META-INF/proguard/hubspot-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\n\nSimplePublicObject simplePublicObject = client.crm().objects().contacts().create(\n params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()\n);\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.time.Duration;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\nIf the proxy responds with `407 Proxy Authentication Required`, supply credentials by also configuring `proxyAuthenticator`:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.ProxyAuthenticator;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .proxy(...)\n // Or a custom implementation of `ProxyAuthenticator`.\n .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.time.Duration;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `hubspot-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`HubSpotClient`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClient.kt), [`HubSpotClientAsync`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsync.kt), [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt), and [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), all of which can work with any HTTP client\n- `hubspot-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) and [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), which provide a way to construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) and [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), respectively, using OkHttp\n- `hubspot-java`\n - Depends on and exposes the APIs of both `hubspot-java-core` and `hubspot-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`hubspot-java` dependency](#installation) with `hubspot-java-core`\n2. Copy `hubspot-java-client-okhttp`\'s [`OkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) or [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), similarly to [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`hubspot-java` dependency](#installation) with `hubspot-java-core`\n2. Write a class that implements the [`HttpClient`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/HttpClient.kt) interface\n3. Construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) or [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), similarly to [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt) object to its setter:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt):\n\n```java\nimport com.hubspot.sdk.core.JsonMissing;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder()\n .contactId(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.crm().objects().contacts().get(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.hubspot.sdk.core.JsonField;\nimport java.util.Optional;\n\nJsonField field = client.crm().objects().contacts().get(params)._field();\n\nif (field.isMissing()) {\n // The property is absent from the JSON response\n} else if (field.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = field.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = field.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`HubSpotInvalidDataException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotInvalidDataException.kt) only if you directly access the property.\n\nValidating the response is _not_ forwards compatible with new types from the API for existing fields.\n\nIf you would still prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-java/issues) with questions, bugs, or suggestions.\n', + }, + { + language: 'php', + content: + "# HubSpot PHP API Library\n\nThe HubSpot PHP library provides convenient access to the HubSpot REST API from any PHP 8.1.0+ application.\n\n## Installation\n\n\n```\ncomposer require \"hubspot/sdk 0.0.1\"\n```\n\n\n## Usage\n\n```php\ncrm->objects->contacts->get(\n 'contactId'\n);\n\nvar_dump($simplePublicObjectWithAssociations->id);\n```", + }, + { + language: 'python', + content: + '# HubSpot Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/hubspot-sdk.svg?label=pypi%20(stable))](https://pypi.org/project/hubspot-sdk/)\n\nThe HubSpot Python library provides convenient access to the HubSpot REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install hubspot-sdk\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\n\nresult = client.crm.objects.contacts.get(\n contact_id="contactId",\n)\nprint(result.id)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncHubSpot` instead of `HubSpot` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom hubspot_sdk import AsyncHubSpot\n\nclient = AsyncHubSpot(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n result = await client.crm.objects.contacts.get(\n contact_id="contactId",\n )\n print(result.id)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install hubspot-sdk[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom hubspot_sdk import DefaultAioHttpClient\nfrom hubspot_sdk import AsyncHubSpot\n\nasync def main() -> None:\n async with AsyncHubSpot(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n result = await client.crm.objects.contacts.get(\n contact_id="contactId",\n )\n print(result.id)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the HubSpot API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\nall_contacts = []\n# Automatically fetches more pages as needed.\nfor contact in client.crm.objects.contacts.list(\n limit=100,\n):\n # Do something with contact here\n all_contacts.append(contact)\nprint(all_contacts)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom hubspot_sdk import AsyncHubSpot\n\nclient = AsyncHubSpot()\n\nasync def main() -> None:\n all_contacts = []\n # Iterate through items across all pages, issuing requests as needed.\n async for contact in client.crm.objects.contacts.list(\n limit=100,\n):\n all_contacts.append(contact)\n print(all_contacts)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.crm.objects.contacts.list(\n limit=100,\n)\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.results)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.crm.objects.contacts.list(\n limit=100,\n)\n\nprint(f"next page cursor: {first_page.paging.next.after}") # => "next page cursor: ..."\nfor contact in first_page.results:\n print(contact.id)\n\n# Remove `await` for non-async usage.\n```\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\npublic_action_definition = client.automation.actions.definitions.create(\n app_id=0,\n action_url="actionUrl",\n functions=[{\n "function_source": "functionSource",\n "function_type": "POST_ACTION_EXECUTION",\n }],\n input_fields=[{\n "is_required": True,\n "type_definition": {\n "name": "name",\n "options": [{\n "label": "label",\n "value": "value",\n }],\n "type": "bool",\n },\n }],\n labels={\n "foo": {\n "action_name": "actionName"\n }\n },\n object_types=["string"],\n published=True,\n object_request_options={\n "properties": ["string"]\n },\n)\nprint(public_action_definition.object_request_options)\n```\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.\n\n```python\nfrom pathlib import Path\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\nclient.cms.hubdb.tables.import_draft(\n table_id_or_name="tableIdOrName",\n file=Path("/path/to/file"),\n)\n```\n\nThe async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `hubspot_sdk.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `hubspot_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `hubspot_sdk.APIError`.\n\n```python\nimport hubspot_sdk\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\ntry:\n client.crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n )\nexcept hubspot_sdk.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept hubspot_sdk.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept hubspot_sdk.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom hubspot_sdk import HubSpot\n\n# Configure the default for all requests:\nclient = HubSpot(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom hubspot_sdk import HubSpot\n\n# Configure the default for all requests:\nclient = HubSpot(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = HubSpot(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `HUBSPOT_LOG` to `info`.\n\n```shell\n$ export HUBSPOT_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\nresponse = client.crm.objects.contacts.with_raw_response.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(response.headers.get(\'X-My-Header\'))\n\ncontact = response.parse() # get the object that `crm.objects.contacts.create()` would have returned\nprint(contact.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/HubSpot/hubspot-sdk-python/tree/main/src/hubspot_sdk/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/HubSpot/hubspot-sdk-python/tree/main/src/hubspot_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.crm.objects.contacts.with_streaming_response.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n) as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom hubspot_sdk import HubSpot, DefaultHttpxClient\n\nclient = HubSpot(\n # Or use the `HUBSPOT_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom hubspot_sdk import HubSpot\n\nwith HubSpot() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport hubspot_sdk\nprint(hubspot_sdk.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + }, + { + language: 'ruby', + content: + '# HubSpot Ruby API library\n\nThe HubSpot Ruby library provides convenient access to the HubSpot REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/HubSpot/hubspot-sdk-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/hubspot-sdk).\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "hubspot-sdk", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contacts.get("contactId")\n\nputs(simple_public_object_with_associations.id)\n```\n\n\n\n### Pagination\n\nList methods in the HubSpot API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = hubspot.crm.objects.contacts.list(limit: 100)\n\n# Fetch single item from page.\ncontact = page.results[0]\nputs(contact.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |contact|\n puts(contact.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.results[0].id)\nend\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.\n\n```ruby\nrequire "pathname"\n\n# Use `Pathname` to send the filename and/or avoid paging a large file into memory:\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: Pathname("/path/to/file"))\n\n# Alternatively, pass file contents or a `StringIO` directly:\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: File.read("/path/to/file"))\n\n# Or, to control the filename and/or content type:\nfile = HubSpotSDK::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: file)\n\nputs(import_result.duplicateRows)\n```\n\nNote that you can also pass a raw `IO` descriptor, but this disables retries, as the library can\'t be sure if the descriptor is a file or pipe (which cannot be rewound).\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `HubSpotSDK::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n contact = hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"}\n )\nrescue HubSpotSDK::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue HubSpotSDK::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue HubSpotSDK::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nhubspot = HubSpotSDK::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nhubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {max_retries: 5}\n)\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nhubspot = HubSpotSDK::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nhubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {timeout: 5}\n)\n```\n\nOn timeout, `HubSpotSDK::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `HubSpotSDK::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\nsimple_public_object =\n hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(simple_public_object[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `HubSpotSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `HubSpotSDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nhubspot.crm.objects.contacts.get("contactId")\n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nhubspot.crm.objects.contacts.get("contactId")\n\n# You can also splat a full Params class:\nparams = HubSpotSDK::Crm::Objects::ContactGetParams.new\nhubspot.crm.objects.contacts.get("contactId", **params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :authorization_code\nputs(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE)\n\n# Revealed type: `T.all(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType, Symbol)`\nT.reveal_type(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nhubspot.auth.oauth.create_token(\n grant_type: HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE,\n # …\n)\n\n# Literal values are also permissible:\nhubspot.auth.oauth.create_token(\n grant_type: :authorization_code,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/HubSpot/hubspot-sdk-ruby/tree/main/CONTRIBUTING.md).\n', + }, + { + language: 'typescript', + content: + "# HubSpot TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@hubspot/sdk.svg?label=npm%20(stable))](https://npmjs.org/package/@hubspot/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@hubspot/sdk)\n\nThis library provides convenient access to the HubSpot REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @hubspot/sdk\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst result = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(result.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst params: HubSpot.Crm.Objects.ContactCreateParams = {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n};\nconst simplePublicObject: HubSpot.SimplePublicObject = await client.crm.objects.contacts.create(\n params,\n);\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed in many different forms:\n- `File` (or an object with the same structure)\n- a `fetch` `Response` (or an object with the same structure)\n- an `fs.ReadStream`\n- the return value of our `toFile` helper\n\n```ts\nimport fs from 'fs';\nimport HubSpot, { toFile } from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// If you have access to Node `fs` we recommend using `fs.createReadStream()`:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: fs.createReadStream('/path/to/file'),\n});\n\n// Or if you have the web `File` API you can pass a `File` instance:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: new File(['my bytes'], 'file'),\n});\n\n// You can also pass a `fetch` `Response`:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await fetch('https://somesite/file'),\n});\n\n// Finally, if none of the above are convenient, you can use our `toFile` helper:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await toFile(Buffer.from('my bytes'), 'file'),\n});\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await toFile(new Uint8Array([0, 1, 2]), 'file'),\n});\n```\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst simplePublicObject = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .catch(async (err) => {\n if (err instanceof HubSpot.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n });\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new HubSpot({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}, {\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new HubSpot({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}, {\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the HubSpot API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllSimplePublicObjectWithAssociations(params) {\n const allSimplePublicObjectWithAssociations = [];\n // Automatically fetches more pages as needed.\n for await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list({\n limit: 100,\n })) {\n allSimplePublicObjectWithAssociations.push(simplePublicObjectWithAssociations);\n }\n return allSimplePublicObjectWithAssociations;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.crm.objects.contacts.list({ limit: 100 });\nfor (const simplePublicObjectWithAssociations of page.results) {\n console.log(simplePublicObjectWithAssociations);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n\n\n## Advanced Usage\n\n### Tree shaking\n\nThis library supports tree shaking to reduce bundle size. Instead of importing the full client, you can create a client only including the API resources you need:\n\n~~~ts\nimport { createClient } from '@hubspot/sdk/tree-shakable';\nimport { Contacts } from '@hubspot/sdk/resources/crm/objects/contacts/contacts';\nimport { BaseTables } from '@hubspot/sdk/resources/cms/hubdb/tables';\n\nconst client = createClient({\n // Specify the resources you'd like to use ...\n resources: [Contacts, BaseTables],\n});\n\n// ... then make API calls as usual.\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', { copyRows: true, isHubspotDefined: true });\n~~~\n\nEach API resource has two versions, the full resource (e.g., `Contacts`) which includes all subresources, and the base resource (e.g., `BaseContacts`) which does not.\n\nThe tree-shaken client is fully typed, so TypeScript will provide accurate autocomplete and prevent access to resources not included in your configuration.\nThe `createClient` function automatically infers the correct type, but you can also use the `PartialHubSpot` type explicitly:\n\n~~~ts\nimport HubSpot from '@hubspot/sdk';\nimport { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable';\nimport { BaseContacts } from '@hubspot/sdk/resources/crm/objects/contacts/contacts';\n\n// Explicit variable type\nconst client: PartialHubSpot<{ crm: { objects: { contacts: BaseContacts } } }> = createClient({\n resources: [BaseContacts],\n /* ... */\n});\n\n// Function parameter type\nasync function main(client: PartialHubSpot<{ crm: { objects: { contacts: BaseContacts } } }>) {\n const simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n }],\n properties: { foo: 'string' },\n });\n}\n\n// Works with any client that has the contacts resource\nconst treeShakableClient = createClient({\n resources: [BaseContacts],\n /* ... */\n});\nconst fullClient = new HubSpot(/* ... */);\n\nmain(treeShakableClient); // Works\nmain(fullClient); // Also works\n~~~\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new HubSpot();\n\nconst response = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: simplePublicObject, response: raw } = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nconsole.log(simplePublicObject.id);\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `HUBSPOT_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new HubSpot({\n logger: logger.child({ name: 'HubSpot' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.crm.objects.contacts.get({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport fetch from 'my-fetch';\n\nconst client = new HubSpot({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new HubSpot({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport HubSpot from 'npm:@hubspot/sdk';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new HubSpot({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-typescript/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", + }, +]; + +const INDEX_OPTIONS = { + fields: [ + 'name', + 'endpoint', + 'summary', + 'description', + 'qualified', + 'stainlessPath', + 'content', + 'sectionContext', + ], + storeFields: ['kind', '_original'], + searchOptions: { + prefix: true, + fuzzy: 0.1, + boost: { + name: 5, + stainlessPath: 3, + endpoint: 3, + qualified: 3, + summary: 2, + content: 1, + description: 1, + } as Record, + }, +}; + +/** + * Self-contained local search engine backed by MiniSearch. + * Method data is embedded at SDK build time; prose documents + * can be loaded from an optional docs directory at runtime. + */ +export class LocalDocsSearch { + private methodIndex: MiniSearch; + private proseIndex: MiniSearch; + + private constructor() { + this.methodIndex = new MiniSearch(INDEX_OPTIONS); + this.proseIndex = new MiniSearch(INDEX_OPTIONS); + } + + static async create(opts?: { docsDir?: string }): Promise { + const instance = new LocalDocsSearch(); + instance.indexMethods(EMBEDDED_METHODS); + for (const readme of EMBEDDED_READMES) { + instance.indexProse(readme.content, `readme:${readme.language}`); + } + if (opts?.docsDir) { + await instance.loadDocsDirectory(opts.docsDir); + } + return instance; + } + + search(props: { + query: string; + language?: string; + detail?: string; + maxResults?: number; + maxLength?: number; + }): SearchResult { + const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props; + + const useMarkdown = detail === 'verbose' || detail === 'high'; + + // Search both indices and merge results by score. + // Filter prose hits so language-tagged content (READMEs and docs with + // frontmatter) only matches the requested language. + const methodHits = this.methodIndex + .search(query) + .map((hit) => ({ ...hit, _kind: 'http_method' as const })); + const proseHits = this.proseIndex + .search(query) + .filter((hit) => { + const source = ((hit as Record)['_original'] as ProseChunk | undefined)?.source; + if (!source) return true; + // Check for language-tagged sources: "readme:" or "lang::" + let taggedLang: string | undefined; + if (source.startsWith('readme:')) taggedLang = source.slice('readme:'.length); + else if (source.startsWith('lang:')) taggedLang = source.split(':')[1]; + if (!taggedLang) return true; + return taggedLang === language || (language === 'javascript' && taggedLang === 'typescript'); + }) + .map((hit) => ({ ...hit, _kind: 'prose' as const })); + const merged = [...methodHits, ...proseHits].sort((a, b) => b.score - a.score); + const top = merged.slice(0, maxResults); + + const fullResults: (string | Record)[] = []; + + for (const hit of top) { + const original = (hit as Record)['_original']; + if (hit._kind === 'http_method') { + const m = original as MethodEntry; + if (useMarkdown && m.markdown) { + fullResults.push(m.markdown); + } else { + // Use per-language data when available, falling back to the + // top-level fields (which are TypeScript-specific in the + // legacy codepath). + const langData = m.perLanguage?.[language]; + fullResults.push({ + method: langData?.method ?? m.qualified, + summary: m.summary, + description: m.description, + endpoint: `${m.httpMethod.toUpperCase()} ${m.endpoint}`, + ...(langData?.example ? { example: langData.example } : {}), + ...(m.params ? { params: m.params } : {}), + ...(m.response ? { response: m.response } : {}), + }); + } + } else { + const c = original as ProseChunk; + fullResults.push({ + content: c.content, + ...(c.source ? { source: c.source } : {}), + }); + } + } + + let totalLength = 0; + const results: (string | Record)[] = []; + for (const result of fullResults) { + const len = typeof result === 'string' ? result.length : JSON.stringify(result).length; + totalLength += len; + if (totalLength > maxLength) break; + results.push(result); + } + + if (results.length < fullResults.length) { + results.unshift(`Truncated; showing ${results.length} of ${fullResults.length} results.`); + } + + return { results }; + } + + private indexMethods(methods: MethodEntry[]): void { + const docs: MiniSearchDocument[] = methods.map((m, i) => ({ + id: `method-${i}`, + kind: 'http_method' as const, + name: m.name, + endpoint: m.endpoint, + summary: m.summary, + description: m.description, + qualified: m.qualified, + stainlessPath: m.stainlessPath, + _original: m as unknown as Record, + })); + if (docs.length > 0) { + this.methodIndex.addAll(docs); + } + } + + private async loadDocsDirectory(docsDir: string): Promise { + let entries; + try { + entries = await fs.readdir(docsDir, { withFileTypes: true }); + } catch (err) { + getLogger().warn({ err, docsDir }, 'Could not read docs directory'); + return; + } + + const files = entries + .filter((e) => e.isFile()) + .filter((e) => e.name.endsWith('.md') || e.name.endsWith('.markdown') || e.name.endsWith('.json')); + + for (const file of files) { + try { + const filePath = path.join(docsDir, file.name); + const content = await fs.readFile(filePath, 'utf-8'); + + if (file.name.endsWith('.json')) { + const texts = extractTexts(JSON.parse(content)); + if (texts.length > 0) { + this.indexProse(texts.join('\n\n'), file.name); + } + } else { + // Parse optional YAML frontmatter for language tagging. + // Files with a "language" field in frontmatter will only + // surface in searches for that language. + // + // Example: + // --- + // language: python + // --- + // # Error handling in Python + // ... + const frontmatter = parseFrontmatter(content); + const source = frontmatter.language ? `lang:${frontmatter.language}:${file.name}` : file.name; + this.indexProse(content, source); + } + } catch (err) { + getLogger().warn({ err, file: file.name }, 'Failed to index docs file'); + } + } + } + + private indexProse(markdown: string, source: string): void { + const chunks = chunkMarkdown(markdown); + const baseId = this.proseIndex.documentCount; + + const docs: MiniSearchDocument[] = chunks.map((chunk, i) => ({ + id: `prose-${baseId + i}`, + kind: 'prose' as const, + content: chunk.content, + ...(chunk.sectionContext != null ? { sectionContext: chunk.sectionContext } : {}), + _original: { ...chunk, source } as unknown as Record, + })); + + if (docs.length > 0) { + this.proseIndex.addAll(docs); + } + } +} + +/** Lightweight markdown chunker — splits on headers, chunks by word count. */ +function chunkMarkdown(markdown: string): { content: string; tag: string; sectionContext?: string }[] { + // Strip YAML frontmatter + const stripped = markdown.replace(/^---\n[\s\S]*?\n---\n?/, ''); + const lines = stripped.split('\n'); + + const chunks: { content: string; tag: string; sectionContext?: string }[] = []; + const headers: string[] = []; + let current: string[] = []; + + const flush = () => { + const text = current.join('\n').trim(); + if (!text) return; + const sectionContext = headers.length > 0 ? headers.join(' > ') : undefined; + // Split into ~200-word chunks + const words = text.split(/\s+/); + for (let i = 0; i < words.length; i += 200) { + const slice = words.slice(i, i + 200).join(' '); + if (slice) { + chunks.push({ content: slice, tag: 'p', ...(sectionContext != null ? { sectionContext } : {}) }); + } + } + current = []; + }; + + for (const line of lines) { + const headerMatch = line.match(/^(#{1,6})\s+(.+)/); + if (headerMatch) { + flush(); + const level = headerMatch[1]!.length; + const text = headerMatch[2]!.trim(); + while (headers.length >= level) headers.pop(); + headers.push(text); + } else { + current.push(line); + } + } + flush(); + + return chunks; +} + +/** Recursively extracts string values from a JSON structure. */ +function extractTexts(data: unknown, depth = 0): string[] { + if (depth > 10) return []; + if (typeof data === 'string') return data.trim() ? [data] : []; + if (Array.isArray(data)) return data.flatMap((item) => extractTexts(item, depth + 1)); + if (typeof data === 'object' && data !== null) { + return Object.values(data).flatMap((v) => extractTexts(v, depth + 1)); + } + return []; +} + +/** Parses YAML frontmatter from a markdown string, extracting the language field if present. */ +function parseFrontmatter(markdown: string): { language?: string } { + const match = markdown.match(/^---\n([\s\S]*?)\n---/); + if (!match) return {}; + const body = match[1] ?? ''; + const langMatch = body.match(/^language:\s*(.+)$/m); + return langMatch ? { language: langMatch[1]!.trim() } : {}; +} diff --git a/packages/mcp-server/src/logger.ts b/packages/mcp-server/src/logger.ts new file mode 100644 index 00000000..29dab11c --- /dev/null +++ b/packages/mcp-server/src/logger.ts @@ -0,0 +1,28 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { pino, type Level, type Logger } from 'pino'; +import pretty from 'pino-pretty'; + +let _logger: Logger | undefined; + +export function configureLogger({ level, pretty: usePretty }: { level: Level; pretty: boolean }): void { + _logger = pino( + { + level, + timestamp: pino.stdTimeFunctions.isoTime, + formatters: { + level(label) { + return { level: label }; + }, + }, + }, + usePretty ? pretty({ colorize: true, levelFirst: true, destination: 2 }) : process.stderr, + ); +} + +export function getLogger(): Logger { + if (!_logger) { + throw new Error('Logger has not been configured. Call configureLogger() before using the logger.'); + } + return _logger; +} diff --git a/packages/mcp-server/src/methods.ts b/packages/mcp-server/src/methods.ts new file mode 100644 index 00000000..7683c8ee --- /dev/null +++ b/packages/mcp-server/src/methods.ts @@ -0,0 +1,5982 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { McpOptions } from './options'; + +export type SdkMethod = { + clientCallName: string; + fullyQualifiedName: string; + httpMethod?: 'get' | 'post' | 'put' | 'patch' | 'delete' | 'query'; + httpPath?: string; +}; + +export const sdkMethods: SdkMethod[] = [ + { + clientCallName: 'client.account.get', + fullyQualifiedName: 'account.get', + httpMethod: 'get', + httpPath: '/account-info/2026-03/details', + }, + { + clientCallName: 'client.account.getDailyPrivateAppsUsage', + fullyQualifiedName: 'account.getDailyPrivateAppsUsage', + httpMethod: 'get', + httpPath: '/account-info/2026-03/api-usage/daily/private-apps', + }, + { + clientCallName: 'client.account.activity.listAuditLogs', + fullyQualifiedName: 'account.activity.listAuditLogs', + httpMethod: 'get', + httpPath: '/account-info/2026-03/activity/audit-logs', + }, + { + clientCallName: 'client.account.activity.listLoginActivities', + fullyQualifiedName: 'account.activity.listLoginActivities', + httpMethod: 'get', + httpPath: '/account-info/2026-03/activity/login', + }, + { + clientCallName: 'client.account.activity.listSecurityActivities', + fullyQualifiedName: 'account.activity.listSecurityActivities', + httpMethod: 'get', + httpPath: '/account-info/2026-03/activity/security', + }, + { + clientCallName: 'client.auth.oauth.createToken', + fullyQualifiedName: 'auth.oauth.createToken', + httpMethod: 'post', + httpPath: '/oauth/2026-03/token', + }, + { + clientCallName: 'client.auth.oauth.introspectToken', + fullyQualifiedName: 'auth.oauth.introspectToken', + httpMethod: 'post', + httpPath: '/oauth/2026-03/token/introspect', + }, + { + clientCallName: 'client.auth.oauth.revokeToken', + fullyQualifiedName: 'auth.oauth.revokeToken', + httpMethod: 'post', + httpPath: '/oauth/2026-03/token/revoke', + }, + { + clientCallName: 'client.automation.actions.callbacks.complete', + fullyQualifiedName: 'automation.actions.callbacks.complete', + httpMethod: 'post', + httpPath: '/automation/actions/callbacks/2026-03/{callbackId}/complete', + }, + { + clientCallName: 'client.automation.actions.callbacks.completeBatch', + fullyQualifiedName: 'automation.actions.callbacks.completeBatch', + httpMethod: 'post', + httpPath: '/automation/actions/callbacks/2026-03/complete', + }, + { + clientCallName: 'client.automation.actions.definitions.create', + fullyQualifiedName: 'automation.actions.definitions.create', + httpMethod: 'post', + httpPath: '/automation/actions/2026-03/{appId}', + }, + { + clientCallName: 'client.automation.actions.definitions.update', + fullyQualifiedName: 'automation.actions.definitions.update', + httpMethod: 'patch', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', + }, + { + clientCallName: 'client.automation.actions.definitions.list', + fullyQualifiedName: 'automation.actions.definitions.list', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}', + }, + { + clientCallName: 'client.automation.actions.definitions.delete', + fullyQualifiedName: 'automation.actions.definitions.delete', + httpMethod: 'delete', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', + }, + { + clientCallName: 'client.automation.actions.definitions.createRequiresObject', + fullyQualifiedName: 'automation.actions.definitions.createRequiresObject', + httpMethod: 'post', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', + }, + { + clientCallName: 'client.automation.actions.definitions.get', + fullyQualifiedName: 'automation.actions.definitions.get', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', + }, + { + clientCallName: 'client.automation.actions.definitions.getRequiresObject', + fullyQualifiedName: 'automation.actions.definitions.getRequiresObject', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', + }, + { + clientCallName: 'client.automation.actions.functions.list', + fullyQualifiedName: 'automation.actions.functions.list', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions', + }, + { + clientCallName: 'client.automation.actions.functions.delete', + fullyQualifiedName: 'automation.actions.functions.delete', + httpMethod: 'delete', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + }, + { + clientCallName: 'client.automation.actions.functions.createOrReplace', + fullyQualifiedName: 'automation.actions.functions.createOrReplace', + httpMethod: 'put', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + }, + { + clientCallName: 'client.automation.actions.functions.createOrReplaceByFunctionType', + fullyQualifiedName: 'automation.actions.functions.createOrReplaceByFunctionType', + httpMethod: 'put', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + }, + { + clientCallName: 'client.automation.actions.functions.deleteByFunctionType', + fullyQualifiedName: 'automation.actions.functions.deleteByFunctionType', + httpMethod: 'delete', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + }, + { + clientCallName: 'client.automation.actions.functions.get', + fullyQualifiedName: 'automation.actions.functions.get', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', + }, + { + clientCallName: 'client.automation.actions.functions.getByFunctionType', + fullyQualifiedName: 'automation.actions.functions.getByFunctionType', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', + }, + { + clientCallName: 'client.automation.actions.revisions.list', + fullyQualifiedName: 'automation.actions.revisions.list', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/revisions', + }, + { + clientCallName: 'client.automation.actions.revisions.get', + fullyQualifiedName: 'automation.actions.revisions.get', + httpMethod: 'get', + httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.automation.sequences.list', + fullyQualifiedName: 'automation.sequences.list', + httpMethod: 'get', + httpPath: '/automation/sequences/2026-03', + }, + { + clientCallName: 'client.automation.sequences.createEnrollment', + fullyQualifiedName: 'automation.sequences.createEnrollment', + httpMethod: 'post', + httpPath: '/automation/sequences/2026-03/enrollments', + }, + { + clientCallName: 'client.automation.sequences.get', + fullyQualifiedName: 'automation.sequences.get', + httpMethod: 'get', + httpPath: '/automation/sequences/2026-03/{sequenceId}', + }, + { + clientCallName: 'client.automation.sequences.getEnrollmentByContactID', + fullyQualifiedName: 'automation.sequences.getEnrollmentByContactID', + httpMethod: 'get', + httpPath: '/automation/sequences/2026-03/enrollments/contact/{contactId}', + }, + { + clientCallName: 'client.businessUnits.businessUnitEntries.getByUserID', + fullyQualifiedName: 'businessUnits.businessUnitEntries.getByUserID', + httpMethod: 'get', + httpPath: '/business-units/public/2026-03/business-units/user/{userId}', + }, + { + clientCallName: 'client.cms.auditLogs.list', + fullyQualifiedName: 'cms.auditLogs.list', + httpMethod: 'get', + httpPath: '/cms/audit-logs/2026-03', + }, + { + clientCallName: 'client.cms.auditLogs.export', + fullyQualifiedName: 'cms.auditLogs.export', + httpMethod: 'post', + httpPath: '/cms/audit-logs/2026-03/export', + }, + { + clientCallName: 'client.cms.blogs.authors.create', + fullyQualifiedName: 'cms.blogs.authors.create', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors', + }, + { + clientCallName: 'client.cms.blogs.authors.update', + fullyQualifiedName: 'cms.blogs.authors.update', + httpMethod: 'patch', + httpPath: '/cms/blogs/2026-03/authors/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.authors.list', + fullyQualifiedName: 'cms.blogs.authors.list', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors', + }, + { + clientCallName: 'client.cms.blogs.authors.delete', + fullyQualifiedName: 'cms.blogs.authors.delete', + httpMethod: 'delete', + httpPath: '/cms/blogs/2026-03/authors/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.authors.attachToLangGroup', + fullyQualifiedName: 'cms.blogs.authors.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.blogs.authors.createLanguageVariation', + fullyQualifiedName: 'cms.blogs.authors.createLanguageVariation', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.blogs.authors.detachFromLangGroup', + fullyQualifiedName: 'cms.blogs.authors.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.blogs.authors.get', + fullyQualifiedName: 'cms.blogs.authors.get', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.authors.getCursor', + fullyQualifiedName: 'cms.blogs.authors.getCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor', + }, + { + clientCallName: 'client.cms.blogs.authors.getCursorByQuery', + fullyQualifiedName: 'cms.blogs.authors.getCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.authors.getPostsCursor', + fullyQualifiedName: 'cms.blogs.authors.getPostsCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor', + }, + { + clientCallName: 'client.cms.blogs.authors.getPostsCursorByQuery', + fullyQualifiedName: 'cms.blogs.authors.getPostsCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.authors.getTagsCursor', + fullyQualifiedName: 'cms.blogs.authors.getTagsCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor', + }, + { + clientCallName: 'client.cms.blogs.authors.getTagsCursorByQuery', + fullyQualifiedName: 'cms.blogs.authors.getTagsCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.authors.setNewLangPrimary', + fullyQualifiedName: 'cms.blogs.authors.setNewLangPrimary', + httpMethod: 'put', + httpPath: '/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.blogs.authors.updateLanguages', + fullyQualifiedName: 'cms.blogs.authors.updateLanguages', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.blogs.authors.batch.create', + fullyQualifiedName: 'cms.blogs.authors.batch.create', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/batch/create', + }, + { + clientCallName: 'client.cms.blogs.authors.batch.update', + fullyQualifiedName: 'cms.blogs.authors.batch.update', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/batch/update', + }, + { + clientCallName: 'client.cms.blogs.authors.batch.delete', + fullyQualifiedName: 'cms.blogs.authors.batch.delete', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/batch/archive', + }, + { + clientCallName: 'client.cms.blogs.authors.batch.get', + fullyQualifiedName: 'cms.blogs.authors.batch.get', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/authors/batch/read', + }, + { + clientCallName: 'client.cms.blogs.posts.create', + fullyQualifiedName: 'cms.blogs.posts.create', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts', + }, + { + clientCallName: 'client.cms.blogs.posts.update', + fullyQualifiedName: 'cms.blogs.posts.update', + httpMethod: 'patch', + httpPath: '/cms/blogs/2026-03/posts/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.posts.list', + fullyQualifiedName: 'cms.blogs.posts.list', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor', + }, + { + clientCallName: 'client.cms.blogs.posts.delete', + fullyQualifiedName: 'cms.blogs.posts.delete', + httpMethod: 'delete', + httpPath: '/cms/blogs/2026-03/posts/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.posts.clone', + fullyQualifiedName: 'cms.blogs.posts.clone', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/clone', + }, + { + clientCallName: 'client.cms.blogs.posts.get', + fullyQualifiedName: 'cms.blogs.posts.get', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.posts.getDraftByID', + fullyQualifiedName: 'cms.blogs.posts.getDraftByID', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft', + }, + { + clientCallName: 'client.cms.blogs.posts.listAuthors', + fullyQualifiedName: 'cms.blogs.posts.listAuthors', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor', + }, + { + clientCallName: 'client.cms.blogs.posts.listTags', + fullyQualifiedName: 'cms.blogs.posts.listTags', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor', + }, + { + clientCallName: 'client.cms.blogs.posts.pushLive', + fullyQualifiedName: 'cms.blogs.posts.pushLive', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft/push-live', + }, + { + clientCallName: 'client.cms.blogs.posts.query', + fullyQualifiedName: 'cms.blogs.posts.query', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.posts.queryAuthors', + fullyQualifiedName: 'cms.blogs.posts.queryAuthors', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.posts.queryTags', + fullyQualifiedName: 'cms.blogs.posts.queryTags', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.posts.resetDraft', + fullyQualifiedName: 'cms.blogs.posts.resetDraft', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft/reset', + }, + { + clientCallName: 'client.cms.blogs.posts.schedule', + fullyQualifiedName: 'cms.blogs.posts.schedule', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/schedule', + }, + { + clientCallName: 'client.cms.blogs.posts.updateDraft', + fullyQualifiedName: 'cms.blogs.posts.updateDraft', + httpMethod: 'patch', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft', + }, + { + clientCallName: 'client.cms.blogs.posts.batch.create', + fullyQualifiedName: 'cms.blogs.posts.batch.create', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/batch/create', + }, + { + clientCallName: 'client.cms.blogs.posts.batch.update', + fullyQualifiedName: 'cms.blogs.posts.batch.update', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/batch/update', + }, + { + clientCallName: 'client.cms.blogs.posts.batch.delete', + fullyQualifiedName: 'cms.blogs.posts.batch.delete', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/batch/archive', + }, + { + clientCallName: 'client.cms.blogs.posts.batch.get', + fullyQualifiedName: 'cms.blogs.posts.batch.get', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/batch/read', + }, + { + clientCallName: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', + fullyQualifiedName: 'cms.blogs.posts.multiLanguage.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.blogs.posts.multiLanguage.createLangVariation', + fullyQualifiedName: 'cms.blogs.posts.multiLanguage.createLangVariation', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', + fullyQualifiedName: 'cms.blogs.posts.multiLanguage.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', + fullyQualifiedName: 'cms.blogs.posts.multiLanguage.setLangPrimary', + httpMethod: 'put', + httpPath: '/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.blogs.posts.multiLanguage.updateLangs', + fullyQualifiedName: 'cms.blogs.posts.multiLanguage.updateLangs', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.blogs.posts.revisions.getPreviousVersion', + fullyQualifiedName: 'cms.blogs.posts.revisions.getPreviousVersion', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.cms.blogs.posts.revisions.getPreviousVersions', + fullyQualifiedName: 'cms.blogs.posts.revisions.getPreviousVersions', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions', + }, + { + clientCallName: 'client.cms.blogs.posts.revisions.restorePreviousVersion', + fullyQualifiedName: 'cms.blogs.posts.revisions.restorePreviousVersion', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore', + }, + { + clientCallName: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', + fullyQualifiedName: 'cms.blogs.posts.revisions.restorePreviousVersionToDraft', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft', + }, + { + clientCallName: 'client.cms.blogs.settings.list', + fullyQualifiedName: 'cms.blogs.settings.list', + httpMethod: 'get', + httpPath: '/cms/blog-settings/2026-03/settings', + }, + { + clientCallName: 'client.cms.blogs.settings.get', + fullyQualifiedName: 'cms.blogs.settings.get', + httpMethod: 'get', + httpPath: '/cms/blog-settings/2026-03/settings/{blogId}', + }, + { + clientCallName: 'client.cms.blogs.settings.getRevision', + fullyQualifiedName: 'cms.blogs.settings.getRevision', + httpMethod: 'get', + httpPath: '/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.cms.blogs.settings.listRevisions', + fullyQualifiedName: 'cms.blogs.settings.listRevisions', + httpMethod: 'get', + httpPath: '/cms/blog-settings/2026-03/settings/{blogId}/revisions', + }, + { + clientCallName: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', + fullyQualifiedName: 'cms.blogs.settings.multiLanguage.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', + fullyQualifiedName: 'cms.blogs.settings.multiLanguage.createLanguageVariation', + httpMethod: 'post', + httpPath: '/cms/blog-settings/2026-03/settings/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', + fullyQualifiedName: 'cms.blogs.settings.multiLanguage.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', + fullyQualifiedName: 'cms.blogs.settings.multiLanguage.setNewLangPrimary', + httpMethod: 'put', + httpPath: '/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.blogs.settings.multiLanguage.updateLanguages', + fullyQualifiedName: 'cms.blogs.settings.multiLanguage.updateLanguages', + httpMethod: 'post', + httpPath: '/cms/blog-settings/2026-03/settings/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.blogs.tags.create', + fullyQualifiedName: 'cms.blogs.tags.create', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags', + }, + { + clientCallName: 'client.cms.blogs.tags.update', + fullyQualifiedName: 'cms.blogs.tags.update', + httpMethod: 'patch', + httpPath: '/cms/blogs/2026-03/tags/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.tags.list', + fullyQualifiedName: 'cms.blogs.tags.list', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags', + }, + { + clientCallName: 'client.cms.blogs.tags.delete', + fullyQualifiedName: 'cms.blogs.tags.delete', + httpMethod: 'delete', + httpPath: '/cms/blogs/2026-03/tags/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.tags.attachToLangGroup', + fullyQualifiedName: 'cms.blogs.tags.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.blogs.tags.createLangVariation', + fullyQualifiedName: 'cms.blogs.tags.createLangVariation', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.blogs.tags.detachFromLangGroup', + fullyQualifiedName: 'cms.blogs.tags.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.blogs.tags.get', + fullyQualifiedName: 'cms.blogs.tags.get', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/{objectId}', + }, + { + clientCallName: 'client.cms.blogs.tags.listAuthorsCursor', + fullyQualifiedName: 'cms.blogs.tags.listAuthorsCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor', + }, + { + clientCallName: 'client.cms.blogs.tags.listAuthorsCursorByQuery', + fullyQualifiedName: 'cms.blogs.tags.listAuthorsCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/authors/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.tags.listCursor', + fullyQualifiedName: 'cms.blogs.tags.listCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor', + }, + { + clientCallName: 'client.cms.blogs.tags.listCursorByQuery', + fullyQualifiedName: 'cms.blogs.tags.listCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/tags/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.tags.listPostsCursor', + fullyQualifiedName: 'cms.blogs.tags.listPostsCursor', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor', + }, + { + clientCallName: 'client.cms.blogs.tags.listPostsCursorByQuery', + fullyQualifiedName: 'cms.blogs.tags.listPostsCursorByQuery', + httpMethod: 'get', + httpPath: '/cms/blogs/2026-03/posts/cursor/query', + }, + { + clientCallName: 'client.cms.blogs.tags.setLangPrimary', + fullyQualifiedName: 'cms.blogs.tags.setLangPrimary', + httpMethod: 'put', + httpPath: '/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.blogs.tags.updateLangs', + fullyQualifiedName: 'cms.blogs.tags.updateLangs', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.blogs.tags.batch.delete', + fullyQualifiedName: 'cms.blogs.tags.batch.delete', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/batch/archive', + }, + { + clientCallName: 'client.cms.blogs.tags.batch.createBatch', + fullyQualifiedName: 'cms.blogs.tags.batch.createBatch', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/batch/create', + }, + { + clientCallName: 'client.cms.blogs.tags.batch.getBatch', + fullyQualifiedName: 'cms.blogs.tags.batch.getBatch', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/batch/read', + }, + { + clientCallName: 'client.cms.blogs.tags.batch.updateBatch', + fullyQualifiedName: 'cms.blogs.tags.batch.updateBatch', + httpMethod: 'post', + httpPath: '/cms/blogs/2026-03/tags/batch/update', + }, + { + clientCallName: 'client.cms.domains.list', + fullyQualifiedName: 'cms.domains.list', + httpMethod: 'get', + httpPath: '/cms/domains/2026-03', + }, + { + clientCallName: 'client.cms.domains.get', + fullyQualifiedName: 'cms.domains.get', + httpMethod: 'get', + httpPath: '/cms/domains/2026-03/{domainId}', + }, + { + clientCallName: 'client.cms.hubdb.rows.create', + fullyQualifiedName: 'cms.hubdb.rows.create', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', + }, + { + clientCallName: 'client.cms.hubdb.rows.list', + fullyQualifiedName: 'cms.hubdb.rows.list', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', + }, + { + clientCallName: 'client.cms.hubdb.rows.cloneBatch', + fullyQualifiedName: 'cms.hubdb.rows.cloneBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone', + }, + { + clientCallName: 'client.cms.hubdb.rows.cloneDraft', + fullyQualifiedName: 'cms.hubdb.rows.cloneDraft', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone', + }, + { + clientCallName: 'client.cms.hubdb.rows.createBatch', + fullyQualifiedName: 'cms.hubdb.rows.createBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create', + }, + { + clientCallName: 'client.cms.hubdb.rows.deleteDraft', + fullyQualifiedName: 'cms.hubdb.rows.deleteDraft', + httpMethod: 'delete', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + }, + { + clientCallName: 'client.cms.hubdb.rows.get', + fullyQualifiedName: 'cms.hubdb.rows.get', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}', + }, + { + clientCallName: 'client.cms.hubdb.rows.getBatch', + fullyQualifiedName: 'cms.hubdb.rows.getBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read', + }, + { + clientCallName: 'client.cms.hubdb.rows.getDraft', + fullyQualifiedName: 'cms.hubdb.rows.getDraft', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + }, + { + clientCallName: 'client.cms.hubdb.rows.getDraftBatch', + fullyQualifiedName: 'cms.hubdb.rows.getDraftBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read', + }, + { + clientCallName: 'client.cms.hubdb.rows.purgeBatch', + fullyQualifiedName: 'cms.hubdb.rows.purgeBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge', + }, + { + clientCallName: 'client.cms.hubdb.rows.replaceBatch', + fullyQualifiedName: 'cms.hubdb.rows.replaceBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace', + }, + { + clientCallName: 'client.cms.hubdb.rows.replaceDraft', + fullyQualifiedName: 'cms.hubdb.rows.replaceDraft', + httpMethod: 'put', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + }, + { + clientCallName: 'client.cms.hubdb.rows.updateBatch', + fullyQualifiedName: 'cms.hubdb.rows.updateBatch', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update', + }, + { + clientCallName: 'client.cms.hubdb.rows.updateDraft', + fullyQualifiedName: 'cms.hubdb.rows.updateDraft', + httpMethod: 'patch', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', + }, + { + clientCallName: 'client.cms.hubdb.tables.create', + fullyQualifiedName: 'cms.hubdb.tables.create', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables', + }, + { + clientCallName: 'client.cms.hubdb.tables.list', + fullyQualifiedName: 'cms.hubdb.tables.list', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables', + }, + { + clientCallName: 'client.cms.hubdb.tables.delete', + fullyQualifiedName: 'cms.hubdb.tables.delete', + httpMethod: 'delete', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}', + }, + { + clientCallName: 'client.cms.hubdb.tables.cloneDraft', + fullyQualifiedName: 'cms.hubdb.tables.cloneDraft', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone', + }, + { + clientCallName: 'client.cms.hubdb.tables.deleteVersion', + fullyQualifiedName: 'cms.hubdb.tables.deleteVersion', + httpMethod: 'delete', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}', + }, + { + clientCallName: 'client.cms.hubdb.tables.export', + fullyQualifiedName: 'cms.hubdb.tables.export', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/export', + }, + { + clientCallName: 'client.cms.hubdb.tables.exportDraft', + fullyQualifiedName: 'cms.hubdb.tables.exportDraft', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export', + }, + { + clientCallName: 'client.cms.hubdb.tables.get', + fullyQualifiedName: 'cms.hubdb.tables.get', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}', + }, + { + clientCallName: 'client.cms.hubdb.tables.getDraft', + fullyQualifiedName: 'cms.hubdb.tables.getDraft', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', + }, + { + clientCallName: 'client.cms.hubdb.tables.importDraft', + fullyQualifiedName: 'cms.hubdb.tables.importDraft', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import', + }, + { + clientCallName: 'client.cms.hubdb.tables.listDraft', + fullyQualifiedName: 'cms.hubdb.tables.listDraft', + httpMethod: 'get', + httpPath: '/cms/hubdb/2026-03/tables/draft', + }, + { + clientCallName: 'client.cms.hubdb.tables.publishDraft', + fullyQualifiedName: 'cms.hubdb.tables.publishDraft', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish', + }, + { + clientCallName: 'client.cms.hubdb.tables.resetDraft', + fullyQualifiedName: 'cms.hubdb.tables.resetDraft', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset', + }, + { + clientCallName: 'client.cms.hubdb.tables.unpublish', + fullyQualifiedName: 'cms.hubdb.tables.unpublish', + httpMethod: 'post', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish', + }, + { + clientCallName: 'client.cms.hubdb.tables.updateDraft', + fullyQualifiedName: 'cms.hubdb.tables.updateDraft', + httpMethod: 'patch', + httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', + }, + { + clientCallName: 'client.cms.mediaBridge.createAssociation', + fullyQualifiedName: 'cms.mediaBridge.createAssociation', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations', + }, + { + clientCallName: 'client.cms.mediaBridge.createAttentionSpanEvent', + fullyQualifiedName: 'cms.mediaBridge.createAttentionSpanEvent', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/events/attention-span', + }, + { + clientCallName: 'client.cms.mediaBridge.createMediaPlayedEvent', + fullyQualifiedName: 'cms.mediaBridge.createMediaPlayedEvent', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/events/media-played', + }, + { + clientCallName: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', + fullyQualifiedName: 'cms.mediaBridge.createMediaPlayedPercentEvent', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/events/media-played-percent', + }, + { + clientCallName: 'client.cms.mediaBridge.createObjectType', + fullyQualifiedName: 'cms.mediaBridge.createObjectType', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/settings/object-definitions', + }, + { + clientCallName: 'client.cms.mediaBridge.createOembedDomain', + fullyQualifiedName: 'cms.mediaBridge.createOembedDomain', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + }, + { + clientCallName: 'client.cms.mediaBridge.createProperty', + fullyQualifiedName: 'cms.mediaBridge.createProperty', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}', + }, + { + clientCallName: 'client.cms.mediaBridge.createPropertyGroup', + fullyQualifiedName: 'cms.mediaBridge.createPropertyGroup', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', + }, + { + clientCallName: 'client.cms.mediaBridge.createVideoAssociationDefinition', + fullyQualifiedName: 'cms.mediaBridge.createVideoAssociationDefinition', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/settings/video-association-definition', + }, + { + clientCallName: 'client.cms.mediaBridge.deleteAssociation', + fullyQualifiedName: 'cms.mediaBridge.deleteAssociation', + httpMethod: 'delete', + httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}', + }, + { + clientCallName: 'client.cms.mediaBridge.deleteOembedDomain', + fullyQualifiedName: 'cms.mediaBridge.deleteOembedDomain', + httpMethod: 'delete', + httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + }, + { + clientCallName: 'client.cms.mediaBridge.deleteProperty', + fullyQualifiedName: 'cms.mediaBridge.deleteProperty', + httpMethod: 'delete', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.cms.mediaBridge.deletePropertyGroup', + fullyQualifiedName: 'cms.mediaBridge.deletePropertyGroup', + httpMethod: 'delete', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.cms.mediaBridge.getEventVisibilitySettings', + fullyQualifiedName: 'cms.mediaBridge.getEventVisibilitySettings', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/settings/event-visibility', + }, + { + clientCallName: 'client.cms.mediaBridge.getOembedDomain', + fullyQualifiedName: 'cms.mediaBridge.getOembedDomain', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', + }, + { + clientCallName: 'client.cms.mediaBridge.getProperty', + fullyQualifiedName: 'cms.mediaBridge.getProperty', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.cms.mediaBridge.getPropertyGroup', + fullyQualifiedName: 'cms.mediaBridge.getPropertyGroup', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.cms.mediaBridge.getSchema', + fullyQualifiedName: 'cms.mediaBridge.getSchema', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}', + }, + { + clientCallName: 'client.cms.mediaBridge.listObjectTypesByMediaType', + fullyQualifiedName: 'cms.mediaBridge.listObjectTypesByMediaType', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}', + }, + { + clientCallName: 'client.cms.mediaBridge.listOembedDomains', + fullyQualifiedName: 'cms.mediaBridge.listOembedDomains', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', + }, + { + clientCallName: 'client.cms.mediaBridge.listProperties', + fullyQualifiedName: 'cms.mediaBridge.listProperties', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}', + }, + { + clientCallName: 'client.cms.mediaBridge.listPropertyGroups', + fullyQualifiedName: 'cms.mediaBridge.listPropertyGroups', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', + }, + { + clientCallName: 'client.cms.mediaBridge.listSchemas', + fullyQualifiedName: 'cms.mediaBridge.listSchemas', + httpMethod: 'get', + httpPath: '/media-bridge/2026-03/{appId}/schemas', + }, + { + clientCallName: 'client.cms.mediaBridge.registerAppName', + fullyQualifiedName: 'cms.mediaBridge.registerAppName', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/settings/register', + }, + { + clientCallName: 'client.cms.mediaBridge.updateEventVisibilitySettings', + fullyQualifiedName: 'cms.mediaBridge.updateEventVisibilitySettings', + httpMethod: 'patch', + httpPath: '/media-bridge/2026-03/{appId}/settings/event-visibility', + }, + { + clientCallName: 'client.cms.mediaBridge.updateOembedDomain', + fullyQualifiedName: 'cms.mediaBridge.updateOembedDomain', + httpMethod: 'patch', + httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', + }, + { + clientCallName: 'client.cms.mediaBridge.updateProperty', + fullyQualifiedName: 'cms.mediaBridge.updateProperty', + httpMethod: 'patch', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.cms.mediaBridge.updatePropertyGroup', + fullyQualifiedName: 'cms.mediaBridge.updatePropertyGroup', + httpMethod: 'patch', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.cms.mediaBridge.updateSchema', + fullyQualifiedName: 'cms.mediaBridge.updateSchema', + httpMethod: 'patch', + httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}', + }, + { + clientCallName: 'client.cms.mediaBridge.updateSettings', + fullyQualifiedName: 'cms.mediaBridge.updateSettings', + httpMethod: 'put', + httpPath: '/media-bridge/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.cms.mediaBridge.batch.create', + fullyQualifiedName: 'cms.mediaBridge.batch.create', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create', + }, + { + clientCallName: 'client.cms.mediaBridge.batch.delete', + fullyQualifiedName: 'cms.mediaBridge.batch.delete', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive', + }, + { + clientCallName: 'client.cms.mediaBridge.batch.get', + fullyQualifiedName: 'cms.mediaBridge.batch.get', + httpMethod: 'post', + httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read', + }, + { + clientCallName: 'client.cms.pages.landingPages.create', + fullyQualifiedName: 'cms.pages.landingPages.create', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages', + }, + { + clientCallName: 'client.cms.pages.landingPages.update', + fullyQualifiedName: 'cms.pages.landingPages.update', + httpMethod: 'patch', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.list', + fullyQualifiedName: 'cms.pages.landingPages.list', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages', + }, + { + clientCallName: 'client.cms.pages.landingPages.delete', + fullyQualifiedName: 'cms.pages.landingPages.delete', + httpMethod: 'delete', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.clone', + fullyQualifiedName: 'cms.pages.landingPages.clone', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/clone', + }, + { + clientCallName: 'client.cms.pages.landingPages.get', + fullyQualifiedName: 'cms.pages.landingPages.get', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.schedule', + fullyQualifiedName: 'cms.pages.landingPages.schedule', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/schedule', + }, + { + clientCallName: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', + fullyQualifiedName: 'cms.pages.landingPages.abTest.createLandingPageVariation', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/ab-test/create-variation', + }, + { + clientCallName: 'client.cms.pages.landingPages.abTest.endLandingPageTest', + fullyQualifiedName: 'cms.pages.landingPages.abTest.endLandingPageTest', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/ab-test/end', + }, + { + clientCallName: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', + fullyQualifiedName: 'cms.pages.landingPages.abTest.rerunLandingPageTest', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/ab-test/rerun', + }, + { + clientCallName: 'client.cms.pages.landingPages.batch.createLandingPages', + fullyQualifiedName: 'cms.pages.landingPages.batch.createLandingPages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/batch/create', + }, + { + clientCallName: 'client.cms.pages.landingPages.batch.deleteLandingPages', + fullyQualifiedName: 'cms.pages.landingPages.batch.deleteLandingPages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/batch/archive', + }, + { + clientCallName: 'client.cms.pages.landingPages.batch.getLandingPages', + fullyQualifiedName: 'cms.pages.landingPages.batch.getLandingPages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/batch/read', + }, + { + clientCallName: 'client.cms.pages.landingPages.batch.updateLandingPages', + fullyQualifiedName: 'cms.pages.landingPages.batch.updateLandingPages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/batch/update', + }, + { + clientCallName: 'client.cms.pages.landingPages.draft.update', + fullyQualifiedName: 'cms.pages.landingPages.draft.update', + httpMethod: 'patch', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft', + }, + { + clientCallName: 'client.cms.pages.landingPages.draft.get', + fullyQualifiedName: 'cms.pages.landingPages.draft.get', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft', + }, + { + clientCallName: 'client.cms.pages.landingPages.draft.pushLive', + fullyQualifiedName: 'cms.pages.landingPages.draft.pushLive', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live', + }, + { + clientCallName: 'client.cms.pages.landingPages.draft.reset', + fullyQualifiedName: 'cms.pages.landingPages.draft.reset', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft/reset', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.create', + fullyQualifiedName: 'cms.pages.landingPages.folders.create', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.update', + fullyQualifiedName: 'cms.pages.landingPages.folders.update', + httpMethod: 'patch', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.list', + fullyQualifiedName: 'cms.pages.landingPages.folders.list', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/folders', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.delete', + fullyQualifiedName: 'cms.pages.landingPages.folders.delete', + httpMethod: 'delete', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.batchGet', + fullyQualifiedName: 'cms.pages.landingPages.folders.batchGet', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/read', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.createFolders', + fullyQualifiedName: 'cms.pages.landingPages.folders.createFolders', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/create', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.deleteFolders', + fullyQualifiedName: 'cms.pages.landingPages.folders.deleteFolders', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/archive', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.get', + fullyQualifiedName: 'cms.pages.landingPages.folders.get', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.getRevision', + fullyQualifiedName: 'cms.pages.landingPages.folders.getRevision', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.listRevisions', + fullyQualifiedName: 'cms.pages.landingPages.folders.listRevisions', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.restoreRevision', + fullyQualifiedName: 'cms.pages.landingPages.folders.restoreRevision', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore', + }, + { + clientCallName: 'client.cms.pages.landingPages.folders.updateFolders', + fullyQualifiedName: 'cms.pages.landingPages.folders.updateFolders', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/update', + }, + { + clientCallName: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', + fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', + fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.createLanguageVariation', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', + fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', + fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.setNewLangPrimary', + httpMethod: 'put', + httpPath: '/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', + fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.updateLanguages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', + fullyQualifiedName: 'cms.pages.landingPages.revisions.getLandingPageRevision', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', + fullyQualifiedName: 'cms.pages.landingPages.revisions.listLandingPageRevisions', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions', + }, + { + clientCallName: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', + fullyQualifiedName: 'cms.pages.landingPages.revisions.restoreLandingPageRevision', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore', + }, + { + clientCallName: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', + fullyQualifiedName: 'cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft', + }, + { + clientCallName: 'client.cms.pages.sitePages.create', + fullyQualifiedName: 'cms.pages.sitePages.create', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages', + }, + { + clientCallName: 'client.cms.pages.sitePages.update', + fullyQualifiedName: 'cms.pages.sitePages.update', + httpMethod: 'patch', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.sitePages.list', + fullyQualifiedName: 'cms.pages.sitePages.list', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/site-pages', + }, + { + clientCallName: 'client.cms.pages.sitePages.delete', + fullyQualifiedName: 'cms.pages.sitePages.delete', + httpMethod: 'delete', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.sitePages.clone', + fullyQualifiedName: 'cms.pages.sitePages.clone', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/clone', + }, + { + clientCallName: 'client.cms.pages.sitePages.get', + fullyQualifiedName: 'cms.pages.sitePages.get', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}', + }, + { + clientCallName: 'client.cms.pages.sitePages.schedule', + fullyQualifiedName: 'cms.pages.sitePages.schedule', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/schedule', + }, + { + clientCallName: 'client.cms.pages.sitePages.abTest.createSitePageVariation', + fullyQualifiedName: 'cms.pages.sitePages.abTest.createSitePageVariation', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/ab-test/create-variation', + }, + { + clientCallName: 'client.cms.pages.sitePages.abTest.endSitePageTest', + fullyQualifiedName: 'cms.pages.sitePages.abTest.endSitePageTest', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/ab-test/end', + }, + { + clientCallName: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', + fullyQualifiedName: 'cms.pages.sitePages.abTest.rerunSitePageTest', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/ab-test/rerun', + }, + { + clientCallName: 'client.cms.pages.sitePages.batch.createSitePages', + fullyQualifiedName: 'cms.pages.sitePages.batch.createSitePages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/batch/create', + }, + { + clientCallName: 'client.cms.pages.sitePages.batch.deleteSitePages', + fullyQualifiedName: 'cms.pages.sitePages.batch.deleteSitePages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/batch/archive', + }, + { + clientCallName: 'client.cms.pages.sitePages.batch.getSitePages', + fullyQualifiedName: 'cms.pages.sitePages.batch.getSitePages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/batch/read', + }, + { + clientCallName: 'client.cms.pages.sitePages.batch.updateSitePages', + fullyQualifiedName: 'cms.pages.sitePages.batch.updateSitePages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/batch/update', + }, + { + clientCallName: 'client.cms.pages.sitePages.draft.getDraft', + fullyQualifiedName: 'cms.pages.sitePages.draft.getDraft', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft', + }, + { + clientCallName: 'client.cms.pages.sitePages.draft.publishDraft', + fullyQualifiedName: 'cms.pages.sitePages.draft.publishDraft', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft/push-live', + }, + { + clientCallName: 'client.cms.pages.sitePages.draft.resetSitePageDraft', + fullyQualifiedName: 'cms.pages.sitePages.draft.resetSitePageDraft', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft/reset', + }, + { + clientCallName: 'client.cms.pages.sitePages.draft.updateDraft', + fullyQualifiedName: 'cms.pages.sitePages.draft.updateDraft', + httpMethod: 'patch', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft', + }, + { + clientCallName: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', + fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.attachToLangGroup', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group', + }, + { + clientCallName: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', + fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.createLanguageVariation', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/multi-language/create-language-variation', + }, + { + clientCallName: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', + fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.detachFromLangGroup', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group', + }, + { + clientCallName: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', + fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.setNewLangPrimary', + httpMethod: 'put', + httpPath: '/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary', + }, + { + clientCallName: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', + fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.updateLanguages', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/multi-language/update-languages', + }, + { + clientCallName: 'client.cms.pages.sitePages.revisions.getSitePageRevision', + fullyQualifiedName: 'cms.pages.sitePages.revisions.getSitePageRevision', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', + fullyQualifiedName: 'cms.pages.sitePages.revisions.listSitePageRevisions', + httpMethod: 'get', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions', + }, + { + clientCallName: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', + fullyQualifiedName: 'cms.pages.sitePages.revisions.restoreSitePageRevision', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore', + }, + { + clientCallName: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', + fullyQualifiedName: 'cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', + httpMethod: 'post', + httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft', + }, + { + clientCallName: 'client.cms.siteSearch.getIndexedData', + fullyQualifiedName: 'cms.siteSearch.getIndexedData', + httpMethod: 'get', + httpPath: '/cms/site-search/2026-03/indexed-data/{contentId}', + }, + { + clientCallName: 'client.cms.sourceCode.extractAsync', + fullyQualifiedName: 'cms.sourceCode.extractAsync', + httpMethod: 'post', + httpPath: '/cms/source-code/2026-03/extract/async', + }, + { + clientCallName: 'client.cms.sourceCode.getExtractionStatus', + fullyQualifiedName: 'cms.sourceCode.getExtractionStatus', + httpMethod: 'get', + httpPath: '/cms/source-code/2026-03/extract/async/tasks/{taskId}/status', + }, + { + clientCallName: 'client.cms.urlMappings.create', + fullyQualifiedName: 'cms.urlMappings.create', + httpMethod: 'post', + httpPath: '/url-mappings/2026-03/url-mappings', + }, + { + clientCallName: 'client.cms.urlMappings.list', + fullyQualifiedName: 'cms.urlMappings.list', + httpMethod: 'get', + httpPath: '/url-mappings/2026-03/url-mappings', + }, + { + clientCallName: 'client.cms.urlMappings.delete', + fullyQualifiedName: 'cms.urlMappings.delete', + httpMethod: 'delete', + httpPath: '/url-mappings/2026-03/url-mappings/{id}', + }, + { + clientCallName: 'client.cms.urlMappings.get', + fullyQualifiedName: 'cms.urlMappings.get', + httpMethod: 'get', + httpPath: '/url-mappings/2026-03/url-mappings/{id}', + }, + { + clientCallName: 'client.cms.urlRedirects.create', + fullyQualifiedName: 'cms.urlRedirects.create', + httpMethod: 'post', + httpPath: '/cms/url-redirects/2026-03', + }, + { + clientCallName: 'client.cms.urlRedirects.update', + fullyQualifiedName: 'cms.urlRedirects.update', + httpMethod: 'patch', + httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', + }, + { + clientCallName: 'client.cms.urlRedirects.list', + fullyQualifiedName: 'cms.urlRedirects.list', + httpMethod: 'get', + httpPath: '/cms/url-redirects/2026-03', + }, + { + clientCallName: 'client.cms.urlRedirects.delete', + fullyQualifiedName: 'cms.urlRedirects.delete', + httpMethod: 'delete', + httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', + }, + { + clientCallName: 'client.cms.urlRedirects.get', + fullyQualifiedName: 'cms.urlRedirects.get', + httpMethod: 'get', + httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', + }, + { + clientCallName: 'client.communicationPreferences.generateLinks', + fullyQualifiedName: 'communicationPreferences.generateLinks', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/links/generate', + }, + { + clientCallName: 'client.communicationPreferences.getStatuses', + fullyQualifiedName: 'communicationPreferences.getStatuses', + httpMethod: 'get', + httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}', + }, + { + clientCallName: 'client.communicationPreferences.getUnsubscribeAllStatus', + fullyQualifiedName: 'communicationPreferences.getUnsubscribeAllStatus', + httpMethod: 'get', + httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', + }, + { + clientCallName: 'client.communicationPreferences.unsubscribeAll', + fullyQualifiedName: 'communicationPreferences.unsubscribeAll', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', + }, + { + clientCallName: 'client.communicationPreferences.updateStatus', + fullyQualifiedName: 'communicationPreferences.updateStatus', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}', + }, + { + clientCallName: 'client.communicationPreferences.definitions.list', + fullyQualifiedName: 'communicationPreferences.definitions.list', + httpMethod: 'get', + httpPath: '/communication-preferences/2026-03/definitions', + }, + { + clientCallName: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', + fullyQualifiedName: 'communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read', + }, + { + clientCallName: 'client.communicationPreferences.statuses.batch.read', + fullyQualifiedName: 'communicationPreferences.statuses.batch.read', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/batch/read', + }, + { + clientCallName: 'client.communicationPreferences.statuses.batch.unsubscribeAll', + fullyQualifiedName: 'communicationPreferences.statuses.batch.unsubscribeAll', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all', + }, + { + clientCallName: 'client.communicationPreferences.statuses.batch.updateStatuses', + fullyQualifiedName: 'communicationPreferences.statuses.batch.updateStatuses', + httpMethod: 'post', + httpPath: '/communication-preferences/2026-03/statuses/batch/write', + }, + { + clientCallName: 'client.conversations.customChannels.create', + fullyQualifiedName: 'conversations.customChannels.create', + httpMethod: 'post', + httpPath: '/conversations/custom-channels/2026-03', + }, + { + clientCallName: 'client.conversations.customChannels.update', + fullyQualifiedName: 'conversations.customChannels.update', + httpMethod: 'patch', + httpPath: '/conversations/custom-channels/2026-03/{channelId}', + }, + { + clientCallName: 'client.conversations.customChannels.list', + fullyQualifiedName: 'conversations.customChannels.list', + httpMethod: 'get', + httpPath: '/conversations/custom-channels/2026-03', + }, + { + clientCallName: 'client.conversations.customChannels.delete', + fullyQualifiedName: 'conversations.customChannels.delete', + httpMethod: 'delete', + httpPath: '/conversations/custom-channels/2026-03/{channelId}', + }, + { + clientCallName: 'client.conversations.customChannels.get', + fullyQualifiedName: 'conversations.customChannels.get', + httpMethod: 'get', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', + }, + { + clientCallName: 'client.conversations.customChannels.channelAccounts.create', + fullyQualifiedName: 'conversations.customChannels.channelAccounts.create', + httpMethod: 'post', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', + }, + { + clientCallName: 'client.conversations.customChannels.channelAccounts.update', + fullyQualifiedName: 'conversations.customChannels.channelAccounts.update', + httpMethod: 'patch', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', + }, + { + clientCallName: 'client.conversations.customChannels.channelAccounts.list', + fullyQualifiedName: 'conversations.customChannels.channelAccounts.list', + httpMethod: 'get', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', + }, + { + clientCallName: 'client.conversations.customChannels.channelAccounts.updateStagingToken', + fullyQualifiedName: 'conversations.customChannels.channelAccounts.updateStagingToken', + httpMethod: 'patch', + httpPath: + '/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}', + }, + { + clientCallName: 'client.conversations.customChannels.messages.create', + fullyQualifiedName: 'conversations.customChannels.messages.create', + httpMethod: 'post', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages', + }, + { + clientCallName: 'client.conversations.customChannels.messages.update', + fullyQualifiedName: 'conversations.customChannels.messages.update', + httpMethod: 'patch', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', + }, + { + clientCallName: 'client.conversations.customChannels.messages.get', + fullyQualifiedName: 'conversations.customChannels.messages.get', + httpMethod: 'get', + httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', + }, + { + clientCallName: 'client.conversations.visitorIdentification.generateToken', + fullyQualifiedName: 'conversations.visitorIdentification.generateToken', + httpMethod: 'post', + httpPath: '/visitor-identification/2026-03/tokens/create', + }, + { + clientCallName: 'client.crm.appUninstalls.uninstall', + fullyQualifiedName: 'crm.appUninstalls.uninstall', + httpMethod: 'delete', + httpPath: '/appinstalls/2026-03/external-install', + }, + { + clientCallName: 'client.crm.associations.create', + fullyQualifiedName: 'crm.associations.create', + httpMethod: 'put', + httpPath: + '/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}', + }, + { + clientCallName: 'client.crm.associations.list', + fullyQualifiedName: 'crm.associations.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}', + }, + { + clientCallName: 'client.crm.associations.delete', + fullyQualifiedName: 'crm.associations.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', + }, + { + clientCallName: 'client.crm.associations.requestHighUsageReport', + fullyQualifiedName: 'crm.associations.requestHighUsageReport', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/usage/high-usage-report/{userId}', + }, + { + clientCallName: 'client.crm.associations.search', + fullyQualifiedName: 'crm.associations.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/search', + }, + { + clientCallName: 'client.crm.associations.updateLabels', + fullyQualifiedName: 'crm.associations.updateLabels', + httpMethod: 'put', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', + }, + { + clientCallName: 'client.crm.associations.batch.create', + fullyQualifiedName: 'crm.associations.batch.create', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create', + }, + { + clientCallName: 'client.crm.associations.batch.delete', + fullyQualifiedName: 'crm.associations.batch.delete', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive', + }, + { + clientCallName: 'client.crm.associations.batch.createDefault', + fullyQualifiedName: 'crm.associations.batch.createDefault', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default', + }, + { + clientCallName: 'client.crm.associations.batch.deleteLabels', + fullyQualifiedName: 'crm.associations.batch.deleteLabels', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive', + }, + { + clientCallName: 'client.crm.associations.batch.get', + fullyQualifiedName: 'crm.associations.batch.get', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read', + }, + { + clientCallName: 'client.crm.associationsSchema.labels.batchCreate', + fullyQualifiedName: 'crm.associationsSchema.labels.batchCreate', + httpMethod: 'post', + httpPath: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create', + }, + { + clientCallName: 'client.crm.associationsSchema.labels.createLabel', + fullyQualifiedName: 'crm.associationsSchema.labels.createLabel', + httpMethod: 'post', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + }, + { + clientCallName: 'client.crm.associationsSchema.labels.deleteLabel', + fullyQualifiedName: 'crm.associationsSchema.labels.deleteLabel', + httpMethod: 'delete', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}', + }, + { + clientCallName: 'client.crm.associationsSchema.labels.listLabels', + fullyQualifiedName: 'crm.associationsSchema.labels.listLabels', + httpMethod: 'get', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + }, + { + clientCallName: 'client.crm.associationsSchema.labels.updateLabel', + fullyQualifiedName: 'crm.associationsSchema.labels.updateLabel', + httpMethod: 'put', + httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', + }, + { + clientCallName: 'client.crm.associationsSchema.limits.list', + fullyQualifiedName: 'crm.associationsSchema.limits.list', + httpMethod: 'get', + httpPath: '/crm/associations/2026-03/definitions/configurations/all', + }, + { + clientCallName: 'client.crm.associationsSchema.limits.batchDelete', + fullyQualifiedName: 'crm.associationsSchema.limits.batchDelete', + httpMethod: 'post', + httpPath: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge', + }, + { + clientCallName: 'client.crm.associationsSchema.limits.batchUpdate', + fullyQualifiedName: 'crm.associationsSchema.limits.batchUpdate', + httpMethod: 'post', + httpPath: + '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update', + }, + { + clientCallName: 'client.crm.associationsSchema.limits.getByObjectTypes', + fullyQualifiedName: 'crm.associationsSchema.limits.getByObjectTypes', + httpMethod: 'get', + httpPath: '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}', + }, + { + clientCallName: 'client.crm.dealSplits.batch.read', + fullyQualifiedName: 'crm.dealSplits.batch.read', + httpMethod: 'post', + httpPath: '/deal-splits/2026-03/batch/read', + }, + { + clientCallName: 'client.crm.dealSplits.batch.upsert', + fullyQualifiedName: 'crm.dealSplits.batch.upsert', + httpMethod: 'post', + httpPath: '/deal-splits/2026-03/batch/upsert', + }, + { + clientCallName: 'client.crm.exports.createAsync', + fullyQualifiedName: 'crm.exports.createAsync', + httpMethod: 'post', + httpPath: '/crm/exports/2026-03/export/async', + }, + { + clientCallName: 'client.crm.exports.get', + fullyQualifiedName: 'crm.exports.get', + httpMethod: 'get', + httpPath: '/crm/exports/2026-03/export/{exportId}', + }, + { + clientCallName: 'client.crm.exports.getStatus', + fullyQualifiedName: 'crm.exports.getStatus', + httpMethod: 'get', + httpPath: '/crm/exports/2026-03/export/async/tasks/{taskId}/status', + }, + { + clientCallName: 'client.crm.extensions.calling.createChannelConnectionSettings', + fullyQualifiedName: 'crm.extensions.calling.createChannelConnectionSettings', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + }, + { + clientCallName: 'client.crm.extensions.calling.createInboundCall', + fullyQualifiedName: 'crm.extensions.calling.createInboundCall', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/inbound-call', + }, + { + clientCallName: 'client.crm.extensions.calling.createRecordingReady', + fullyQualifiedName: 'crm.extensions.calling.createRecordingReady', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/recordings/ready', + }, + { + clientCallName: 'client.crm.extensions.calling.createRecordingSettings', + fullyQualifiedName: 'crm.extensions.calling.createRecordingSettings', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + }, + { + clientCallName: 'client.crm.extensions.calling.createSettings', + fullyQualifiedName: 'crm.extensions.calling.createSettings', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.crm.extensions.calling.deleteChannelConnectionSettings', + fullyQualifiedName: 'crm.extensions.calling.deleteChannelConnectionSettings', + httpMethod: 'delete', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + }, + { + clientCallName: 'client.crm.extensions.calling.deleteSettings', + fullyQualifiedName: 'crm.extensions.calling.deleteSettings', + httpMethod: 'delete', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.crm.extensions.calling.getChannelConnectionSettings', + fullyQualifiedName: 'crm.extensions.calling.getChannelConnectionSettings', + httpMethod: 'get', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + }, + { + clientCallName: 'client.crm.extensions.calling.getRecordingSettings', + fullyQualifiedName: 'crm.extensions.calling.getRecordingSettings', + httpMethod: 'get', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + }, + { + clientCallName: 'client.crm.extensions.calling.getSettings', + fullyQualifiedName: 'crm.extensions.calling.getSettings', + httpMethod: 'get', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.crm.extensions.calling.updateChannelConnectionSettings', + fullyQualifiedName: 'crm.extensions.calling.updateChannelConnectionSettings', + httpMethod: 'patch', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', + }, + { + clientCallName: 'client.crm.extensions.calling.updateRecordingSettings', + fullyQualifiedName: 'crm.extensions.calling.updateRecordingSettings', + httpMethod: 'patch', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', + }, + { + clientCallName: 'client.crm.extensions.calling.updateSettings', + fullyQualifiedName: 'crm.extensions.calling.updateSettings', + httpMethod: 'patch', + httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.crm.extensions.calling.transcripts.create', + fullyQualifiedName: 'crm.extensions.calling.transcripts.create', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/transcripts', + }, + { + clientCallName: 'client.crm.extensions.calling.transcripts.delete', + fullyQualifiedName: 'crm.extensions.calling.transcripts.delete', + httpMethod: 'delete', + httpPath: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', + }, + { + clientCallName: 'client.crm.extensions.calling.transcripts.createInboundCall', + fullyQualifiedName: 'crm.extensions.calling.transcripts.createInboundCall', + httpMethod: 'post', + httpPath: '/crm/extensions/calling/2026-03/inbound-call', + }, + { + clientCallName: 'client.crm.extensions.calling.transcripts.get', + fullyQualifiedName: 'crm.extensions.calling.transcripts.get', + httpMethod: 'get', + httpPath: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.create', + fullyQualifiedName: 'crm.extensions.cardsDev.create', + httpMethod: 'post', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.update', + fullyQualifiedName: 'crm.extensions.cardsDev.update', + httpMethod: 'patch', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.delete', + fullyQualifiedName: 'crm.extensions.cardsDev.delete', + httpMethod: 'delete', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.get', + fullyQualifiedName: 'crm.extensions.cardsDev.get', + httpMethod: 'get', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.getByID', + fullyQualifiedName: 'crm.extensions.cardsDev.getByID', + httpMethod: 'get', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.getSampleResponse', + fullyQualifiedName: 'crm.extensions.cardsDev.getSampleResponse', + httpMethod: 'get', + httpPath: '/crm/extensions/cards-dev/2026-03/sample-response', + }, + { + clientCallName: 'client.crm.extensions.cardsDev.migrateViews', + fullyQualifiedName: 'crm.extensions.cardsDev.migrateViews', + httpMethod: 'post', + httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/views/migrate', + }, + { + clientCallName: 'client.crm.extensions.videoConferencing.update', + fullyQualifiedName: 'crm.extensions.videoConferencing.update', + httpMethod: 'put', + httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + }, + { + clientCallName: 'client.crm.extensions.videoConferencing.delete', + fullyQualifiedName: 'crm.extensions.videoConferencing.delete', + httpMethod: 'delete', + httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + }, + { + clientCallName: 'client.crm.extensions.videoConferencing.get', + fullyQualifiedName: 'crm.extensions.videoConferencing.get', + httpMethod: 'get', + httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', + }, + { + clientCallName: 'client.crm.featureFlags.update', + fullyQualifiedName: 'crm.featureFlags.update', + httpMethod: 'put', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', + }, + { + clientCallName: 'client.crm.featureFlags.delete', + fullyQualifiedName: 'crm.featureFlags.delete', + httpMethod: 'delete', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', + }, + { + clientCallName: 'client.crm.featureFlags.deletePortalState', + fullyQualifiedName: 'crm.featureFlags.deletePortalState', + httpMethod: 'delete', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + }, + { + clientCallName: 'client.crm.featureFlags.get', + fullyQualifiedName: 'crm.featureFlags.get', + httpMethod: 'get', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', + }, + { + clientCallName: 'client.crm.featureFlags.getPortalState', + fullyQualifiedName: 'crm.featureFlags.getPortalState', + httpMethod: 'get', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + }, + { + clientCallName: 'client.crm.featureFlags.listAll', + fullyQualifiedName: 'crm.featureFlags.listAll', + httpMethod: 'get', + httpPath: '/feature-flags/2026-03/{appId}/flags/all', + }, + { + clientCallName: 'client.crm.featureFlags.listPortals', + fullyQualifiedName: 'crm.featureFlags.listPortals', + httpMethod: 'get', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals', + }, + { + clientCallName: 'client.crm.featureFlags.updatePortalState', + fullyQualifiedName: 'crm.featureFlags.updatePortalState', + httpMethod: 'put', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', + }, + { + clientCallName: 'client.crm.featureFlags.batch.delete', + fullyQualifiedName: 'crm.featureFlags.batch.delete', + httpMethod: 'post', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete', + }, + { + clientCallName: 'client.crm.featureFlags.batch.upsert', + fullyQualifiedName: 'crm.featureFlags.batch.upsert', + httpMethod: 'post', + httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert', + }, + { + clientCallName: 'client.crm.imports.create', + fullyQualifiedName: 'crm.imports.create', + httpMethod: 'post', + httpPath: '/crm/imports/2026-03', + }, + { + clientCallName: 'client.crm.imports.list', + fullyQualifiedName: 'crm.imports.list', + httpMethod: 'get', + httpPath: '/crm/imports/2026-03', + }, + { + clientCallName: 'client.crm.imports.cancel', + fullyQualifiedName: 'crm.imports.cancel', + httpMethod: 'post', + httpPath: '/crm/imports/2026-03/{importId}/cancel', + }, + { + clientCallName: 'client.crm.imports.get', + fullyQualifiedName: 'crm.imports.get', + httpMethod: 'get', + httpPath: '/crm/imports/2026-03/{importId}', + }, + { + clientCallName: 'client.crm.imports.listErrors', + fullyQualifiedName: 'crm.imports.listErrors', + httpMethod: 'get', + httpPath: '/crm/imports/2026-03/{importId}/errors', + }, + { + clientCallName: 'client.crm.limits.getAssociationLabelLimits', + fullyQualifiedName: 'crm.limits.getAssociationLabelLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/associations/labels', + }, + { + clientCallName: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', + fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsByObjectType', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}', + }, + { + clientCallName: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', + fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsFromObjects', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/associations/records/from', + }, + { + clientCallName: 'client.crm.limits.getAssociationRecordsLimitsToObjects', + fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsToObjects', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to', + }, + { + clientCallName: 'client.crm.limits.getCalculatedPropertyLimits', + fullyQualifiedName: 'crm.limits.getCalculatedPropertyLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/calculated-properties', + }, + { + clientCallName: 'client.crm.limits.getCustomObjectTypeLimits', + fullyQualifiedName: 'crm.limits.getCustomObjectTypeLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/custom-object-types', + }, + { + clientCallName: 'client.crm.limits.getCustomPropertyLimits', + fullyQualifiedName: 'crm.limits.getCustomPropertyLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/custom-properties', + }, + { + clientCallName: 'client.crm.limits.getPipelineLimits', + fullyQualifiedName: 'crm.limits.getPipelineLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/pipelines', + }, + { + clientCallName: 'client.crm.limits.getRecordLimits', + fullyQualifiedName: 'crm.limits.getRecordLimits', + httpMethod: 'get', + httpPath: '/crm/limits/2026-03/records', + }, + { + clientCallName: 'client.crm.lists.create', + fullyQualifiedName: 'crm.lists.create', + httpMethod: 'post', + httpPath: '/crm/lists/2026-03', + }, + { + clientCallName: 'client.crm.lists.list', + fullyQualifiedName: 'crm.lists.list', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03', + }, + { + clientCallName: 'client.crm.lists.delete', + fullyQualifiedName: 'crm.lists.delete', + httpMethod: 'delete', + httpPath: '/crm/lists/2026-03/{listId}', + }, + { + clientCallName: 'client.crm.lists.addAndRemoveMemberships', + fullyQualifiedName: 'crm.lists.addAndRemoveMemberships', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/memberships/add-and-remove', + }, + { + clientCallName: 'client.crm.lists.addMemberships', + fullyQualifiedName: 'crm.lists.addMemberships', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/memberships/add', + }, + { + clientCallName: 'client.crm.lists.addMembershipsFrom', + fullyQualifiedName: 'crm.lists.addMembershipsFrom', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}', + }, + { + clientCallName: 'client.crm.lists.batchReadMemberships', + fullyQualifiedName: 'crm.lists.batchReadMemberships', + httpMethod: 'post', + httpPath: '/crm/lists/2026-03/records/memberships/batch/read', + }, + { + clientCallName: 'client.crm.lists.createFolder', + fullyQualifiedName: 'crm.lists.createFolder', + httpMethod: 'post', + httpPath: '/crm/lists/2026-03/folders', + }, + { + clientCallName: 'client.crm.lists.createIDMapping', + fullyQualifiedName: 'crm.lists.createIDMapping', + httpMethod: 'post', + httpPath: '/crm/lists/2026-03/idmapping', + }, + { + clientCallName: 'client.crm.lists.deleteFolder', + fullyQualifiedName: 'crm.lists.deleteFolder', + httpMethod: 'delete', + httpPath: '/crm/lists/2026-03/folders/{folderId}', + }, + { + clientCallName: 'client.crm.lists.deleteMemberships', + fullyQualifiedName: 'crm.lists.deleteMemberships', + httpMethod: 'delete', + httpPath: '/crm/lists/2026-03/{listId}/memberships', + }, + { + clientCallName: 'client.crm.lists.get', + fullyQualifiedName: 'crm.lists.get', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/{listId}', + }, + { + clientCallName: 'client.crm.lists.getByObjectTypeAndName', + fullyQualifiedName: 'crm.lists.getByObjectTypeAndName', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}', + }, + { + clientCallName: 'client.crm.lists.getIDMapping', + fullyQualifiedName: 'crm.lists.getIDMapping', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/idmapping', + }, + { + clientCallName: 'client.crm.lists.getMembershipsJoinOrder', + fullyQualifiedName: 'crm.lists.getMembershipsJoinOrder', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/{listId}/memberships/join-order', + }, + { + clientCallName: 'client.crm.lists.getRecordMemberships', + fullyQualifiedName: 'crm.lists.getRecordMemberships', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships', + }, + { + clientCallName: 'client.crm.lists.getScheduleConversion', + fullyQualifiedName: 'crm.lists.getScheduleConversion', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', + }, + { + clientCallName: 'client.crm.lists.getSizeAndEditsHistoryBetween', + fullyQualifiedName: 'crm.lists.getSizeAndEditsHistoryBetween', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/{listId}/size-and-edits-history/between', + }, + { + clientCallName: 'client.crm.lists.listBySearch', + fullyQualifiedName: 'crm.lists.listBySearch', + httpMethod: 'post', + httpPath: '/crm/lists/2026-03/search', + }, + { + clientCallName: 'client.crm.lists.listFolders', + fullyQualifiedName: 'crm.lists.listFolders', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/folders', + }, + { + clientCallName: 'client.crm.lists.listMemberships', + fullyQualifiedName: 'crm.lists.listMemberships', + httpMethod: 'get', + httpPath: '/crm/lists/2026-03/{listId}/memberships', + }, + { + clientCallName: 'client.crm.lists.moveFolder', + fullyQualifiedName: 'crm.lists.moveFolder', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}', + }, + { + clientCallName: 'client.crm.lists.moveList', + fullyQualifiedName: 'crm.lists.moveList', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/folders/move-list', + }, + { + clientCallName: 'client.crm.lists.removeMemberships', + fullyQualifiedName: 'crm.lists.removeMemberships', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/memberships/remove', + }, + { + clientCallName: 'client.crm.lists.renameFolder', + fullyQualifiedName: 'crm.lists.renameFolder', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/folders/{folderId}/rename', + }, + { + clientCallName: 'client.crm.lists.restore', + fullyQualifiedName: 'crm.lists.restore', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/restore', + }, + { + clientCallName: 'client.crm.lists.scheduleConversion', + fullyQualifiedName: 'crm.lists.scheduleConversion', + httpMethod: 'delete', + httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', + }, + { + clientCallName: 'client.crm.lists.updateListFilters', + fullyQualifiedName: 'crm.lists.updateListFilters', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/update-list-filters', + }, + { + clientCallName: 'client.crm.lists.updateListName', + fullyQualifiedName: 'crm.lists.updateListName', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/update-list-name', + }, + { + clientCallName: 'client.crm.lists.updateScheduleConversion', + fullyQualifiedName: 'crm.lists.updateScheduleConversion', + httpMethod: 'put', + httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', + }, + { + clientCallName: 'client.crm.objectLibrary.enablement.getAll', + fullyQualifiedName: 'crm.objectLibrary.enablement.getAll', + httpMethod: 'get', + httpPath: '/crm/object-library/2026-03/enablement', + }, + { + clientCallName: 'client.crm.objectLibrary.enablement.getByObjectTypeID', + fullyQualifiedName: 'crm.objectLibrary.enablement.getByObjectTypeID', + httpMethod: 'get', + httpPath: '/crm/object-library/2026-03/enablement/{objectTypeId}', + }, + { + clientCallName: 'client.crm.objectSchemas.create', + fullyQualifiedName: 'crm.objectSchemas.create', + httpMethod: 'post', + httpPath: '/crm-object-schemas/2026-03/schemas', + }, + { + clientCallName: 'client.crm.objectSchemas.update', + fullyQualifiedName: 'crm.objectSchemas.update', + httpMethod: 'patch', + httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', + }, + { + clientCallName: 'client.crm.objectSchemas.list', + fullyQualifiedName: 'crm.objectSchemas.list', + httpMethod: 'get', + httpPath: '/crm-object-schemas/2026-03/schemas', + }, + { + clientCallName: 'client.crm.objectSchemas.delete', + fullyQualifiedName: 'crm.objectSchemas.delete', + httpMethod: 'delete', + httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', + }, + { + clientCallName: 'client.crm.objectSchemas.createAssociation', + fullyQualifiedName: 'crm.objectSchemas.createAssociation', + httpMethod: 'post', + httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}/associations', + }, + { + clientCallName: 'client.crm.objectSchemas.deleteAssociation', + fullyQualifiedName: 'crm.objectSchemas.deleteAssociation', + httpMethod: 'delete', + httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}', + }, + { + clientCallName: 'client.crm.objectSchemas.get', + fullyQualifiedName: 'crm.objectSchemas.get', + httpMethod: 'get', + httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', + }, + { + clientCallName: 'client.crm.objectSchemas.batch.get', + fullyQualifiedName: 'crm.objectSchemas.batch.get', + httpMethod: 'post', + httpPath: '/crm-object-schemas/2026-03/schemas/batch/read', + }, + { + clientCallName: 'client.crm.objects.calls.create', + fullyQualifiedName: 'crm.objects.calls.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls', + }, + { + clientCallName: 'client.crm.objects.calls.update', + fullyQualifiedName: 'crm.objects.calls.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/calls/{callId}', + }, + { + clientCallName: 'client.crm.objects.calls.list', + fullyQualifiedName: 'crm.objects.calls.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/calls', + }, + { + clientCallName: 'client.crm.objects.calls.delete', + fullyQualifiedName: 'crm.objects.calls.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/calls/{callId}', + }, + { + clientCallName: 'client.crm.objects.calls.get', + fullyQualifiedName: 'crm.objects.calls.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/calls/{callId}', + }, + { + clientCallName: 'client.crm.objects.calls.search', + fullyQualifiedName: 'crm.objects.calls.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/search', + }, + { + clientCallName: 'client.crm.objects.calls.batch.create', + fullyQualifiedName: 'crm.objects.calls.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/batch/create', + }, + { + clientCallName: 'client.crm.objects.calls.batch.update', + fullyQualifiedName: 'crm.objects.calls.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/batch/update', + }, + { + clientCallName: 'client.crm.objects.calls.batch.delete', + fullyQualifiedName: 'crm.objects.calls.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/batch/archive', + }, + { + clientCallName: 'client.crm.objects.calls.batch.get', + fullyQualifiedName: 'crm.objects.calls.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/batch/read', + }, + { + clientCallName: 'client.crm.objects.calls.batch.upsert', + fullyQualifiedName: 'crm.objects.calls.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/calls/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.carts.create', + fullyQualifiedName: 'crm.objects.carts.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts', + }, + { + clientCallName: 'client.crm.objects.carts.update', + fullyQualifiedName: 'crm.objects.carts.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/carts/{cartId}', + }, + { + clientCallName: 'client.crm.objects.carts.list', + fullyQualifiedName: 'crm.objects.carts.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/carts', + }, + { + clientCallName: 'client.crm.objects.carts.delete', + fullyQualifiedName: 'crm.objects.carts.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/carts/{cartId}', + }, + { + clientCallName: 'client.crm.objects.carts.get', + fullyQualifiedName: 'crm.objects.carts.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/carts/{cartId}', + }, + { + clientCallName: 'client.crm.objects.carts.search', + fullyQualifiedName: 'crm.objects.carts.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/search', + }, + { + clientCallName: 'client.crm.objects.carts.batch.create', + fullyQualifiedName: 'crm.objects.carts.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/batch/create', + }, + { + clientCallName: 'client.crm.objects.carts.batch.update', + fullyQualifiedName: 'crm.objects.carts.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/batch/update', + }, + { + clientCallName: 'client.crm.objects.carts.batch.delete', + fullyQualifiedName: 'crm.objects.carts.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/batch/archive', + }, + { + clientCallName: 'client.crm.objects.carts.batch.get', + fullyQualifiedName: 'crm.objects.carts.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/batch/read', + }, + { + clientCallName: 'client.crm.objects.carts.batch.upsert', + fullyQualifiedName: 'crm.objects.carts.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/carts/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.commercePayments.create', + fullyQualifiedName: 'crm.objects.commercePayments.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments', + }, + { + clientCallName: 'client.crm.objects.commercePayments.update', + fullyQualifiedName: 'crm.objects.commercePayments.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + }, + { + clientCallName: 'client.crm.objects.commercePayments.list', + fullyQualifiedName: 'crm.objects.commercePayments.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/commerce_payments', + }, + { + clientCallName: 'client.crm.objects.commercePayments.delete', + fullyQualifiedName: 'crm.objects.commercePayments.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + }, + { + clientCallName: 'client.crm.objects.commercePayments.get', + fullyQualifiedName: 'crm.objects.commercePayments.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', + }, + { + clientCallName: 'client.crm.objects.commercePayments.search', + fullyQualifiedName: 'crm.objects.commercePayments.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/search', + }, + { + clientCallName: 'client.crm.objects.commercePayments.batch.create', + fullyQualifiedName: 'crm.objects.commercePayments.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/batch/create', + }, + { + clientCallName: 'client.crm.objects.commercePayments.batch.update', + fullyQualifiedName: 'crm.objects.commercePayments.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/batch/update', + }, + { + clientCallName: 'client.crm.objects.commercePayments.batch.delete', + fullyQualifiedName: 'crm.objects.commercePayments.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/batch/archive', + }, + { + clientCallName: 'client.crm.objects.commercePayments.batch.get', + fullyQualifiedName: 'crm.objects.commercePayments.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/batch/read', + }, + { + clientCallName: 'client.crm.objects.commercePayments.batch.upsert', + fullyQualifiedName: 'crm.objects.commercePayments.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/commerce_payments/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.communications.create', + fullyQualifiedName: 'crm.objects.communications.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications', + }, + { + clientCallName: 'client.crm.objects.communications.update', + fullyQualifiedName: 'crm.objects.communications.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/communications/{communicationId}', + }, + { + clientCallName: 'client.crm.objects.communications.list', + fullyQualifiedName: 'crm.objects.communications.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/communications', + }, + { + clientCallName: 'client.crm.objects.communications.delete', + fullyQualifiedName: 'crm.objects.communications.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/communications/{communicationId}', + }, + { + clientCallName: 'client.crm.objects.communications.get', + fullyQualifiedName: 'crm.objects.communications.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/communications/{communicationId}', + }, + { + clientCallName: 'client.crm.objects.communications.search', + fullyQualifiedName: 'crm.objects.communications.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/search', + }, + { + clientCallName: 'client.crm.objects.communications.batch.create', + fullyQualifiedName: 'crm.objects.communications.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/batch/create', + }, + { + clientCallName: 'client.crm.objects.communications.batch.update', + fullyQualifiedName: 'crm.objects.communications.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/batch/update', + }, + { + clientCallName: 'client.crm.objects.communications.batch.delete', + fullyQualifiedName: 'crm.objects.communications.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/batch/archive', + }, + { + clientCallName: 'client.crm.objects.communications.batch.get', + fullyQualifiedName: 'crm.objects.communications.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/batch/read', + }, + { + clientCallName: 'client.crm.objects.communications.batch.upsert', + fullyQualifiedName: 'crm.objects.communications.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/communications/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.companies.create', + fullyQualifiedName: 'crm.objects.companies.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies', + }, + { + clientCallName: 'client.crm.objects.companies.update', + fullyQualifiedName: 'crm.objects.companies.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/companies/{companyId}', + }, + { + clientCallName: 'client.crm.objects.companies.list', + fullyQualifiedName: 'crm.objects.companies.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/companies', + }, + { + clientCallName: 'client.crm.objects.companies.delete', + fullyQualifiedName: 'crm.objects.companies.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/companies/{companyId}', + }, + { + clientCallName: 'client.crm.objects.companies.get', + fullyQualifiedName: 'crm.objects.companies.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/companies/{companyId}', + }, + { + clientCallName: 'client.crm.objects.companies.merge', + fullyQualifiedName: 'crm.objects.companies.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/merge', + }, + { + clientCallName: 'client.crm.objects.companies.search', + fullyQualifiedName: 'crm.objects.companies.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/search', + }, + { + clientCallName: 'client.crm.objects.companies.batch.create', + fullyQualifiedName: 'crm.objects.companies.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/batch/create', + }, + { + clientCallName: 'client.crm.objects.companies.batch.update', + fullyQualifiedName: 'crm.objects.companies.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/batch/update', + }, + { + clientCallName: 'client.crm.objects.companies.batch.delete', + fullyQualifiedName: 'crm.objects.companies.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/batch/archive', + }, + { + clientCallName: 'client.crm.objects.companies.batch.get', + fullyQualifiedName: 'crm.objects.companies.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/batch/read', + }, + { + clientCallName: 'client.crm.objects.companies.batch.upsert', + fullyQualifiedName: 'crm.objects.companies.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/companies/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.contacts.create', + fullyQualifiedName: 'crm.objects.contacts.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts', + }, + { + clientCallName: 'client.crm.objects.contacts.update', + fullyQualifiedName: 'crm.objects.contacts.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/contacts/{contactId}', + }, + { + clientCallName: 'client.crm.objects.contacts.list', + fullyQualifiedName: 'crm.objects.contacts.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/contacts', + }, + { + clientCallName: 'client.crm.objects.contacts.delete', + fullyQualifiedName: 'crm.objects.contacts.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/contacts/{contactId}', + }, + { + clientCallName: 'client.crm.objects.contacts.gdprDelete', + fullyQualifiedName: 'crm.objects.contacts.gdprDelete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/gdpr-delete', + }, + { + clientCallName: 'client.crm.objects.contacts.get', + fullyQualifiedName: 'crm.objects.contacts.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/contacts/{contactId}', + }, + { + clientCallName: 'client.crm.objects.contacts.merge', + fullyQualifiedName: 'crm.objects.contacts.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/merge', + }, + { + clientCallName: 'client.crm.objects.contacts.search', + fullyQualifiedName: 'crm.objects.contacts.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/search', + }, + { + clientCallName: 'client.crm.objects.contacts.batch.create', + fullyQualifiedName: 'crm.objects.contacts.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/batch/create', + }, + { + clientCallName: 'client.crm.objects.contacts.batch.update', + fullyQualifiedName: 'crm.objects.contacts.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/batch/update', + }, + { + clientCallName: 'client.crm.objects.contacts.batch.delete', + fullyQualifiedName: 'crm.objects.contacts.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/batch/archive', + }, + { + clientCallName: 'client.crm.objects.contacts.batch.get', + fullyQualifiedName: 'crm.objects.contacts.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/batch/read', + }, + { + clientCallName: 'client.crm.objects.contacts.batch.upsert', + fullyQualifiedName: 'crm.objects.contacts.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contacts/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.contracts.list', + fullyQualifiedName: 'crm.objects.contracts.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/contracts', + }, + { + clientCallName: 'client.crm.objects.contracts.get', + fullyQualifiedName: 'crm.objects.contracts.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/contracts/{contractId}', + }, + { + clientCallName: 'client.crm.objects.contracts.batch.get', + fullyQualifiedName: 'crm.objects.contracts.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/contracts/batch/read', + }, + { + clientCallName: 'client.crm.objects.courses.create', + fullyQualifiedName: 'crm.objects.courses.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410', + }, + { + clientCallName: 'client.crm.objects.courses.update', + fullyQualifiedName: 'crm.objects.courses.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/0-410/{courseId}', + }, + { + clientCallName: 'client.crm.objects.courses.list', + fullyQualifiedName: 'crm.objects.courses.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-410', + }, + { + clientCallName: 'client.crm.objects.courses.delete', + fullyQualifiedName: 'crm.objects.courses.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/0-410/{courseId}', + }, + { + clientCallName: 'client.crm.objects.courses.get', + fullyQualifiedName: 'crm.objects.courses.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-410/{courseId}', + }, + { + clientCallName: 'client.crm.objects.courses.search', + fullyQualifiedName: 'crm.objects.courses.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/search', + }, + { + clientCallName: 'client.crm.objects.courses.batch.create', + fullyQualifiedName: 'crm.objects.courses.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/batch/create', + }, + { + clientCallName: 'client.crm.objects.courses.batch.update', + fullyQualifiedName: 'crm.objects.courses.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/batch/update', + }, + { + clientCallName: 'client.crm.objects.courses.batch.delete', + fullyQualifiedName: 'crm.objects.courses.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/batch/archive', + }, + { + clientCallName: 'client.crm.objects.courses.batch.get', + fullyQualifiedName: 'crm.objects.courses.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/batch/read', + }, + { + clientCallName: 'client.crm.objects.courses.batch.upsert', + fullyQualifiedName: 'crm.objects.courses.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-410/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.custom.create', + fullyQualifiedName: 'crm.objects.custom.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.objects.custom.update', + fullyQualifiedName: 'crm.objects.custom.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.custom.list', + fullyQualifiedName: 'crm.objects.custom.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.objects.custom.delete', + fullyQualifiedName: 'crm.objects.custom.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.custom.get', + fullyQualifiedName: 'crm.objects.custom.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.custom.merge', + fullyQualifiedName: 'crm.objects.custom.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/merge', + }, + { + clientCallName: 'client.crm.objects.custom.search', + fullyQualifiedName: 'crm.objects.custom.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/search', + }, + { + clientCallName: 'client.crm.objects.custom.batch.create', + fullyQualifiedName: 'crm.objects.custom.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/create', + }, + { + clientCallName: 'client.crm.objects.custom.batch.update', + fullyQualifiedName: 'crm.objects.custom.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/update', + }, + { + clientCallName: 'client.crm.objects.custom.batch.delete', + fullyQualifiedName: 'crm.objects.custom.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/archive', + }, + { + clientCallName: 'client.crm.objects.custom.batch.get', + fullyQualifiedName: 'crm.objects.custom.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/read', + }, + { + clientCallName: 'client.crm.objects.custom.batch.upsert', + fullyQualifiedName: 'crm.objects.custom.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.deals.create', + fullyQualifiedName: 'crm.objects.deals.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3', + }, + { + clientCallName: 'client.crm.objects.deals.update', + fullyQualifiedName: 'crm.objects.deals.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/0-3/{dealId}', + }, + { + clientCallName: 'client.crm.objects.deals.list', + fullyQualifiedName: 'crm.objects.deals.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-3', + }, + { + clientCallName: 'client.crm.objects.deals.delete', + fullyQualifiedName: 'crm.objects.deals.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/0-3/{dealId}', + }, + { + clientCallName: 'client.crm.objects.deals.get', + fullyQualifiedName: 'crm.objects.deals.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-3/{dealId}', + }, + { + clientCallName: 'client.crm.objects.deals.merge', + fullyQualifiedName: 'crm.objects.deals.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/merge', + }, + { + clientCallName: 'client.crm.objects.deals.search', + fullyQualifiedName: 'crm.objects.deals.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/search', + }, + { + clientCallName: 'client.crm.objects.deals.batch.create', + fullyQualifiedName: 'crm.objects.deals.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/batch/create', + }, + { + clientCallName: 'client.crm.objects.deals.batch.update', + fullyQualifiedName: 'crm.objects.deals.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/batch/update', + }, + { + clientCallName: 'client.crm.objects.deals.batch.delete', + fullyQualifiedName: 'crm.objects.deals.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/batch/archive', + }, + { + clientCallName: 'client.crm.objects.deals.batch.get', + fullyQualifiedName: 'crm.objects.deals.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/batch/read', + }, + { + clientCallName: 'client.crm.objects.deals.batch.upsert', + fullyQualifiedName: 'crm.objects.deals.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-3/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.discounts.create', + fullyQualifiedName: 'crm.objects.discounts.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts', + }, + { + clientCallName: 'client.crm.objects.discounts.update', + fullyQualifiedName: 'crm.objects.discounts.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/discounts/{discountId}', + }, + { + clientCallName: 'client.crm.objects.discounts.list', + fullyQualifiedName: 'crm.objects.discounts.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/discounts', + }, + { + clientCallName: 'client.crm.objects.discounts.delete', + fullyQualifiedName: 'crm.objects.discounts.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/discounts/{discountId}', + }, + { + clientCallName: 'client.crm.objects.discounts.get', + fullyQualifiedName: 'crm.objects.discounts.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/discounts/{discountId}', + }, + { + clientCallName: 'client.crm.objects.discounts.search', + fullyQualifiedName: 'crm.objects.discounts.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/search', + }, + { + clientCallName: 'client.crm.objects.discounts.batch.create', + fullyQualifiedName: 'crm.objects.discounts.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/batch/create', + }, + { + clientCallName: 'client.crm.objects.discounts.batch.update', + fullyQualifiedName: 'crm.objects.discounts.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/batch/update', + }, + { + clientCallName: 'client.crm.objects.discounts.batch.delete', + fullyQualifiedName: 'crm.objects.discounts.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/batch/archive', + }, + { + clientCallName: 'client.crm.objects.discounts.batch.get', + fullyQualifiedName: 'crm.objects.discounts.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/batch/read', + }, + { + clientCallName: 'client.crm.objects.discounts.batch.upsert', + fullyQualifiedName: 'crm.objects.discounts.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/discounts/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.emails.create', + fullyQualifiedName: 'crm.objects.emails.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails', + }, + { + clientCallName: 'client.crm.objects.emails.update', + fullyQualifiedName: 'crm.objects.emails.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/emails/{emailId}', + }, + { + clientCallName: 'client.crm.objects.emails.list', + fullyQualifiedName: 'crm.objects.emails.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/emails', + }, + { + clientCallName: 'client.crm.objects.emails.delete', + fullyQualifiedName: 'crm.objects.emails.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/emails/{emailId}', + }, + { + clientCallName: 'client.crm.objects.emails.get', + fullyQualifiedName: 'crm.objects.emails.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/emails/{emailId}', + }, + { + clientCallName: 'client.crm.objects.emails.search', + fullyQualifiedName: 'crm.objects.emails.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/search', + }, + { + clientCallName: 'client.crm.objects.emails.batch.create', + fullyQualifiedName: 'crm.objects.emails.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/batch/create', + }, + { + clientCallName: 'client.crm.objects.emails.batch.update', + fullyQualifiedName: 'crm.objects.emails.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/batch/update', + }, + { + clientCallName: 'client.crm.objects.emails.batch.delete', + fullyQualifiedName: 'crm.objects.emails.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/batch/archive', + }, + { + clientCallName: 'client.crm.objects.emails.batch.get', + fullyQualifiedName: 'crm.objects.emails.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/batch/read', + }, + { + clientCallName: 'client.crm.objects.emails.batch.upsert', + fullyQualifiedName: 'crm.objects.emails.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/emails/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.feedbackSubmissions.list', + fullyQualifiedName: 'crm.objects.feedbackSubmissions.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/feedback_submissions', + }, + { + clientCallName: 'client.crm.objects.feedbackSubmissions.get', + fullyQualifiedName: 'crm.objects.feedbackSubmissions.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}', + }, + { + clientCallName: 'client.crm.objects.feedbackSubmissions.search', + fullyQualifiedName: 'crm.objects.feedbackSubmissions.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/feedback_submissions/search', + }, + { + clientCallName: 'client.crm.objects.feedbackSubmissions.batch.get', + fullyQualifiedName: 'crm.objects.feedbackSubmissions.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/feedback_submissions/batch/read', + }, + { + clientCallName: 'client.crm.objects.fees.create', + fullyQualifiedName: 'crm.objects.fees.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees', + }, + { + clientCallName: 'client.crm.objects.fees.update', + fullyQualifiedName: 'crm.objects.fees.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/fees/{feeId}', + }, + { + clientCallName: 'client.crm.objects.fees.list', + fullyQualifiedName: 'crm.objects.fees.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/fees', + }, + { + clientCallName: 'client.crm.objects.fees.delete', + fullyQualifiedName: 'crm.objects.fees.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/fees/{feeId}', + }, + { + clientCallName: 'client.crm.objects.fees.get', + fullyQualifiedName: 'crm.objects.fees.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/fees/{feeId}', + }, + { + clientCallName: 'client.crm.objects.fees.search', + fullyQualifiedName: 'crm.objects.fees.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/search', + }, + { + clientCallName: 'client.crm.objects.fees.batch.create', + fullyQualifiedName: 'crm.objects.fees.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/batch/create', + }, + { + clientCallName: 'client.crm.objects.fees.batch.update', + fullyQualifiedName: 'crm.objects.fees.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/batch/update', + }, + { + clientCallName: 'client.crm.objects.fees.batch.delete', + fullyQualifiedName: 'crm.objects.fees.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/batch/archive', + }, + { + clientCallName: 'client.crm.objects.fees.batch.get', + fullyQualifiedName: 'crm.objects.fees.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/batch/read', + }, + { + clientCallName: 'client.crm.objects.fees.batch.upsert', + fullyQualifiedName: 'crm.objects.fees.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/fees/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.genericObjects.create', + fullyQualifiedName: 'crm.objects.genericObjects.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.objects.genericObjects.update', + fullyQualifiedName: 'crm.objects.genericObjects.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.genericObjects.list', + fullyQualifiedName: 'crm.objects.genericObjects.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.objects.genericObjects.delete', + fullyQualifiedName: 'crm.objects.genericObjects.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.genericObjects.get', + fullyQualifiedName: 'crm.objects.genericObjects.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', + }, + { + clientCallName: 'client.crm.objects.genericObjects.search', + fullyQualifiedName: 'crm.objects.genericObjects.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/search', + }, + { + clientCallName: 'client.crm.objects.genericObjects.batch.create', + fullyQualifiedName: 'crm.objects.genericObjects.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/create', + }, + { + clientCallName: 'client.crm.objects.genericObjects.batch.update', + fullyQualifiedName: 'crm.objects.genericObjects.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/update', + }, + { + clientCallName: 'client.crm.objects.genericObjects.batch.delete', + fullyQualifiedName: 'crm.objects.genericObjects.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/archive', + }, + { + clientCallName: 'client.crm.objects.genericObjects.batch.get', + fullyQualifiedName: 'crm.objects.genericObjects.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/read', + }, + { + clientCallName: 'client.crm.objects.genericObjects.batch.upsert', + fullyQualifiedName: 'crm.objects.genericObjects.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/{objectType}/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.goalTargets.create', + fullyQualifiedName: 'crm.objects.goalTargets.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets', + }, + { + clientCallName: 'client.crm.objects.goalTargets.update', + fullyQualifiedName: 'crm.objects.goalTargets.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + }, + { + clientCallName: 'client.crm.objects.goalTargets.list', + fullyQualifiedName: 'crm.objects.goalTargets.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/goal_targets', + }, + { + clientCallName: 'client.crm.objects.goalTargets.delete', + fullyQualifiedName: 'crm.objects.goalTargets.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + }, + { + clientCallName: 'client.crm.objects.goalTargets.get', + fullyQualifiedName: 'crm.objects.goalTargets.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', + }, + { + clientCallName: 'client.crm.objects.goalTargets.search', + fullyQualifiedName: 'crm.objects.goalTargets.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/search', + }, + { + clientCallName: 'client.crm.objects.goalTargets.batch.create', + fullyQualifiedName: 'crm.objects.goalTargets.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/batch/create', + }, + { + clientCallName: 'client.crm.objects.goalTargets.batch.update', + fullyQualifiedName: 'crm.objects.goalTargets.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/batch/update', + }, + { + clientCallName: 'client.crm.objects.goalTargets.batch.delete', + fullyQualifiedName: 'crm.objects.goalTargets.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/batch/archive', + }, + { + clientCallName: 'client.crm.objects.goalTargets.batch.get', + fullyQualifiedName: 'crm.objects.goalTargets.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/batch/read', + }, + { + clientCallName: 'client.crm.objects.goalTargets.batch.upsert', + fullyQualifiedName: 'crm.objects.goalTargets.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/goal_targets/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.invoices.create', + fullyQualifiedName: 'crm.objects.invoices.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices', + }, + { + clientCallName: 'client.crm.objects.invoices.update', + fullyQualifiedName: 'crm.objects.invoices.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', + }, + { + clientCallName: 'client.crm.objects.invoices.list', + fullyQualifiedName: 'crm.objects.invoices.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/invoices', + }, + { + clientCallName: 'client.crm.objects.invoices.delete', + fullyQualifiedName: 'crm.objects.invoices.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', + }, + { + clientCallName: 'client.crm.objects.invoices.get', + fullyQualifiedName: 'crm.objects.invoices.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', + }, + { + clientCallName: 'client.crm.objects.invoices.search', + fullyQualifiedName: 'crm.objects.invoices.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/search', + }, + { + clientCallName: 'client.crm.objects.invoices.batch.create', + fullyQualifiedName: 'crm.objects.invoices.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/batch/create', + }, + { + clientCallName: 'client.crm.objects.invoices.batch.update', + fullyQualifiedName: 'crm.objects.invoices.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/batch/update', + }, + { + clientCallName: 'client.crm.objects.invoices.batch.delete', + fullyQualifiedName: 'crm.objects.invoices.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/batch/archive', + }, + { + clientCallName: 'client.crm.objects.invoices.batch.get', + fullyQualifiedName: 'crm.objects.invoices.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/batch/read', + }, + { + clientCallName: 'client.crm.objects.invoices.batch.upsert', + fullyQualifiedName: 'crm.objects.invoices.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/invoices/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.leads.create', + fullyQualifiedName: 'crm.objects.leads.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads', + }, + { + clientCallName: 'client.crm.objects.leads.update', + fullyQualifiedName: 'crm.objects.leads.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/leads/{leadsId}', + }, + { + clientCallName: 'client.crm.objects.leads.list', + fullyQualifiedName: 'crm.objects.leads.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/leads', + }, + { + clientCallName: 'client.crm.objects.leads.delete', + fullyQualifiedName: 'crm.objects.leads.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/leads/{leadsId}', + }, + { + clientCallName: 'client.crm.objects.leads.get', + fullyQualifiedName: 'crm.objects.leads.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/leads/{leadsId}', + }, + { + clientCallName: 'client.crm.objects.leads.search', + fullyQualifiedName: 'crm.objects.leads.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/search', + }, + { + clientCallName: 'client.crm.objects.leads.batch.create', + fullyQualifiedName: 'crm.objects.leads.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/batch/create', + }, + { + clientCallName: 'client.crm.objects.leads.batch.update', + fullyQualifiedName: 'crm.objects.leads.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/batch/update', + }, + { + clientCallName: 'client.crm.objects.leads.batch.delete', + fullyQualifiedName: 'crm.objects.leads.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/batch/archive', + }, + { + clientCallName: 'client.crm.objects.leads.batch.get', + fullyQualifiedName: 'crm.objects.leads.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/batch/read', + }, + { + clientCallName: 'client.crm.objects.leads.batch.upsert', + fullyQualifiedName: 'crm.objects.leads.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/leads/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.lineItems.create', + fullyQualifiedName: 'crm.objects.lineItems.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items', + }, + { + clientCallName: 'client.crm.objects.lineItems.update', + fullyQualifiedName: 'crm.objects.lineItems.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', + }, + { + clientCallName: 'client.crm.objects.lineItems.list', + fullyQualifiedName: 'crm.objects.lineItems.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/line_items', + }, + { + clientCallName: 'client.crm.objects.lineItems.delete', + fullyQualifiedName: 'crm.objects.lineItems.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', + }, + { + clientCallName: 'client.crm.objects.lineItems.get', + fullyQualifiedName: 'crm.objects.lineItems.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', + }, + { + clientCallName: 'client.crm.objects.lineItems.search', + fullyQualifiedName: 'crm.objects.lineItems.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/search', + }, + { + clientCallName: 'client.crm.objects.lineItems.batch.create', + fullyQualifiedName: 'crm.objects.lineItems.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/batch/create', + }, + { + clientCallName: 'client.crm.objects.lineItems.batch.update', + fullyQualifiedName: 'crm.objects.lineItems.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/batch/update', + }, + { + clientCallName: 'client.crm.objects.lineItems.batch.delete', + fullyQualifiedName: 'crm.objects.lineItems.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/batch/archive', + }, + { + clientCallName: 'client.crm.objects.lineItems.batch.get', + fullyQualifiedName: 'crm.objects.lineItems.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/batch/read', + }, + { + clientCallName: 'client.crm.objects.lineItems.batch.upsert', + fullyQualifiedName: 'crm.objects.lineItems.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/line_items/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.listings.create', + fullyQualifiedName: 'crm.objects.listings.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420', + }, + { + clientCallName: 'client.crm.objects.listings.update', + fullyQualifiedName: 'crm.objects.listings.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/0-420/{listingId}', + }, + { + clientCallName: 'client.crm.objects.listings.list', + fullyQualifiedName: 'crm.objects.listings.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-420', + }, + { + clientCallName: 'client.crm.objects.listings.delete', + fullyQualifiedName: 'crm.objects.listings.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/0-420/{listingId}', + }, + { + clientCallName: 'client.crm.objects.listings.get', + fullyQualifiedName: 'crm.objects.listings.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-420/{listingId}', + }, + { + clientCallName: 'client.crm.objects.listings.search', + fullyQualifiedName: 'crm.objects.listings.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/search', + }, + { + clientCallName: 'client.crm.objects.listings.batch.create', + fullyQualifiedName: 'crm.objects.listings.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/batch/create', + }, + { + clientCallName: 'client.crm.objects.listings.batch.update', + fullyQualifiedName: 'crm.objects.listings.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/batch/update', + }, + { + clientCallName: 'client.crm.objects.listings.batch.delete', + fullyQualifiedName: 'crm.objects.listings.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/batch/archive', + }, + { + clientCallName: 'client.crm.objects.listings.batch.get', + fullyQualifiedName: 'crm.objects.listings.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/batch/read', + }, + { + clientCallName: 'client.crm.objects.listings.batch.upsert', + fullyQualifiedName: 'crm.objects.listings.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-420/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.meetings.create', + fullyQualifiedName: 'crm.objects.meetings.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings', + }, + { + clientCallName: 'client.crm.objects.meetings.update', + fullyQualifiedName: 'crm.objects.meetings.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/meetings/{meetingId}', + }, + { + clientCallName: 'client.crm.objects.meetings.list', + fullyQualifiedName: 'crm.objects.meetings.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/meetings', + }, + { + clientCallName: 'client.crm.objects.meetings.delete', + fullyQualifiedName: 'crm.objects.meetings.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/meetings/{meetingId}', + }, + { + clientCallName: 'client.crm.objects.meetings.get', + fullyQualifiedName: 'crm.objects.meetings.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/meetings/{meetingId}', + }, + { + clientCallName: 'client.crm.objects.meetings.search', + fullyQualifiedName: 'crm.objects.meetings.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/search', + }, + { + clientCallName: 'client.crm.objects.meetings.batch.create', + fullyQualifiedName: 'crm.objects.meetings.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/batch/create', + }, + { + clientCallName: 'client.crm.objects.meetings.batch.update', + fullyQualifiedName: 'crm.objects.meetings.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/batch/update', + }, + { + clientCallName: 'client.crm.objects.meetings.batch.delete', + fullyQualifiedName: 'crm.objects.meetings.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/batch/archive', + }, + { + clientCallName: 'client.crm.objects.meetings.batch.get', + fullyQualifiedName: 'crm.objects.meetings.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/batch/read', + }, + { + clientCallName: 'client.crm.objects.meetings.batch.upsert', + fullyQualifiedName: 'crm.objects.meetings.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/meetings/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.notes.create', + fullyQualifiedName: 'crm.objects.notes.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes', + }, + { + clientCallName: 'client.crm.objects.notes.update', + fullyQualifiedName: 'crm.objects.notes.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/notes/{noteId}', + }, + { + clientCallName: 'client.crm.objects.notes.list', + fullyQualifiedName: 'crm.objects.notes.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/notes', + }, + { + clientCallName: 'client.crm.objects.notes.delete', + fullyQualifiedName: 'crm.objects.notes.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/notes/{noteId}', + }, + { + clientCallName: 'client.crm.objects.notes.get', + fullyQualifiedName: 'crm.objects.notes.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/notes/{noteId}', + }, + { + clientCallName: 'client.crm.objects.notes.search', + fullyQualifiedName: 'crm.objects.notes.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/search', + }, + { + clientCallName: 'client.crm.objects.notes.batch.create', + fullyQualifiedName: 'crm.objects.notes.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/batch/create', + }, + { + clientCallName: 'client.crm.objects.notes.batch.update', + fullyQualifiedName: 'crm.objects.notes.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/batch/update', + }, + { + clientCallName: 'client.crm.objects.notes.batch.delete', + fullyQualifiedName: 'crm.objects.notes.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/batch/archive', + }, + { + clientCallName: 'client.crm.objects.notes.batch.get', + fullyQualifiedName: 'crm.objects.notes.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/batch/read', + }, + { + clientCallName: 'client.crm.objects.notes.batch.upsert', + fullyQualifiedName: 'crm.objects.notes.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/notes/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.orders.create', + fullyQualifiedName: 'crm.objects.orders.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders', + }, + { + clientCallName: 'client.crm.objects.orders.update', + fullyQualifiedName: 'crm.objects.orders.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/orders/{orderId}', + }, + { + clientCallName: 'client.crm.objects.orders.list', + fullyQualifiedName: 'crm.objects.orders.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/orders', + }, + { + clientCallName: 'client.crm.objects.orders.delete', + fullyQualifiedName: 'crm.objects.orders.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/orders/{orderId}', + }, + { + clientCallName: 'client.crm.objects.orders.get', + fullyQualifiedName: 'crm.objects.orders.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/orders/{orderId}', + }, + { + clientCallName: 'client.crm.objects.orders.search', + fullyQualifiedName: 'crm.objects.orders.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/search', + }, + { + clientCallName: 'client.crm.objects.orders.batch.create', + fullyQualifiedName: 'crm.objects.orders.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/batch/create', + }, + { + clientCallName: 'client.crm.objects.orders.batch.update', + fullyQualifiedName: 'crm.objects.orders.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/batch/update', + }, + { + clientCallName: 'client.crm.objects.orders.batch.delete', + fullyQualifiedName: 'crm.objects.orders.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/batch/archive', + }, + { + clientCallName: 'client.crm.objects.orders.batch.get', + fullyQualifiedName: 'crm.objects.orders.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/batch/read', + }, + { + clientCallName: 'client.crm.objects.orders.batch.upsert', + fullyQualifiedName: 'crm.objects.orders.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/orders/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.partnerClients.update', + fullyQualifiedName: 'crm.objects.partnerClients.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}', + }, + { + clientCallName: 'client.crm.objects.partnerClients.list', + fullyQualifiedName: 'crm.objects.partnerClients.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/partner_clients', + }, + { + clientCallName: 'client.crm.objects.partnerClients.get', + fullyQualifiedName: 'crm.objects.partnerClients.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}', + }, + { + clientCallName: 'client.crm.objects.partnerClients.listAssociations', + fullyQualifiedName: 'crm.objects.partnerClients.listAssociations', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}', + }, + { + clientCallName: 'client.crm.objects.partnerClients.search', + fullyQualifiedName: 'crm.objects.partnerClients.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_clients/search', + }, + { + clientCallName: 'client.crm.objects.partnerClients.batch.update', + fullyQualifiedName: 'crm.objects.partnerClients.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_clients/batch/update', + }, + { + clientCallName: 'client.crm.objects.partnerClients.batch.get', + fullyQualifiedName: 'crm.objects.partnerClients.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_clients/batch/read', + }, + { + clientCallName: 'client.crm.objects.partnerServices.update', + fullyQualifiedName: 'crm.objects.partnerServices.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}', + }, + { + clientCallName: 'client.crm.objects.partnerServices.list', + fullyQualifiedName: 'crm.objects.partnerServices.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}', + }, + { + clientCallName: 'client.crm.objects.partnerServices.get', + fullyQualifiedName: 'crm.objects.partnerServices.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}', + }, + { + clientCallName: 'client.crm.objects.partnerServices.search', + fullyQualifiedName: 'crm.objects.partnerServices.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_services/search', + }, + { + clientCallName: 'client.crm.objects.partnerServices.batch.update', + fullyQualifiedName: 'crm.objects.partnerServices.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_services/batch/update', + }, + { + clientCallName: 'client.crm.objects.partnerServices.batch.get', + fullyQualifiedName: 'crm.objects.partnerServices.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/partner_services/batch/read', + }, + { + clientCallName: 'client.crm.objects.postalMail.create', + fullyQualifiedName: 'crm.objects.postalMail.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail', + }, + { + clientCallName: 'client.crm.objects.postalMail.update', + fullyQualifiedName: 'crm.objects.postalMail.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', + }, + { + clientCallName: 'client.crm.objects.postalMail.list', + fullyQualifiedName: 'crm.objects.postalMail.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/postal_mail', + }, + { + clientCallName: 'client.crm.objects.postalMail.delete', + fullyQualifiedName: 'crm.objects.postalMail.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', + }, + { + clientCallName: 'client.crm.objects.postalMail.get', + fullyQualifiedName: 'crm.objects.postalMail.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', + }, + { + clientCallName: 'client.crm.objects.postalMail.search', + fullyQualifiedName: 'crm.objects.postalMail.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/search', + }, + { + clientCallName: 'client.crm.objects.postalMail.batch.create', + fullyQualifiedName: 'crm.objects.postalMail.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/batch/create', + }, + { + clientCallName: 'client.crm.objects.postalMail.batch.update', + fullyQualifiedName: 'crm.objects.postalMail.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/batch/update', + }, + { + clientCallName: 'client.crm.objects.postalMail.batch.delete', + fullyQualifiedName: 'crm.objects.postalMail.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/batch/archive', + }, + { + clientCallName: 'client.crm.objects.postalMail.batch.get', + fullyQualifiedName: 'crm.objects.postalMail.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/batch/read', + }, + { + clientCallName: 'client.crm.objects.postalMail.batch.upsert', + fullyQualifiedName: 'crm.objects.postalMail.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/postal_mail/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.products.create', + fullyQualifiedName: 'crm.objects.products.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products', + }, + { + clientCallName: 'client.crm.objects.products.update', + fullyQualifiedName: 'crm.objects.products.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/products/{productId}', + }, + { + clientCallName: 'client.crm.objects.products.list', + fullyQualifiedName: 'crm.objects.products.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/products', + }, + { + clientCallName: 'client.crm.objects.products.delete', + fullyQualifiedName: 'crm.objects.products.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/products/{productId}', + }, + { + clientCallName: 'client.crm.objects.products.get', + fullyQualifiedName: 'crm.objects.products.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/products/{productId}', + }, + { + clientCallName: 'client.crm.objects.products.search', + fullyQualifiedName: 'crm.objects.products.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/search', + }, + { + clientCallName: 'client.crm.objects.products.batch.create', + fullyQualifiedName: 'crm.objects.products.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/batch/create', + }, + { + clientCallName: 'client.crm.objects.products.batch.update', + fullyQualifiedName: 'crm.objects.products.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/batch/update', + }, + { + clientCallName: 'client.crm.objects.products.batch.delete', + fullyQualifiedName: 'crm.objects.products.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/batch/archive', + }, + { + clientCallName: 'client.crm.objects.products.batch.get', + fullyQualifiedName: 'crm.objects.products.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/batch/read', + }, + { + clientCallName: 'client.crm.objects.products.batch.upsert', + fullyQualifiedName: 'crm.objects.products.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/products/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.projects.create', + fullyQualifiedName: 'crm.objects.projects.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects', + }, + { + clientCallName: 'client.crm.objects.projects.update', + fullyQualifiedName: 'crm.objects.projects.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/projects/{projectId}', + }, + { + clientCallName: 'client.crm.objects.projects.list', + fullyQualifiedName: 'crm.objects.projects.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/projects', + }, + { + clientCallName: 'client.crm.objects.projects.delete', + fullyQualifiedName: 'crm.objects.projects.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/projects/{projectId}', + }, + { + clientCallName: 'client.crm.objects.projects.get', + fullyQualifiedName: 'crm.objects.projects.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/projects/{projectId}', + }, + { + clientCallName: 'client.crm.objects.projects.merge', + fullyQualifiedName: 'crm.objects.projects.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/merge', + }, + { + clientCallName: 'client.crm.objects.projects.search', + fullyQualifiedName: 'crm.objects.projects.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/search', + }, + { + clientCallName: 'client.crm.objects.projects.batch.create', + fullyQualifiedName: 'crm.objects.projects.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/batch/create', + }, + { + clientCallName: 'client.crm.objects.projects.batch.update', + fullyQualifiedName: 'crm.objects.projects.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/batch/update', + }, + { + clientCallName: 'client.crm.objects.projects.batch.delete', + fullyQualifiedName: 'crm.objects.projects.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/batch/archive', + }, + { + clientCallName: 'client.crm.objects.projects.batch.get', + fullyQualifiedName: 'crm.objects.projects.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/batch/read', + }, + { + clientCallName: 'client.crm.objects.projects.batch.upsert', + fullyQualifiedName: 'crm.objects.projects.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/projects/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.quotes.create', + fullyQualifiedName: 'crm.objects.quotes.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes', + }, + { + clientCallName: 'client.crm.objects.quotes.update', + fullyQualifiedName: 'crm.objects.quotes.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/quotes/{quoteId}', + }, + { + clientCallName: 'client.crm.objects.quotes.list', + fullyQualifiedName: 'crm.objects.quotes.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/quotes', + }, + { + clientCallName: 'client.crm.objects.quotes.delete', + fullyQualifiedName: 'crm.objects.quotes.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/quotes/{quoteId}', + }, + { + clientCallName: 'client.crm.objects.quotes.get', + fullyQualifiedName: 'crm.objects.quotes.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/quotes/{quoteId}', + }, + { + clientCallName: 'client.crm.objects.quotes.search', + fullyQualifiedName: 'crm.objects.quotes.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/search', + }, + { + clientCallName: 'client.crm.objects.quotes.batch.create', + fullyQualifiedName: 'crm.objects.quotes.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/batch/create', + }, + { + clientCallName: 'client.crm.objects.quotes.batch.update', + fullyQualifiedName: 'crm.objects.quotes.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/batch/update', + }, + { + clientCallName: 'client.crm.objects.quotes.batch.delete', + fullyQualifiedName: 'crm.objects.quotes.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/batch/archive', + }, + { + clientCallName: 'client.crm.objects.quotes.batch.get', + fullyQualifiedName: 'crm.objects.quotes.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/batch/read', + }, + { + clientCallName: 'client.crm.objects.quotes.batch.upsert', + fullyQualifiedName: 'crm.objects.quotes.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/quotes/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.services.create', + fullyQualifiedName: 'crm.objects.services.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162', + }, + { + clientCallName: 'client.crm.objects.services.update', + fullyQualifiedName: 'crm.objects.services.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/0-162/{serviceId}', + }, + { + clientCallName: 'client.crm.objects.services.list', + fullyQualifiedName: 'crm.objects.services.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-162', + }, + { + clientCallName: 'client.crm.objects.services.delete', + fullyQualifiedName: 'crm.objects.services.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/0-162/{serviceId}', + }, + { + clientCallName: 'client.crm.objects.services.get', + fullyQualifiedName: 'crm.objects.services.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/0-162/{serviceId}', + }, + { + clientCallName: 'client.crm.objects.services.search', + fullyQualifiedName: 'crm.objects.services.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/search', + }, + { + clientCallName: 'client.crm.objects.services.batch.create', + fullyQualifiedName: 'crm.objects.services.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/batch/create', + }, + { + clientCallName: 'client.crm.objects.services.batch.update', + fullyQualifiedName: 'crm.objects.services.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/batch/update', + }, + { + clientCallName: 'client.crm.objects.services.batch.delete', + fullyQualifiedName: 'crm.objects.services.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/batch/archive', + }, + { + clientCallName: 'client.crm.objects.services.batch.get', + fullyQualifiedName: 'crm.objects.services.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/batch/read', + }, + { + clientCallName: 'client.crm.objects.services.batch.upsert', + fullyQualifiedName: 'crm.objects.services.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/0-162/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.subscriptions.create', + fullyQualifiedName: 'crm.objects.subscriptions.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions', + }, + { + clientCallName: 'client.crm.objects.subscriptions.update', + fullyQualifiedName: 'crm.objects.subscriptions.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.crm.objects.subscriptions.list', + fullyQualifiedName: 'crm.objects.subscriptions.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/subscriptions', + }, + { + clientCallName: 'client.crm.objects.subscriptions.delete', + fullyQualifiedName: 'crm.objects.subscriptions.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.crm.objects.subscriptions.get', + fullyQualifiedName: 'crm.objects.subscriptions.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.crm.objects.subscriptions.search', + fullyQualifiedName: 'crm.objects.subscriptions.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/search', + }, + { + clientCallName: 'client.crm.objects.subscriptions.batch.create', + fullyQualifiedName: 'crm.objects.subscriptions.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/batch/create', + }, + { + clientCallName: 'client.crm.objects.subscriptions.batch.update', + fullyQualifiedName: 'crm.objects.subscriptions.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/batch/update', + }, + { + clientCallName: 'client.crm.objects.subscriptions.batch.delete', + fullyQualifiedName: 'crm.objects.subscriptions.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/batch/archive', + }, + { + clientCallName: 'client.crm.objects.subscriptions.batch.get', + fullyQualifiedName: 'crm.objects.subscriptions.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/batch/read', + }, + { + clientCallName: 'client.crm.objects.subscriptions.batch.upsert', + fullyQualifiedName: 'crm.objects.subscriptions.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/subscriptions/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.tasks.create', + fullyQualifiedName: 'crm.objects.tasks.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks', + }, + { + clientCallName: 'client.crm.objects.tasks.update', + fullyQualifiedName: 'crm.objects.tasks.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/tasks/{taskId}', + }, + { + clientCallName: 'client.crm.objects.tasks.list', + fullyQualifiedName: 'crm.objects.tasks.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/tasks', + }, + { + clientCallName: 'client.crm.objects.tasks.delete', + fullyQualifiedName: 'crm.objects.tasks.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/tasks/{taskId}', + }, + { + clientCallName: 'client.crm.objects.tasks.get', + fullyQualifiedName: 'crm.objects.tasks.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/tasks/{taskId}', + }, + { + clientCallName: 'client.crm.objects.tasks.search', + fullyQualifiedName: 'crm.objects.tasks.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/search', + }, + { + clientCallName: 'client.crm.objects.tasks.batch.create', + fullyQualifiedName: 'crm.objects.tasks.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/batch/create', + }, + { + clientCallName: 'client.crm.objects.tasks.batch.update', + fullyQualifiedName: 'crm.objects.tasks.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/batch/update', + }, + { + clientCallName: 'client.crm.objects.tasks.batch.delete', + fullyQualifiedName: 'crm.objects.tasks.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/batch/archive', + }, + { + clientCallName: 'client.crm.objects.tasks.batch.get', + fullyQualifiedName: 'crm.objects.tasks.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/batch/read', + }, + { + clientCallName: 'client.crm.objects.tasks.batch.upsert', + fullyQualifiedName: 'crm.objects.tasks.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tasks/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.taxes.create', + fullyQualifiedName: 'crm.objects.taxes.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes', + }, + { + clientCallName: 'client.crm.objects.taxes.update', + fullyQualifiedName: 'crm.objects.taxes.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/taxes/{taxId}', + }, + { + clientCallName: 'client.crm.objects.taxes.list', + fullyQualifiedName: 'crm.objects.taxes.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/taxes', + }, + { + clientCallName: 'client.crm.objects.taxes.delete', + fullyQualifiedName: 'crm.objects.taxes.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/taxes/{taxId}', + }, + { + clientCallName: 'client.crm.objects.taxes.get', + fullyQualifiedName: 'crm.objects.taxes.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/taxes/{taxId}', + }, + { + clientCallName: 'client.crm.objects.taxes.search', + fullyQualifiedName: 'crm.objects.taxes.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/search', + }, + { + clientCallName: 'client.crm.objects.taxes.batch.create', + fullyQualifiedName: 'crm.objects.taxes.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/batch/create', + }, + { + clientCallName: 'client.crm.objects.taxes.batch.update', + fullyQualifiedName: 'crm.objects.taxes.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/batch/update', + }, + { + clientCallName: 'client.crm.objects.taxes.batch.delete', + fullyQualifiedName: 'crm.objects.taxes.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/batch/archive', + }, + { + clientCallName: 'client.crm.objects.taxes.batch.get', + fullyQualifiedName: 'crm.objects.taxes.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/batch/read', + }, + { + clientCallName: 'client.crm.objects.taxes.batch.upsert', + fullyQualifiedName: 'crm.objects.taxes.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/taxes/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.tickets.create', + fullyQualifiedName: 'crm.objects.tickets.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets', + }, + { + clientCallName: 'client.crm.objects.tickets.update', + fullyQualifiedName: 'crm.objects.tickets.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/tickets/{ticketId}', + }, + { + clientCallName: 'client.crm.objects.tickets.list', + fullyQualifiedName: 'crm.objects.tickets.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/tickets', + }, + { + clientCallName: 'client.crm.objects.tickets.delete', + fullyQualifiedName: 'crm.objects.tickets.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/tickets/{ticketId}', + }, + { + clientCallName: 'client.crm.objects.tickets.get', + fullyQualifiedName: 'crm.objects.tickets.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/tickets/{ticketId}', + }, + { + clientCallName: 'client.crm.objects.tickets.merge', + fullyQualifiedName: 'crm.objects.tickets.merge', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/merge', + }, + { + clientCallName: 'client.crm.objects.tickets.search', + fullyQualifiedName: 'crm.objects.tickets.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/search', + }, + { + clientCallName: 'client.crm.objects.tickets.batch.create', + fullyQualifiedName: 'crm.objects.tickets.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/batch/create', + }, + { + clientCallName: 'client.crm.objects.tickets.batch.update', + fullyQualifiedName: 'crm.objects.tickets.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/batch/update', + }, + { + clientCallName: 'client.crm.objects.tickets.batch.delete', + fullyQualifiedName: 'crm.objects.tickets.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/batch/archive', + }, + { + clientCallName: 'client.crm.objects.tickets.batch.get', + fullyQualifiedName: 'crm.objects.tickets.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/batch/read', + }, + { + clientCallName: 'client.crm.objects.tickets.batch.upsert', + fullyQualifiedName: 'crm.objects.tickets.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/tickets/batch/upsert', + }, + { + clientCallName: 'client.crm.objects.users.create', + fullyQualifiedName: 'crm.objects.users.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users', + }, + { + clientCallName: 'client.crm.objects.users.update', + fullyQualifiedName: 'crm.objects.users.update', + httpMethod: 'patch', + httpPath: '/crm/objects/2026-03/users/{userId}', + }, + { + clientCallName: 'client.crm.objects.users.list', + fullyQualifiedName: 'crm.objects.users.list', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/users', + }, + { + clientCallName: 'client.crm.objects.users.delete', + fullyQualifiedName: 'crm.objects.users.delete', + httpMethod: 'delete', + httpPath: '/crm/objects/2026-03/users/{userId}', + }, + { + clientCallName: 'client.crm.objects.users.get', + fullyQualifiedName: 'crm.objects.users.get', + httpMethod: 'get', + httpPath: '/crm/objects/2026-03/users/{userId}', + }, + { + clientCallName: 'client.crm.objects.users.search', + fullyQualifiedName: 'crm.objects.users.search', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/search', + }, + { + clientCallName: 'client.crm.objects.users.batch.create', + fullyQualifiedName: 'crm.objects.users.batch.create', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/batch/create', + }, + { + clientCallName: 'client.crm.objects.users.batch.update', + fullyQualifiedName: 'crm.objects.users.batch.update', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/batch/update', + }, + { + clientCallName: 'client.crm.objects.users.batch.delete', + fullyQualifiedName: 'crm.objects.users.batch.delete', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/batch/archive', + }, + { + clientCallName: 'client.crm.objects.users.batch.get', + fullyQualifiedName: 'crm.objects.users.batch.get', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/batch/read', + }, + { + clientCallName: 'client.crm.objects.users.batch.upsert', + fullyQualifiedName: 'crm.objects.users.batch.upsert', + httpMethod: 'post', + httpPath: '/crm/objects/2026-03/users/batch/upsert', + }, + { + clientCallName: 'client.crm.owners.list', + fullyQualifiedName: 'crm.owners.list', + httpMethod: 'get', + httpPath: '/crm/owners/2026-03', + }, + { + clientCallName: 'client.crm.owners.get', + fullyQualifiedName: 'crm.owners.get', + httpMethod: 'get', + httpPath: '/crm/owners/2026-03/{ownerId}', + }, + { + clientCallName: 'client.crm.pipelines.create', + fullyQualifiedName: 'crm.pipelines.create', + httpMethod: 'post', + httpPath: '/crm/pipelines/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.pipelines.update', + fullyQualifiedName: 'crm.pipelines.update', + httpMethod: 'patch', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + }, + { + clientCallName: 'client.crm.pipelines.list', + fullyQualifiedName: 'crm.pipelines.list', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.pipelines.delete', + fullyQualifiedName: 'crm.pipelines.delete', + httpMethod: 'delete', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + }, + { + clientCallName: 'client.crm.pipelines.createStage', + fullyQualifiedName: 'crm.pipelines.createStage', + httpMethod: 'post', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', + }, + { + clientCallName: 'client.crm.pipelines.deleteStage', + fullyQualifiedName: 'crm.pipelines.deleteStage', + httpMethod: 'delete', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + }, + { + clientCallName: 'client.crm.pipelines.get', + fullyQualifiedName: 'crm.pipelines.get', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + }, + { + clientCallName: 'client.crm.pipelines.getStage', + fullyQualifiedName: 'crm.pipelines.getStage', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + }, + { + clientCallName: 'client.crm.pipelines.listAudit', + fullyQualifiedName: 'crm.pipelines.listAudit', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit', + }, + { + clientCallName: 'client.crm.pipelines.listStageAudit', + fullyQualifiedName: 'crm.pipelines.listStageAudit', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit', + }, + { + clientCallName: 'client.crm.pipelines.listStages', + fullyQualifiedName: 'crm.pipelines.listStages', + httpMethod: 'get', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', + }, + { + clientCallName: 'client.crm.pipelines.updateAllProperties', + fullyQualifiedName: 'crm.pipelines.updateAllProperties', + httpMethod: 'put', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', + }, + { + clientCallName: 'client.crm.pipelines.updateStage', + fullyQualifiedName: 'crm.pipelines.updateStage', + httpMethod: 'patch', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + }, + { + clientCallName: 'client.crm.pipelines.updateStageAllProperties', + fullyQualifiedName: 'crm.pipelines.updateStageAllProperties', + httpMethod: 'put', + httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', + }, + { + clientCallName: 'client.crm.properties.create', + fullyQualifiedName: 'crm.properties.create', + httpMethod: 'post', + httpPath: '/crm/properties/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.properties.update', + fullyQualifiedName: 'crm.properties.update', + httpMethod: 'patch', + httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.crm.properties.list', + fullyQualifiedName: 'crm.properties.list', + httpMethod: 'get', + httpPath: '/crm/properties/2026-03/{objectType}', + }, + { + clientCallName: 'client.crm.properties.delete', + fullyQualifiedName: 'crm.properties.delete', + httpMethod: 'delete', + httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.crm.properties.get', + fullyQualifiedName: 'crm.properties.get', + httpMethod: 'get', + httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', + }, + { + clientCallName: 'client.crm.properties.batch.create', + fullyQualifiedName: 'crm.properties.batch.create', + httpMethod: 'post', + httpPath: '/crm/properties/2026-03/{objectType}/batch/create', + }, + { + clientCallName: 'client.crm.properties.batch.delete', + fullyQualifiedName: 'crm.properties.batch.delete', + httpMethod: 'post', + httpPath: '/crm/properties/2026-03/{objectType}/batch/archive', + }, + { + clientCallName: 'client.crm.properties.batch.get', + fullyQualifiedName: 'crm.properties.batch.get', + httpMethod: 'post', + httpPath: '/crm/properties/2026-03/{objectType}/batch/read', + }, + { + clientCallName: 'client.crm.properties.groups.create', + fullyQualifiedName: 'crm.properties.groups.create', + httpMethod: 'post', + httpPath: '/crm/properties/2026-03/{objectType}/groups', + }, + { + clientCallName: 'client.crm.properties.groups.update', + fullyQualifiedName: 'crm.properties.groups.update', + httpMethod: 'patch', + httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.crm.properties.groups.list', + fullyQualifiedName: 'crm.properties.groups.list', + httpMethod: 'get', + httpPath: '/crm/properties/2026-03/{objectType}/groups', + }, + { + clientCallName: 'client.crm.properties.groups.delete', + fullyQualifiedName: 'crm.properties.groups.delete', + httpMethod: 'delete', + httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.crm.properties.groups.get', + fullyQualifiedName: 'crm.properties.groups.get', + httpMethod: 'get', + httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', + }, + { + clientCallName: 'client.crm.propertiesValidations.getByObjectTypeID', + fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeID', + httpMethod: 'get', + httpPath: '/crm/property-validations/2026-03/{objectTypeId}', + }, + { + clientCallName: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', + fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeIDAndPropertyName', + httpMethod: 'get', + httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}', + }, + { + clientCallName: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', + fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', + httpMethod: 'get', + httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', + }, + { + clientCallName: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', + fullyQualifiedName: 'crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', + httpMethod: 'put', + httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', + }, + { + clientCallName: 'client.crm.timeline.createEvent', + fullyQualifiedName: 'crm.timeline.createEvent', + httpMethod: 'post', + httpPath: '/integrators/timeline/2026-03/events', + }, + { + clientCallName: 'client.crm.timeline.createProjectType', + fullyQualifiedName: 'crm.timeline.createProjectType', + httpMethod: 'post', + httpPath: '/integrators/timeline/2026-03/types/projects', + }, + { + clientCallName: 'client.crm.timeline.batch.create', + fullyQualifiedName: 'crm.timeline.batch.create', + httpMethod: 'post', + httpPath: '/integrators/timeline/2026-03/events/batch', + }, + { + clientCallName: 'client.events.definitions.create', + fullyQualifiedName: 'events.definitions.create', + httpMethod: 'post', + httpPath: '/events/2026-03/event-definitions', + }, + { + clientCallName: 'client.events.definitions.update', + fullyQualifiedName: 'events.definitions.update', + httpMethod: 'patch', + httpPath: '/events/2026-03/event-definitions/{eventName}', + }, + { + clientCallName: 'client.events.definitions.list', + fullyQualifiedName: 'events.definitions.list', + httpMethod: 'get', + httpPath: '/events/2026-03/event-definitions', + }, + { + clientCallName: 'client.events.definitions.delete', + fullyQualifiedName: 'events.definitions.delete', + httpMethod: 'delete', + httpPath: '/events/2026-03/event-definitions/{eventName}', + }, + { + clientCallName: 'client.events.definitions.createProperty', + fullyQualifiedName: 'events.definitions.createProperty', + httpMethod: 'post', + httpPath: '/events/2026-03/event-definitions/{eventName}/property', + }, + { + clientCallName: 'client.events.definitions.deleteProperty', + fullyQualifiedName: 'events.definitions.deleteProperty', + httpMethod: 'delete', + httpPath: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', + }, + { + clientCallName: 'client.events.definitions.get', + fullyQualifiedName: 'events.definitions.get', + httpMethod: 'get', + httpPath: '/events/2026-03/event-definitions/{eventName}', + }, + { + clientCallName: 'client.events.definitions.sendBatch', + fullyQualifiedName: 'events.definitions.sendBatch', + httpMethod: 'post', + httpPath: '/events/2026-03/send/batch', + }, + { + clientCallName: 'client.events.definitions.updateProperty', + fullyQualifiedName: 'events.definitions.updateProperty', + httpMethod: 'patch', + httpPath: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', + }, + { + clientCallName: 'client.events.occurrences.list', + fullyQualifiedName: 'events.occurrences.list', + httpMethod: 'get', + httpPath: '/events/event-occurrences/2026-03', + }, + { + clientCallName: 'client.events.occurrences.listEventTypes', + fullyQualifiedName: 'events.occurrences.listEventTypes', + httpMethod: 'get', + httpPath: '/events/event-occurrences/2026-03/event-types', + }, + { + clientCallName: 'client.events.send.batchSend', + fullyQualifiedName: 'events.send.batchSend', + httpMethod: 'post', + httpPath: '/events/2026-03/send/batch', + }, + { + clientCallName: 'client.events.send.send', + fullyQualifiedName: 'events.send.send', + httpMethod: 'post', + httpPath: '/events/2026-03/send', + }, + { + clientCallName: 'client.files.fileAssets.create', + fullyQualifiedName: 'files.fileAssets.create', + httpMethod: 'post', + httpPath: '/files/2026-03/folders', + }, + { + clientCallName: 'client.files.fileAssets.update', + fullyQualifiedName: 'files.fileAssets.update', + httpMethod: 'patch', + httpPath: '/files/2026-03/files/{fileId}', + }, + { + clientCallName: 'client.files.fileAssets.delete', + fullyQualifiedName: 'files.fileAssets.delete', + httpMethod: 'delete', + httpPath: '/files/2026-03/files/{fileId}', + }, + { + clientCallName: 'client.files.fileAssets.gdprDelete', + fullyQualifiedName: 'files.fileAssets.gdprDelete', + httpMethod: 'delete', + httpPath: '/files/2026-03/files/{fileId}/gdpr-delete', + }, + { + clientCallName: 'client.files.fileAssets.get', + fullyQualifiedName: 'files.fileAssets.get', + httpMethod: 'get', + httpPath: '/files/2026-03/files/{fileId}', + }, + { + clientCallName: 'client.files.fileAssets.getImportTaskStatus', + fullyQualifiedName: 'files.fileAssets.getImportTaskStatus', + httpMethod: 'get', + httpPath: '/files/2026-03/files/import-from-url/async/tasks/{taskId}/status', + }, + { + clientCallName: 'client.files.fileAssets.getSignedURL', + fullyQualifiedName: 'files.fileAssets.getSignedURL', + httpMethod: 'get', + httpPath: '/files/2026-03/files/{fileId}/signed-url', + }, + { + clientCallName: 'client.files.fileAssets.importFromURLAsync', + fullyQualifiedName: 'files.fileAssets.importFromURLAsync', + httpMethod: 'post', + httpPath: '/files/2026-03/files/import-from-url/async', + }, + { + clientCallName: 'client.files.fileAssets.replace', + fullyQualifiedName: 'files.fileAssets.replace', + httpMethod: 'put', + httpPath: '/files/2026-03/files/{fileId}', + }, + { + clientCallName: 'client.files.fileAssets.search', + fullyQualifiedName: 'files.fileAssets.search', + httpMethod: 'get', + httpPath: '/files/2026-03/files/search', + }, + { + clientCallName: 'client.files.fileAssets.upload', + fullyQualifiedName: 'files.fileAssets.upload', + httpMethod: 'post', + httpPath: '/files/2026-03/files', + }, + { + clientCallName: 'client.files.folders.deleteByID', + fullyQualifiedName: 'files.folders.deleteByID', + httpMethod: 'delete', + httpPath: '/files/2026-03/folders/{folderId}', + }, + { + clientCallName: 'client.files.folders.deleteByPath', + fullyQualifiedName: 'files.folders.deleteByPath', + httpMethod: 'delete', + httpPath: '/files/2026-03/folders/{folderPath}', + }, + { + clientCallName: 'client.files.folders.getByID', + fullyQualifiedName: 'files.folders.getByID', + httpMethod: 'get', + httpPath: '/files/2026-03/folders/{folderId}', + }, + { + clientCallName: 'client.files.folders.getByPath', + fullyQualifiedName: 'files.folders.getByPath', + httpMethod: 'get', + httpPath: '/files/2026-03/folders/{folderPath}', + }, + { + clientCallName: 'client.files.folders.getUpdateAsyncStatus', + fullyQualifiedName: 'files.folders.getUpdateAsyncStatus', + httpMethod: 'get', + httpPath: '/files/2026-03/folders/update/async/tasks/{taskId}/status', + }, + { + clientCallName: 'client.files.folders.search', + fullyQualifiedName: 'files.folders.search', + httpMethod: 'get', + httpPath: '/files/2026-03/folders/search', + }, + { + clientCallName: 'client.files.folders.updateAsyncByID', + fullyQualifiedName: 'files.folders.updateAsyncByID', + httpMethod: 'post', + httpPath: '/files/2026-03/folders/update/async', + }, + { + clientCallName: 'client.files.folders.updateByID', + fullyQualifiedName: 'files.folders.updateByID', + httpMethod: 'patch', + httpPath: '/files/2026-03/folders/{folderId}', + }, + { + clientCallName: 'client.marketing.campaigns.create', + fullyQualifiedName: 'marketing.campaigns.create', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03', + }, + { + clientCallName: 'client.marketing.campaigns.update', + fullyQualifiedName: 'marketing.campaigns.update', + httpMethod: 'patch', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', + }, + { + clientCallName: 'client.marketing.campaigns.list', + fullyQualifiedName: 'marketing.campaigns.list', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03', + }, + { + clientCallName: 'client.marketing.campaigns.delete', + fullyQualifiedName: 'marketing.campaigns.delete', + httpMethod: 'delete', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', + }, + { + clientCallName: 'client.marketing.campaigns.get', + fullyQualifiedName: 'marketing.campaigns.get', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', + }, + { + clientCallName: 'client.marketing.campaigns.assets.update', + fullyQualifiedName: 'marketing.campaigns.assets.update', + httpMethod: 'put', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', + }, + { + clientCallName: 'client.marketing.campaigns.assets.list', + fullyQualifiedName: 'marketing.campaigns.assets.list', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}', + }, + { + clientCallName: 'client.marketing.campaigns.assets.delete', + fullyQualifiedName: 'marketing.campaigns.assets.delete', + httpMethod: 'delete', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', + }, + { + clientCallName: 'client.marketing.campaigns.batch.create', + fullyQualifiedName: 'marketing.campaigns.batch.create', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/batch/create', + }, + { + clientCallName: 'client.marketing.campaigns.batch.update', + fullyQualifiedName: 'marketing.campaigns.batch.update', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/batch/update', + }, + { + clientCallName: 'client.marketing.campaigns.batch.delete', + fullyQualifiedName: 'marketing.campaigns.batch.delete', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/batch/archive', + }, + { + clientCallName: 'client.marketing.campaigns.batch.get', + fullyQualifiedName: 'marketing.campaigns.batch.get', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/batch/read', + }, + { + clientCallName: 'client.marketing.campaigns.budget.create', + fullyQualifiedName: 'marketing.campaigns.budget.create', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget', + }, + { + clientCallName: 'client.marketing.campaigns.budget.update', + fullyQualifiedName: 'marketing.campaigns.budget.update', + httpMethod: 'put', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + }, + { + clientCallName: 'client.marketing.campaigns.budget.delete', + fullyQualifiedName: 'marketing.campaigns.budget.delete', + httpMethod: 'delete', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + }, + { + clientCallName: 'client.marketing.campaigns.budget.get', + fullyQualifiedName: 'marketing.campaigns.budget.get', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', + }, + { + clientCallName: 'client.marketing.campaigns.budget.getTotals', + fullyQualifiedName: 'marketing.campaigns.budget.getTotals', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/totals', + }, + { + clientCallName: 'client.marketing.campaigns.metrics.getAttributionMetrics', + fullyQualifiedName: 'marketing.campaigns.metrics.getAttributionMetrics', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics', + }, + { + clientCallName: 'client.marketing.campaigns.metrics.getRevenueAttribution', + fullyQualifiedName: 'marketing.campaigns.metrics.getRevenueAttribution', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue', + }, + { + clientCallName: 'client.marketing.campaigns.metrics.listContactIDsByType', + fullyQualifiedName: 'marketing.campaigns.metrics.listContactIDsByType', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}', + }, + { + clientCallName: 'client.marketing.campaigns.spend.create', + fullyQualifiedName: 'marketing.campaigns.spend.create', + httpMethod: 'post', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend', + }, + { + clientCallName: 'client.marketing.campaigns.spend.update', + fullyQualifiedName: 'marketing.campaigns.spend.update', + httpMethod: 'put', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + }, + { + clientCallName: 'client.marketing.campaigns.spend.delete', + fullyQualifiedName: 'marketing.campaigns.spend.delete', + httpMethod: 'delete', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + }, + { + clientCallName: 'client.marketing.campaigns.spend.get', + fullyQualifiedName: 'marketing.campaigns.spend.get', + httpMethod: 'get', + httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', + }, + { + clientCallName: 'client.marketing.emails.create', + fullyQualifiedName: 'marketing.emails.create', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03', + }, + { + clientCallName: 'client.marketing.emails.update', + fullyQualifiedName: 'marketing.emails.update', + httpMethod: 'patch', + httpPath: '/marketing/emails/2026-03/{emailId}', + }, + { + clientCallName: 'client.marketing.emails.list', + fullyQualifiedName: 'marketing.emails.list', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03', + }, + { + clientCallName: 'client.marketing.emails.delete', + fullyQualifiedName: 'marketing.emails.delete', + httpMethod: 'delete', + httpPath: '/marketing/emails/2026-03/{emailId}', + }, + { + clientCallName: 'client.marketing.emails.clone', + fullyQualifiedName: 'marketing.emails.clone', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/clone', + }, + { + clientCallName: 'client.marketing.emails.createAbTestVariation', + fullyQualifiedName: 'marketing.emails.createAbTestVariation', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/ab-test/create-variation', + }, + { + clientCallName: 'client.marketing.emails.get', + fullyQualifiedName: 'marketing.emails.get', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/statistics/list', + }, + { + clientCallName: 'client.marketing.emails.getAbTestVariation', + fullyQualifiedName: 'marketing.emails.getAbTestVariation', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/{emailId}/ab-test/get-variation', + }, + { + clientCallName: 'client.marketing.emails.getDraft', + fullyQualifiedName: 'marketing.emails.getDraft', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/{emailId}/draft', + }, + { + clientCallName: 'client.marketing.emails.getHistogram', + fullyQualifiedName: 'marketing.emails.getHistogram', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/statistics/histogram', + }, + { + clientCallName: 'client.marketing.emails.getRevision', + fullyQualifiedName: 'marketing.emails.getRevision', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}', + }, + { + clientCallName: 'client.marketing.emails.listRevisions', + fullyQualifiedName: 'marketing.emails.listRevisions', + httpMethod: 'get', + httpPath: '/marketing/emails/2026-03/{emailId}/revisions', + }, + { + clientCallName: 'client.marketing.emails.publish', + fullyQualifiedName: 'marketing.emails.publish', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/{emailId}/publish', + }, + { + clientCallName: 'client.marketing.emails.resetDraft', + fullyQualifiedName: 'marketing.emails.resetDraft', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/{emailId}/draft/reset', + }, + { + clientCallName: 'client.marketing.emails.restoreRevision', + fullyQualifiedName: 'marketing.emails.restoreRevision', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore', + }, + { + clientCallName: 'client.marketing.emails.restoreRevisionToDraft', + fullyQualifiedName: 'marketing.emails.restoreRevisionToDraft', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft', + }, + { + clientCallName: 'client.marketing.emails.unpublish', + fullyQualifiedName: 'marketing.emails.unpublish', + httpMethod: 'post', + httpPath: '/marketing/emails/2026-03/{emailId}/unpublish', + }, + { + clientCallName: 'client.marketing.emails.updateDraft', + fullyQualifiedName: 'marketing.emails.updateDraft', + httpMethod: 'patch', + httpPath: '/marketing/emails/2026-03/{emailId}/draft', + }, + { + clientCallName: 'client.marketing.marketingEvents.create', + fullyQualifiedName: 'marketing.marketingEvents.create', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events', + }, + { + clientCallName: 'client.marketing.marketingEvents.update', + fullyQualifiedName: 'marketing.marketingEvents.update', + httpMethod: 'patch', + httpPath: '/marketing/marketing-events/2026-03/{objectId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.list', + fullyQualifiedName: 'marketing.marketingEvents.list', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03', + }, + { + clientCallName: 'client.marketing.marketingEvents.delete', + fullyQualifiedName: 'marketing.marketingEvents.delete', + httpMethod: 'delete', + httpPath: '/marketing/marketing-events/2026-03/{objectId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.deleteBatch', + fullyQualifiedName: 'marketing.marketingEvents.deleteBatch', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/batch/archive', + }, + { + clientCallName: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.deleteBatchByExternalEventID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/delete', + }, + { + clientCallName: 'client.marketing.marketingEvents.deleteByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.deleteByExternalEventID', + httpMethod: 'delete', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.get', + fullyQualifiedName: 'marketing.marketingEvents.get', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/{objectId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.getByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.getByExternalEventID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.searchByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.searchByExternalEventID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/events/search', + }, + { + clientCallName: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.searchIdentifiersByExternalEventID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/{externalEventId}/identifiers', + }, + { + clientCallName: 'client.marketing.marketingEvents.updateBatch', + fullyQualifiedName: 'marketing.marketingEvents.updateBatch', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/batch/update', + }, + { + clientCallName: 'client.marketing.marketingEvents.updateByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.updateByExternalEventID', + httpMethod: 'patch', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.upsertBatch', + fullyQualifiedName: 'marketing.marketingEvents.upsertBatch', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/upsert', + }, + { + clientCallName: 'client.marketing.marketingEvents.upsertByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.upsertByExternalEventID', + httpMethod: 'put', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', + fullyQualifiedName: 'marketing.marketingEvents.attendance.createByEventIDAndContactID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create', + }, + { + clientCallName: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', + fullyQualifiedName: 'marketing.marketingEvents.attendance.createByEventIDAndEmail', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create', + }, + { + clientCallName: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', + fullyQualifiedName: 'marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create', + }, + { + clientCallName: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', + fullyQualifiedName: 'marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', + httpMethod: 'post', + httpPath: + '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create', + }, + { + clientCallName: 'client.marketing.marketingEvents.events.cancelByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.events.cancelByExternalEventID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/cancel', + }, + { + clientCallName: 'client.marketing.marketingEvents.events.completeByExternalEventID', + fullyQualifiedName: 'marketing.marketingEvents.events.completeByExternalEventID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/complete', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.list', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.list', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.delete', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.delete', + httpMethod: 'delete', + httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.associate', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.associate', + httpMethod: 'put', + httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.associateByExternalAccount', + httpMethod: 'put', + httpPath: + '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.deleteByExternalAccount', + httpMethod: 'delete', + httpPath: + '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', + fullyQualifiedName: 'marketing.marketingEvents.listAssociations.listByExternalAccount', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists', + }, + { + clientCallName: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', + fullyQualifiedName: 'marketing.marketingEvents.participations.getByExternalAccountAndEventID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.participations.getByID', + fullyQualifiedName: 'marketing.marketingEvents.participations.getByID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/participations/{marketingEventId}', + }, + { + clientCallName: 'client.marketing.marketingEvents.participations.listBreakdownByContact', + fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByContact', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown', + }, + { + clientCallName: + 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', + fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', + httpMethod: 'get', + httpPath: + '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown', + }, + { + clientCallName: 'client.marketing.marketingEvents.participations.listBreakdownByID', + fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByID', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown', + }, + { + clientCallName: 'client.marketing.marketingEvents.settings.createOrUpdate', + fullyQualifiedName: 'marketing.marketingEvents.settings.createOrUpdate', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.marketing.marketingEvents.settings.get', + fullyQualifiedName: 'marketing.marketingEvents.settings.get', + httpMethod: 'get', + httpPath: '/marketing/marketing-events/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.marketing.marketingEvents.subscriberState.recordByEmail', + fullyQualifiedName: 'marketing.marketingEvents.subscriberState.recordByEmail', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert', + }, + { + clientCallName: 'client.marketing.marketingEvents.subscriberState.recordByID', + fullyQualifiedName: 'marketing.marketingEvents.subscriberState.recordByID', + httpMethod: 'post', + httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert', + }, + { + clientCallName: 'client.marketing.singleSend.create', + fullyQualifiedName: 'marketing.singleSend.create', + httpMethod: 'post', + httpPath: '/marketing/email-campaigns/2026-03/single-send', + }, + { + clientCallName: 'client.marketing.transactional.singleEmail.send', + fullyQualifiedName: 'marketing.transactional.singleEmail.send', + httpMethod: 'post', + httpPath: '/marketing/transactional/2026-03/single-email/send', + }, + { + clientCallName: 'client.marketing.transactional.smtpTokens.create', + fullyQualifiedName: 'marketing.transactional.smtpTokens.create', + httpMethod: 'post', + httpPath: '/marketing/transactional/2026-03/smtp-tokens', + }, + { + clientCallName: 'client.marketing.transactional.smtpTokens.list', + fullyQualifiedName: 'marketing.transactional.smtpTokens.list', + httpMethod: 'get', + httpPath: '/marketing/transactional/2026-03/smtp-tokens', + }, + { + clientCallName: 'client.marketing.transactional.smtpTokens.delete', + fullyQualifiedName: 'marketing.transactional.smtpTokens.delete', + httpMethod: 'delete', + httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', + }, + { + clientCallName: 'client.marketing.transactional.smtpTokens.get', + fullyQualifiedName: 'marketing.transactional.smtpTokens.get', + httpMethod: 'get', + httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', + }, + { + clientCallName: 'client.marketing.transactional.smtpTokens.resetPassword', + fullyQualifiedName: 'marketing.transactional.smtpTokens.resetPassword', + httpMethod: 'post', + httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset', + }, + { + clientCallName: 'client.meta.origins.ipRanges.list', + fullyQualifiedName: 'meta.origins.ipRanges.list', + httpMethod: 'get', + httpPath: '/meta/network-origins/2026-03/ip-ranges', + }, + { + clientCallName: 'client.meta.origins.ipRanges.listSimple', + fullyQualifiedName: 'meta.origins.ipRanges.listSimple', + httpMethod: 'get', + httpPath: '/meta/network-origins/2026-03/ip-ranges/simple', + }, + { + clientCallName: 'client.scheduler.meetings.advanced.create', + fullyQualifiedName: 'scheduler.meetings.advanced.create', + httpMethod: 'post', + httpPath: '/scheduler/2026-03/meetings/calendar', + }, + { + clientCallName: 'client.scheduler.meetings.advanced.book', + fullyQualifiedName: 'scheduler.meetings.advanced.book', + httpMethod: 'post', + httpPath: '/scheduler/2026-03/meetings/meeting-links/book', + }, + { + clientCallName: 'client.scheduler.meetings.basic.list', + fullyQualifiedName: 'scheduler.meetings.basic.list', + httpMethod: 'get', + httpPath: '/scheduler/2026-03/meetings/meeting-links', + }, + { + clientCallName: 'client.scheduler.meetings.basic.getAvailabilityBySlug', + fullyQualifiedName: 'scheduler.meetings.basic.getAvailabilityBySlug', + httpMethod: 'get', + httpPath: '/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}', + }, + { + clientCallName: 'client.scheduler.meetings.basic.getBookingInfoBySlug', + fullyQualifiedName: 'scheduler.meetings.basic.getBookingInfoBySlug', + httpMethod: 'get', + httpPath: '/scheduler/2026-03/meetings/meeting-links/book/{slug}', + }, + { + clientCallName: 'client.settings.currencies.getCompanyCurrency', + fullyQualifiedName: 'settings.currencies.getCompanyCurrency', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/company-currency', + }, + { + clientCallName: 'client.settings.currencies.listCodes', + fullyQualifiedName: 'settings.currencies.listCodes', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/codes', + }, + { + clientCallName: 'client.settings.currencies.updateCompanyCurrency', + fullyQualifiedName: 'settings.currencies.updateCompanyCurrency', + httpMethod: 'put', + httpPath: '/settings/currencies/2026-03/company-currency', + }, + { + clientCallName: 'client.settings.currencies.centralFxRates.createCurrency', + fullyQualifiedName: 'settings.currencies.centralFxRates.createCurrency', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/central-fx-rates/add-currency', + }, + { + clientCallName: 'client.settings.currencies.centralFxRates.getInformation', + fullyQualifiedName: 'settings.currencies.centralFxRates.getInformation', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/central-fx-rates/information', + }, + { + clientCallName: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', + fullyQualifiedName: 'settings.currencies.centralFxRates.getUnsupportedCurrencies', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/central-fx-rates/unsupported-currencies', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.createExchangeRate', + fullyQualifiedName: 'settings.currencies.exchangeRates.createExchangeRate', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/exchange-rates', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.getExchangeRateByID', + fullyQualifiedName: 'settings.currencies.exchangeRates.getExchangeRateByID', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', + fullyQualifiedName: 'settings.currencies.exchangeRates.listCurrentExchangeRates', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/exchange-rates/current', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.listExchangeRates', + fullyQualifiedName: 'settings.currencies.exchangeRates.listExchangeRates', + httpMethod: 'get', + httpPath: '/settings/currencies/2026-03/exchange-rates', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.updateExchangeRate', + fullyQualifiedName: 'settings.currencies.exchangeRates.updateExchangeRate', + httpMethod: 'patch', + httpPath: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.updateVisibility', + fullyQualifiedName: 'settings.currencies.exchangeRates.updateVisibility', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/exchange-rates/update-visibility', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.batch.create', + fullyQualifiedName: 'settings.currencies.exchangeRates.batch.create', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/exchange-rates/batch/create', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.batch.update', + fullyQualifiedName: 'settings.currencies.exchangeRates.batch.update', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/exchange-rates/batch/update', + }, + { + clientCallName: 'client.settings.currencies.exchangeRates.batch.get', + fullyQualifiedName: 'settings.currencies.exchangeRates.batch.get', + httpMethod: 'post', + httpPath: '/settings/currencies/2026-03/exchange-rates/batch/read', + }, + { + clientCallName: 'client.settings.taxRates.list', + fullyQualifiedName: 'settings.taxRates.list', + httpMethod: 'get', + httpPath: '/tax-rates/2026-03/tax-rates', + }, + { + clientCallName: 'client.settings.taxRates.get', + fullyQualifiedName: 'settings.taxRates.get', + httpMethod: 'get', + httpPath: '/tax-rates/2026-03/tax-rates/{taxRateGroupId}', + }, + { + clientCallName: 'client.settings.users.create', + fullyQualifiedName: 'settings.users.create', + httpMethod: 'post', + httpPath: '/settings/users/2026-03', + }, + { + clientCallName: 'client.settings.users.update', + fullyQualifiedName: 'settings.users.update', + httpMethod: 'put', + httpPath: '/settings/users/2026-03/{userId}', + }, + { + clientCallName: 'client.settings.users.list', + fullyQualifiedName: 'settings.users.list', + httpMethod: 'get', + httpPath: '/settings/users/2026-03', + }, + { + clientCallName: 'client.settings.users.delete', + fullyQualifiedName: 'settings.users.delete', + httpMethod: 'delete', + httpPath: '/settings/users/2026-03/{userId}', + }, + { + clientCallName: 'client.settings.users.get', + fullyQualifiedName: 'settings.users.get', + httpMethod: 'get', + httpPath: '/settings/users/2026-03/{userId}', + }, + { + clientCallName: 'client.settings.users.listRoles', + fullyQualifiedName: 'settings.users.listRoles', + httpMethod: 'get', + httpPath: '/settings/users/2026-03/roles', + }, + { + clientCallName: 'client.settings.users.listTeams', + fullyQualifiedName: 'settings.users.listTeams', + httpMethod: 'get', + httpPath: '/settings/users/2026-03/teams', + }, + { + clientCallName: 'client.webhooks.createBatchEventSubscriptions', + fullyQualifiedName: 'webhooks.createBatchEventSubscriptions', + httpMethod: 'post', + httpPath: '/webhooks/2026-03/{appId}/subscriptions/batch/update', + }, + { + clientCallName: 'client.webhooks.createCrmSnapshots', + fullyQualifiedName: 'webhooks.createCrmSnapshots', + httpMethod: 'post', + httpPath: '/webhooks-journal/snapshots/2026-03/crm', + }, + { + clientCallName: 'client.webhooks.createEventSubscription', + fullyQualifiedName: 'webhooks.createEventSubscription', + httpMethod: 'post', + httpPath: '/webhooks/2026-03/{appId}/subscriptions', + }, + { + clientCallName: 'client.webhooks.createJournalSubscription', + fullyQualifiedName: 'webhooks.createJournalSubscription', + httpMethod: 'post', + httpPath: '/webhooks-journal/subscriptions/2026-03', + }, + { + clientCallName: 'client.webhooks.createSubscriptionFilter', + fullyQualifiedName: 'webhooks.createSubscriptionFilter', + httpMethod: 'post', + httpPath: '/webhooks-journal/subscriptions/2026-03/filters', + }, + { + clientCallName: 'client.webhooks.deleteEventSubscription', + fullyQualifiedName: 'webhooks.deleteEventSubscription', + httpMethod: 'delete', + httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.deleteJournalSubscription', + fullyQualifiedName: 'webhooks.deleteJournalSubscription', + httpMethod: 'delete', + httpPath: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.deleteJournalSubscriptionForPortal', + fullyQualifiedName: 'webhooks.deleteJournalSubscriptionForPortal', + httpMethod: 'delete', + httpPath: '/webhooks-journal/subscriptions/2026-03/portals/{portalId}', + }, + { + clientCallName: 'client.webhooks.deleteSettings', + fullyQualifiedName: 'webhooks.deleteSettings', + httpMethod: 'delete', + httpPath: '/webhooks/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.webhooks.deleteSubscriptionFilter', + fullyQualifiedName: 'webhooks.deleteSubscriptionFilter', + httpMethod: 'delete', + httpPath: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', + }, + { + clientCallName: 'client.webhooks.getEarliestJournalBatch', + fullyQualifiedName: 'webhooks.getEarliestJournalBatch', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/batch/earliest/{count}', + }, + { + clientCallName: 'client.webhooks.getEarliestJournalEntry', + fullyQualifiedName: 'webhooks.getEarliestJournalEntry', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/earliest', + }, + { + clientCallName: 'client.webhooks.getEarliestLocalJournalBatch', + fullyQualifiedName: 'webhooks.getEarliestLocalJournalBatch', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/batch/earliest/{count}', + }, + { + clientCallName: 'client.webhooks.getEarliestLocalJournalEntry', + fullyQualifiedName: 'webhooks.getEarliestLocalJournalEntry', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/earliest', + }, + { + clientCallName: 'client.webhooks.getEventSubscription', + fullyQualifiedName: 'webhooks.getEventSubscription', + httpMethod: 'get', + httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.getJournalBatchByRequest', + fullyQualifiedName: 'webhooks.getJournalBatchByRequest', + httpMethod: 'post', + httpPath: '/webhooks-journal/journal/2026-03/batch/read', + }, + { + clientCallName: 'client.webhooks.getJournalBatchFromOffset', + fullyQualifiedName: 'webhooks.getJournalBatchFromOffset', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}', + }, + { + clientCallName: 'client.webhooks.getJournalStatus', + fullyQualifiedName: 'webhooks.getJournalStatus', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/status/{statusId}', + }, + { + clientCallName: 'client.webhooks.getJournalSubscription', + fullyQualifiedName: 'webhooks.getJournalSubscription', + httpMethod: 'get', + httpPath: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.getLatestJournalBatch', + fullyQualifiedName: 'webhooks.getLatestJournalBatch', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/batch/latest/{count}', + }, + { + clientCallName: 'client.webhooks.getLatestJournalEntry', + fullyQualifiedName: 'webhooks.getLatestJournalEntry', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/latest', + }, + { + clientCallName: 'client.webhooks.getLatestLocalJournalBatch', + fullyQualifiedName: 'webhooks.getLatestLocalJournalBatch', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/batch/latest/{count}', + }, + { + clientCallName: 'client.webhooks.getLatestLocalJournalEntry', + fullyQualifiedName: 'webhooks.getLatestLocalJournalEntry', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/latest', + }, + { + clientCallName: 'client.webhooks.getLocalJournalBatchByRequest', + fullyQualifiedName: 'webhooks.getLocalJournalBatchByRequest', + httpMethod: 'post', + httpPath: '/webhooks-journal/journal-local/2026-03/batch/read', + }, + { + clientCallName: 'client.webhooks.getLocalJournalBatchFromOffset', + fullyQualifiedName: 'webhooks.getLocalJournalBatchFromOffset', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}', + }, + { + clientCallName: 'client.webhooks.getLocalJournalStatus', + fullyQualifiedName: 'webhooks.getLocalJournalStatus', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/status/{statusId}', + }, + { + clientCallName: 'client.webhooks.getNextJournalEntries', + fullyQualifiedName: 'webhooks.getNextJournalEntries', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal/2026-03/offset/{offset}/next', + }, + { + clientCallName: 'client.webhooks.getNextLocalJournalEntries', + fullyQualifiedName: 'webhooks.getNextLocalJournalEntries', + httpMethod: 'get', + httpPath: '/webhooks-journal/journal-local/2026-03/offset/{offset}/next', + }, + { + clientCallName: 'client.webhooks.getSettings', + fullyQualifiedName: 'webhooks.getSettings', + httpMethod: 'get', + httpPath: '/webhooks/2026-03/{appId}/settings', + }, + { + clientCallName: 'client.webhooks.getSubscriptionFilter', + fullyQualifiedName: 'webhooks.getSubscriptionFilter', + httpMethod: 'get', + httpPath: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', + }, + { + clientCallName: 'client.webhooks.listEventSubscriptions', + fullyQualifiedName: 'webhooks.listEventSubscriptions', + httpMethod: 'get', + httpPath: '/webhooks/2026-03/{appId}/subscriptions', + }, + { + clientCallName: 'client.webhooks.listJournalSubscriptions', + fullyQualifiedName: 'webhooks.listJournalSubscriptions', + httpMethod: 'get', + httpPath: '/webhooks-journal/subscriptions/2026-03', + }, + { + clientCallName: 'client.webhooks.listSubscriptionFilters', + fullyQualifiedName: 'webhooks.listSubscriptionFilters', + httpMethod: 'get', + httpPath: '/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.updateEventSubscription', + fullyQualifiedName: 'webhooks.updateEventSubscription', + httpMethod: 'patch', + httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', + }, + { + clientCallName: 'client.webhooks.updateSettings', + fullyQualifiedName: 'webhooks.updateSettings', + httpMethod: 'put', + httpPath: '/webhooks/2026-03/{appId}/settings', + }, +]; + +function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { + if (!options) { + return undefined; + } + + let allowedMethods: SdkMethod[]; + + if (options.codeAllowHttpGets || options.codeAllowedMethods) { + // Start with nothing allowed and then add into it from options + let allowedMethodsSet = new Set(); + + if (options.codeAllowHttpGets) { + // Add all methods that map to an HTTP GET + sdkMethods + .filter((method) => method.httpMethod === 'get') + .forEach((method) => allowedMethodsSet.add(method)); + } + + if (options.codeAllowedMethods) { + // Add all methods that match any of the allowed regexps + const allowedRegexps = options.codeAllowedMethods.map((pattern) => { + try { + return new RegExp(pattern); + } catch (e) { + throw new Error( + `Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`, + ); + } + }); + + sdkMethods + .filter((method) => allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName))) + .forEach((method) => allowedMethodsSet.add(method)); + } + + allowedMethods = Array.from(allowedMethodsSet); + } else { + // Start with everything allowed + allowedMethods = [...sdkMethods]; + } + + if (options.codeBlockedMethods) { + // Filter down based on blocked regexps + const blockedRegexps = options.codeBlockedMethods.map((pattern) => { + try { + return new RegExp(pattern); + } catch (e) { + throw new Error( + `Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`, + ); + } + }); + + allowedMethods = allowedMethods.filter( + (method) => !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)), + ); + } + + return allowedMethods; +} + +export function blockedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { + const allowedMethods = allowedMethodsForCodeTool(options); + if (!allowedMethods) { + return undefined; + } + + const allowedSet = new Set(allowedMethods.map((method) => method.fullyQualifiedName)); + + // Return any methods that are not explicitly allowed + return sdkMethods.filter((method) => !allowedSet.has(method.fullyQualifiedName)); +} diff --git a/packages/mcp-server/src/options.ts b/packages/mcp-server/src/options.ts new file mode 100644 index 00000000..f1518764 --- /dev/null +++ b/packages/mcp-server/src/options.ts @@ -0,0 +1,185 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import qs from 'qs'; +import yargs from 'yargs'; +import { hideBin } from 'yargs/helpers'; +import z from 'zod'; +import { readEnv } from './util'; + +export type CLIOptions = McpOptions & { + debug: boolean; + logFormat: 'json' | 'pretty'; + transport: 'stdio' | 'http'; + port: number | undefined; + socket: string | undefined; +}; + +export type McpOptions = { + includeCodeTool?: boolean | undefined; + includeDocsTools?: boolean | undefined; + stainlessApiKey?: string | undefined; + docsSearchMode?: 'stainless-api' | 'local' | undefined; + docsDir?: string | undefined; + codeAllowHttpGets?: boolean | undefined; + codeAllowedMethods?: string[] | undefined; + codeBlockedMethods?: string[] | undefined; + codeExecutionMode: McpCodeExecutionMode; + customInstructionsPath?: string | undefined; +}; + +export type McpCodeExecutionMode = 'stainless-sandbox' | 'local'; + +export function parseCLIOptions(): CLIOptions { + const opts = yargs(hideBin(process.argv)) + .option('code-allow-http-gets', { + type: 'boolean', + description: + 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.', + }) + .option('code-allowed-methods', { + type: 'string', + array: true, + description: + 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + }) + .option('code-blocked-methods', { + type: 'string', + array: true, + description: + 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + }) + .option('code-execution-mode', { + type: 'string', + choices: ['stainless-sandbox', 'local'], + default: 'stainless-sandbox', + description: + "Where to run code execution in code tool; 'stainless-sandbox' will execute code in Stainless-hosted sandboxes whereas 'local' will execute code locally on the MCP server machine.", + }) + .option('custom-instructions-path', { + type: 'string', + description: 'Path to custom instructions for the MCP server', + }) + .option('debug', { type: 'boolean', description: 'Enable debug logging' }) + .option('docs-dir', { + type: 'string', + description: + 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.', + }) + .option('docs-search-mode', { + type: 'string', + choices: ['stainless-api', 'local'], + default: 'stainless-api', + description: + "Where to search documentation; 'stainless-api' uses the Stainless-hosted search API whereas 'local' uses an in-memory search index built from embedded SDK method data and optional local docs files.", + }) + .option('log-format', { + type: 'string', + choices: ['json', 'pretty'], + description: 'Format for log output; defaults to json unless tty is detected', + }) + .option('no-tools', { + type: 'string', + array: true, + choices: ['code', 'docs'], + description: 'Tools to explicitly disable', + }) + .option('port', { + type: 'number', + default: 3000, + description: 'Port to serve on if using http transport', + }) + .option('socket', { type: 'string', description: 'Unix socket to serve on if using http transport' }) + .option('stainless-api-key', { + type: 'string', + default: readEnv('STAINLESS_API_KEY'), + description: + 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', + }) + .option('tools', { + type: 'string', + array: true, + choices: ['code', 'docs'], + description: 'Tools to explicitly enable', + }) + .option('transport', { + type: 'string', + choices: ['stdio', 'http'], + default: 'stdio', + description: 'What transport to use; stdio for local servers or http for remote servers', + }) + .env('MCP_SERVER') + .version(true) + .help(); + + const argv = opts.parseSync(); + + const shouldIncludeToolType = (toolType: 'code' | 'docs') => + argv.noTools?.includes(toolType) ? false + : argv.tools?.includes(toolType) ? true + : undefined; + + const includeCodeTool = shouldIncludeToolType('code'); + const includeDocsTools = shouldIncludeToolType('docs'); + + const transport = argv.transport as 'stdio' | 'http'; + const logFormat = + argv.logFormat ? (argv.logFormat as 'json' | 'pretty') + : process.stderr.isTTY ? 'pretty' + : 'json'; + + return { + ...(includeCodeTool !== undefined && { includeCodeTool }), + ...(includeDocsTools !== undefined && { includeDocsTools }), + debug: !!argv.debug, + stainlessApiKey: argv.stainlessApiKey, + docsSearchMode: argv.docsSearchMode as 'stainless-api' | 'local' | undefined, + docsDir: argv.docsDir, + codeAllowHttpGets: argv.codeAllowHttpGets, + codeAllowedMethods: argv.codeAllowedMethods, + codeBlockedMethods: argv.codeBlockedMethods, + codeExecutionMode: argv.codeExecutionMode as McpCodeExecutionMode, + customInstructionsPath: argv.customInstructionsPath, + transport, + logFormat, + port: argv.port, + socket: argv.socket, + }; +} + +const coerceArray = (zodType: T) => + z.preprocess( + (val) => + Array.isArray(val) ? val + : val ? [val] + : val, + z.array(zodType).optional(), + ); + +const QueryOptions = z.object({ + tools: coerceArray(z.enum(['code', 'docs'])).describe('Specify which MCP tools to use'), + no_tools: coerceArray(z.enum(['code', 'docs'])).describe('Specify which MCP tools to not use.'), + tool: coerceArray(z.string()).describe('Include tools matching the specified names'), +}); + +export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): McpOptions { + const queryObject = typeof query === 'string' ? qs.parse(query) : query; + const queryOptions = QueryOptions.parse(queryObject); + + let codeTool: boolean | undefined = + queryOptions.no_tools && queryOptions.no_tools?.includes('code') ? false + : queryOptions.tools?.includes('code') ? true + : defaultOptions.includeCodeTool; + + let docsTools: boolean | undefined = + queryOptions.no_tools && queryOptions.no_tools?.includes('docs') ? false + : queryOptions.tools?.includes('docs') ? true + : defaultOptions.includeDocsTools; + + return { + ...(codeTool !== undefined && { includeCodeTool: codeTool }), + ...(docsTools !== undefined && { includeDocsTools: docsTools }), + codeExecutionMode: defaultOptions.codeExecutionMode, + docsSearchMode: defaultOptions.docsSearchMode, + docsDir: defaultOptions.docsDir, + }; +} diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts new file mode 100644 index 00000000..7136e102 --- /dev/null +++ b/packages/mcp-server/src/server.ts @@ -0,0 +1,213 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { Server } from '@modelcontextprotocol/sdk/server/index.js'; +import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; +import { + CallToolRequestSchema, + ListToolsRequestSchema, + SetLevelRequestSchema, +} from '@modelcontextprotocol/sdk/types.js'; +import { ClientOptions } from '@hubspot/sdk'; +import HubSpot from '@hubspot/sdk'; +import { codeTool } from './code-tool'; +import docsSearchTool from './docs-search-tool'; +import { setLocalSearch } from './docs-search-tool'; +import { LocalDocsSearch } from './local-docs-search'; +import { getInstructions } from './instructions'; +import { McpOptions } from './options'; +import { blockedMethodsForCodeTool } from './methods'; +import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from './types'; +import { readEnv } from './util'; + +export const newMcpServer = async ({ + stainlessApiKey, + customInstructionsPath, +}: { + stainlessApiKey?: string | undefined; + customInstructionsPath?: string | undefined; +}) => + new McpServer( + { + name: 'hubspot_sdk_api', + version: '0.1.0-alpha.9', + }, + { + instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), + capabilities: { tools: {}, logging: {} }, + }, + ); + +/** + * Initializes the provided MCP Server with the given tools and handlers. + * If not provided, the default client, tools and handlers will be used. + */ +export async function initMcpServer(params: { + server: Server | McpServer; + clientOptions?: ClientOptions; + mcpOptions?: McpOptions; + stainlessApiKey?: string | undefined; + upstreamClientEnvs?: Record | undefined; + mcpSessionId?: string | undefined; + mcpClientInfo?: { name: string; version: string } | undefined; +}) { + const server = params.server instanceof McpServer ? params.server.server : params.server; + + const logAtLevel = + (level: 'debug' | 'info' | 'warning' | 'error') => + (message: string, ...rest: unknown[]) => { + void server.sendLoggingMessage({ + level, + data: { message, rest }, + }); + }; + const logger = { + debug: logAtLevel('debug'), + info: logAtLevel('info'), + warn: logAtLevel('warning'), + error: logAtLevel('error'), + }; + + if (params.mcpOptions?.docsSearchMode === 'local') { + const docsDir = params.mcpOptions?.docsDir; + const localSearch = await LocalDocsSearch.create(docsDir ? { docsDir } : undefined); + setLocalSearch(localSearch); + } + + let _client: HubSpot | undefined; + let _clientError: Error | undefined; + let _logLevel: 'debug' | 'info' | 'warn' | 'error' | 'off' | undefined; + + const getClient = (): HubSpot => { + if (_clientError) throw _clientError; + if (!_client) { + try { + _client = new HubSpot({ + ...{ + accessToken: readEnv('HUBSPOT_ACCESS_TOKEN'), + developerAPIKey: readEnv('HUBSPOT_DEVELOPER_API_KEY'), + }, + logger, + ...params.clientOptions, + defaultHeaders: { + ...params.clientOptions?.defaultHeaders, + 'X-Stainless-MCP': 'true', + }, + }); + if (_logLevel) { + _client = _client.withOptions({ logLevel: _logLevel }); + } + } catch (e) { + _clientError = e instanceof Error ? e : new Error(String(e)); + throw _clientError; + } + } + return _client; + }; + + const providedTools = selectTools(params.mcpOptions); + const toolMap = Object.fromEntries(providedTools.map((mcpTool) => [mcpTool.tool.name, mcpTool])); + + server.setRequestHandler(ListToolsRequestSchema, async () => { + return { + tools: providedTools.map((mcpTool) => mcpTool.tool), + }; + }); + + server.setRequestHandler(CallToolRequestSchema, async (request) => { + const { name, arguments: args } = request.params; + const mcpTool = toolMap[name]; + if (!mcpTool) { + throw new Error(`Unknown tool: ${name}`); + } + + let client: HubSpot; + try { + client = getClient(); + } catch (error) { + return { + content: [ + { + type: 'text' as const, + text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, + }, + ], + isError: true, + }; + } + + return executeHandler({ + handler: mcpTool.handler, + reqContext: { + client, + stainlessApiKey: params.stainlessApiKey ?? params.mcpOptions?.stainlessApiKey, + upstreamClientEnvs: params.upstreamClientEnvs, + mcpSessionId: params.mcpSessionId, + mcpClientInfo: params.mcpClientInfo, + }, + args, + }); + }); + + server.setRequestHandler(SetLevelRequestSchema, async (request) => { + const { level } = request.params; + let logLevel: 'debug' | 'info' | 'warn' | 'error' | 'off'; + switch (level) { + case 'debug': + logLevel = 'debug'; + break; + case 'info': + logLevel = 'info'; + break; + case 'notice': + case 'warning': + logLevel = 'warn'; + break; + case 'error': + logLevel = 'error'; + break; + default: + logLevel = 'off'; + break; + } + _logLevel = logLevel; + if (_client) { + _client = _client.withOptions({ logLevel }); + } + return {}; + }); +} + +/** + * Selects the tools to include in the MCP Server based on the provided options. + */ +export function selectTools(options?: McpOptions): McpTool[] { + const includedTools = []; + + if (options?.includeCodeTool ?? true) { + includedTools.push( + codeTool({ + blockedMethods: blockedMethodsForCodeTool(options), + codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', + }), + ); + } + if (options?.includeDocsTools ?? true) { + includedTools.push(docsSearchTool); + } + return includedTools; +} + +/** + * Runs the provided handler with the given client and arguments. + */ +export async function executeHandler({ + handler, + reqContext, + args, +}: { + handler: HandlerFunction; + reqContext: McpRequestContext; + args: Record | undefined; +}): Promise { + return await handler({ reqContext, args: args || {} }); +} diff --git a/packages/mcp-server/src/stdio.ts b/packages/mcp-server/src/stdio.ts new file mode 100644 index 00000000..b04a5441 --- /dev/null +++ b/packages/mcp-server/src/stdio.ts @@ -0,0 +1,17 @@ +import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; +import { McpOptions } from './options'; +import { initMcpServer, newMcpServer } from './server'; +import { getLogger } from './logger'; + +export const launchStdioServer = async (mcpOptions: McpOptions) => { + const server = await newMcpServer({ + stainlessApiKey: mcpOptions.stainlessApiKey, + customInstructionsPath: mcpOptions.customInstructionsPath, + }); + + await initMcpServer({ server, mcpOptions, stainlessApiKey: mcpOptions.stainlessApiKey }); + + const transport = new StdioServerTransport(); + await server.connect(transport); + getLogger().info('MCP Server running on stdio'); +}; diff --git a/packages/mcp-server/src/types.ts b/packages/mcp-server/src/types.ts new file mode 100644 index 00000000..78a48b07 --- /dev/null +++ b/packages/mcp-server/src/types.ts @@ -0,0 +1,126 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import HubSpot from '@hubspot/sdk'; +import { Tool } from '@modelcontextprotocol/sdk/types.js'; + +type TextContentBlock = { + type: 'text'; + text: string; +}; + +type ImageContentBlock = { + type: 'image'; + data: string; + mimeType: string; +}; + +type AudioContentBlock = { + type: 'audio'; + data: string; + mimeType: string; +}; + +type ResourceContentBlock = { + type: 'resource'; + resource: + | { + uri: string; + mimeType: string; + text: string; + } + | { + uri: string; + mimeType: string; + blob: string; + }; +}; + +export type ContentBlock = TextContentBlock | ImageContentBlock | AudioContentBlock | ResourceContentBlock; + +export type ToolCallResult = { + content: ContentBlock[]; + isError?: boolean; +}; + +export type McpRequestContext = { + client: HubSpot; + stainlessApiKey?: string | undefined; + upstreamClientEnvs?: Record | undefined; + mcpSessionId?: string | undefined; + mcpClientInfo?: { name: string; version: string } | undefined; +}; + +export type HandlerFunction = ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: Record | undefined; +}) => Promise; + +export function asTextContentResult(result: unknown): ToolCallResult { + return { + content: [ + { + type: 'text', + text: JSON.stringify(result, null, 2), + }, + ], + }; +} + +export async function asBinaryContentResult(response: Response): Promise { + const blob = await response.blob(); + const mimeType = blob.type; + const data = Buffer.from(await blob.arrayBuffer()).toString('base64'); + if (mimeType.startsWith('image/')) { + return { + content: [{ type: 'image', mimeType, data }], + }; + } else if (mimeType.startsWith('audio/')) { + return { + content: [{ type: 'audio', mimeType, data }], + }; + } else { + return { + content: [ + { + type: 'resource', + resource: { + // We must give a URI, even though this isn't actually an MCP resource. + uri: 'resource://tool-response', + mimeType, + blob: data, + }, + }, + ], + }; + } +} + +export function asErrorResult(message: string): ToolCallResult { + return { + content: [ + { + type: 'text', + text: message, + }, + ], + isError: true, + }; +} + +export type Metadata = { + resource: string; + operation: 'read' | 'write'; + tags: string[]; + httpMethod?: string; + httpPath?: string; + operationId?: string; +}; + +export type McpTool = { + metadata: Metadata; + tool: Tool; + handler: HandlerFunction; +}; diff --git a/packages/mcp-server/src/util.ts b/packages/mcp-server/src/util.ts new file mode 100644 index 00000000..069a2b47 --- /dev/null +++ b/packages/mcp-server/src/util.ts @@ -0,0 +1,25 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export const readEnv = (env: string): string | undefined => { + if (typeof (globalThis as any).process !== 'undefined') { + return (globalThis as any).process.env?.[env]?.trim() || undefined; + } else if (typeof (globalThis as any).Deno !== 'undefined') { + return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined; + } + return; +}; + +export const readEnvOrError = (env: string): string => { + let envValue = readEnv(env); + if (envValue === undefined) { + throw new Error(`Environment variable ${env} is not set`); + } + return envValue; +}; + +export const requireValue = (value: T | undefined, description: string): T => { + if (value === undefined) { + throw new Error(`Missing required value: ${description}`); + } + return value; +}; diff --git a/packages/mcp-server/tests/options.test.ts b/packages/mcp-server/tests/options.test.ts new file mode 100644 index 00000000..17306295 --- /dev/null +++ b/packages/mcp-server/tests/options.test.ts @@ -0,0 +1,32 @@ +import { parseCLIOptions } from '../src/options'; + +// Mock process.argv +const mockArgv = (args: string[]) => { + const originalArgv = process.argv; + process.argv = ['node', 'test.js', ...args]; + return () => { + process.argv = originalArgv; + }; +}; + +describe('parseCLIOptions', () => { + it('default parsing should be stdio', () => { + const cleanup = mockArgv([]); + + const result = parseCLIOptions(); + + expect(result.transport).toBe('stdio'); + + cleanup(); + }); + + it('using http transport with a port', () => { + const cleanup = mockArgv(['--transport=http', '--port=2222']); + + const result = parseCLIOptions(); + + expect(result.transport).toBe('http'); + expect(result.port).toBe(2222); + cleanup(); + }); +}); diff --git a/packages/mcp-server/tsc-multi.json b/packages/mcp-server/tsc-multi.json new file mode 100644 index 00000000..4facad5a --- /dev/null +++ b/packages/mcp-server/tsc-multi.json @@ -0,0 +1,7 @@ +{ + "targets": [ + { "extname": ".js", "module": "commonjs" }, + { "extname": ".mjs", "module": "esnext" } + ], + "projects": ["tsconfig.build.json"] +} diff --git a/packages/mcp-server/tsconfig.build.json b/packages/mcp-server/tsconfig.build.json new file mode 100644 index 00000000..ceb04135 --- /dev/null +++ b/packages/mcp-server/tsconfig.build.json @@ -0,0 +1,18 @@ +{ + "extends": "./tsconfig.json", + "include": ["dist/src"], + "exclude": [], + "compilerOptions": { + "rootDir": "./dist/src", + "paths": { + "@hubspot/sdk-mcp/*": ["./dist/src/*"], + "@hubspot/sdk-mcp": ["./dist/src/index.ts"] + }, + "noEmit": false, + "declaration": true, + "declarationMap": true, + "outDir": "dist", + "pretty": true, + "sourceMap": true + } +} diff --git a/packages/mcp-server/tsconfig.dist-src.json b/packages/mcp-server/tsconfig.dist-src.json new file mode 100644 index 00000000..e9f2d70b --- /dev/null +++ b/packages/mcp-server/tsconfig.dist-src.json @@ -0,0 +1,11 @@ +{ + // this config is included in the published src directory to prevent TS errors + // from appearing when users go to source, and VSCode opens the source .ts file + // via declaration maps + "include": ["index.ts"], + "compilerOptions": { + "target": "es2015", + "lib": ["DOM"], + "moduleResolution": "node" + } +} diff --git a/packages/mcp-server/tsconfig.json b/packages/mcp-server/tsconfig.json new file mode 100644 index 00000000..3af4bd0c --- /dev/null +++ b/packages/mcp-server/tsconfig.json @@ -0,0 +1,36 @@ +{ + "include": ["src", "tests", "examples"], + "exclude": [], + "compilerOptions": { + "target": "es2022", + "lib": ["es2022"], + "module": "commonjs", + "moduleResolution": "node", + "esModuleInterop": true, + "paths": { + "@hubspot/sdk-mcp/*": ["./src/*"], + "@hubspot/sdk-mcp": ["./src/index.ts"] + }, + "noEmit": true, + + "resolveJsonModule": true, + + "forceConsistentCasingInFileNames": true, + + "strict": true, + "noImplicitAny": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "strictBindCallApply": true, + "strictPropertyInitialization": true, + "noImplicitThis": true, + "noImplicitReturns": true, + "alwaysStrict": true, + "exactOptionalPropertyTypes": true, + "noUncheckedIndexedAccess": true, + "noImplicitOverride": true, + "noPropertyAccessFromIndexSignature": true, + + "skipLibCheck": true + } +} diff --git a/packages/mcp-server/yarn.lock b/packages/mcp-server/yarn.lock new file mode 100644 index 00000000..c6b17b02 --- /dev/null +++ b/packages/mcp-server/yarn.lock @@ -0,0 +1,4169 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@anthropic-ai/mcpb@^2.1.2": + version "2.1.2" + resolved "https://registry.yarnpkg.com/@anthropic-ai/mcpb/-/mcpb-2.1.2.tgz#cf02801929734b8810961f22e2eb72758c27d527" + integrity sha512-goRbBC8ySo7SWb7tRzr+tL6FxDc4JPTRCdgfD2omba7freofvjq5rom1lBnYHZHo6Mizs1jAHJeN53aZbDoy8A== + dependencies: + "@inquirer/prompts" "^6.0.1" + commander "^13.1.0" + fflate "^0.8.2" + galactus "^1.0.0" + ignore "^7.0.5" + node-forge "^1.3.2" + pretty-bytes "^5.6.0" + zod "^3.25.67" + zod-to-json-schema "^3.24.6" + +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.28.6.tgz#72499312ec58b1e2245ba4a4f550c132be4982f7" + integrity sha512-JYgintcMjRiCvS8mMECzaEn+m3PfoQiyqukOMCCVQtoJGYJw8j/8LBJEiqkHLkfwCcs74E3pbAUFNg7d9VNJ+Q== + dependencies: + "@babel/helper-validator-identifier" "^7.28.5" + js-tokens "^4.0.0" + picocolors "^1.1.1" + +"@babel/compat-data@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.6.tgz#103f466803fa0f059e82ccac271475470570d74c" + integrity sha512-2lfu57JtzctfIrcGMz992hyLlByuzgIk58+hhGCxjKZ3rWI82NnVLjXcaTqkI2NvlcvOskZaiZ5kjUALo3Lpxg== + +"@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.6.tgz#531bf883a1126e53501ba46eb3bb414047af507f" + integrity sha512-H3mcG6ZDLTlYfaSNi0iOKkigqMFvkTKlGUYlD8GW7nNOYRrevuA46iTypPyv+06V3fEmvvazfntkBU34L0azAw== + dependencies: + "@babel/code-frame" "^7.28.6" + "@babel/generator" "^7.28.6" + "@babel/helper-compilation-targets" "^7.28.6" + "@babel/helper-module-transforms" "^7.28.6" + "@babel/helpers" "^7.28.6" + "@babel/parser" "^7.28.6" + "@babel/template" "^7.28.6" + "@babel/traverse" "^7.28.6" + "@babel/types" "^7.28.6" + "@jridgewell/remapping" "^2.3.5" + convert-source-map "^2.0.0" + debug "^4.1.0" + gensync "^1.0.0-beta.2" + json5 "^2.2.3" + semver "^6.3.1" + +"@babel/generator@^7.28.6", "@babel/generator@^7.7.2": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.6.tgz#48dcc65d98fcc8626a48f72b62e263d25fc3c3f1" + integrity sha512-lOoVRwADj8hjf7al89tvQ2a1lf53Z+7tiXMgpZJL3maQPDxh0DgLMN62B2MKUOFcoodBHLMbDM6WAbKgNy5Suw== + dependencies: + "@babel/parser" "^7.28.6" + "@babel/types" "^7.28.6" + "@jridgewell/gen-mapping" "^0.3.12" + "@jridgewell/trace-mapping" "^0.3.28" + jsesc "^3.0.2" + +"@babel/helper-compilation-targets@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz#32c4a3f41f12ed1532179b108a4d746e105c2b25" + integrity sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA== + dependencies: + "@babel/compat-data" "^7.28.6" + "@babel/helper-validator-option" "^7.27.1" + browserslist "^4.24.0" + lru-cache "^5.1.1" + semver "^6.3.1" + +"@babel/helper-globals@^7.28.0": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" + integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== + +"@babel/helper-module-imports@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz#60632cbd6ffb70b22823187201116762a03e2d5c" + integrity sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw== + dependencies: + "@babel/traverse" "^7.28.6" + "@babel/types" "^7.28.6" + +"@babel/helper-module-transforms@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz#9312d9d9e56edc35aeb6e95c25d4106b50b9eb1e" + integrity sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA== + dependencies: + "@babel/helper-module-imports" "^7.28.6" + "@babel/helper-validator-identifier" "^7.28.5" + "@babel/traverse" "^7.28.6" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.28.6", "@babel/helper-plugin-utils@^7.8.0": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz#6f13ea251b68c8532e985fd532f28741a8af9ac8" + integrity sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug== + +"@babel/helper-string-parser@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz#54da796097ab19ce67ed9f88b47bb2ec49367687" + integrity sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA== + +"@babel/helper-validator-identifier@^7.28.5": + version "7.28.5" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz#010b6938fab7cb7df74aa2bbc06aa503b8fe5fb4" + integrity sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q== + +"@babel/helper-validator-option@^7.27.1": + version "7.27.1" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" + integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== + +"@babel/helpers@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.6.tgz#fca903a313ae675617936e8998b814c415cbf5d7" + integrity sha512-xOBvwq86HHdB7WUDTfKfT/Vuxh7gElQ+Sfti2Cy6yIWNW05P8iUslOVcZ4/sKbE+/jQaukQAdz/gf3724kYdqw== + dependencies: + "@babel/template" "^7.28.6" + "@babel/types" "^7.28.6" + +"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.6.tgz#f01a8885b7fa1e56dd8a155130226cd698ef13fd" + integrity sha512-TeR9zWR18BvbfPmGbLampPMW+uW1NZnJlRuuHso8i87QZNq2JRF9i6RgxRqtEq+wQGsS19NNTWr2duhnE49mfQ== + dependencies: + "@babel/types" "^7.28.6" + +"@babel/plugin-syntax-async-generators@^7.8.4": + version "7.8.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz#a983fb1aeb2ec3f6ed042a210f640e90e786fe0d" + integrity sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-bigint@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz#4c9a6f669f5d0cdf1b90a1671e9a146be5300cea" + integrity sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-class-properties@^7.12.13": + version "7.12.13" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz#b5c987274c4a3a82b89714796931a6b53544ae10" + integrity sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA== + dependencies: + "@babel/helper-plugin-utils" "^7.12.13" + +"@babel/plugin-syntax-class-static-block@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz#195df89b146b4b78b3bf897fd7a257c84659d406" + integrity sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-import-attributes@^7.24.7": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz#b71d5914665f60124e133696f17cd7669062c503" + integrity sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw== + dependencies: + "@babel/helper-plugin-utils" "^7.28.6" + +"@babel/plugin-syntax-import-meta@^7.10.4": + version "7.10.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz#ee601348c370fa334d2207be158777496521fd51" + integrity sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-json-strings@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz#01ca21b668cd8218c9e640cb6dd88c5412b2c96a" + integrity sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-jsx@^7.7.2": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.28.6.tgz#f8ca28bbd84883b5fea0e447c635b81ba73997ee" + integrity sha512-wgEmr06G6sIpqr8YDwA2dSRTE3bJ+V0IfpzfSY3Lfgd7YWOaAdlykvJi13ZKBt8cZHfgH1IXN+CL656W3uUa4w== + dependencies: + "@babel/helper-plugin-utils" "^7.28.6" + +"@babel/plugin-syntax-logical-assignment-operators@^7.10.4": + version "7.10.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz#ca91ef46303530448b906652bac2e9fe9941f699" + integrity sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-nullish-coalescing-operator@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz#167ed70368886081f74b5c36c65a88c03b66d1a9" + integrity sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-numeric-separator@^7.10.4": + version "7.10.4" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz#b9b070b3e33570cd9fd07ba7fa91c0dd37b9af97" + integrity sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-object-rest-spread@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz#60e225edcbd98a640332a2e72dd3e66f1af55871" + integrity sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-optional-catch-binding@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz#6111a265bcfb020eb9efd0fdfd7d26402b9ed6c1" + integrity sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-optional-chaining@^7.8.3": + version "7.8.3" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz#4f69c2ab95167e0180cd5336613f8c5788f7d48a" + integrity sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-private-property-in-object@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz#0dc6671ec0ea22b6e94a1114f857970cd39de1ad" + integrity sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-top-level-await@^7.14.5": + version "7.14.5" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz#c1cfdadc35a646240001f06138247b741c34d94c" + integrity sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-typescript@^7.7.2": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.28.6.tgz#c7b2ddf1d0a811145b1de800d1abd146af92e3a2" + integrity sha512-+nDNmQye7nlnuuHDboPbGm00Vqg3oO8niRRL27/4LYHUsHYh0zJ1xWOz0uRwNFmM1Avzk8wZbc6rdiYhomzv/A== + dependencies: + "@babel/helper-plugin-utils" "^7.28.6" + +"@babel/template@^7.28.6", "@babel/template@^7.3.3": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.28.6.tgz#0e7e56ecedb78aeef66ce7972b082fce76a23e57" + integrity sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ== + dependencies: + "@babel/code-frame" "^7.28.6" + "@babel/parser" "^7.28.6" + "@babel/types" "^7.28.6" + +"@babel/traverse@^7.28.6": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.6.tgz#871ddc79a80599a5030c53b1cc48cbe3a5583c2e" + integrity sha512-fgWX62k02qtjqdSNTAGxmKYY/7FSL9WAS1o2Hu5+I5m9T0yxZzr4cnrfXQ/MX0rIifthCSs6FKTlzYbJcPtMNg== + dependencies: + "@babel/code-frame" "^7.28.6" + "@babel/generator" "^7.28.6" + "@babel/helper-globals" "^7.28.0" + "@babel/parser" "^7.28.6" + "@babel/template" "^7.28.6" + "@babel/types" "^7.28.6" + debug "^4.3.1" + +"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.28.2", "@babel/types@^7.28.6", "@babel/types@^7.3.3": + version "7.28.6" + resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.6.tgz#c3e9377f1b155005bcc4c46020e7e394e13089df" + integrity sha512-0ZrskXVEHSWIqZM/sQZ4EV3jZJXRkio/WCxaqKZP1g//CEWEPSfeZFcms4XeKBCHU0ZKnIkdJeU/kF+eRp5lBg== + dependencies: + "@babel/helper-string-parser" "^7.27.1" + "@babel/helper-validator-identifier" "^7.28.5" + +"@bcoe/v8-coverage@^0.2.3": + version "0.2.3" + resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39" + integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw== + +"@cloudflare/cabidela@^0.2.4": + version "0.2.4" + resolved "https://registry.yarnpkg.com/@cloudflare/cabidela/-/cabidela-0.2.4.tgz#9a3e9212e636a24d796a8f16741c24885b326a1a" + integrity sha512-u/1OwwqfcMvjmUFOcb6QtFzVVGpncHJxwl254wjzp0JC5CUlBkV6r5BbRrHI5ZYJEAgu8NeeorirxngmMFPZjQ== + +"@cspotcode/source-map-support@^0.8.0": + version "0.8.1" + resolved "https://registry.yarnpkg.com/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz#00629c35a688e05a88b1cda684fb9d5e73f000a1" + integrity sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw== + dependencies: + "@jridgewell/trace-mapping" "0.3.9" + +"@eslint-community/eslint-utils@^4.4.0", "@eslint-community/eslint-utils@^4.8.0": + version "4.9.1" + resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz#4e90af67bc51ddee6cdef5284edf572ec376b595" + integrity sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ== + dependencies: + eslint-visitor-keys "^3.4.3" + +"@eslint-community/regexpp@^4.10.0", "@eslint-community/regexpp@^4.12.1": + version "4.12.2" + resolved "https://registry.yarnpkg.com/@eslint-community/regexpp/-/regexpp-4.12.2.tgz#bccdf615bcf7b6e8db830ec0b8d21c9a25de597b" + integrity sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew== + +"@eslint/config-array@^0.21.2": + version "0.21.2" + resolved "https://registry.yarnpkg.com/@eslint/config-array/-/config-array-0.21.2.tgz#f29e22057ad5316cf23836cee9a34c81fffcb7e6" + integrity sha512-nJl2KGTlrf9GjLimgIru+V/mzgSK0ABCDQRvxw5BjURL7WfH5uoWmizbH7QB6MmnMBd8cIC9uceWnezL1VZWWw== + dependencies: + "@eslint/object-schema" "^2.1.7" + debug "^4.3.1" + minimatch "^3.1.5" + +"@eslint/config-helpers@^0.4.2": + version "0.4.2" + resolved "https://registry.yarnpkg.com/@eslint/config-helpers/-/config-helpers-0.4.2.tgz#1bd006ceeb7e2e55b2b773ab318d300e1a66aeda" + integrity sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw== + dependencies: + "@eslint/core" "^0.17.0" + +"@eslint/core@^0.17.0": + version "0.17.0" + resolved "https://registry.yarnpkg.com/@eslint/core/-/core-0.17.0.tgz#77225820413d9617509da9342190a2019e78761c" + integrity sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ== + dependencies: + "@types/json-schema" "^7.0.15" + +"@eslint/eslintrc@^3.3.5": + version "3.3.5" + resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-3.3.5.tgz#c131793cfc1a7b96f24a83e0a8bbd4b881558c60" + integrity sha512-4IlJx0X0qftVsN5E+/vGujTRIFtwuLbNsVUe7TO6zYPDR1O6nFwvwhIKEKSrl6dZchmYBITazxKoUYOjdtjlRg== + dependencies: + ajv "^6.14.0" + debug "^4.3.2" + espree "^10.0.1" + globals "^14.0.0" + ignore "^5.2.0" + import-fresh "^3.2.1" + js-yaml "^4.1.1" + minimatch "^3.1.5" + strip-json-comments "^3.1.1" + +"@eslint/js@9.39.4": + version "9.39.4" + resolved "https://registry.yarnpkg.com/@eslint/js/-/js-9.39.4.tgz#a3f83bfc6fd9bf33a853dfacd0b49b398eb596c1" + integrity sha512-nE7DEIchvtiFTwBw4Lfbu59PG+kCofhjsKaCWzxTpt4lfRjRMqG6uMBzKXuEcyXhOHoUp9riAm7/aWYGhXZ9cw== + +"@eslint/object-schema@^2.1.7": + version "2.1.7" + resolved "https://registry.yarnpkg.com/@eslint/object-schema/-/object-schema-2.1.7.tgz#6e2126a1347e86a4dedf8706ec67ff8e107ebbad" + integrity sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA== + +"@eslint/plugin-kit@^0.4.1": + version "0.4.1" + resolved "https://registry.yarnpkg.com/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz#9779e3fd9b7ee33571a57435cf4335a1794a6cb2" + integrity sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA== + dependencies: + "@eslint/core" "^0.17.0" + levn "^0.4.1" + +"@hono/node-server@^1.19.10", "@hono/node-server@^1.19.9": + version "1.19.11" + resolved "https://registry.yarnpkg.com/@hono/node-server/-/node-server-1.19.11.tgz#dc419f0826dd2504e9fc86ad289d5636a0444e2f" + integrity sha512-dr8/3zEaB+p0D2n/IUrlPF1HZm586qgJNXK1a9fhg/PzdtkK7Ksd5l312tJX2yBuALqDYBlG20QEbayqPyxn+g== + +"@humanfs/core@^0.19.1": + version "0.19.1" + resolved "https://registry.yarnpkg.com/@humanfs/core/-/core-0.19.1.tgz#17c55ca7d426733fe3c561906b8173c336b40a77" + integrity sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA== + +"@humanfs/node@^0.16.6": + version "0.16.7" + resolved "https://registry.yarnpkg.com/@humanfs/node/-/node-0.16.7.tgz#822cb7b3a12c5a240a24f621b5a2413e27a45f26" + integrity sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ== + dependencies: + "@humanfs/core" "^0.19.1" + "@humanwhocodes/retry" "^0.4.0" + +"@humanwhocodes/module-importer@^1.0.1": + version "1.0.1" + resolved "https://registry.yarnpkg.com/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz#af5b2691a22b44be847b0ca81641c5fb6ad0172c" + integrity sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA== + +"@humanwhocodes/retry@^0.4.0", "@humanwhocodes/retry@^0.4.2": + version "0.4.3" + resolved "https://registry.yarnpkg.com/@humanwhocodes/retry/-/retry-0.4.3.tgz#c2b9d2e374ee62c586d3adbea87199b1d7a7a6ba" + integrity sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ== + +"@inquirer/checkbox@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/checkbox/-/checkbox-3.0.1.tgz#0a57f704265f78c36e17f07e421b98efb4b9867b" + integrity sha512-0hm2nrToWUdD6/UHnel/UKGdk1//ke5zGUpHIvk5ZWmaKezlGxZkOJXNSWsdxO/rEqTkbB3lNC2J6nBElV2aAQ== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/figures" "^1.0.6" + "@inquirer/type" "^2.0.0" + ansi-escapes "^4.3.2" + yoctocolors-cjs "^2.1.2" + +"@inquirer/confirm@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-4.0.1.tgz#9106d6bffa0b2fdd0e4f60319b6f04f2e06e6e25" + integrity sha512-46yL28o2NJ9doViqOy0VDcoTzng7rAb6yPQKU7VDLqkmbCaH4JqK4yk4XqlzNWy9PVC5pG1ZUXPBQv+VqnYs2w== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + +"@inquirer/core@^9.2.1": + version "9.2.1" + resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-9.2.1.tgz#677c49dee399c9063f31e0c93f0f37bddc67add1" + integrity sha512-F2VBt7W/mwqEU4bL0RnHNZmC/OxzNx9cOYxHqnXX3MP6ruYvZUZAW9imgN9+h/uBT/oP8Gh888J2OZSbjSeWcg== + dependencies: + "@inquirer/figures" "^1.0.6" + "@inquirer/type" "^2.0.0" + "@types/mute-stream" "^0.0.4" + "@types/node" "^22.5.5" + "@types/wrap-ansi" "^3.0.0" + ansi-escapes "^4.3.2" + cli-width "^4.1.0" + mute-stream "^1.0.0" + signal-exit "^4.1.0" + strip-ansi "^6.0.1" + wrap-ansi "^6.2.0" + yoctocolors-cjs "^2.1.2" + +"@inquirer/editor@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/editor/-/editor-3.0.1.tgz#d109f21e050af6b960725388cb1c04214ed7c7bc" + integrity sha512-VA96GPFaSOVudjKFraokEEmUQg/Lub6OXvbIEZU1SDCmBzRkHGhxoFAVaF30nyiB4m5cEbDgiI2QRacXZ2hw9Q== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + external-editor "^3.1.0" + +"@inquirer/expand@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/expand/-/expand-3.0.1.tgz#aed9183cac4d12811be47a4a895ea8e82a17e22c" + integrity sha512-ToG8d6RIbnVpbdPdiN7BCxZGiHOTomOX94C2FaT5KOHupV40tKEDozp12res6cMIfRKrXLJyexAZhWVHgbALSQ== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + yoctocolors-cjs "^2.1.2" + +"@inquirer/figures@^1.0.6": + version "1.0.15" + resolved "https://registry.yarnpkg.com/@inquirer/figures/-/figures-1.0.15.tgz#dbb49ed80df11df74268023b496ac5d9acd22b3a" + integrity sha512-t2IEY+unGHOzAaVM5Xx6DEWKeXlDDcNPeDyUpsRc6CUhBfU3VQOEl+Vssh7VNp1dR8MdUJBWhuObjXCsVpjN5g== + +"@inquirer/input@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/input/-/input-3.0.1.tgz#de63d49e516487388508d42049deb70f2cb5f28e" + integrity sha512-BDuPBmpvi8eMCxqC5iacloWqv+5tQSJlUafYWUe31ow1BVXjW2a5qe3dh4X/Z25Wp22RwvcaLCc2siHobEOfzg== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + +"@inquirer/number@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/number/-/number-2.0.1.tgz#b9863080d02ab7dc2e56e16433d83abea0f2a980" + integrity sha512-QpR8jPhRjSmlr/mD2cw3IR8HRO7lSVOnqUvQa8scv1Lsr3xoAMMworcYW3J13z3ppjBFBD2ef1Ci6AE5Qn8goQ== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + +"@inquirer/password@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/password/-/password-3.0.1.tgz#2a9a9143591088336bbd573bcb05d5bf080dbf87" + integrity sha512-haoeEPUisD1NeE2IanLOiFr4wcTXGWrBOyAyPZi1FfLJuXOzNmxCJPgUrGYKVh+Y8hfGJenIfz5Wb/DkE9KkMQ== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + ansi-escapes "^4.3.2" + +"@inquirer/prompts@^6.0.1": + version "6.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/prompts/-/prompts-6.0.1.tgz#43f5c0ed35c5ebfe52f1d43d46da2d363d950071" + integrity sha512-yl43JD/86CIj3Mz5mvvLJqAOfIup7ncxfJ0Btnl0/v5TouVUyeEdcpknfgc+yMevS/48oH9WAkkw93m7otLb/A== + dependencies: + "@inquirer/checkbox" "^3.0.1" + "@inquirer/confirm" "^4.0.1" + "@inquirer/editor" "^3.0.1" + "@inquirer/expand" "^3.0.1" + "@inquirer/input" "^3.0.1" + "@inquirer/number" "^2.0.1" + "@inquirer/password" "^3.0.1" + "@inquirer/rawlist" "^3.0.1" + "@inquirer/search" "^2.0.1" + "@inquirer/select" "^3.0.1" + +"@inquirer/rawlist@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/rawlist/-/rawlist-3.0.1.tgz#729def358419cc929045f264131878ed379e0af3" + integrity sha512-VgRtFIwZInUzTiPLSfDXK5jLrnpkuSOh1ctfaoygKAdPqjcjKYmGh6sCY1pb0aGnCGsmhUxoqLDUAU0ud+lGXQ== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/type" "^2.0.0" + yoctocolors-cjs "^2.1.2" + +"@inquirer/search@^2.0.1": + version "2.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/search/-/search-2.0.1.tgz#69b774a0a826de2e27b48981d01bc5ad81e73721" + integrity sha512-r5hBKZk3g5MkIzLVoSgE4evypGqtOannnB3PKTG9NRZxyFRKcfzrdxXXPcoJQsxJPzvdSU2Rn7pB7lw0GCmGAg== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/figures" "^1.0.6" + "@inquirer/type" "^2.0.0" + yoctocolors-cjs "^2.1.2" + +"@inquirer/select@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@inquirer/select/-/select-3.0.1.tgz#1df9ed27fb85a5f526d559ac5ce7cc4e9dc4e7ec" + integrity sha512-lUDGUxPhdWMkN/fHy1Lk7pF3nK1fh/gqeyWXmctefhxLYxlDsc7vsPBEpxrfVGDsVdyYJsiJoD4bJ1b623cV1Q== + dependencies: + "@inquirer/core" "^9.2.1" + "@inquirer/figures" "^1.0.6" + "@inquirer/type" "^2.0.0" + ansi-escapes "^4.3.2" + yoctocolors-cjs "^2.1.2" + +"@inquirer/type@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@inquirer/type/-/type-2.0.0.tgz#08fa513dca2cb6264fe1b0a2fabade051444e3f6" + integrity sha512-XvJRx+2KR3YXyYtPUUy+qd9i7p+GO9Ko6VIIpWlBrpWwXDv8WLFeHTxz35CfQFUiBMLXlGHhGzys7lqit9gWag== + dependencies: + mute-stream "^1.0.0" + +"@istanbuljs/load-nyc-config@^1.0.0": + version "1.1.0" + resolved "https://registry.yarnpkg.com/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz#fd3db1d59ecf7cf121e80650bb86712f9b55eced" + integrity sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ== + dependencies: + camelcase "^5.3.1" + find-up "^4.1.0" + get-package-type "^0.1.0" + js-yaml "^3.13.1" + resolve-from "^5.0.0" + +"@istanbuljs/schema@^0.1.2", "@istanbuljs/schema@^0.1.3": + version "0.1.3" + resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.3.tgz#e45e384e4b8ec16bce2fd903af78450f6bf7ec98" + integrity sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== + +"@jest/console@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/console/-/console-29.7.0.tgz#cd4822dbdb84529265c5a2bdb529a3c9cc950ffc" + integrity sha512-5Ni4CU7XHQi32IJ398EEP4RrB8eV09sXP2ROqD4bksHrnTree52PsxvX8tpL8LvTZ3pFzXyPbNQReSN41CAhOg== + dependencies: + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + jest-message-util "^29.7.0" + jest-util "^29.7.0" + slash "^3.0.0" + +"@jest/core@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/core/-/core-29.7.0.tgz#b6cccc239f30ff36609658c5a5e2291757ce448f" + integrity sha512-n7aeXWKMnGtDA48y8TLWJPJmLmmZ642Ceo78cYWEpiD7FzDgmNDV/GCVRorPABdXLJZ/9wzzgZAlHjXjxDHGsg== + dependencies: + "@jest/console" "^29.7.0" + "@jest/reporters" "^29.7.0" + "@jest/test-result" "^29.7.0" + "@jest/transform" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + ansi-escapes "^4.2.1" + chalk "^4.0.0" + ci-info "^3.2.0" + exit "^0.1.2" + graceful-fs "^4.2.9" + jest-changed-files "^29.7.0" + jest-config "^29.7.0" + jest-haste-map "^29.7.0" + jest-message-util "^29.7.0" + jest-regex-util "^29.6.3" + jest-resolve "^29.7.0" + jest-resolve-dependencies "^29.7.0" + jest-runner "^29.7.0" + jest-runtime "^29.7.0" + jest-snapshot "^29.7.0" + jest-util "^29.7.0" + jest-validate "^29.7.0" + jest-watcher "^29.7.0" + micromatch "^4.0.4" + pretty-format "^29.7.0" + slash "^3.0.0" + strip-ansi "^6.0.0" + +"@jest/environment@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-29.7.0.tgz#24d61f54ff1f786f3cd4073b4b94416383baf2a7" + integrity sha512-aQIfHDq33ExsN4jP1NWGXhxgQ/wixs60gDiKO+XVMd8Mn0NWPWgc34ZQDTb2jKaUWQ7MuwoitXAsN2XVXNMpAw== + dependencies: + "@jest/fake-timers" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + jest-mock "^29.7.0" + +"@jest/expect-utils@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/expect-utils/-/expect-utils-29.7.0.tgz#023efe5d26a8a70f21677d0a1afc0f0a44e3a1c6" + integrity sha512-GlsNBWiFQFCVi9QVSx7f5AgMeLxe9YCCs5PuP2O2LdjDAA8Jh9eX7lA1Jq/xdXw3Wb3hyvlFNfZIfcRetSzYcA== + dependencies: + jest-get-type "^29.6.3" + +"@jest/expect@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/expect/-/expect-29.7.0.tgz#76a3edb0cb753b70dfbfe23283510d3d45432bf2" + integrity sha512-8uMeAMycttpva3P1lBHB8VciS9V0XAr3GymPpipdyQXbBcuhkLQOSe8E/p92RyAdToS6ZD1tFkX+CkhoECE0dQ== + dependencies: + expect "^29.7.0" + jest-snapshot "^29.7.0" + +"@jest/fake-timers@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-29.7.0.tgz#fd91bf1fffb16d7d0d24a426ab1a47a49881a565" + integrity sha512-q4DH1Ha4TTFPdxLsqDXK1d3+ioSL7yL5oCMJZgDYm6i+6CygW5E5xVr/D1HdsGxjt1ZWSfUAs9OxSB/BNelWrQ== + dependencies: + "@jest/types" "^29.6.3" + "@sinonjs/fake-timers" "^10.0.2" + "@types/node" "*" + jest-message-util "^29.7.0" + jest-mock "^29.7.0" + jest-util "^29.7.0" + +"@jest/globals@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-29.7.0.tgz#8d9290f9ec47ff772607fa864ca1d5a2efae1d4d" + integrity sha512-mpiz3dutLbkW2MNFubUGUEVLkTGiqW6yLVTA+JbP6fI6J5iL9Y0Nlg8k95pcF8ctKwCS7WVxteBs29hhfAotzQ== + dependencies: + "@jest/environment" "^29.7.0" + "@jest/expect" "^29.7.0" + "@jest/types" "^29.6.3" + jest-mock "^29.7.0" + +"@jest/reporters@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-29.7.0.tgz#04b262ecb3b8faa83b0b3d321623972393e8f4c7" + integrity sha512-DApq0KJbJOEzAFYjHADNNxAE3KbhxQB1y5Kplb5Waqw6zVbuWatSnMjE5gs8FUgEPmNsnZA3NCWl9NG0ia04Pg== + dependencies: + "@bcoe/v8-coverage" "^0.2.3" + "@jest/console" "^29.7.0" + "@jest/test-result" "^29.7.0" + "@jest/transform" "^29.7.0" + "@jest/types" "^29.6.3" + "@jridgewell/trace-mapping" "^0.3.18" + "@types/node" "*" + chalk "^4.0.0" + collect-v8-coverage "^1.0.0" + exit "^0.1.2" + glob "^7.1.3" + graceful-fs "^4.2.9" + istanbul-lib-coverage "^3.0.0" + istanbul-lib-instrument "^6.0.0" + istanbul-lib-report "^3.0.0" + istanbul-lib-source-maps "^4.0.0" + istanbul-reports "^3.1.3" + jest-message-util "^29.7.0" + jest-util "^29.7.0" + jest-worker "^29.7.0" + slash "^3.0.0" + string-length "^4.0.1" + strip-ansi "^6.0.0" + v8-to-istanbul "^9.0.1" + +"@jest/schemas@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.6.3.tgz#430b5ce8a4e0044a7e3819663305a7b3091c8e03" + integrity sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA== + dependencies: + "@sinclair/typebox" "^0.27.8" + +"@jest/source-map@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-29.6.3.tgz#d90ba772095cf37a34a5eb9413f1b562a08554c4" + integrity sha512-MHjT95QuipcPrpLM+8JMSzFx6eHp5Bm+4XeFDJlwsvVBjmKNiIAvasGK2fxz2WbGRlnvqehFbh07MMa7n3YJnw== + dependencies: + "@jridgewell/trace-mapping" "^0.3.18" + callsites "^3.0.0" + graceful-fs "^4.2.9" + +"@jest/test-result@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-29.7.0.tgz#8db9a80aa1a097bb2262572686734baed9b1657c" + integrity sha512-Fdx+tv6x1zlkJPcWXmMDAG2HBnaR9XPSd5aDWQVsfrZmLVT3lU1cwyxLgRmXR9yrq4NBoEm9BMsfgFzTQAbJYA== + dependencies: + "@jest/console" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/istanbul-lib-coverage" "^2.0.0" + collect-v8-coverage "^1.0.0" + +"@jest/test-sequencer@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-29.7.0.tgz#6cef977ce1d39834a3aea887a1726628a6f072ce" + integrity sha512-GQwJ5WZVrKnOJuiYiAF52UNUJXgTZx1NHjFSEB0qEMmSZKAkdMoIzw/Cj6x6NF4AvV23AUqDpFzQkN/eYCYTxw== + dependencies: + "@jest/test-result" "^29.7.0" + graceful-fs "^4.2.9" + jest-haste-map "^29.7.0" + slash "^3.0.0" + +"@jest/transform@^29.7.0": + version "29.7.0" + resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-29.7.0.tgz#df2dd9c346c7d7768b8a06639994640c642e284c" + integrity sha512-ok/BTPFzFKVMwO5eOHRrvnBVHdRy9IrsrW1GpMaQ9MCnilNLXQKmAX8s1YXDFaai9xJpac2ySzV0YeRRECr2Vw== + dependencies: + "@babel/core" "^7.11.6" + "@jest/types" "^29.6.3" + "@jridgewell/trace-mapping" "^0.3.18" + babel-plugin-istanbul "^6.1.1" + chalk "^4.0.0" + convert-source-map "^2.0.0" + fast-json-stable-stringify "^2.1.0" + graceful-fs "^4.2.9" + jest-haste-map "^29.7.0" + jest-regex-util "^29.6.3" + jest-util "^29.7.0" + micromatch "^4.0.4" + pirates "^4.0.4" + slash "^3.0.0" + write-file-atomic "^4.0.2" + +"@jest/types@^29.6.3": + version "29.6.3" + resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.6.3.tgz#1131f8cf634e7e84c5e77bab12f052af585fba59" + integrity sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw== + dependencies: + "@jest/schemas" "^29.6.3" + "@types/istanbul-lib-coverage" "^2.0.0" + "@types/istanbul-reports" "^3.0.0" + "@types/node" "*" + "@types/yargs" "^17.0.8" + chalk "^4.0.0" + +"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": + version "0.3.13" + resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" + integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== + dependencies: + "@jridgewell/sourcemap-codec" "^1.5.0" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/remapping@^2.3.5": + version "2.3.5" + resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" + integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== + dependencies: + "@jridgewell/gen-mapping" "^0.3.5" + "@jridgewell/trace-mapping" "^0.3.24" + +"@jridgewell/resolve-uri@^3.0.3", "@jridgewell/resolve-uri@^3.1.0": + version "3.1.2" + resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" + integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== + +"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": + version "1.5.5" + resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" + integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== + +"@jridgewell/trace-mapping@0.3.9": + version "0.3.9" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz#6534fd5933a53ba7cbf3a17615e273a0d1273ff9" + integrity sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ== + dependencies: + "@jridgewell/resolve-uri" "^3.0.3" + "@jridgewell/sourcemap-codec" "^1.4.10" + +"@jridgewell/trace-mapping@^0.3.12", "@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.28": + version "0.3.31" + resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" + integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== + dependencies: + "@jridgewell/resolve-uri" "^3.1.0" + "@jridgewell/sourcemap-codec" "^1.4.14" + +"@modelcontextprotocol/sdk@^1.27.1": + version "1.27.1" + resolved "https://registry.yarnpkg.com/@modelcontextprotocol/sdk/-/sdk-1.27.1.tgz#a602cf823bf8a68e13e7112f50aeb02b09fb83b9" + integrity sha512-sr6GbP+4edBwFndLbM60gf07z0FQ79gaExpnsjMGePXqFcSSb7t6iscpjk9DhFhwd+mTEQrzNafGP8/iGGFYaA== + dependencies: + "@hono/node-server" "^1.19.9" + ajv "^8.17.1" + ajv-formats "^3.0.1" + content-type "^1.0.5" + cors "^2.8.5" + cross-spawn "^7.0.5" + eventsource "^3.0.2" + eventsource-parser "^3.0.0" + express "^5.2.1" + express-rate-limit "^8.2.1" + hono "^4.11.4" + jose "^6.1.3" + json-schema-typed "^8.0.2" + pkce-challenge "^5.0.0" + raw-body "^3.0.0" + zod "^3.25 || ^4.0" + zod-to-json-schema "^3.25.1" + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@pinojs/redact@^0.4.0": + version "0.4.0" + resolved "https://registry.yarnpkg.com/@pinojs/redact/-/redact-0.4.0.tgz#c3de060dd12640dcc838516aa2a6803cc7b2e9d6" + integrity sha512-k2ENnmBugE/rzQfEcdWHcCY+/FM3VLzH9cYEsbdsoqrvzAKRhUZeRNhAZvB8OitQJ1TBed3yqWtdjzS6wJKBwg== + +"@pkgr/core@^0.2.9": + version "0.2.9" + resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.2.9.tgz#d229a7b7f9dac167a156992ef23c7f023653f53b" + integrity sha512-QNqXyfVS2wm9hweSYD2O7F0G06uurj9kZ96TRQE5Y9hU7+tgdZwIkbAKc5Ocy1HxEY2kuDQa6cQ1WRs/O5LFKA== + +"@sinclair/typebox@^0.27.8": + version "0.27.8" + resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" + integrity sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA== + +"@sinonjs/commons@^3.0.0": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-3.0.1.tgz#1029357e44ca901a615585f6d27738dbc89084cd" + integrity sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ== + dependencies: + type-detect "4.0.8" + +"@sinonjs/fake-timers@^10.0.2": + version "10.3.0" + resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-10.3.0.tgz#55fdff1ecab9f354019129daf4df0dd4d923ea66" + integrity sha512-V4BG07kuYSUkTCSBHG8G8TNhM+F19jXFWnQtzj+we8DrkpSBCee9Z3Ms8yiGer/dlmhe35/Xdgyo3/0rQKg7YA== + dependencies: + "@sinonjs/commons" "^3.0.0" + +"@ts-morph/common@~0.20.0": + version "0.20.0" + resolved "https://registry.yarnpkg.com/@ts-morph/common/-/common-0.20.0.tgz#3f161996b085ba4519731e4d24c35f6cba5b80af" + integrity sha512-7uKjByfbPpwuzkstL3L5MQyuXPSKdoNG93Fmi2JoDcTf3pEP731JdRFAduRVkOs8oqxPsXKA+ScrWkdQ8t/I+Q== + dependencies: + fast-glob "^3.2.12" + minimatch "^7.4.3" + mkdirp "^2.1.6" + path-browserify "^1.0.1" + +"@tsconfig/node10@^1.0.7": + version "1.0.12" + resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.12.tgz#be57ceac1e4692b41be9de6be8c32a106636dba4" + integrity sha512-UCYBaeFvM11aU2y3YPZ//O5Rhj+xKyzy7mvcIoAjASbigy8mHMryP5cK7dgjlz2hWxh1g5pLw084E0a/wlUSFQ== + +"@tsconfig/node12@^1.0.7": + version "1.0.11" + resolved "https://registry.yarnpkg.com/@tsconfig/node12/-/node12-1.0.11.tgz#ee3def1f27d9ed66dac6e46a295cffb0152e058d" + integrity sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag== + +"@tsconfig/node14@^1.0.0": + version "1.0.3" + resolved "https://registry.yarnpkg.com/@tsconfig/node14/-/node14-1.0.3.tgz#e4386316284f00b98435bf40f72f75a09dabf6c1" + integrity sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow== + +"@tsconfig/node16@^1.0.2": + version "1.0.4" + resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.4.tgz#0b92dcc0cc1c81f6f306a381f28e31b1a56536e9" + integrity sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA== + +"@types/babel__core@^7.1.14": + version "7.20.5" + resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.20.5.tgz#3df15f27ba85319caa07ba08d0721889bb39c017" + integrity sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA== + dependencies: + "@babel/parser" "^7.20.7" + "@babel/types" "^7.20.7" + "@types/babel__generator" "*" + "@types/babel__template" "*" + "@types/babel__traverse" "*" + +"@types/babel__generator@*": + version "7.27.0" + resolved "https://registry.yarnpkg.com/@types/babel__generator/-/babel__generator-7.27.0.tgz#b5819294c51179957afaec341442f9341e4108a9" + integrity sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg== + dependencies: + "@babel/types" "^7.0.0" + +"@types/babel__template@*": + version "7.4.4" + resolved "https://registry.yarnpkg.com/@types/babel__template/-/babel__template-7.4.4.tgz#5672513701c1b2199bc6dad636a9d7491586766f" + integrity sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A== + dependencies: + "@babel/parser" "^7.1.0" + "@babel/types" "^7.0.0" + +"@types/babel__traverse@*", "@types/babel__traverse@^7.0.6": + version "7.28.0" + resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.28.0.tgz#07d713d6cce0d265c9849db0cbe62d3f61f36f74" + integrity sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q== + dependencies: + "@babel/types" "^7.28.2" + +"@types/body-parser@*": + version "1.19.6" + resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" + integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== + dependencies: + "@types/connect" "*" + "@types/node" "*" + +"@types/connect@*": + version "3.4.38" + resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.38.tgz#5ba7f3bc4fbbdeaff8dded952e5ff2cc53f8d858" + integrity sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug== + dependencies: + "@types/node" "*" + +"@types/cookie-parser@^1.4.10": + version "1.4.10" + resolved "https://registry.yarnpkg.com/@types/cookie-parser/-/cookie-parser-1.4.10.tgz#a045272a383a30597a01955d4f9c790018f214e4" + integrity sha512-B4xqkqfZ8Wek+rCOeRxsjMS9OgvzebEzzLYw7NHYuvzb7IdxOkI0ZHGgeEBX4PUM7QGVvNSK60T3OvWj3YfBRg== + +"@types/cors@^2.8.19": + version "2.8.19" + resolved "https://registry.yarnpkg.com/@types/cors/-/cors-2.8.19.tgz#d93ea2673fd8c9f697367f5eeefc2bbfa94f0342" + integrity sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg== + dependencies: + "@types/node" "*" + +"@types/estree@^1.0.6": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" + integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== + +"@types/express-serve-static-core@^5.0.0": + version "5.1.1" + resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.1.1.tgz#1a77faffee9572d39124933259be2523837d7eaa" + integrity sha512-v4zIMr/cX7/d2BpAEX3KNKL/JrT1s43s96lLvvdTmza1oEvDudCqK9aF/djc/SWgy8Yh0h30TZx5VpzqFCxk5A== + dependencies: + "@types/node" "*" + "@types/qs" "*" + "@types/range-parser" "*" + "@types/send" "*" + +"@types/express@^5.0.3": + version "5.0.6" + resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.6.tgz#2d724b2c990dcb8c8444063f3580a903f6d500cc" + integrity sha512-sKYVuV7Sv9fbPIt/442koC7+IIwK5olP1KWeD88e/idgoJqDm3JV/YUiPwkoKK92ylff2MGxSz1CSjsXelx0YA== + dependencies: + "@types/body-parser" "*" + "@types/express-serve-static-core" "^5.0.0" + "@types/serve-static" "^2" + +"@types/graceful-fs@^4.1.3": + version "4.1.9" + resolved "https://registry.yarnpkg.com/@types/graceful-fs/-/graceful-fs-4.1.9.tgz#2a06bc0f68a20ab37b3e36aa238be6abdf49e8b4" + integrity sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ== + dependencies: + "@types/node" "*" + +"@types/http-errors@*": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" + integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== + +"@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0", "@types/istanbul-lib-coverage@^2.0.1": + version "2.0.6" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz#7739c232a1fee9b4d3ce8985f314c0c6d33549d7" + integrity sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w== + +"@types/istanbul-lib-report@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz#53047614ae72e19fc0401d872de3ae2b4ce350bf" + integrity sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA== + dependencies: + "@types/istanbul-lib-coverage" "*" + +"@types/istanbul-reports@^3.0.0": + version "3.0.4" + resolved "https://registry.yarnpkg.com/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz#0f03e3d2f670fbdac586e34b433783070cc16f54" + integrity sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ== + dependencies: + "@types/istanbul-lib-report" "*" + +"@types/jest@^29.4.0": + version "29.5.14" + resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.14.tgz#2b910912fa1d6856cadcd0c1f95af7df1d6049e5" + integrity sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ== + dependencies: + expect "^29.0.0" + pretty-format "^29.0.0" + +"@types/json-schema@^7.0.15": + version "7.0.15" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" + integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== + +"@types/mute-stream@^0.0.4": + version "0.0.4" + resolved "https://registry.yarnpkg.com/@types/mute-stream/-/mute-stream-0.0.4.tgz#77208e56a08767af6c5e1237be8888e2f255c478" + integrity sha512-CPM9nzrCPPJHQNA9keH9CVkVI+WR5kMa+7XEs5jcGQ0VoAGnLv242w8lIVgwAEfmE4oufJRaTc9PNLQl0ioAow== + dependencies: + "@types/node" "*" + +"@types/node@*": + version "25.0.8" + resolved "https://registry.yarnpkg.com/@types/node/-/node-25.0.8.tgz#e54e00f94fe1db2497b3e42d292b8376a2678c8d" + integrity sha512-powIePYMmC3ibL0UJ2i2s0WIbq6cg6UyVFQxSCpaPxxzAaziRfimGivjdF943sSGV6RADVbk0Nvlm5P/FB44Zg== + dependencies: + undici-types "~7.16.0" + +"@types/node@^22.5.5": + version "22.19.6" + resolved "https://registry.yarnpkg.com/@types/node/-/node-22.19.6.tgz#0e9d80ebcd2dfce03265768c17a1212d4eb07e82" + integrity sha512-qm+G8HuG6hOHQigsi7VGuLjUVu6TtBo/F05zvX04Mw2uCg9Dv0Qxy3Qw7j41SidlTcl5D/5yg0SEZqOB+EqZnQ== + dependencies: + undici-types "~6.21.0" + +"@types/qs@*", "@types/qs@^6.14.0": + version "6.14.0" + resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.14.0.tgz#d8b60cecf62f2db0fb68e5e006077b9178b85de5" + integrity sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ== + +"@types/range-parser@*": + version "1.2.7" + resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.7.tgz#50ae4353eaaddc04044279812f52c8c65857dbcb" + integrity sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ== + +"@types/send@*": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@types/send/-/send-1.2.1.tgz#6a784e45543c18c774c049bff6d3dbaf045c9c74" + integrity sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ== + dependencies: + "@types/node" "*" + +"@types/serve-static@^2": + version "2.2.0" + resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-2.2.0.tgz#d4a447503ead0d1671132d1ab6bd58b805d8de6a" + integrity sha512-8mam4H1NHLtu7nmtalF7eyBH14QyOASmcxHhSfEoRyr0nP/YdoesEtU+uSRvMe96TW/HPTtkoKqQLl53N7UXMQ== + dependencies: + "@types/http-errors" "*" + "@types/node" "*" + +"@types/stack-utils@^2.0.0": + version "2.0.3" + resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.3.tgz#6209321eb2c1712a7e7466422b8cb1fc0d9dd5d8" + integrity sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw== + +"@types/wrap-ansi@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@types/wrap-ansi/-/wrap-ansi-3.0.0.tgz#18b97a972f94f60a679fd5c796d96421b9abb9fd" + integrity sha512-ltIpx+kM7g/MLRZfkbL7EsCEjfzCcScLpkg37eXEtx5kmrAKBkTJwd1GIAjDSL8wTpM6Hzn5YO4pSb91BEwu1g== + +"@types/yargs-parser@*": + version "21.0.3" + resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.3.tgz#815e30b786d2e8f0dcd85fd5bcf5e1a04d008f15" + integrity sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ== + +"@types/yargs@^17.0.8": + version "17.0.35" + resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.35.tgz#07013e46aa4d7d7d50a49e15604c1c5340d4eb24" + integrity sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg== + dependencies: + "@types/yargs-parser" "*" + +"@typescript-eslint/eslint-plugin@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.31.1.tgz#62f1befe59647524994e89de4516d8dcba7a850a" + integrity sha512-oUlH4h1ABavI4F0Xnl8/fOtML/eu8nI2A1nYd+f+55XI0BLu+RIqKoCiZKNo6DtqZBEQm5aNKA20G3Z5w3R6GQ== + dependencies: + "@eslint-community/regexpp" "^4.10.0" + "@typescript-eslint/scope-manager" "8.31.1" + "@typescript-eslint/type-utils" "8.31.1" + "@typescript-eslint/utils" "8.31.1" + "@typescript-eslint/visitor-keys" "8.31.1" + graphemer "^1.4.0" + ignore "^5.3.1" + natural-compare "^1.4.0" + ts-api-utils "^2.0.1" + +"@typescript-eslint/parser@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.31.1.tgz#e9b0ccf30d37dde724ee4d15f4dbc195995cce1b" + integrity sha512-oU/OtYVydhXnumd0BobL9rkJg7wFJ9bFFPmSmB/bf/XWN85hlViji59ko6bSKBXyseT9V8l+CN1nwmlbiN0G7Q== + dependencies: + "@typescript-eslint/scope-manager" "8.31.1" + "@typescript-eslint/types" "8.31.1" + "@typescript-eslint/typescript-estree" "8.31.1" + "@typescript-eslint/visitor-keys" "8.31.1" + debug "^4.3.4" + +"@typescript-eslint/scope-manager@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.31.1.tgz#1eb52e76878f545e4add142e0d8e3e97e7aa443b" + integrity sha512-BMNLOElPxrtNQMIsFHE+3P0Yf1z0dJqV9zLdDxN/xLlWMlXK/ApEsVEKzpizg9oal8bAT5Sc7+ocal7AC1HCVw== + dependencies: + "@typescript-eslint/types" "8.31.1" + "@typescript-eslint/visitor-keys" "8.31.1" + +"@typescript-eslint/type-utils@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.31.1.tgz#be0f438fb24b03568e282a0aed85f776409f970c" + integrity sha512-fNaT/m9n0+dpSp8G/iOQ05GoHYXbxw81x+yvr7TArTuZuCA6VVKbqWYVZrV5dVagpDTtj/O8k5HBEE/p/HM5LA== + dependencies: + "@typescript-eslint/typescript-estree" "8.31.1" + "@typescript-eslint/utils" "8.31.1" + debug "^4.3.4" + ts-api-utils "^2.0.1" + +"@typescript-eslint/types@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.31.1.tgz#478ed6f7e8aee1be7b63a60212b6bffe1423b5d4" + integrity sha512-SfepaEFUDQYRoA70DD9GtytljBePSj17qPxFHA/h3eg6lPTqGJ5mWOtbXCk1YrVU1cTJRd14nhaXWFu0l2troQ== + +"@typescript-eslint/typescript-estree@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.31.1.tgz#37792fe7ef4d3021c7580067c8f1ae66daabacdf" + integrity sha512-kaA0ueLe2v7KunYOyWYtlf/QhhZb7+qh4Yw6Ni5kgukMIG+iP773tjgBiLWIXYumWCwEq3nLW+TUywEp8uEeag== + dependencies: + "@typescript-eslint/types" "8.31.1" + "@typescript-eslint/visitor-keys" "8.31.1" + debug "^4.3.4" + fast-glob "^3.3.2" + is-glob "^4.0.3" + minimatch "^9.0.4" + semver "^7.6.0" + ts-api-utils "^2.0.1" + +"@typescript-eslint/utils@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.31.1.tgz#5628ea0393598a0b2f143d0fc6d019f0dee9dd14" + integrity sha512-2DSI4SNfF5T4oRveQ4nUrSjUqjMND0nLq9rEkz0gfGr3tg0S5KB6DhwR+WZPCjzkZl3cH+4x2ce3EsL50FubjQ== + dependencies: + "@eslint-community/eslint-utils" "^4.4.0" + "@typescript-eslint/scope-manager" "8.31.1" + "@typescript-eslint/types" "8.31.1" + "@typescript-eslint/typescript-estree" "8.31.1" + +"@typescript-eslint/visitor-keys@8.31.1": + version "8.31.1" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.31.1.tgz#6742b0e3ba1e0c1e35bdaf78c03e759eb8dd8e75" + integrity sha512-I+/rgqOVBn6f0o7NDTmAPWWC6NuqhV174lfYvAm9fUaWeiefLdux9/YI3/nLugEn9L8fcSi0XmpKi/r5u0nmpw== + dependencies: + "@typescript-eslint/types" "8.31.1" + eslint-visitor-keys "^4.2.0" + +"@valtown/deno-http-worker@^0.0.21": + version "0.0.21" + resolved "https://registry.yarnpkg.com/@valtown/deno-http-worker/-/deno-http-worker-0.0.21.tgz#9ce3b5c1d0db211fe7ea8297881fe551838474ad" + integrity sha512-16kFuUykann75lNytnXXIQlmpzreZjzdyT27ebT3yNGCS3kKaS1iZYWHc3Si9An54Cphwr4qEcviChQkEeJBlA== + +accepts@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/accepts/-/accepts-2.0.0.tgz#bbcf4ba5075467f3f2131eab3cffc73c2f5d7895" + integrity sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng== + dependencies: + mime-types "^3.0.0" + negotiator "^1.0.0" + +acorn-jsx@^5.3.2: + version "5.3.2" + resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" + integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== + +acorn-walk@^8.1.1: + version "8.3.4" + resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7" + integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g== + dependencies: + acorn "^8.11.0" + +acorn@^8.11.0, acorn@^8.4.1: + version "8.15.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" + integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== + +acorn@^8.15.0: + version "8.16.0" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.16.0.tgz#4ce79c89be40afe7afe8f3adb902a1f1ce9ac08a" + integrity sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw== + +aggregate-error@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" + integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== + dependencies: + clean-stack "^2.0.0" + indent-string "^4.0.0" + +ajv-formats@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-3.0.1.tgz#3d5dc762bca17679c3c2ea7e90ad6b7532309578" + integrity sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ== + dependencies: + ajv "^8.0.0" + +ajv@^6.14.0: + version "6.14.0" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.14.0.tgz#fd067713e228210636ebb08c60bd3765d6dbe73a" + integrity sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ajv@^8.0.0, ajv@^8.17.1: + version "8.17.1" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" + integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +ajv@^8.18.0: + version "8.18.0" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.18.0.tgz#8864186b6738d003eb3a933172bb3833e10cefbc" + integrity sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A== + dependencies: + fast-deep-equal "^3.1.3" + fast-uri "^3.0.1" + json-schema-traverse "^1.0.0" + require-from-string "^2.0.2" + +ansi-escapes@^4.2.1, ansi-escapes@^4.3.2: + version "4.3.2" + resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" + integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== + dependencies: + type-fest "^0.21.3" + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +ansi-styles@^5.0.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-5.2.0.tgz#07449690ad45777d1924ac2abb2fc8895dba836b" + integrity sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA== + +anymatch@^3.0.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" + integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== + dependencies: + normalize-path "^3.0.0" + picomatch "^2.0.4" + +arg@^4.1.0: + version "4.1.3" + resolved "https://registry.yarnpkg.com/arg/-/arg-4.1.3.tgz#269fc7ad5b8e42cb63c896d5666017261c144089" + integrity sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA== + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +atomic-sleep@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/atomic-sleep/-/atomic-sleep-1.0.0.tgz#eb85b77a601fc932cfe432c5acd364a9e2c9075b" + integrity sha512-kNOjDqAh7px0XWNI+4QbzoiR/nTkHAWNud2uvnJquD1/x5a7EQZMJT0AczqK0Qn67oY/TTQ1LbUKajZpp3I9tQ== + +babel-jest@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-29.7.0.tgz#f4369919225b684c56085998ac63dbd05be020d5" + integrity sha512-BrvGY3xZSwEcCzKvKsCi2GgHqDqsYkOP4/by5xCgIwGXQxIEh+8ew3gmrE1y7XRR6LHZIj6yLYnUi/mm2KXKBg== + dependencies: + "@jest/transform" "^29.7.0" + "@types/babel__core" "^7.1.14" + babel-plugin-istanbul "^6.1.1" + babel-preset-jest "^29.6.3" + chalk "^4.0.0" + graceful-fs "^4.2.9" + slash "^3.0.0" + +babel-plugin-istanbul@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz#fa88ec59232fd9b4e36dbbc540a8ec9a9b47da73" + integrity sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA== + dependencies: + "@babel/helper-plugin-utils" "^7.0.0" + "@istanbuljs/load-nyc-config" "^1.0.0" + "@istanbuljs/schema" "^0.1.2" + istanbul-lib-instrument "^5.0.4" + test-exclude "^6.0.0" + +babel-plugin-jest-hoist@^29.6.3: + version "29.6.3" + resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.6.3.tgz#aadbe943464182a8922c3c927c3067ff40d24626" + integrity sha512-ESAc/RJvGTFEzRwOTT4+lNDk/GNHMkKbNzsvT0qKRfDyyYTskxB5rnU2njIDYVxXCBHHEI1c0YwHob3WaYujOg== + dependencies: + "@babel/template" "^7.3.3" + "@babel/types" "^7.3.3" + "@types/babel__core" "^7.1.14" + "@types/babel__traverse" "^7.0.6" + +babel-preset-current-node-syntax@^1.0.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz#20730d6cdc7dda5d89401cab10ac6a32067acde6" + integrity sha512-E/VlAEzRrsLEb2+dv8yp3bo4scof3l9nR4lrld+Iy5NyVqgVYUJnDAmunkhPMisRI32Qc4iRiz425d8vM++2fg== + dependencies: + "@babel/plugin-syntax-async-generators" "^7.8.4" + "@babel/plugin-syntax-bigint" "^7.8.3" + "@babel/plugin-syntax-class-properties" "^7.12.13" + "@babel/plugin-syntax-class-static-block" "^7.14.5" + "@babel/plugin-syntax-import-attributes" "^7.24.7" + "@babel/plugin-syntax-import-meta" "^7.10.4" + "@babel/plugin-syntax-json-strings" "^7.8.3" + "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" + "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.3" + "@babel/plugin-syntax-numeric-separator" "^7.10.4" + "@babel/plugin-syntax-object-rest-spread" "^7.8.3" + "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" + "@babel/plugin-syntax-optional-chaining" "^7.8.3" + "@babel/plugin-syntax-private-property-in-object" "^7.14.5" + "@babel/plugin-syntax-top-level-await" "^7.14.5" + +babel-preset-jest@^29.6.3: + version "29.6.3" + resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-29.6.3.tgz#fa05fa510e7d493896d7b0dd2033601c840f171c" + integrity sha512-0B3bhxR6snWXJZtR/RliHTDPRgn1sNHOR0yVtq/IiQFyuOVjFS+wuio/R4gSNkyYmKmJB4wGZv2NZanmKmTnNA== + dependencies: + babel-plugin-jest-hoist "^29.6.3" + babel-preset-current-node-syntax "^1.0.0" + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +baseline-browser-mapping@^2.9.0: + version "2.9.14" + resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.9.14.tgz#3b6af0bc032445bca04de58caa9a87cfe921cbb3" + integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg== + +body-parser@^2.2.1: + version "2.2.2" + resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-2.2.2.tgz#1a32cdb966beaf68de50a9dfbe5b58f83cb8890c" + integrity sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA== + dependencies: + bytes "^3.1.2" + content-type "^1.0.5" + debug "^4.4.3" + http-errors "^2.0.0" + iconv-lite "^0.7.0" + on-finished "^2.4.1" + qs "^6.14.1" + raw-body "^3.0.1" + type-is "^2.0.1" + +brace-expansion@^1.1.7: + version "1.1.12" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" + integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +brace-expansion@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" + integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== + dependencies: + balanced-match "^1.0.0" + +braces@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" + integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== + dependencies: + fill-range "^7.1.1" + +browserslist@^4.24.0: + version "4.28.1" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.28.1.tgz#7f534594628c53c63101079e27e40de490456a95" + integrity sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA== + dependencies: + baseline-browser-mapping "^2.9.0" + caniuse-lite "^1.0.30001759" + electron-to-chromium "^1.5.263" + node-releases "^2.0.27" + update-browserslist-db "^1.2.0" + +bs-logger@^0.2.6: + version "0.2.6" + resolved "https://registry.yarnpkg.com/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8" + integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog== + dependencies: + fast-json-stable-stringify "2.x" + +bser@2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/bser/-/bser-2.1.1.tgz#e6787da20ece9d07998533cfd9de6f5c38f4bc05" + integrity sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ== + dependencies: + node-int64 "^0.4.0" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +bytes@^3.1.2, bytes@~3.1.2: + version "3.1.2" + resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.2.tgz#8b0beeb98605adf1b128fa4386403c009e0221a5" + integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== + +call-bind-apply-helpers@^1.0.1, call-bind-apply-helpers@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz#4b5428c222be985d79c3d82657479dbe0b59b2d6" + integrity sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ== + dependencies: + es-errors "^1.3.0" + function-bind "^1.1.2" + +call-bound@^1.0.2: + version "1.0.4" + resolved "https://registry.yarnpkg.com/call-bound/-/call-bound-1.0.4.tgz#238de935d2a2a692928c538c7ccfa91067fd062a" + integrity sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg== + dependencies: + call-bind-apply-helpers "^1.0.2" + get-intrinsic "^1.3.0" + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +camelcase@^5.3.1: + version "5.3.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" + integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== + +camelcase@^6.2.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" + integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== + +caniuse-lite@^1.0.30001759: + version "1.0.30001764" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001764.tgz#03206c56469f236103b90f9ae10bcb8b9e1f6005" + integrity sha512-9JGuzl2M+vPL+pz70gtMF9sHdMFbY9FJaQBi186cHKH3pSzDvzoUJUPV6fqiKIMyXbud9ZLg4F3Yza1vJ1+93g== + +chalk@^4.0.0: + version "4.1.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +char-regex@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" + integrity sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw== + +chardet@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/chardet/-/chardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e" + integrity sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA== + +ci-info@^3.2.0: + version "3.9.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" + integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== + +cjs-module-lexer@^1.0.0: + version "1.4.3" + resolved "https://registry.yarnpkg.com/cjs-module-lexer/-/cjs-module-lexer-1.4.3.tgz#0f79731eb8cfe1ec72acd4066efac9d61991b00d" + integrity sha512-9z8TZaGM1pfswYeXrUpzPrkx8UnWYdhJclsiYMm6x/w5+nN+8Tf/LnAgfLGQCm59qAOxU8WwHEq2vNwF6i4j+Q== + +clean-stack@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== + +cli-width@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-4.1.0.tgz#42daac41d3c254ef38ad8ac037672130173691c5" + integrity sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ== + +cliui@^8.0.1: + version "8.0.1" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa" + integrity sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.1" + wrap-ansi "^7.0.0" + +co@^4.6.0: + version "4.6.0" + resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184" + integrity sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ== + +code-block-writer@^12.0.0: + version "12.0.0" + resolved "https://registry.yarnpkg.com/code-block-writer/-/code-block-writer-12.0.0.tgz#4dd58946eb4234105aff7f0035977b2afdc2a770" + integrity sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w== + +collect-v8-coverage@^1.0.0: + version "1.0.3" + resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.3.tgz#cc1f01eb8d02298cbc9a437c74c70ab4e5210b80" + integrity sha512-1L5aqIkwPfiodaMgQunkF1zRhNqifHBmtbbbxcr6yVxxBnliw4TDOW6NxpO8DJLgJ16OT+Y4ztZqP6p/FtXnAw== + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +colorette@^2.0.7: + version "2.0.20" + resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.20.tgz#9eb793e6833067f7235902fcd3b09917a000a95a" + integrity sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== + +commander@^13.1.0: + version "13.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-13.1.0.tgz#776167db68c78f38dcce1f9b8d7b8b9a488abf46" + integrity sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw== + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg== + +content-disposition@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-1.0.1.tgz#a8b7bbeb2904befdfb6787e5c0c086959f605f9b" + integrity sha512-oIXISMynqSqm241k6kcQ5UwttDILMK4BiurCfGEREw6+X9jkkpEe5T9FZaApyLGGOnFuyMWZpdolTXMtvEJ08Q== + +content-type@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" + integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== + +convert-source-map@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-2.0.0.tgz#4b560f649fc4e918dd0ab75cf4961e8bc882d82a" + integrity sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== + +cookie-parser@^1.4.6: + version "1.4.7" + resolved "https://registry.yarnpkg.com/cookie-parser/-/cookie-parser-1.4.7.tgz#e2125635dfd766888ffe90d60c286404fa0e7b26" + integrity sha512-nGUvgXnotP3BsjiLX2ypbQnWoGUPIIfHQNZkkC668ntrzGWEZVW70HDEB1qnNGMicPje6EttlIgzo51YSwNQGw== + dependencies: + cookie "0.7.2" + cookie-signature "1.0.6" + +cookie-signature@1.0.6: + version "1.0.6" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" + integrity sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== + +cookie-signature@^1.2.1: + version "1.2.2" + resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.2.2.tgz#57c7fc3cc293acab9fec54d73e15690ebe4a1793" + integrity sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg== + +cookie@0.7.2, cookie@^0.7.1: + version "0.7.2" + resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.2.tgz#556369c472a2ba910f2979891b526b3436237ed7" + integrity sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w== + +cors@^2.8.5: + version "2.8.5" + resolved "https://registry.yarnpkg.com/cors/-/cors-2.8.5.tgz#eac11da51592dd86b9f06f6e7ac293b3df875d29" + integrity sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g== + dependencies: + object-assign "^4" + vary "^1" + +create-jest@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/create-jest/-/create-jest-29.7.0.tgz#a355c5b3cb1e1af02ba177fe7afd7feee49a5320" + integrity sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q== + dependencies: + "@jest/types" "^29.6.3" + chalk "^4.0.0" + exit "^0.1.2" + graceful-fs "^4.2.9" + jest-config "^29.7.0" + jest-util "^29.7.0" + prompts "^2.0.1" + +create-require@^1.1.0: + version "1.1.1" + resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333" + integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ== + +cross-spawn@^7.0.3, cross-spawn@^7.0.5, cross-spawn@^7.0.6: + version "7.0.6" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" + integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +dateformat@^4.6.3: + version "4.6.3" + resolved "https://registry.yarnpkg.com/dateformat/-/dateformat-4.6.3.tgz#556fa6497e5217fedb78821424f8a1c22fa3f4b5" + integrity sha512-2P0p0pFGzHS5EMnhdxQi7aJN+iMheud0UhG4dlE1DLAlvL8JHjJJTX/CSm4JXwV0Ka5nGk3zC5mcb5bUQUxxMA== + +debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4, debug@^4.3.7, debug@^4.4.0, debug@^4.4.3: + version "4.4.3" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" + integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== + dependencies: + ms "^2.1.3" + +dedent@^1.0.0: + version "1.7.1" + resolved "https://registry.yarnpkg.com/dedent/-/dedent-1.7.1.tgz#364661eea3d73f3faba7089214420ec2f8f13e15" + integrity sha512-9JmrhGZpOlEgOLdQgSm0zxFaYoQon408V1v49aqTWuXENVlnCuY9JBZcXZiCsZQWDjTm5Qf/nIvAy77mXDAjEg== + +deep-is@^0.1.3: + version "0.1.4" + resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.4.tgz#a6f2dce612fadd2ef1f519b73551f17e85199831" + integrity sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ== + +deepmerge@^4.2.2: + version "4.3.1" + resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" + integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== + +depd@^2.0.0, depd@~2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" + integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== + +detect-newline@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/detect-newline/-/detect-newline-3.1.0.tgz#576f5dfc63ae1a192ff192d8ad3af6308991b651" + integrity sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA== + +diff-sequences@^29.6.3: + version "29.6.3" + resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-29.6.3.tgz#4deaf894d11407c51efc8418012f9e70b84ea921" + integrity sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q== + +diff@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d" + integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A== + +dunder-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a" + integrity sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A== + dependencies: + call-bind-apply-helpers "^1.0.1" + es-errors "^1.3.0" + gopd "^1.2.0" + +ee-first@1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" + integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== + +electron-to-chromium@^1.5.263: + version "1.5.267" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.267.tgz#5d84f2df8cdb6bfe7e873706bb21bd4bfb574dc7" + integrity sha512-0Drusm6MVRXSOJpGbaSVgcQsuB4hEkMpHXaVstcPmhu5LIedxs1xNK/nIxmQIU/RPC0+1/o0AVZfBTkTNJOdUw== + +emittery@^0.13.1: + version "0.13.1" + resolved "https://registry.yarnpkg.com/emittery/-/emittery-0.13.1.tgz#c04b8c3457490e0847ae51fced3af52d338e3dad" + integrity sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +encodeurl@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" + integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== + +end-of-stream@^1.1.0: + version "1.4.5" + resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.5.tgz#7344d711dea40e0b74abc2ed49778743ccedb08c" + integrity sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg== + dependencies: + once "^1.4.0" + +error-ex@^1.3.1: + version "1.3.4" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" + integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== + dependencies: + is-arrayish "^0.2.1" + +es-define-property@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/es-define-property/-/es-define-property-1.0.1.tgz#983eb2f9a6724e9303f61addf011c72e09e0b0fa" + integrity sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g== + +es-errors@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/es-errors/-/es-errors-1.3.0.tgz#05f75a25dab98e4fb1dcd5e1472c0546d5057c8f" + integrity sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw== + +es-object-atoms@^1.0.0, es-object-atoms@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.1.tgz#1c4f2c4837327597ce69d2ca190a7fdd172338c1" + integrity sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA== + dependencies: + es-errors "^1.3.0" + +escalade@^3.1.1, escalade@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5" + integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA== + +escape-html@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" + integrity sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== + +escape-string-regexp@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz#a30304e99daa32e23b2fd20f51babd07cffca344" + integrity sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w== + +escape-string-regexp@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" + integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== + +eslint-plugin-prettier@^5.4.1: + version "5.5.5" + resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-5.5.5.tgz#9eae11593faa108859c26f9a9c367d619a0769c0" + integrity sha512-hscXkbqUZ2sPithAuLm5MXL+Wph+U7wHngPBv9OMWwlP8iaflyxpjTYZkmdgB4/vPIhemRlBEoLrH7UC1n7aUw== + dependencies: + prettier-linter-helpers "^1.0.1" + synckit "^0.11.12" + +eslint-plugin-unused-imports@^4.1.4: + version "4.4.1" + resolved "https://registry.yarnpkg.com/eslint-plugin-unused-imports/-/eslint-plugin-unused-imports-4.4.1.tgz#a831f0a2937d7631eba30cb87091ab7d3a5da0e1" + integrity sha512-oZGYUz1X3sRMGUB+0cZyK2VcvRX5lm/vB56PgNNcU+7ficUCKm66oZWKUubXWnOuPjQ8PvmXtCViXBMONPe7tQ== + +eslint-scope@^8.4.0: + version "8.4.0" + resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-8.4.0.tgz#88e646a207fad61436ffa39eb505147200655c82" + integrity sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg== + dependencies: + esrecurse "^4.3.0" + estraverse "^5.2.0" + +eslint-visitor-keys@^3.4.3: + version "3.4.3" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz#0cd72fe8550e3c2eae156a96a4dddcd1c8ac5800" + integrity sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag== + +eslint-visitor-keys@^4.2.0, eslint-visitor-keys@^4.2.1: + version "4.2.1" + resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-4.2.1.tgz#4cfea60fe7dd0ad8e816e1ed026c1d5251b512c1" + integrity sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ== + +eslint@^9.39.1: + version "9.39.4" + resolved "https://registry.yarnpkg.com/eslint/-/eslint-9.39.4.tgz#855da1b2e2ad66dc5991195f35e262bcec8117b5" + integrity sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ== + dependencies: + "@eslint-community/eslint-utils" "^4.8.0" + "@eslint-community/regexpp" "^4.12.1" + "@eslint/config-array" "^0.21.2" + "@eslint/config-helpers" "^0.4.2" + "@eslint/core" "^0.17.0" + "@eslint/eslintrc" "^3.3.5" + "@eslint/js" "9.39.4" + "@eslint/plugin-kit" "^0.4.1" + "@humanfs/node" "^0.16.6" + "@humanwhocodes/module-importer" "^1.0.1" + "@humanwhocodes/retry" "^0.4.2" + "@types/estree" "^1.0.6" + ajv "^6.14.0" + chalk "^4.0.0" + cross-spawn "^7.0.6" + debug "^4.3.2" + escape-string-regexp "^4.0.0" + eslint-scope "^8.4.0" + eslint-visitor-keys "^4.2.1" + espree "^10.4.0" + esquery "^1.5.0" + esutils "^2.0.2" + fast-deep-equal "^3.1.3" + file-entry-cache "^8.0.0" + find-up "^5.0.0" + glob-parent "^6.0.2" + ignore "^5.2.0" + imurmurhash "^0.1.4" + is-glob "^4.0.0" + json-stable-stringify-without-jsonify "^1.0.1" + lodash.merge "^4.6.2" + minimatch "^3.1.5" + natural-compare "^1.4.0" + optionator "^0.9.3" + +espree@^10.0.1, espree@^10.4.0: + version "10.4.0" + resolved "https://registry.yarnpkg.com/espree/-/espree-10.4.0.tgz#d54f4949d4629005a1fa168d937c3ff1f7e2a837" + integrity sha512-j6PAQ2uUr79PZhBjP5C5fhl8e39FmRnOjsD5lGnWrFU8i2G776tBK7+nP8KuQUTTyAZUwfQqXAgrVH5MbH9CYQ== + dependencies: + acorn "^8.15.0" + acorn-jsx "^5.3.2" + eslint-visitor-keys "^4.2.1" + +esprima@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +esquery@^1.5.0: + version "1.7.0" + resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.7.0.tgz#08d048f261f0ddedb5bae95f46809463d9c9496d" + integrity sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g== + dependencies: + estraverse "^5.1.0" + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^5.1.0, estraverse@^5.2.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" + integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== + +esutils@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" + integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== + +etag@^1.8.1: + version "1.8.1" + resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887" + integrity sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg== + +eventsource-parser@^3.0.0, eventsource-parser@^3.0.1: + version "3.0.6" + resolved "https://registry.yarnpkg.com/eventsource-parser/-/eventsource-parser-3.0.6.tgz#292e165e34cacbc936c3c92719ef326d4aeb4e90" + integrity sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg== + +eventsource@^3.0.2: + version "3.0.7" + resolved "https://registry.yarnpkg.com/eventsource/-/eventsource-3.0.7.tgz#1157622e2f5377bb6aef2114372728ba0c156989" + integrity sha512-CRT1WTyuQoD771GW56XEZFQ/ZoSfWid1alKGDYMmkt2yl8UXrVR4pspqWNEcqKvVIzg6PAltWjxcSSPrboA4iA== + dependencies: + eventsource-parser "^3.0.1" + +execa@^5.0.0: + version "5.1.1" + resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== + dependencies: + cross-spawn "^7.0.3" + get-stream "^6.0.0" + human-signals "^2.1.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.1" + onetime "^5.1.2" + signal-exit "^3.0.3" + strip-final-newline "^2.0.0" + +exit@^0.1.2: + version "0.1.2" + resolved "https://registry.yarnpkg.com/exit/-/exit-0.1.2.tgz#0632638f8d877cc82107d30a0fff1a17cba1cd0c" + integrity sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ== + +expect@^29.0.0, expect@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/expect/-/expect-29.7.0.tgz#578874590dcb3214514084c08115d8aee61e11bc" + integrity sha512-2Zks0hf1VLFYI1kbh0I5jP3KHHyCHpkfyHBzsSXRFgl/Bg9mWYfMW8oD+PdMPlEwy5HNsR9JutYy6pMeOh61nw== + dependencies: + "@jest/expect-utils" "^29.7.0" + jest-get-type "^29.6.3" + jest-matcher-utils "^29.7.0" + jest-message-util "^29.7.0" + jest-util "^29.7.0" + +express-rate-limit@^8.2.1: + version "8.3.1" + resolved "https://registry.yarnpkg.com/express-rate-limit/-/express-rate-limit-8.3.1.tgz#0aaba098eadd40f6737f30a98e6b16fa1a29edfb" + integrity sha512-D1dKN+cmyPWuvB+G2SREQDzPY1agpBIcTa9sJxOPMCNeH3gwzhqJRDWCXW3gg0y//+LQ/8j52JbMROWyrKdMdw== + dependencies: + ip-address "10.1.0" + +express@^5.1.0, express@^5.2.1: + version "5.2.1" + resolved "https://registry.yarnpkg.com/express/-/express-5.2.1.tgz#8f21d15b6d327f92b4794ecf8cb08a72f956ac04" + integrity sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw== + dependencies: + accepts "^2.0.0" + body-parser "^2.2.1" + content-disposition "^1.0.0" + content-type "^1.0.5" + cookie "^0.7.1" + cookie-signature "^1.2.1" + debug "^4.4.0" + depd "^2.0.0" + encodeurl "^2.0.0" + escape-html "^1.0.3" + etag "^1.8.1" + finalhandler "^2.1.0" + fresh "^2.0.0" + http-errors "^2.0.0" + merge-descriptors "^2.0.0" + mime-types "^3.0.0" + on-finished "^2.4.1" + once "^1.4.0" + parseurl "^1.3.3" + proxy-addr "^2.0.7" + qs "^6.14.0" + range-parser "^1.2.1" + router "^2.2.0" + send "^1.1.0" + serve-static "^2.2.0" + statuses "^2.0.1" + type-is "^2.0.1" + vary "^1.1.2" + +external-editor@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-3.1.0.tgz#cb03f740befae03ea4d283caed2741a83f335495" + integrity sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew== + dependencies: + chardet "^0.7.0" + iconv-lite "^0.4.24" + tmp "^0.0.33" + +fast-copy@^4.0.0: + version "4.0.2" + resolved "https://registry.yarnpkg.com/fast-copy/-/fast-copy-4.0.2.tgz#57f14115e1edbec274f69090072a480aa29cbedd" + integrity sha512-ybA6PDXIXOXivLJK/z9e+Otk7ve13I4ckBvGO5I2RRmBU1gMHLVDJYEuJYhGwez7YNlYji2M2DvVU+a9mSFDlw== + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-diff@^1.1.2: + version "1.3.0" + resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.3.0.tgz#ece407fa550a64d638536cd727e129c61616e0f0" + integrity sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw== + +fast-glob@^3.2.12, fast-glob@^3.3.2: + version "3.3.3" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818" + integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.8" + +fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-levenshtein@^2.0.6: + version "2.0.6" + resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" + integrity sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw== + +fast-safe-stringify@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz#c406a83b6e70d9e35ce3b30a81141df30aeba884" + integrity sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA== + +fast-uri@^3.0.1: + version "3.1.0" + resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" + integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== + +fastq@^1.6.0: + version "1.20.1" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.20.1.tgz#ca750a10dc925bc8b18839fd203e3ef4b3ced675" + integrity sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw== + dependencies: + reusify "^1.0.4" + +fb-watchman@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/fb-watchman/-/fb-watchman-2.0.2.tgz#e9524ee6b5c77e9e5001af0f85f3adbb8623255c" + integrity sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA== + dependencies: + bser "2.1.1" + +fflate@^0.8.2: + version "0.8.2" + resolved "https://registry.yarnpkg.com/fflate/-/fflate-0.8.2.tgz#fc8631f5347812ad6028bbe4a2308b2792aa1dea" + integrity sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A== + +file-entry-cache@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-8.0.0.tgz#7787bddcf1131bffb92636c69457bbc0edd6d81f" + integrity sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ== + dependencies: + flat-cache "^4.0.0" + +fill-range@^7.1.1: + version "7.1.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" + integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== + dependencies: + to-regex-range "^5.0.1" + +finalhandler@^2.1.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-2.1.1.tgz#a2c517a6559852bcdb06d1f8bd7f51b68fad8099" + integrity sha512-S8KoZgRZN+a5rNwqTxlZZePjT/4cnm0ROV70LedRHZ0p8u9fRID0hJUZQpkKLzro8LfmC8sx23bY6tVNxv8pQA== + dependencies: + debug "^4.4.0" + encodeurl "^2.0.0" + escape-html "^1.0.3" + on-finished "^2.4.1" + parseurl "^1.3.3" + statuses "^2.0.1" + +find-up@^4.0.0, find-up@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +find-up@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-5.0.0.tgz#4c92819ecb7083561e4f4a240a86be5198f536fc" + integrity sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng== + dependencies: + locate-path "^6.0.0" + path-exists "^4.0.0" + +flat-cache@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/flat-cache/-/flat-cache-4.0.1.tgz#0ece39fcb14ee012f4b0410bd33dd9c1f011127c" + integrity sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw== + dependencies: + flatted "^3.2.9" + keyv "^4.5.4" + +flatted@^3.2.9: + version "3.3.3" + resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.3.3.tgz#67c8fad95454a7c7abebf74bb78ee74a44023358" + integrity sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg== + +flora-colossus@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/flora-colossus/-/flora-colossus-2.0.0.tgz#af1e85db0a8256ef05f3fb531c1235236c97220a" + integrity sha512-dz4HxH6pOvbUzZpZ/yXhafjbR2I8cenK5xL0KtBFb7U2ADsR+OwXifnxZjij/pZWF775uSCMzWVd+jDik2H2IA== + dependencies: + debug "^4.3.4" + fs-extra "^10.1.0" + +forwarded@0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.2.0.tgz#2269936428aad4c15c7ebe9779a84bf0b2a81811" + integrity sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow== + +fresh@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/fresh/-/fresh-2.0.0.tgz#8dd7df6a1b3a1b3a5cf186c05a5dd267622635a4" + integrity sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A== + +fs-extra@^10.1.0: + version "10.1.0" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.1.0.tgz#02873cfbc4084dde127eaa5f9905eef2325d1abf" + integrity sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== + +fsevents@^2.3.2: + version "2.3.3" + resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + +function-bind@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" + integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== + +fuse.js@^7.1.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-7.1.0.tgz#306228b4befeee11e05b027087c2744158527d09" + integrity sha512-trLf4SzuuUxfusZADLINj+dE8clK1frKdmqiJNb1Es75fmI5oY6X2mxLVUciLLjxqw/xr72Dhy+lER6dGd02FQ== + +galactus@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/galactus/-/galactus-1.0.0.tgz#c2615182afa0c6d0859b92e56ae36d052827db7e" + integrity sha512-R1fam6D4CyKQGNlvJne4dkNF+PvUUl7TAJInvTGa9fti9qAv95quQz29GXapA4d8Ec266mJJxFVh82M4GIIGDQ== + dependencies: + debug "^4.3.4" + flora-colossus "^2.0.0" + fs-extra "^10.1.0" + +gensync@^1.0.0-beta.2: + version "1.0.0-beta.2" + resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" + integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== + +get-caller-file@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + +get-intrinsic@^1.2.5, get-intrinsic@^1.3.0: + version "1.3.0" + resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.3.0.tgz#743f0e3b6964a93a5491ed1bffaae054d7f98d01" + integrity sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ== + dependencies: + call-bind-apply-helpers "^1.0.2" + es-define-property "^1.0.1" + es-errors "^1.3.0" + es-object-atoms "^1.1.1" + function-bind "^1.1.2" + get-proto "^1.0.1" + gopd "^1.2.0" + has-symbols "^1.1.0" + hasown "^2.0.2" + math-intrinsics "^1.1.0" + +get-package-type@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a" + integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q== + +get-proto@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/get-proto/-/get-proto-1.0.1.tgz#150b3f2743869ef3e851ec0c49d15b1d14d00ee1" + integrity sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g== + dependencies: + dunder-proto "^1.0.1" + es-object-atoms "^1.0.0" + +get-stdin@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-8.0.0.tgz#cbad6a73feb75f6eeb22ba9e01f89aa28aa97a53" + integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== + +get-stream@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob-parent@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" + integrity sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== + dependencies: + is-glob "^4.0.3" + +glob@^7.1.3, glob@^7.1.4: + version "7.2.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" + integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.1.1" + once "^1.3.0" + path-is-absolute "^1.0.0" + +globals@^14.0.0: + version "14.0.0" + resolved "https://registry.yarnpkg.com/globals/-/globals-14.0.0.tgz#898d7413c29babcf6bafe56fcadded858ada724e" + integrity sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ== + +gopd@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1" + integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg== + +graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.9: + version "4.2.11" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" + integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== + +graphemer@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/graphemer/-/graphemer-1.4.0.tgz#fb2f1d55e0e3a1849aeffc90c4fa0dd53a0e66c6" + integrity sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag== + +handlebars@^4.7.8: + version "4.7.8" + resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9" + integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ== + dependencies: + minimist "^1.2.5" + neo-async "^2.6.2" + source-map "^0.6.1" + wordwrap "^1.0.0" + optionalDependencies: + uglify-js "^3.1.4" + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +has-symbols@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.1.0.tgz#fc9c6a783a084951d0b971fe1018de813707a338" + integrity sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ== + +hasown@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.2.tgz#003eaf91be7adc372e84ec59dc37252cedb80003" + integrity sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ== + dependencies: + function-bind "^1.1.2" + +help-me@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/help-me/-/help-me-5.0.0.tgz#b1ebe63b967b74060027c2ac61f9be12d354a6f6" + integrity sha512-7xgomUX6ADmcYzFik0HzAxh/73YlKR9bmFzf51CZwR+b6YtzU2m0u49hQCqV6SvlqIqsaxovfwdvbnsw3b/zpg== + +hono@^4.11.4, hono@^4.12.4: + version "4.12.7" + resolved "https://registry.yarnpkg.com/hono/-/hono-4.12.7.tgz#ca000956e965c2b3d791e43540498e616d6c6442" + integrity sha512-jq9l1DM0zVIvsm3lv9Nw9nlJnMNPOcAtsbsgiUhWcFzPE99Gvo6yRTlszSLLYacMeQ6quHD6hMfId8crVHvexw== + +html-escaper@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" + integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== + +http-errors@^2.0.0, http-errors@^2.0.1, http-errors@~2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.1.tgz#36d2f65bc909c8790018dd36fb4d93da6caae06b" + integrity sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ== + dependencies: + depd "~2.0.0" + inherits "~2.0.4" + setprototypeof "~1.2.0" + statuses "~2.0.2" + toidentifier "~1.0.1" + +human-signals@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== + +iconv-lite@^0.4.24: + version "0.4.24" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" + integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== + dependencies: + safer-buffer ">= 2.1.2 < 3" + +iconv-lite@^0.7.0, iconv-lite@~0.7.0: + version "0.7.2" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.7.2.tgz#d0bdeac3f12b4835b7359c2ad89c422a4d1cc72e" + integrity sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw== + dependencies: + safer-buffer ">= 2.1.2 < 3.0.0" + +ignore@^5.2.0, ignore@^5.3.1: + version "5.3.2" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5" + integrity sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g== + +ignore@^7.0.5: + version "7.0.5" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-7.0.5.tgz#4cb5f6cd7d4c7ab0365738c7aea888baa6d7efd9" + integrity sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg== + +import-fresh@^3.2.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.1.tgz#9cecb56503c0ada1f2741dbbd6546e4b13b57ccf" + integrity sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +import-local@^3.0.2: + version "3.2.0" + resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.2.0.tgz#c3d5c745798c02a6f8b897726aba5100186ee260" + integrity sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA== + dependencies: + pkg-dir "^4.2.0" + resolve-cwd "^3.0.0" + +imurmurhash@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" + integrity sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA== + +indent-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@^2.0.3, inherits@~2.0.4: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +ip-address@10.1.0: + version "10.1.0" + resolved "https://registry.yarnpkg.com/ip-address/-/ip-address-10.1.0.tgz#d8dcffb34d0e02eb241427444a6e23f5b0595aa4" + integrity sha512-XXADHxXmvT9+CRxhXg56LJovE+bmWnEWB78LB83VZTprKTmaC5QfruXocxzTZ2Kl0DNwKuBdlIhjL8LeY8Sf8Q== + +ipaddr.js@1.9.1: + version "1.9.1" + resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" + integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== + +is-core-module@^2.16.1: + version "2.16.1" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.16.1.tgz#2a98801a849f43e2add644fbb6bc6229b19a4ef4" + integrity sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w== + dependencies: + hasown "^2.0.2" + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-generator-fn@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/is-generator-fn/-/is-generator-fn-2.1.0.tgz#7d140adc389aaf3011a8f2a2a4cfa6faadffb118" + integrity sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ== + +is-glob@^4.0.0, is-glob@^4.0.1, is-glob@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-promise@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/is-promise/-/is-promise-4.0.0.tgz#42ff9f84206c1991d26debf520dd5c01042dd2f3" + integrity sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ== + +is-stream@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== + +istanbul-lib-coverage@^3.0.0, istanbul-lib-coverage@^3.2.0: + version "3.2.2" + resolved "https://registry.yarnpkg.com/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz#2d166c4b0644d43a39f04bf6c2edd1e585f31756" + integrity sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg== + +istanbul-lib-instrument@^5.0.4: + version "5.2.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz#d10c8885c2125574e1c231cacadf955675e1ce3d" + integrity sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg== + dependencies: + "@babel/core" "^7.12.3" + "@babel/parser" "^7.14.7" + "@istanbuljs/schema" "^0.1.2" + istanbul-lib-coverage "^3.2.0" + semver "^6.3.0" + +istanbul-lib-instrument@^6.0.0: + version "6.0.3" + resolved "https://registry.yarnpkg.com/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz#fa15401df6c15874bcb2105f773325d78c666765" + integrity sha512-Vtgk7L/R2JHyyGW07spoFlB8/lpjiOLTjMdms6AFMraYt3BaJauod/NGrfnVG/y4Ix1JEuMRPDPEj2ua+zz1/Q== + dependencies: + "@babel/core" "^7.23.9" + "@babel/parser" "^7.23.9" + "@istanbuljs/schema" "^0.1.3" + istanbul-lib-coverage "^3.2.0" + semver "^7.5.4" + +istanbul-lib-report@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz#908305bac9a5bd175ac6a74489eafd0fc2445a7d" + integrity sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw== + dependencies: + istanbul-lib-coverage "^3.0.0" + make-dir "^4.0.0" + supports-color "^7.1.0" + +istanbul-lib-source-maps@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz#895f3a709fcfba34c6de5a42939022f3e4358551" + integrity sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw== + dependencies: + debug "^4.1.1" + istanbul-lib-coverage "^3.0.0" + source-map "^0.6.1" + +istanbul-reports@^3.1.3: + version "3.2.0" + resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.2.0.tgz#cb4535162b5784aa623cee21a7252cf2c807ac93" + integrity sha512-HGYWWS/ehqTV3xN10i23tkPkpH46MLCIMFNCaaKNavAXTF1RkqxawEPtnjnGZ6XKSInBKkiOA5BKS+aZiY3AvA== + dependencies: + html-escaper "^2.0.0" + istanbul-lib-report "^3.0.0" + +jest-changed-files@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-29.7.0.tgz#1c06d07e77c78e1585d020424dedc10d6e17ac3a" + integrity sha512-fEArFiwf1BpQ+4bXSprcDc3/x4HSzL4al2tozwVpDFpsxALjLYdyiIK4e5Vz66GQJIbXJ82+35PtysofptNX2w== + dependencies: + execa "^5.0.0" + jest-util "^29.7.0" + p-limit "^3.1.0" + +jest-circus@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-circus/-/jest-circus-29.7.0.tgz#b6817a45fcc835d8b16d5962d0c026473ee3668a" + integrity sha512-3E1nCMgipcTkCocFwM90XXQab9bS+GMsjdpmPrlelaxwD93Ad8iVEjX/vvHPdLPnFf+L40u+5+iutRdA1N9myw== + dependencies: + "@jest/environment" "^29.7.0" + "@jest/expect" "^29.7.0" + "@jest/test-result" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + co "^4.6.0" + dedent "^1.0.0" + is-generator-fn "^2.0.0" + jest-each "^29.7.0" + jest-matcher-utils "^29.7.0" + jest-message-util "^29.7.0" + jest-runtime "^29.7.0" + jest-snapshot "^29.7.0" + jest-util "^29.7.0" + p-limit "^3.1.0" + pretty-format "^29.7.0" + pure-rand "^6.0.0" + slash "^3.0.0" + stack-utils "^2.0.3" + +jest-cli@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-29.7.0.tgz#5592c940798e0cae677eec169264f2d839a37995" + integrity sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg== + dependencies: + "@jest/core" "^29.7.0" + "@jest/test-result" "^29.7.0" + "@jest/types" "^29.6.3" + chalk "^4.0.0" + create-jest "^29.7.0" + exit "^0.1.2" + import-local "^3.0.2" + jest-config "^29.7.0" + jest-util "^29.7.0" + jest-validate "^29.7.0" + yargs "^17.3.1" + +jest-config@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-29.7.0.tgz#bcbda8806dbcc01b1e316a46bb74085a84b0245f" + integrity sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ== + dependencies: + "@babel/core" "^7.11.6" + "@jest/test-sequencer" "^29.7.0" + "@jest/types" "^29.6.3" + babel-jest "^29.7.0" + chalk "^4.0.0" + ci-info "^3.2.0" + deepmerge "^4.2.2" + glob "^7.1.3" + graceful-fs "^4.2.9" + jest-circus "^29.7.0" + jest-environment-node "^29.7.0" + jest-get-type "^29.6.3" + jest-regex-util "^29.6.3" + jest-resolve "^29.7.0" + jest-runner "^29.7.0" + jest-util "^29.7.0" + jest-validate "^29.7.0" + micromatch "^4.0.4" + parse-json "^5.2.0" + pretty-format "^29.7.0" + slash "^3.0.0" + strip-json-comments "^3.1.1" + +jest-diff@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-29.7.0.tgz#017934a66ebb7ecf6f205e84699be10afd70458a" + integrity sha512-LMIgiIrhigmPrs03JHpxUh2yISK3vLFPkAodPeo0+BuF7wA2FoQbkEg1u8gBYBThncu7e1oEDUfIXVuTqLRUjw== + dependencies: + chalk "^4.0.0" + diff-sequences "^29.6.3" + jest-get-type "^29.6.3" + pretty-format "^29.7.0" + +jest-docblock@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-29.7.0.tgz#8fddb6adc3cdc955c93e2a87f61cfd350d5d119a" + integrity sha512-q617Auw3A612guyaFgsbFeYpNP5t2aoUNLwBUbc/0kD1R4t9ixDbyFTHd1nok4epoVFpr7PmeWHrhvuV3XaJ4g== + dependencies: + detect-newline "^3.0.0" + +jest-each@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-29.7.0.tgz#162a9b3f2328bdd991beaabffbb74745e56577d1" + integrity sha512-gns+Er14+ZrEoC5fhOfYCY1LOHHr0TI+rQUHZS8Ttw2l7gl+80eHc/gFf2Ktkw0+SIACDTeWvpFcv3B04VembQ== + dependencies: + "@jest/types" "^29.6.3" + chalk "^4.0.0" + jest-get-type "^29.6.3" + jest-util "^29.7.0" + pretty-format "^29.7.0" + +jest-environment-node@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-29.7.0.tgz#0b93e111dda8ec120bc8300e6d1fb9576e164376" + integrity sha512-DOSwCRqXirTOyheM+4d5YZOrWcdu0LNZ87ewUoywbcb2XR4wKgqiG8vNeYwhjFMbEkfju7wx2GYH0P2gevGvFw== + dependencies: + "@jest/environment" "^29.7.0" + "@jest/fake-timers" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + jest-mock "^29.7.0" + jest-util "^29.7.0" + +jest-get-type@^29.6.3: + version "29.6.3" + resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-29.6.3.tgz#36f499fdcea197c1045a127319c0481723908fd1" + integrity sha512-zrteXnqYxfQh7l5FHyL38jL39di8H8rHoecLH3JNxH3BwOrBsNeabdap5e0I23lD4HHI8W5VFBZqG4Eaq5LNcw== + +jest-haste-map@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-29.7.0.tgz#3c2396524482f5a0506376e6c858c3bbcc17b104" + integrity sha512-fP8u2pyfqx0K1rGn1R9pyE0/KTn+G7PxktWidOBTqFPLYX0b9ksaMFkhK5vrS3DVun09pckLdlx90QthlW7AmA== + dependencies: + "@jest/types" "^29.6.3" + "@types/graceful-fs" "^4.1.3" + "@types/node" "*" + anymatch "^3.0.3" + fb-watchman "^2.0.0" + graceful-fs "^4.2.9" + jest-regex-util "^29.6.3" + jest-util "^29.7.0" + jest-worker "^29.7.0" + micromatch "^4.0.4" + walker "^1.0.8" + optionalDependencies: + fsevents "^2.3.2" + +jest-leak-detector@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-29.7.0.tgz#5b7ec0dadfdfec0ca383dc9aa016d36b5ea4c728" + integrity sha512-kYA8IJcSYtST2BY9I+SMC32nDpBT3J2NvWJx8+JCuCdl/CR1I4EKUJROiP8XtCcxqgTTBGJNdbB1A8XRKbTetw== + dependencies: + jest-get-type "^29.6.3" + pretty-format "^29.7.0" + +jest-matcher-utils@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-29.7.0.tgz#ae8fec79ff249fd592ce80e3ee474e83a6c44f12" + integrity sha512-sBkD+Xi9DtcChsI3L3u0+N0opgPYnCRPtGcQYrgXmR+hmt/fYfWAL0xRXYU8eWOdfuLgBe0YCW3AFtnRLagq/g== + dependencies: + chalk "^4.0.0" + jest-diff "^29.7.0" + jest-get-type "^29.6.3" + pretty-format "^29.7.0" + +jest-message-util@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-29.7.0.tgz#8bc392e204e95dfe7564abbe72a404e28e51f7f3" + integrity sha512-GBEV4GRADeP+qtB2+6u61stea8mGcOT4mCtrYISZwfu9/ISHFJ/5zOMXYbpBE9RsS5+Gb63DW4FgmnKJ79Kf6w== + dependencies: + "@babel/code-frame" "^7.12.13" + "@jest/types" "^29.6.3" + "@types/stack-utils" "^2.0.0" + chalk "^4.0.0" + graceful-fs "^4.2.9" + micromatch "^4.0.4" + pretty-format "^29.7.0" + slash "^3.0.0" + stack-utils "^2.0.3" + +jest-mock@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-29.7.0.tgz#4e836cf60e99c6fcfabe9f99d017f3fdd50a6347" + integrity sha512-ITOMZn+UkYS4ZFh83xYAOzWStloNzJFO2s8DWrE4lhtGD+AorgnbkiKERe4wQVBydIGPx059g6riW5Btp6Llnw== + dependencies: + "@jest/types" "^29.6.3" + "@types/node" "*" + jest-util "^29.7.0" + +jest-pnp-resolver@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz#930b1546164d4ad5937d5540e711d4d38d4cad2e" + integrity sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w== + +jest-regex-util@^29.6.3: + version "29.6.3" + resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-29.6.3.tgz#4a556d9c776af68e1c5f48194f4d0327d24e8a52" + integrity sha512-KJJBsRCyyLNWCNBOvZyRDnAIfUiRJ8v+hOBQYGn8gDyF3UegwiP4gwRR3/SDa42g1YbVycTidUF3rKjyLFDWbg== + +jest-resolve-dependencies@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-29.7.0.tgz#1b04f2c095f37fc776ff40803dc92921b1e88428" + integrity sha512-un0zD/6qxJ+S0et7WxeI3H5XSe9lTBBR7bOHCHXkKR6luG5mwDDlIzVQ0V5cZCuoTgEdcdwzTghYkTWfubi+nA== + dependencies: + jest-regex-util "^29.6.3" + jest-snapshot "^29.7.0" + +jest-resolve@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-29.7.0.tgz#64d6a8992dd26f635ab0c01e5eef4399c6bcbc30" + integrity sha512-IOVhZSrg+UvVAshDSDtHyFCCBUl/Q3AAJv8iZ6ZjnZ74xzvwuzLXid9IIIPgTnY62SJjfuupMKZsZQRsCvxEgA== + dependencies: + chalk "^4.0.0" + graceful-fs "^4.2.9" + jest-haste-map "^29.7.0" + jest-pnp-resolver "^1.2.2" + jest-util "^29.7.0" + jest-validate "^29.7.0" + resolve "^1.20.0" + resolve.exports "^2.0.0" + slash "^3.0.0" + +jest-runner@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-29.7.0.tgz#809af072d408a53dcfd2e849a4c976d3132f718e" + integrity sha512-fsc4N6cPCAahybGBfTRcq5wFR6fpLznMg47sY5aDpsoejOcVYFb07AHuSnR0liMcPTgBsA3ZJL6kFOjPdoNipQ== + dependencies: + "@jest/console" "^29.7.0" + "@jest/environment" "^29.7.0" + "@jest/test-result" "^29.7.0" + "@jest/transform" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + emittery "^0.13.1" + graceful-fs "^4.2.9" + jest-docblock "^29.7.0" + jest-environment-node "^29.7.0" + jest-haste-map "^29.7.0" + jest-leak-detector "^29.7.0" + jest-message-util "^29.7.0" + jest-resolve "^29.7.0" + jest-runtime "^29.7.0" + jest-util "^29.7.0" + jest-watcher "^29.7.0" + jest-worker "^29.7.0" + p-limit "^3.1.0" + source-map-support "0.5.13" + +jest-runtime@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-29.7.0.tgz#efecb3141cf7d3767a3a0cc8f7c9990587d3d817" + integrity sha512-gUnLjgwdGqW7B4LvOIkbKs9WGbn+QLqRQQ9juC6HndeDiezIwhDP+mhMwHWCEcfQ5RUXa6OPnFF8BJh5xegwwQ== + dependencies: + "@jest/environment" "^29.7.0" + "@jest/fake-timers" "^29.7.0" + "@jest/globals" "^29.7.0" + "@jest/source-map" "^29.6.3" + "@jest/test-result" "^29.7.0" + "@jest/transform" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + cjs-module-lexer "^1.0.0" + collect-v8-coverage "^1.0.0" + glob "^7.1.3" + graceful-fs "^4.2.9" + jest-haste-map "^29.7.0" + jest-message-util "^29.7.0" + jest-mock "^29.7.0" + jest-regex-util "^29.6.3" + jest-resolve "^29.7.0" + jest-snapshot "^29.7.0" + jest-util "^29.7.0" + slash "^3.0.0" + strip-bom "^4.0.0" + +jest-snapshot@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-29.7.0.tgz#c2c574c3f51865da1bb329036778a69bf88a6be5" + integrity sha512-Rm0BMWtxBcioHr1/OX5YCP8Uov4riHvKPknOGs804Zg9JGZgmIBkbtlxJC/7Z4msKYVbIJtfU+tKb8xlYNfdkw== + dependencies: + "@babel/core" "^7.11.6" + "@babel/generator" "^7.7.2" + "@babel/plugin-syntax-jsx" "^7.7.2" + "@babel/plugin-syntax-typescript" "^7.7.2" + "@babel/types" "^7.3.3" + "@jest/expect-utils" "^29.7.0" + "@jest/transform" "^29.7.0" + "@jest/types" "^29.6.3" + babel-preset-current-node-syntax "^1.0.0" + chalk "^4.0.0" + expect "^29.7.0" + graceful-fs "^4.2.9" + jest-diff "^29.7.0" + jest-get-type "^29.6.3" + jest-matcher-utils "^29.7.0" + jest-message-util "^29.7.0" + jest-util "^29.7.0" + natural-compare "^1.4.0" + pretty-format "^29.7.0" + semver "^7.5.3" + +jest-util@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.7.0.tgz#23c2b62bfb22be82b44de98055802ff3710fc0bc" + integrity sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA== + dependencies: + "@jest/types" "^29.6.3" + "@types/node" "*" + chalk "^4.0.0" + ci-info "^3.2.0" + graceful-fs "^4.2.9" + picomatch "^2.2.3" + +jest-validate@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-29.7.0.tgz#7bf705511c64da591d46b15fce41400d52147d9c" + integrity sha512-ZB7wHqaRGVw/9hST/OuFUReG7M8vKeq0/J2egIGLdvjHCmYqGARhzXmtgi+gVeZ5uXFF219aOc3Ls2yLg27tkw== + dependencies: + "@jest/types" "^29.6.3" + camelcase "^6.2.0" + chalk "^4.0.0" + jest-get-type "^29.6.3" + leven "^3.1.0" + pretty-format "^29.7.0" + +jest-watcher@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-29.7.0.tgz#7810d30d619c3a62093223ce6bb359ca1b28a2f2" + integrity sha512-49Fg7WXkU3Vl2h6LbLtMQ/HyB6rXSIX7SqvBLQmssRBGN9I0PNvPmAmCWSOY6SOvrjhI/F7/bGAv9RtnsPA03g== + dependencies: + "@jest/test-result" "^29.7.0" + "@jest/types" "^29.6.3" + "@types/node" "*" + ansi-escapes "^4.2.1" + chalk "^4.0.0" + emittery "^0.13.1" + jest-util "^29.7.0" + string-length "^4.0.1" + +jest-worker@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.7.0.tgz#acad073acbbaeb7262bd5389e1bcf43e10058d4a" + integrity sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw== + dependencies: + "@types/node" "*" + jest-util "^29.7.0" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jest@^29.4.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/jest/-/jest-29.7.0.tgz#994676fc24177f088f1c5e3737f5697204ff2613" + integrity sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw== + dependencies: + "@jest/core" "^29.7.0" + "@jest/types" "^29.6.3" + import-local "^3.0.2" + jest-cli "^29.7.0" + +jose@^6.1.3: + version "6.2.1" + resolved "https://registry.yarnpkg.com/jose/-/jose-6.2.1.tgz#7a6b1de83816deaee9055a558e1278a7b2b9ea1b" + integrity sha512-jUaKr1yrbfaImV7R2TN/b3IcZzsw38/chqMpo2XJ7i2F8AfM/lA4G1goC3JVEwg0H7UldTmSt3P68nt31W7/mw== + +joycon@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/joycon/-/joycon-3.1.1.tgz#bce8596d6ae808f8b68168f5fc69280996894f03" + integrity sha512-34wB/Y7MW7bzjKRjUKTa46I2Z7eV62Rkhva+KkopW7Qvv/OSWBqvkSY7vusOPrNuZcUG3tApvdVgNB8POj3SPw== + +"jq-web@https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz": + version "0.8.8" + resolved "https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz#7849ef64bdfc28f70cbfc9888f886860e96da10d" + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@^3.13.1: + version "3.14.2" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.2.tgz#77485ce1dd7f33c061fd1b16ecea23b55fcb04b0" + integrity sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +js-yaml@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.1.tgz#854c292467705b699476e1a2decc0c8a3458806b" + integrity sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA== + dependencies: + argparse "^2.0.1" + +jsesc@^3.0.2: + version "3.1.0" + resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" + integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== + +json-buffer@3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" + integrity sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== + +json-parse-even-better-errors@^2.3.0: + version "2.3.1" + resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" + integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema-traverse@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" + integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== + +json-schema-typed@^8.0.2: + version "8.0.2" + resolved "https://registry.yarnpkg.com/json-schema-typed/-/json-schema-typed-8.0.2.tgz#e98ee7b1899ff4a184534d1f167c288c66bbeff4" + integrity sha512-fQhoXdcvc3V28x7C7BMs4P5+kNlgUURe2jmUT1T//oBRMDrqy1QPelJimwZGo7Hg9VPV3EQV5Bnq4hbFy2vetA== + +json-stable-stringify-without-jsonify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651" + integrity sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw== + +json5@^2.2.2, json5@^2.2.3: + version "2.2.3" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" + integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== + +jsonfile@^6.0.1: + version "6.2.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" + integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== + dependencies: + universalify "^2.0.0" + optionalDependencies: + graceful-fs "^4.1.6" + +keyv@^4.5.4: + version "4.5.4" + resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93" + integrity sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw== + dependencies: + json-buffer "3.0.1" + +kleur@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" + integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== + +leven@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" + integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== + +levn@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade" + integrity sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ== + dependencies: + prelude-ls "^1.2.1" + type-check "~0.4.0" + +lines-and-columns@^1.1.6: + version "1.2.4" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +locate-path@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-6.0.0.tgz#55321eb309febbc59c4801d931a72452a681d286" + integrity sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw== + dependencies: + p-locate "^5.0.0" + +lodash.memoize@^4.1.2: + version "4.1.2" + resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" + integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag== + +lodash.merge@^4.6.2: + version "4.6.2" + resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a" + integrity sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ== + +lru-cache@^5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" + integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== + dependencies: + yallist "^3.0.2" + +make-dir@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-4.0.0.tgz#c3c2307a771277cd9638305f915c29ae741b614e" + integrity sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw== + dependencies: + semver "^7.5.3" + +make-error@^1.1.1, make-error@^1.3.6: + version "1.3.6" + resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2" + integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw== + +makeerror@1.0.12: + version "1.0.12" + resolved "https://registry.yarnpkg.com/makeerror/-/makeerror-1.0.12.tgz#3e5dd2079a82e812e983cc6610c4a2cb0eaa801a" + integrity sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg== + dependencies: + tmpl "1.0.5" + +math-intrinsics@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" + integrity sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g== + +media-typer@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-1.1.0.tgz#6ab74b8f2d3320f2064b2a87a38e7931ff3a5561" + integrity sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw== + +merge-descriptors@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-2.0.0.tgz#ea922f660635a2249ee565e0449f951e6b603808" + integrity sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g== + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +merge2@^1.3.0: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4, micromatch@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" + integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== + dependencies: + braces "^3.0.3" + picomatch "^2.3.1" + +mime-db@^1.54.0: + version "1.54.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" + integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== + +mime-types@^3.0.0, mime-types@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-3.0.2.tgz#39002d4182575d5af036ffa118100f2524b2e2ab" + integrity sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A== + dependencies: + mime-db "^1.54.0" + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.5: + version "3.1.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.5.tgz#580c88f8d5445f2bd6aa8f3cadefa0de79fbd69e" + integrity sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w== + dependencies: + brace-expansion "^1.1.7" + +minimatch@^7.4.3: + version "7.4.6" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb" + integrity sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw== + dependencies: + brace-expansion "^2.0.1" + +minimatch@^9.0.4: + version "9.0.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" + integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== + dependencies: + brace-expansion "^2.0.1" + +minimist@^1.2.5, minimist@^1.2.6: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +mkdirp@^2.1.6: + version "2.1.6" + resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-2.1.6.tgz#964fbcb12b2d8c5d6fbc62a963ac95a273e2cc19" + integrity sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A== + +ms@^2.1.3: + version "2.1.3" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== + +mute-stream@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-1.0.0.tgz#e31bd9fe62f0aed23520aa4324ea6671531e013e" + integrity sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA== + +natural-compare@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" + integrity sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw== + +negotiator@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-1.0.0.tgz#b6c91bb47172d69f93cfd7c357bbb529019b5f6a" + integrity sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg== + +neo-async@^2.6.2: + version "2.6.2" + resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" + integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== + +node-forge@^1.3.2: + version "1.3.3" + resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.3.tgz#0ad80f6333b3a0045e827ac20b7f735f93716751" + integrity sha512-rLvcdSyRCyouf6jcOIPe/BgwG/d7hKjzMKOas33/pHEr6gbq18IK9zV7DiPvzsz0oBJPme6qr6H6kGZuI9/DZg== + +node-int64@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" + integrity sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw== + +node-releases@^2.0.27: + version "2.0.27" + resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.27.tgz#eedca519205cf20f650f61d56b070db111231e4e" + integrity sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA== + +normalize-path@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +npm-run-path@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +object-assign@^4: + version "4.1.1" + resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" + integrity sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== + +object-inspect@^1.13.3: + version "1.13.4" + resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.4.tgz#8375265e21bc20d0fa582c22e1b13485d6e00213" + integrity sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew== + +on-exit-leak-free@^2.1.0: + version "2.1.2" + resolved "https://registry.yarnpkg.com/on-exit-leak-free/-/on-exit-leak-free-2.1.2.tgz#fed195c9ebddb7d9e4c3842f93f281ac8dadd3b8" + integrity sha512-0eJJY6hXLGf1udHwfNftBqH+g73EU4B504nZeKpz1sYRKafAghwxEJunB2O7rDZkL4PGfsMVnTXZ2EjibbqcsA== + +on-finished@^2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" + integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== + dependencies: + ee-first "1.1.1" + +once@^1.3.0, once@^1.3.1, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== + dependencies: + wrappy "1" + +onetime@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== + dependencies: + mimic-fn "^2.1.0" + +optionator@^0.9.3: + version "0.9.4" + resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.9.4.tgz#7ea1c1a5d91d764fb282139c88fe11e182a3a734" + integrity sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g== + dependencies: + deep-is "^0.1.3" + fast-levenshtein "^2.0.6" + levn "^0.4.1" + prelude-ls "^1.2.1" + type-check "^0.4.0" + word-wrap "^1.2.5" + +os-tmpdir@~1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/os-tmpdir/-/os-tmpdir-1.0.2.tgz#bbe67406c79aa85c5cfec766fe5734555dfa1274" + integrity sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g== + +p-all@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/p-all/-/p-all-3.0.0.tgz#077c023c37e75e760193badab2bad3ccd5782bfb" + integrity sha512-qUZbvbBFVXm6uJ7U/WDiO0fv6waBMbjlCm4E66oZdRR+egswICarIdHyVSZZHudH8T5SF8x/JG0q0duFzPnlBw== + dependencies: + p-map "^4.0.0" + +p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-limit@^3.0.2, p-limit@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-3.1.0.tgz#e1daccbe78d0d1388ca18c64fea38e3e57e3706b" + integrity sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ== + dependencies: + yocto-queue "^0.1.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-locate@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-5.0.0.tgz#83c8315c6785005e3bd021839411c9e110e6d834" + integrity sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw== + dependencies: + p-limit "^3.0.2" + +p-map@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== + dependencies: + aggregate-error "^3.0.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +parse-json@^5.2.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" + integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== + dependencies: + "@babel/code-frame" "^7.0.0" + error-ex "^1.3.1" + json-parse-even-better-errors "^2.3.0" + lines-and-columns "^1.1.6" + +parseurl@^1.3.3: + version "1.3.3" + resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" + integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ== + +path-browserify@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd" + integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g== + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-parse@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +path-to-regexp@^8.0.0: + version "8.3.0" + resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-8.3.0.tgz#aa818a6981f99321003a08987d3cec9c3474cd1f" + integrity sha512-7jdwVIRtsP8MYpdXSwOS0YdD0Du+qOoF/AEPIt88PcCFrZCzx41oxku1jD88hZBwbNUIEfpqvuhjFaMAqMTWnA== + +picocolors@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" + integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== + +picomatch@^2.0.4, picomatch@^2.2.3, picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +pino-abstract-transport@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-3.0.0.tgz#b21e5f33a297e8c4c915c62b3ce5dd4a87a52c23" + integrity sha512-wlfUczU+n7Hy/Ha5j9a/gZNy7We5+cXp8YL+X+PG8S0KXxw7n/JXA3c46Y0zQznIJ83URJiwy7Lh56WLokNuxg== + dependencies: + split2 "^4.0.0" + +pino-http@^11.0.0: + version "11.0.0" + resolved "https://registry.yarnpkg.com/pino-http/-/pino-http-11.0.0.tgz#ebadef4694fc59aadab9be7e5939aea625b4615f" + integrity sha512-wqg5XIAGRRIWtTk8qPGxkbrfiwEWz1lgedVLvhLALudKXvg1/L2lTFgTGPJ4Z2e3qcRmxoFxDuSdMdMGNM6I1g== + dependencies: + get-caller-file "^2.0.5" + pino "^10.0.0" + pino-std-serializers "^7.0.0" + process-warning "^5.0.0" + +pino-pretty@^13.1.3: + version "13.1.3" + resolved "https://registry.yarnpkg.com/pino-pretty/-/pino-pretty-13.1.3.tgz#2274cccda925dd355c104079a5029f6598d0381b" + integrity sha512-ttXRkkOz6WWC95KeY9+xxWL6AtImwbyMHrL1mSwqwW9u+vLp/WIElvHvCSDg0xO/Dzrggz1zv3rN5ovTRVowKg== + dependencies: + colorette "^2.0.7" + dateformat "^4.6.3" + fast-copy "^4.0.0" + fast-safe-stringify "^2.1.1" + help-me "^5.0.0" + joycon "^3.1.1" + minimist "^1.2.6" + on-exit-leak-free "^2.1.0" + pino-abstract-transport "^3.0.0" + pump "^3.0.0" + secure-json-parse "^4.0.0" + sonic-boom "^4.0.1" + strip-json-comments "^5.0.2" + +pino-std-serializers@^7.0.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/pino-std-serializers/-/pino-std-serializers-7.1.0.tgz#a7b0cd65225f29e92540e7853bd73b07479893fc" + integrity sha512-BndPH67/JxGExRgiX1dX0w1FvZck5Wa4aal9198SrRhZjH3GxKQUKIBnYJTdj2HDN3UQAS06HlfcSbQj2OHmaw== + +pino@^10.0.0, pino@^10.3.1: + version "10.3.1" + resolved "https://registry.yarnpkg.com/pino/-/pino-10.3.1.tgz#6552c8f8d8481844c9e452e7bf0be90bff1939ce" + integrity sha512-r34yH/GlQpKZbU1BvFFqOjhISRo1MNx1tWYsYvmj6KIRHSPMT2+yHOEb1SG6NMvRoHRF0a07kCOox/9yakl1vg== + dependencies: + "@pinojs/redact" "^0.4.0" + atomic-sleep "^1.0.0" + on-exit-leak-free "^2.1.0" + pino-abstract-transport "^3.0.0" + pino-std-serializers "^7.0.0" + process-warning "^5.0.0" + quick-format-unescaped "^4.0.3" + real-require "^0.2.0" + safe-stable-stringify "^2.3.1" + sonic-boom "^4.0.1" + thread-stream "^4.0.0" + +pirates@^4.0.4: + version "4.0.7" + resolved "https://registry.yarnpkg.com/pirates/-/pirates-4.0.7.tgz#643b4a18c4257c8a65104b73f3049ce9a0a15e22" + integrity sha512-TfySrs/5nm8fQJDcBDuUng3VOUKsd7S+zqvbOTiGXHfxX4wK31ard+hoNuvkicM/2YFzlpDgABOevKSsB4G/FA== + +pkce-challenge@^5.0.0: + version "5.0.1" + resolved "https://registry.yarnpkg.com/pkce-challenge/-/pkce-challenge-5.0.1.tgz#3b4446865b17b1745e9ace2016a31f48ddf6230d" + integrity sha512-wQ0b/W4Fr01qtpHlqSqspcj3EhBvimsdh0KlHhH8HRZnMsEa0ea2fTULOXOS9ccQr3om+GcGRk4e+isrZWV8qQ== + +pkg-dir@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" + integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== + dependencies: + find-up "^4.0.0" + +prelude-ls@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" + integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== + +prettier-linter-helpers@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.1.tgz#6a31f88a4bad6c7adda253de12ba4edaea80ebcd" + integrity sha512-SxToR7P8Y2lWmv/kTzVLC1t/GDI2WGjMwNhLLE9qtH8Q13C+aEmuRlzDst4Up4s0Wc8sF2M+J57iB3cMLqftfg== + dependencies: + fast-diff "^1.1.2" + +prettier@^3.0.0: + version "3.7.4" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.7.4.tgz#d2f8335d4b1cec47e1c8098645411b0c9dff9c0f" + integrity sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA== + +pretty-bytes@^5.6.0: + version "5.6.0" + resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-5.6.0.tgz#356256f643804773c82f64723fe78c92c62beaeb" + integrity sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg== + +pretty-format@^29.0.0, pretty-format@^29.7.0: + version "29.7.0" + resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-29.7.0.tgz#ca42c758310f365bfa71a0bda0a807160b776812" + integrity sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ== + dependencies: + "@jest/schemas" "^29.6.3" + ansi-styles "^5.0.0" + react-is "^18.0.0" + +process-warning@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/process-warning/-/process-warning-5.0.0.tgz#566e0bf79d1dff30a72d8bbbe9e8ecefe8d378d7" + integrity sha512-a39t9ApHNx2L4+HBnQKqxxHNs1r7KF+Intd8Q/g1bUh6q0WIp9voPXJ/x0j+ZL45KF1pJd9+q2jLIRMfvEshkA== + +prompts@^2.0.1: + version "2.4.2" + resolved "https://registry.yarnpkg.com/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" + integrity sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== + dependencies: + kleur "^3.0.3" + sisteransi "^1.0.5" + +proxy-addr@^2.0.7: + version "2.0.7" + resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025" + integrity sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg== + dependencies: + forwarded "0.2.0" + ipaddr.js "1.9.1" + +pump@^3.0.0: + version "3.0.4" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.4.tgz#1f313430527fa8b905622ebd22fe1444e757ab3c" + integrity sha512-VS7sjc6KR7e1ukRFhQSY5LM2uBWAUPiOPa/A3mkKmiMwSmRFUITt0xuj+/lesgnCv+dPIEYlkzrcyXgquIHMcA== + dependencies: + end-of-stream "^1.1.0" + once "^1.3.1" + +punycode@^2.1.0: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" + integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== + +pure-rand@^6.0.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/pure-rand/-/pure-rand-6.1.0.tgz#d173cf23258231976ccbdb05247c9787957604f2" + integrity sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA== + +qs@^6.14.0, qs@^6.14.1: + version "6.14.1" + resolved "https://registry.yarnpkg.com/qs/-/qs-6.14.1.tgz#a41d85b9d3902f31d27861790506294881871159" + integrity sha512-4EK3+xJl8Ts67nLYNwqw/dsFVnCf+qR7RgXSK9jEEm9unao3njwMDdmsdvoKBKHzxd7tCYz5e5M+SnMjdtXGQQ== + dependencies: + side-channel "^1.1.0" + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +quick-format-unescaped@^4.0.3: + version "4.0.4" + resolved "https://registry.yarnpkg.com/quick-format-unescaped/-/quick-format-unescaped-4.0.4.tgz#93ef6dd8d3453cbc7970dd614fad4c5954d6b5a7" + integrity sha512-tYC1Q1hgyRuHgloV/YXs2w15unPVh8qfu/qCTfhTYamaw7fyhumKa2yGpdSo87vY32rIclj+4fWYQXUMs9EHvg== + +range-parser@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.1.tgz#3cf37023d199e1c24d1a55b84800c2f3e6468031" + integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== + +raw-body@^3.0.0, raw-body@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-3.0.2.tgz#3e3ada5ae5568f9095d84376fd3a49b8fb000a51" + integrity sha512-K5zQjDllxWkf7Z5xJdV0/B0WTNqx6vxG70zJE4N0kBs4LovmEYWJzQGxC9bS9RAKu3bgM40lrd5zoLJ12MQ5BA== + dependencies: + bytes "~3.1.2" + http-errors "~2.0.1" + iconv-lite "~0.7.0" + unpipe "~1.0.0" + +react-is@^18.0.0: + version "18.3.1" + resolved "https://registry.yarnpkg.com/react-is/-/react-is-18.3.1.tgz#e83557dc12eae63a99e003a46388b1dcbb44db7e" + integrity sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg== + +readable-stream@^3.4.0: + version "3.6.2" + resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" + integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +real-require@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/real-require/-/real-require-0.2.0.tgz#209632dea1810be2ae063a6ac084fee7e33fba78" + integrity sha512-57frrGM/OCTLqLOAh0mhVA9VBMHd+9U7Zb2THMGdBUoZVOtGbJzjxsYGDJ3A9AYYCP4hn6y1TVbaOfzWtm5GFg== + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q== + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +resolve-cwd@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d" + integrity sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg== + dependencies: + resolve-from "^5.0.0" + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +resolve-from@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-5.0.0.tgz#c35225843df8f776df21c57557bc087e9dfdfc69" + integrity sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== + +resolve.exports@^2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/resolve.exports/-/resolve.exports-2.0.3.tgz#41955e6f1b4013b7586f873749a635dea07ebe3f" + integrity sha512-OcXjMsGdhL4XnbShKpAcSqPMzQoYkYyhbEaeSko47MjRP9NfEQMhZkXL1DoFlt9LWQn4YttrdnV6X2OiyzBi+A== + +resolve@^1.20.0: + version "1.22.11" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.11.tgz#aad857ce1ffb8bfa9b0b1ac29f1156383f68c262" + integrity sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ== + dependencies: + is-core-module "^2.16.1" + path-parse "^1.0.7" + supports-preserve-symlinks-flag "^1.0.0" + +reusify@^1.0.4: + version "1.1.0" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" + integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== + +router@^2.2.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/router/-/router-2.2.0.tgz#019be620b711c87641167cc79b99090f00b146ef" + integrity sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ== + dependencies: + debug "^4.4.0" + depd "^2.0.0" + is-promise "^4.0.0" + parseurl "^1.3.3" + path-to-regexp "^8.0.0" + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +safe-stable-stringify@^2.3.1: + version "2.5.0" + resolved "https://registry.yarnpkg.com/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz#4ca2f8e385f2831c432a719b108a3bf7af42a1dd" + integrity sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA== + +"safer-buffer@>= 2.1.2 < 3", "safer-buffer@>= 2.1.2 < 3.0.0": + version "2.1.2" + resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" + integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== + +secure-json-parse@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/secure-json-parse/-/secure-json-parse-4.1.0.tgz#4f1ab41c67a13497ea1b9131bb4183a22865477c" + integrity sha512-l4KnYfEyqYJxDwlNVyRfO2E4NTHfMKAWdUuA8J0yve2Dz/E/PdBepY03RvyJpssIpRFwJoCD55wA+mEDs6ByWA== + +semver@^6.3.0, semver@^6.3.1: + version "6.3.1" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" + integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== + +semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.7.3: + version "7.7.3" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" + integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== + +send@^1.1.0, send@^1.2.0: + version "1.2.1" + resolved "https://registry.yarnpkg.com/send/-/send-1.2.1.tgz#9eab743b874f3550f40a26867bf286ad60d3f3ed" + integrity sha512-1gnZf7DFcoIcajTjTwjwuDjzuz4PPcY2StKPlsGAQ1+YH20IRVrBaXSWmdjowTJ6u8Rc01PoYOGHXfP1mYcZNQ== + dependencies: + debug "^4.4.3" + encodeurl "^2.0.0" + escape-html "^1.0.3" + etag "^1.8.1" + fresh "^2.0.0" + http-errors "^2.0.1" + mime-types "^3.0.2" + ms "^2.1.3" + on-finished "^2.4.1" + range-parser "^1.2.1" + statuses "^2.0.2" + +serve-static@^2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-2.2.1.tgz#7f186a4a4e5f5b663ad7a4294ff1bf37cf0e98a9" + integrity sha512-xRXBn0pPqQTVQiC8wyQrKs2MOlX24zQ0POGaj0kultvoOCstBQM5yvOhAVSUwOMjQtTvsPWoNCHfPGwaaQJhTw== + dependencies: + encodeurl "^2.0.0" + escape-html "^1.0.3" + parseurl "^1.3.3" + send "^1.2.0" + +setprototypeof@~1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.2.0.tgz#66c9a24a73f9fc28cbe66b09fed3d33dcaf1b424" + integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +side-channel-list@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/side-channel-list/-/side-channel-list-1.0.0.tgz#10cb5984263115d3b7a0e336591e290a830af8ad" + integrity sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + +side-channel-map@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/side-channel-map/-/side-channel-map-1.0.1.tgz#d6bb6b37902c6fef5174e5f533fab4c732a26f42" + integrity sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + +side-channel-weakmap@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz#11dda19d5368e40ce9ec2bdc1fb0ecbc0790ecea" + integrity sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A== + dependencies: + call-bound "^1.0.2" + es-errors "^1.3.0" + get-intrinsic "^1.2.5" + object-inspect "^1.13.3" + side-channel-map "^1.0.1" + +side-channel@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.1.0.tgz#c3fcff9c4da932784873335ec9765fa94ff66bc9" + integrity sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw== + dependencies: + es-errors "^1.3.0" + object-inspect "^1.13.3" + side-channel-list "^1.0.0" + side-channel-map "^1.0.1" + side-channel-weakmap "^1.0.2" + +signal-exit@^3.0.3, signal-exit@^3.0.7: + version "3.0.7" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" + integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + +signal-exit@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-4.1.0.tgz#952188c1cbd546070e2dd20d0f41c0ae0530cb04" + integrity sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw== + +sisteransi@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed" + integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +sonic-boom@^4.0.1: + version "4.2.1" + resolved "https://registry.yarnpkg.com/sonic-boom/-/sonic-boom-4.2.1.tgz#28598250df4899c0ac572d7e2f0460690ba6a030" + integrity sha512-w6AxtubXa2wTXAUsZMMWERrsIRAdrK0Sc+FUytWvYAhBJLyuI4llrMIC1DtlNSdI99EI86KZum2MMq3EAZlF9Q== + dependencies: + atomic-sleep "^1.0.0" + +source-map-support@0.5.13: + version "0.5.13" + resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.13.tgz#31b24a9c2e73c2de85066c0feb7d44767ed52932" + integrity sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w== + dependencies: + buffer-from "^1.0.0" + source-map "^0.6.0" + +source-map@^0.6.0, source-map@^0.6.1: + version "0.6.1" + resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" + integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== + +split2@^4.0.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/split2/-/split2-4.2.0.tgz#c9c5920904d148bab0b9f67145f245a86aadbfa4" + integrity sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg== + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g== + +stack-utils@^2.0.3: + version "2.0.6" + resolved "https://registry.yarnpkg.com/stack-utils/-/stack-utils-2.0.6.tgz#aaf0748169c02fc33c8232abccf933f54a1cc34f" + integrity sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ== + dependencies: + escape-string-regexp "^2.0.0" + +statuses@^2.0.1, statuses@^2.0.2, statuses@~2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.2.tgz#8f75eecef765b5e1cfcdc080da59409ed424e382" + integrity sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw== + +string-length@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/string-length/-/string-length-4.0.2.tgz#a8a8dc7bd5c1a82b9b3c8b87e125f66871b6e57a" + integrity sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ== + dependencies: + char-regex "^1.0.2" + strip-ansi "^6.0.0" + +string-to-stream@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/string-to-stream/-/string-to-stream-3.0.1.tgz#480e6fb4d5476d31cb2221f75307a5dcb6638a42" + integrity sha512-Hl092MV3USJuUCC6mfl9sPzGloA3K5VwdIeJjYIkXY/8K+mUvaeEabWJgArp+xXrsWxCajeT2pc4axbVhIZJyg== + dependencies: + readable-stream "^3.4.0" + +string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-bom@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-3.0.0.tgz#2334c18e9c759f7bdd56fdef7e9ae3d588e68ed3" + integrity sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA== + +strip-bom@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-4.0.0.tgz#9c3505c1db45bcedca3d9cf7a16f5c5aa3901878" + integrity sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w== + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +strip-json-comments@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +strip-json-comments@^5.0.2: + version "5.0.3" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-5.0.3.tgz#b7304249dd402ee67fd518ada993ab3593458bcf" + integrity sha512-1tB5mhVo7U+ETBKNf92xT4hrQa3pm0MZ0PQvuDnWgAAGHDsfp4lPSpiS6psrSiet87wyGPh9ft6wmhOMQ0hDiw== + +superstruct@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/superstruct/-/superstruct-1.0.4.tgz#0adb99a7578bd2f1c526220da6571b2d485d91ca" + integrity sha512-7JpaAoX2NGyoFlI9NBh66BQXGONc+uE+MRS5i2iOBKuS4e+ccgMDjATgZldkah+33DakBxDHiss9kvUcGAO8UQ== + +supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +supports-color@^8.0.0: + version "8.1.1" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + +supports-preserve-symlinks-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" + integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== + +synckit@^0.11.12: + version "0.11.12" + resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.11.12.tgz#abe74124264fbc00a48011b0d98bdc1cffb64a7b" + integrity sha512-Bh7QjT8/SuKUIfObSXNHNSK6WHo6J1tHCqJsuaFDP7gP0fkzSfTxI8y85JrppZ0h8l0maIgc2tfuZQ6/t3GtnQ== + dependencies: + "@pkgr/core" "^0.2.9" + +test-exclude@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" + integrity sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w== + dependencies: + "@istanbuljs/schema" "^0.1.2" + glob "^7.1.4" + minimatch "^3.0.4" + +thread-stream@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/thread-stream/-/thread-stream-4.0.0.tgz#732f007c24da7084f729d6e3a7e3f5934a7380b7" + integrity sha512-4iMVL6HAINXWf1ZKZjIPcz5wYaOdPhtO8ATvZ+Xqp3BTdaqtAwQkNmKORqcIo5YkQqGXq5cwfswDwMqqQNrpJA== + dependencies: + real-require "^0.2.0" + +tmp@^0.0.33: + version "0.0.33" + resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.0.33.tgz#6d34335889768d21b2bcda0aa277ced3b1bfadf9" + integrity sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw== + dependencies: + os-tmpdir "~1.0.2" + +tmpl@1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc" + integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +toidentifier@~1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.1.tgz#3be34321a88a820ed1bd80dfaa33e479fbb8dd35" + integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== + +ts-api-utils@^2.0.1: + version "2.4.0" + resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-2.4.0.tgz#2690579f96d2790253bdcf1ca35d569ad78f9ad8" + integrity sha512-3TaVTaAv2gTiMB35i3FiGJaRfwb3Pyn/j3m/bfAvGe8FB7CF6u+LMYqYlDh7reQf7UNvoTvdfAqHGmPGOSsPmA== + +ts-jest@^29.1.0: + version "29.4.6" + resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.4.6.tgz#51cb7c133f227396818b71297ad7409bb77106e9" + integrity sha512-fSpWtOO/1AjSNQguk43hb/JCo16oJDnMJf3CdEGNkqsEX3t0KX96xvyX1D7PfLCpVoKu4MfVrqUkFyblYoY4lA== + dependencies: + bs-logger "^0.2.6" + fast-json-stable-stringify "^2.1.0" + handlebars "^4.7.8" + json5 "^2.2.3" + lodash.memoize "^4.1.2" + make-error "^1.3.6" + semver "^7.7.3" + type-fest "^4.41.0" + yargs-parser "^21.1.1" + +ts-morph@^19.0.0: + version "19.0.0" + resolved "https://registry.yarnpkg.com/ts-morph/-/ts-morph-19.0.0.tgz#43e95fb0156c3fe3c77c814ac26b7d0be2f93169" + integrity sha512-D6qcpiJdn46tUqV45vr5UGM2dnIEuTGNxVhg0sk5NX11orcouwj6i1bMqZIz2mZTZB1Hcgy7C3oEVhAT+f6mbQ== + dependencies: + "@ts-morph/common" "~0.20.0" + code-block-writer "^12.0.0" + +ts-node@^10.5.0: + version "10.9.2" + resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f" + integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ== + dependencies: + "@cspotcode/source-map-support" "^0.8.0" + "@tsconfig/node10" "^1.0.7" + "@tsconfig/node12" "^1.0.7" + "@tsconfig/node14" "^1.0.0" + "@tsconfig/node16" "^1.0.2" + acorn "^8.4.1" + acorn-walk "^8.1.1" + arg "^4.1.0" + create-require "^1.1.0" + diff "^4.0.1" + make-error "^1.1.1" + v8-compile-cache-lib "^3.0.1" + yn "3.1.1" + +"tsc-multi@https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz": + version "1.1.11" + resolved "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz#010247051be13b55abdc98f787c017285149f4f2" + dependencies: + debug "^4.3.7" + fast-glob "^3.3.2" + get-stdin "^8.0.0" + p-all "^3.0.0" + picocolors "^1.1.1" + signal-exit "^3.0.7" + string-to-stream "^3.0.1" + superstruct "^1.0.4" + tslib "^2.8.1" + yargs "^17.7.2" + +tsconfig-paths@^4.0.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/tsconfig-paths/-/tsconfig-paths-4.2.0.tgz#ef78e19039133446d244beac0fd6a1632e2d107c" + integrity sha512-NoZ4roiN7LnbKn9QqE1amc9DJfzvZXxF4xDavcOWt1BPkdx+m+0gJuPM+S0vCe7zTJMYUP0R8pO2XMr+Y8oLIg== + dependencies: + json5 "^2.2.2" + minimist "^1.2.6" + strip-bom "^3.0.0" + +tslib@^2.8.1: + version "2.8.1" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" + integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== + +type-check@^0.4.0, type-check@~0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.4.0.tgz#07b8203bfa7056c0657050e3ccd2c37730bab8f1" + integrity sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew== + dependencies: + prelude-ls "^1.2.1" + +type-detect@4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c" + integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g== + +type-fest@^0.21.3: + version "0.21.3" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" + integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== + +type-fest@^4.41.0: + version "4.41.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.41.0.tgz#6ae1c8e5731273c2bf1f58ad39cbae2c91a46c58" + integrity sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA== + +type-is@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/type-is/-/type-is-2.0.1.tgz#64f6cf03f92fce4015c2b224793f6bdd4b068c97" + integrity sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw== + dependencies: + content-type "^1.0.5" + media-typer "^1.1.0" + mime-types "^3.0.0" + +typescript@5.8.3: + version "5.8.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.8.3.tgz#92f8a3e5e3cf497356f4178c34cd65a7f5e8440e" + integrity sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ== + +uglify-js@^3.1.4: + version "3.19.3" + resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.19.3.tgz#82315e9bbc6f2b25888858acd1fff8441035b77f" + integrity sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ== + +undici-types@~6.21.0: + version "6.21.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.21.0.tgz#691d00af3909be93a7faa13be61b3a5b50ef12cb" + integrity sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ== + +undici-types@~7.16.0: + version "7.16.0" + resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.16.0.tgz#ffccdff36aea4884cbfce9a750a0580224f58a46" + integrity sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw== + +universalify@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" + integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== + +unpipe@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" + integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== + +update-browserslist-db@^1.2.0: + version "1.2.3" + resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz#64d76db58713136acbeb4c49114366cc6cc2e80d" + integrity sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w== + dependencies: + escalade "^3.2.0" + picocolors "^1.1.1" + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +util-deprecate@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== + +v8-compile-cache-lib@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf" + integrity sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg== + +v8-to-istanbul@^9.0.1: + version "9.3.0" + resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz#b9572abfa62bd556c16d75fdebc1a411d5ff3175" + integrity sha512-kiGUalWN+rgBJ/1OHZsBtU4rXZOfj/7rKQxULKlIzwzQSvMJUUNgPwJEEh7gU6xEVxC0ahoOBvN2YI8GH6FNgA== + dependencies: + "@jridgewell/trace-mapping" "^0.3.12" + "@types/istanbul-lib-coverage" "^2.0.1" + convert-source-map "^2.0.0" + +vary@^1, vary@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc" + integrity sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg== + +walker@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/walker/-/walker-1.0.8.tgz#bd498db477afe573dc04185f011d3ab8a8d7653f" + integrity sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ== + dependencies: + makeerror "1.0.12" + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +word-wrap@^1.2.5: + version "1.2.5" + resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.5.tgz#d2c45c6dd4fbce621a66f136cbe328afd0410b34" + integrity sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA== + +wordwrap@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" + integrity sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q== + +wrap-ansi@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== + +write-file-atomic@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-4.0.2.tgz#a9df01ae5b77858a027fd2e80768ee433555fcfd" + integrity sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg== + dependencies: + imurmurhash "^0.1.4" + signal-exit "^3.0.7" + +y18n@^5.0.5: + version "5.0.8" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" + integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== + +yallist@^3.0.2: + version "3.1.1" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" + integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== + +yargs-parser@^21.1.1: + version "21.1.1" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35" + integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== + +yargs@^17.3.1, yargs@^17.7.2: + version "17.7.2" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.2.tgz#991df39aca675a192b816e1e0363f9d75d2aa269" + integrity sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w== + dependencies: + cliui "^8.0.1" + escalade "^3.1.1" + get-caller-file "^2.0.5" + require-directory "^2.1.1" + string-width "^4.2.3" + y18n "^5.0.5" + yargs-parser "^21.1.1" + +yn@3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/yn/-/yn-3.1.1.tgz#1e87401a09d767c1d5eab26a6e4c185182d2eb50" + integrity sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q== + +yocto-queue@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" + integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== + +yoctocolors-cjs@^2.1.2: + version "2.1.3" + resolved "https://registry.yarnpkg.com/yoctocolors-cjs/-/yoctocolors-cjs-2.1.3.tgz#7e4964ea8ec422b7a40ac917d3a344cfd2304baa" + integrity sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw== + +zod-to-json-schema@^3.24.5, zod-to-json-schema@^3.24.6, zod-to-json-schema@^3.25.1: + version "3.25.1" + resolved "https://registry.yarnpkg.com/zod-to-json-schema/-/zod-to-json-schema-3.25.1.tgz#7f24962101a439ddade2bf1aeab3c3bfec7d84ba" + integrity sha512-pM/SU9d3YAggzi6MtR4h7ruuQlqKtad8e9S0fmxcMi+ueAK5Korys/aWcV9LIIHTVbj01NdzxcnXSN+O74ZIVA== + +zod-validation-error@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/zod-validation-error/-/zod-validation-error-4.0.2.tgz#bc605eba49ce0fcd598c127fee1c236be3f22918" + integrity sha512-Q6/nZLe6jxuU80qb/4uJ4t5v2VEZ44lzQjPDhYJNztRQ4wyWc6VF3D3Kb/fAuPetZQnhS3hnajCf9CsWesghLQ== + +"zod@^3.25 || ^4.0": + version "4.3.5" + resolved "https://registry.yarnpkg.com/zod/-/zod-4.3.5.tgz#aeb269a6f9fc259b1212c348c7c5432aaa474d2a" + integrity sha512-k7Nwx6vuWx1IJ9Bjuf4Zt1PEllcwe7cls3VNzm4CQ1/hgtFUK2bRNG3rvnpPUhFjmqJKAKtjV576KnUkHocg/g== + +zod@^3.25.20, zod@^3.25.67: + version "3.25.76" + resolved "https://registry.yarnpkg.com/zod/-/zod-3.25.76.tgz#26841c3f6fd22a6a2760e7ccb719179768471e34" + integrity sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ== diff --git a/release-please-config.json b/release-please-config.json index 1ebd0bde..9b042792 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -60,5 +60,19 @@ } ], "release-type": "node", - "extra-files": ["src/version.ts", "README.md"] + "extra-files": [ + "src/version.ts", + "README.md", + "packages/mcp-server/yarn.lock", + { + "type": "json", + "path": "packages/mcp-server/package.json", + "jsonpath": "$.version" + }, + { + "type": "json", + "path": "packages/mcp-server/manifest.json", + "jsonpath": "$.version" + } + ] } diff --git a/scripts/build b/scripts/build index 76462cfc..bb31f229 100755 --- a/scripts/build +++ b/scripts/build @@ -49,3 +49,9 @@ if [ -e ./scripts/build-deno ] then ./scripts/build-deno fi +# build all sub-packages +for dir in packages/*; do + if [ -d "$dir" ]; then + (cd "$dir" && yarn install && yarn build) + fi +done diff --git a/scripts/build-all b/scripts/build-all new file mode 100755 index 00000000..4e5ac01f --- /dev/null +++ b/scripts/build-all @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +# build-all is deprecated, use build instead + +bash ./scripts/build diff --git a/scripts/publish-packages.ts b/scripts/publish-packages.ts new file mode 100644 index 00000000..50e93fef --- /dev/null +++ b/scripts/publish-packages.ts @@ -0,0 +1,102 @@ +/** + * Called from the `create-releases.yml` workflow with the output + * of the release please action as the first argument. + * + * Example JSON input: + * + * ```json + { + "releases_created": "true", + "release_created": "true", + "id": "137967744", + "name": "sdk: v0.14.5", + "tag_name": "sdk-v0.14.5", + "sha": "7cc2ba5c694e76a117f731d4cf0b06f8b8361f2e", + "body": "## 0.14.5 (2024-01-22)\n\n...", + "html_url": "https://github.com/$org/$repo/releases/tag/sdk-v0.14.5", + "draft": "false", + "upload_url": "https://uploads.github.com/repos/$org/$repo/releases/137967744/assets{?name,label}", + "path": ".", + "version": "0.14.5", + "major": "0", + "minor": "14", + "patch": "5", + "packages/additional-sdk--release_created": "true", + "packages/additional-sdk--id": "137967756", + "packages/additional-sdk--name": "additional-sdk: v0.5.2", + "packages/additional-sdk--tag_name": "additional-sdk-v0.5.2", + "packages/additional-sdk--sha": "7cc2ba5c694e76a117f731d4cf0b06f8b8361f2e", + "packages/additional-sdk--body": "## 0.5.2 (2024-01-22)\n\n...", + "packages/additional-sdk--html_url": "https://github.com/$org/$repo/releases/tag/additional-sdk-v0.5.2", + "packages/additional-sdk--draft": "false", + "packages/additional-sdk--upload_url": "https://uploads.github.com/repos/$org/$repo/releases/137967756/assets{?name,label}", + "packages/additional-sdk--path": "packages/additional-sdk", + "packages/additional-sdk--version": "0.5.2", + "packages/additional-sdk--major": "0", + "packages/additional-sdk--minor": "5", + "packages/additional-sdk--patch": "2", + "paths_released": "[\".\",\"packages/additional-sdk\"]" + } + ``` + */ + +import { execSync } from 'child_process'; +import path from 'path'; + +function main() { + const data = process.argv[2] ?? process.env['DATA']; + if (!data) { + throw new Error(`Usage: publish-packages.ts '{"json": "obj"}'`); + } + + const rootDir = path.join(__dirname, '..'); + console.log('root dir', rootDir); + console.log(`publish-packages called with ${data}`); + + const outputs = JSON.parse(data); + + const rawPaths = outputs.paths_released; + + if (!rawPaths) { + console.error(JSON.stringify(outputs, null, 2)); + throw new Error('Expected outputs to contain a truthy `paths_released` property'); + } + if (typeof rawPaths !== 'string') { + console.error(JSON.stringify(outputs, null, 2)); + throw new Error('Expected outputs `paths_released` property to be a JSON string'); + } + + const paths = JSON.parse(rawPaths); + if (!Array.isArray(paths)) { + console.error(JSON.stringify(outputs, null, 2)); + throw new Error('Expected outputs `paths_released` property to be an array'); + } + if (!paths.length) { + console.error(JSON.stringify(outputs, null, 2)); + throw new Error('Expected outputs `paths_released` property to contain at least one entry'); + } + + const publishScriptPath = path.join(rootDir, 'bin', 'publish-npm'); + console.log('Using publish script at', publishScriptPath); + + console.log('Ensuring root package is built'); + console.log(`$ yarn build`); + execSync(`yarn build`, { cwd: rootDir, encoding: 'utf8', stdio: 'inherit' }); + + for (const relPackagePath of paths) { + console.log('\n'); + + const packagePath = path.join(rootDir, relPackagePath); + console.log(`Publishing in directory: ${packagePath}`); + + console.log(`$ yarn install`); + execSync(`yarn install`, { cwd: packagePath, encoding: 'utf8', stdio: 'inherit' }); + + console.log(`$ bash ${publishScriptPath}`); + execSync(`bash ${publishScriptPath}`, { cwd: packagePath, encoding: 'utf8', stdio: 'inherit' }); + } + + console.log('Finished publishing packages'); +} + +main(); diff --git a/scripts/utils/make-dist-package-json.cjs b/scripts/utils/make-dist-package-json.cjs index 7c24f56e..4d6634ea 100644 --- a/scripts/utils/make-dist-package-json.cjs +++ b/scripts/utils/make-dist-package-json.cjs @@ -12,6 +12,14 @@ processExportMap(pkgJson.exports); for (const key of ['types', 'main', 'module']) { if (typeof pkgJson[key] === 'string') pkgJson[key] = pkgJson[key].replace(/^(\.\/)?dist\//, './'); } +// Fix bin paths if present +if (pkgJson.bin) { + for (const key in pkgJson.bin) { + if (typeof pkgJson.bin[key] === 'string') { + pkgJson.bin[key] = pkgJson.bin[key].replace(/^(\.\/)?dist\//, './'); + } + } +} delete pkgJson.devDependencies; delete pkgJson.scripts.prepack; From 52f45ff260e7b90e519dc3ac48dab608858da918 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 19 May 2026 09:59:37 +0000 Subject: [PATCH 2/6] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index e2813b39..3e5d86cf 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 955 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-d306a9f90ec487d227a47c390018997eebc86a5983ac7fe21f945b82a74868db.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-15f6f8c8af544fcdb763ecbe190ab42b3565a9f048111a02a9a255845c383ab5.yml openapi_spec_hash: 47d20b6496315d47f4f64441d4682f47 -config_hash: f0caff211e137f418213baf5da549f3b +config_hash: a79df9b7d8f6fcbbdee9076f1d8ad007 From 3cdcc58594135075c61b6e5732dd10c4848d8337 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 20 May 2026 09:44:24 +0000 Subject: [PATCH 3/6] feat(api): manual updates --- .dockerignore | 59 - .github/workflows/ci.yml | 20 +- .github/workflows/publish-npm.yml | 22 +- .gitignore | 2 - .prettierignore | 3 +- .stats.yml | 4 +- README.md | 9 - eslint.config.mjs | 2 +- packages/mcp-server/Dockerfile | 78 - packages/mcp-server/README.md | 98 - packages/mcp-server/build | 56 - packages/mcp-server/jest.config.ts | 17 - packages/mcp-server/manifest.json | 53 - packages/mcp-server/package.json | 96 - .../mcp-server/scripts/copy-bundle-files.cjs | 36 - .../scripts/postprocess-dist-package-json.cjs | 12 - packages/mcp-server/src/auth.ts | 38 - packages/mcp-server/src/code-tool-paths.cts | 5 - packages/mcp-server/src/code-tool-types.ts | 17 - packages/mcp-server/src/code-tool-worker.ts | 1260 - packages/mcp-server/src/code-tool.ts | 392 - packages/mcp-server/src/docs-search-tool.ts | 138 - packages/mcp-server/src/http.ts | 227 - packages/mcp-server/src/index.ts | 67 - packages/mcp-server/src/instructions.ts | 83 - packages/mcp-server/src/local-docs-search.ts | 52869 ---------------- packages/mcp-server/src/logger.ts | 28 - packages/mcp-server/src/methods.ts | 5982 -- packages/mcp-server/src/options.ts | 185 - packages/mcp-server/src/server.ts | 213 - packages/mcp-server/src/stdio.ts | 17 - packages/mcp-server/src/types.ts | 126 - packages/mcp-server/src/util.ts | 25 - packages/mcp-server/tests/options.test.ts | 32 - packages/mcp-server/tsc-multi.json | 7 - packages/mcp-server/tsconfig.build.json | 18 - packages/mcp-server/tsconfig.dist-src.json | 11 - packages/mcp-server/tsconfig.json | 36 - packages/mcp-server/yarn.lock | 4169 -- release-please-config.json | 16 +- scripts/build | 6 - scripts/build-all | 5 - scripts/publish-packages.ts | 102 - scripts/utils/make-dist-package-json.cjs | 8 - 44 files changed, 10 insertions(+), 66639 deletions(-) delete mode 100644 .dockerignore delete mode 100644 packages/mcp-server/Dockerfile delete mode 100644 packages/mcp-server/README.md delete mode 100644 packages/mcp-server/build delete mode 100644 packages/mcp-server/jest.config.ts delete mode 100644 packages/mcp-server/manifest.json delete mode 100644 packages/mcp-server/package.json delete mode 100644 packages/mcp-server/scripts/copy-bundle-files.cjs delete mode 100644 packages/mcp-server/scripts/postprocess-dist-package-json.cjs delete mode 100644 packages/mcp-server/src/auth.ts delete mode 100644 packages/mcp-server/src/code-tool-paths.cts delete mode 100644 packages/mcp-server/src/code-tool-types.ts delete mode 100644 packages/mcp-server/src/code-tool-worker.ts delete mode 100644 packages/mcp-server/src/code-tool.ts delete mode 100644 packages/mcp-server/src/docs-search-tool.ts delete mode 100644 packages/mcp-server/src/http.ts delete mode 100644 packages/mcp-server/src/index.ts delete mode 100644 packages/mcp-server/src/instructions.ts delete mode 100644 packages/mcp-server/src/local-docs-search.ts delete mode 100644 packages/mcp-server/src/logger.ts delete mode 100644 packages/mcp-server/src/methods.ts delete mode 100644 packages/mcp-server/src/options.ts delete mode 100644 packages/mcp-server/src/server.ts delete mode 100644 packages/mcp-server/src/stdio.ts delete mode 100644 packages/mcp-server/src/types.ts delete mode 100644 packages/mcp-server/src/util.ts delete mode 100644 packages/mcp-server/tests/options.test.ts delete mode 100644 packages/mcp-server/tsc-multi.json delete mode 100644 packages/mcp-server/tsconfig.build.json delete mode 100644 packages/mcp-server/tsconfig.dist-src.json delete mode 100644 packages/mcp-server/tsconfig.json delete mode 100644 packages/mcp-server/yarn.lock delete mode 100755 scripts/build-all delete mode 100644 scripts/publish-packages.ts diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index 12ff1e64..00000000 --- a/.dockerignore +++ /dev/null @@ -1,59 +0,0 @@ -# Dependencies -node_modules/ -**/node_modules/ - -# Build outputs -dist/ -**/dist/ - -# Git -.git/ -.gitignore - -# CI/CD -.github/ -.gitlab-ci.yml -.travis.yml - -# IDE -.vscode/ -.idea/ -*.swp -*.swo -*~ - -# OS -.DS_Store -Thumbs.db - -# Testing -test/ -tests/ -__tests__/ -*.test.js -*.spec.js -coverage/ -.nyc_output/ - -# Logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# Environment -.env -.env.* - -# Temporary files -*.tmp -*.temp -.cache/ - -# Examples and scripts -examples/ -bin/ - -# Other packages (we only need mcp-server) -packages/*/ -!packages/mcp-server/ diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c0ca8f2e..5513e37f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '22' + node-version: '20' - name: Bootstrap run: ./scripts/bootstrap @@ -48,7 +48,7 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '22' + node-version: '20' - name: Bootstrap run: ./scripts/bootstrap @@ -74,17 +74,6 @@ jobs: AUTH: ${{ steps.github-oidc.outputs.github_token }} SHA: ${{ github.sha }} run: ./scripts/utils/upload-artifact.sh - - - name: Upload MCP Server tarball - if: |- - github.repository == 'stainless-sdks/hubspot-sdk-typescript' && - !startsWith(github.ref, 'refs/heads/stl/') - env: - URL: https://pkg.stainless.com/s?subpackage=mcp-server - AUTH: ${{ steps.github-oidc.outputs.github_token }} - SHA: ${{ github.sha }} - BASE_PATH: packages/mcp-server - run: ./scripts/utils/upload-artifact.sh test: timeout-minutes: 10 name: test @@ -96,13 +85,10 @@ jobs: - name: Set up Node uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 with: - node-version: '22' + node-version: '20' - name: Bootstrap run: ./scripts/bootstrap - - name: Build - run: ./scripts/build - - name: Run tests run: ./scripts/test diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml index cff607c0..a6ea0887 100644 --- a/.github/workflows/publish-npm.yml +++ b/.github/workflows/publish-npm.yml @@ -4,10 +4,6 @@ name: Publish NPM on: workflow_dispatch: - inputs: - path: - description: The path to run the release in, e.g. '.' or 'packages/mcp-server' - required: true release: types: [published] @@ -17,7 +13,7 @@ jobs: name: publish runs-on: ubuntu-latest permissions: - contents: write + contents: read id-token: write steps: @@ -34,18 +30,4 @@ jobs: - name: Publish to NPM run: | - if [ -n "$INPUT_PATH" ]; then - PATHS_RELEASED="[\"$INPUT_PATH\"]" - else - PATHS_RELEASED='[\".\", \"packages/mcp-server\"]' - fi - yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }" - env: - INPUT_PATH: ${{ github.event.inputs.path }} - - - name: Upload MCP Server DXT GitHub release asset - run: | - gh release upload ${{ github.event.release.tag_name }} \ - packages/mcp-server/hubspot_sdk_api.mcpb - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + bash ./bin/publish-npm diff --git a/.gitignore b/.gitignore index ae4aa20e..9487e48a 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,4 @@ dist-deno /*.tgz .idea/ .eslintcache -dist-bundle -*.mcpb oidc diff --git a/.prettierignore b/.prettierignore index 36afd3b3..3548c5af 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,7 +2,6 @@ CHANGELOG.md /ecosystem-tests/*/** /node_modules /deno -/packages/mcp-server/manifest.json # don't format tsc output, will break source maps -dist +/dist diff --git a/.stats.yml b/.stats.yml index 3e5d86cf..c94373b3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 955 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-15f6f8c8af544fcdb763ecbe190ab42b3565a9f048111a02a9a255845c383ab5.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-45b4e4548d5c629c40a55d10db6d924a20591a47a25928c3eeb82b3a7e1b640e.yml openapi_spec_hash: 47d20b6496315d47f4f64441d4682f47 -config_hash: a79df9b7d8f6fcbbdee9076f1d8ad007 +config_hash: 997f7d3ccb889010d92f2906d731d7d1 diff --git a/README.md b/README.md index 90038c4b..6309e5a4 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,6 @@ The REST API documentation can be found on [developers.hubspot.com](https://deve It is generated with [Stainless](https://www.stainless.com/). -## MCP Server - -Use the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. - -[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19) -[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D) - -> Note: You may need to set environment variables in your MCP client. - ## Installation ```sh diff --git a/eslint.config.mjs b/eslint.config.mjs index 0866279a..9ff827e0 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -31,7 +31,7 @@ export default tseslint.config( }, }, { - files: ['tests/**', 'examples/**', 'packages/**'], + files: ['tests/**', 'examples/**'], rules: { 'no-restricted-imports': 'off', }, diff --git a/packages/mcp-server/Dockerfile b/packages/mcp-server/Dockerfile deleted file mode 100644 index d2743fec..00000000 --- a/packages/mcp-server/Dockerfile +++ /dev/null @@ -1,78 +0,0 @@ -# Dockerfile for HubSpot MCP Server -# -# This Dockerfile builds a Docker image for the MCP Server. -# -# To build the image locally: -# docker build -f packages/mcp-server/Dockerfile -t @hubspot/sdk-mcp:local . -# -# To run the image: -# docker run -i @hubspot/sdk-mcp:local [OPTIONS] -# -# Common options: -# --tool= Include specific tools -# --resource= Include tools for specific resources -# --operation=read|write Filter by operation type -# --client= Set client compatibility (e.g., claude, cursor) -# --transport= Set transport type (stdio or http) -# -# For a full list of options: -# docker run -i @hubspot/sdk-mcp:local --help -# -# Note: The MCP server uses stdio transport by default. Docker's -i flag -# enables interactive mode, allowing the container to communicate over stdin/stdout. - -# Build stage -FROM node:24-alpine AS builder - -# Install bash for build script -RUN apk add --no-cache bash openssl - -# Set working directory -WORKDIR /build - -# Copy entire repository -COPY . . - -# Install all dependencies and build everything -RUN yarn install --frozen-lockfile && \ - yarn build && \ - # Remove the symlink to the SDK so it doesn't interfere with the explicit COPY below - rm -Rf packages/mcp-server/node_modules/@hubspot/sdk - -FROM denoland/deno:alpine-2.7.1 - -# Install node and npm -RUN apk add --no-cache nodejs npm - -ENV LD_LIBRARY_PATH=/usr/lib:/usr/local/lib - -# Add non-root user -RUN addgroup -g 1001 -S nodejs && adduser -S nodejs -u 1001 - -# Set working directory -WORKDIR /app - -# Copy the built mcp-server dist directory -COPY --from=builder /build/packages/mcp-server/dist ./ - -# Copy node_modules from mcp-server (includes all production deps) -COPY --from=builder /build/packages/mcp-server/node_modules ./node_modules - -# Copy the built @hubspot/sdk into node_modules -COPY --from=builder /build/dist ./node_modules/@hubspot/sdk - -# Change ownership to nodejs user -RUN chown -R nodejs:nodejs /app -RUN chown -R nodejs:nodejs /deno-dir - -# Switch to non-root user -USER nodejs - -# The MCP server uses stdio transport by default -# No exposed ports needed for stdio communication - -# Set the entrypoint to the MCP server -ENTRYPOINT ["node", "index.js"] - -# Allow passing arguments to the MCP server -CMD [] diff --git a/packages/mcp-server/README.md b/packages/mcp-server/README.md deleted file mode 100644 index c490640e..00000000 --- a/packages/mcp-server/README.md +++ /dev/null @@ -1,98 +0,0 @@ -# HubSpot TypeScript MCP Server - -It is generated with [Stainless](https://www.stainless.com/). - -## Installation - -### Direct invocation - -You can run the MCP Server directly via `npx`: - -```sh -export HUBSPOT_ACCESS_TOKEN="My Access Token" -export HUBSPOT_DEVELOPER_API_KEY="My Developer API Key" -npx -y @hubspot/sdk-mcp@latest -``` - -### Via MCP Client - -There is a partial list of existing clients at [modelcontextprotocol.io](https://modelcontextprotocol.io/clients). If you already -have a client, consult their documentation to install the MCP server. - -For clients with a configuration JSON, it might look something like this: - -```json -{ - "mcpServers": { - "hubspot_sdk_api": { - "command": "npx", - "args": ["-y", "@hubspot/sdk-mcp"], - "env": { - "HUBSPOT_ACCESS_TOKEN": "My Access Token", - "HUBSPOT_DEVELOPER_API_KEY": "My Developer API Key" - } - } - } -} -``` - -### Cursor - -If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables -in Cursor's `mcp.json`, which can be found in Cursor Settings > Tools & MCP > New MCP Server. - -[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19) - -### VS Code - -If you use MCP, you can install the MCP server by clicking the link below. You will need to set your environment variables -in VS Code's `mcp.json`, which can be found via Command Palette > MCP: Open User Configuration. - -[Open VS Code](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D) - -### Claude Code - -If you use Claude Code, you can install the MCP server by running the command below in your terminal. You will need to set your -environment variables in Claude Code's `.claude.json`, which can be found in your home directory. - -``` -claude mcp add hubspot_sdk_mcp_api --env HUBSPOT_ACCESS_TOKEN="My Access Token" HUBSPOT_DEVELOPER_API_KEY="My Developer API Key" -- npx -y @hubspot/sdk-mcp -``` - -## Code Mode - -This MCP server is built on the "Code Mode" tool scheme. In this MCP Server, -your agent will write code against the TypeScript SDK, which will then be executed in an -isolated sandbox. To accomplish this, the server will expose two tools to your agent: - -- The first tool is a docs search tool, which can be used to generically query for - documentation about your API/SDK. - -- The second tool is a code tool, where the agent can write code against the TypeScript SDK. - The code will be executed in a sandbox environment without web or filesystem access. Then, - anything the code returns or prints will be returned to the agent as the result of the - tool call. - -Using this scheme, agents are capable of performing very complex tasks deterministically -and repeatably. - -## Running remotely - -Launching the client with `--transport=http` launches the server as a remote server using Streamable HTTP transport. The `--port` setting can choose the port it will run on, and the `--socket` setting allows it to run on a Unix socket. - -Authorization can be provided via the `Authorization` header using the Bearer scheme. - -A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`: - -```json -{ - "mcpServers": { - "hubspot_sdk_api": { - "url": "http://localhost:3000", - "headers": { - "Authorization": "Bearer " - } - } - } -} -``` diff --git a/packages/mcp-server/build b/packages/mcp-server/build deleted file mode 100644 index 01944266..00000000 --- a/packages/mcp-server/build +++ /dev/null @@ -1,56 +0,0 @@ -#!/usr/bin/env bash -set -exuo pipefail - -rm -rf dist; mkdir dist - -# Copy src to dist/src and build from dist/src into dist, so that -# the source map for index.js.map will refer to ./src/index.ts etc -cp -rp src README.md dist - -for file in LICENSE; do - if [ -e "../../${file}" ]; then cp "../../${file}" dist; fi -done - -for file in CHANGELOG.md; do - if [ -e "${file}" ]; then cp "${file}" dist; fi -done - -# this converts the export map paths for the dist directory -# and does a few other minor things -PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist/package.json - -# updates the `@hubspot/sdk` dependency to point to NPM -node scripts/postprocess-dist-package-json.cjs - -# build to .js/.mjs/.d.ts files -./node_modules/.bin/tsc-multi - -cp tsconfig.dist-src.json dist/src/tsconfig.json - -chmod +x dist/index.js - -DIST_PATH=./dist PKG_IMPORT_PATH=@hubspot/sdk-mcp/ node ../../scripts/utils/postprocess-files.cjs - -# mcp bundle -rm -rf dist-bundle hubspot_sdk_api.mcpb; mkdir dist-bundle - -# copy package.json -PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist-bundle/package.json - -# copy files -node scripts/copy-bundle-files.cjs - -# install runtime deps -cd dist-bundle -npm install -cd .. - -# pack bundle -cp manifest.json dist-bundle - -npx mcpb pack dist-bundle hubspot_sdk_api.mcpb - -npx mcpb sign hubspot_sdk_api.mcpb --self-signed - -# clean up -rm -rf dist-bundle diff --git a/packages/mcp-server/jest.config.ts b/packages/mcp-server/jest.config.ts deleted file mode 100644 index 8bbfd427..00000000 --- a/packages/mcp-server/jest.config.ts +++ /dev/null @@ -1,17 +0,0 @@ -import type { JestConfigWithTsJest } from 'ts-jest'; - -const config: JestConfigWithTsJest = { - preset: 'ts-jest/presets/default-esm', - testEnvironment: 'node', - transform: { - '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }], - }, - moduleNameMapper: { - '^@hubspot/sdk-mcp$': '/src/index.ts', - '^@hubspot/sdk-mcp/(.*)$': '/src/$1', - }, - modulePathIgnorePatterns: ['/dist/'], - testPathIgnorePatterns: ['scripts'], -}; - -export default config; diff --git a/packages/mcp-server/manifest.json b/packages/mcp-server/manifest.json deleted file mode 100644 index 037a8358..00000000 --- a/packages/mcp-server/manifest.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "dxt_version": "0.2", - "name": "@hubspot/sdk-mcp", - "version": "0.1.0-alpha.9", - "description": "The official MCP Server for the HubSpot API", - "author": { - "name": "HubSpot" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/HubSpot/hubspot-sdk-typescript.git" - }, - "homepage": "https://github.com/HubSpot/hubspot-sdk-typescript/tree/main/packages/mcp-server#readme", - "documentation": "https://developers.hubspot.com/docs/api-reference/overview", - "server": { - "type": "node", - "entry_point": "index.js", - "mcp_config": { - "command": "node", - "args": [ - "${__dirname}/index.js" - ], - "env": { - "HUBSPOT_ACCESS_TOKEN": "${user_config.HUBSPOT_ACCESS_TOKEN}", - "HUBSPOT_DEVELOPER_API_KEY": "${user_config.HUBSPOT_DEVELOPER_API_KEY}" - } - } - }, - "user_config": { - "HUBSPOT_ACCESS_TOKEN": { - "title": "access_token", - "description": "", - "required": false, - "type": "string" - }, - "HUBSPOT_DEVELOPER_API_KEY": { - "title": "developer_api_key", - "description": "", - "required": false, - "type": "string" - } - }, - "tools": [], - "tools_generated": true, - "compatibility": { - "runtimes": { - "node": ">=18.0.0" - } - }, - "keywords": [ - "api" - ] -} diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json deleted file mode 100644 index b60d2e04..00000000 --- a/packages/mcp-server/package.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "name": "@hubspot/sdk-mcp", - "version": "0.1.0-alpha.9", - "description": "The official MCP Server for the HubSpot API", - "author": "HubSpot <>", - "types": "dist/index.d.ts", - "main": "dist/index.js", - "type": "commonjs", - "repository": { - "type": "git", - "url": "git+https://github.com/HubSpot/hubspot-sdk-typescript.git", - "directory": "packages/mcp-server" - }, - "homepage": "https://github.com/HubSpot/hubspot-sdk-typescript/tree/main/packages/mcp-server#readme", - "license": "Apache-2.0", - "packageManager": "yarn@1.22.22", - "private": false, - "publishConfig": { - "access": "public" - }, - "scripts": { - "test": "jest", - "build": "bash ./build", - "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1", - "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1", - "format": "prettier --write --cache --cache-strategy metadata . !dist", - "prepare": "npm run build", - "tsn": "ts-node -r tsconfig-paths/register", - "lint": "eslint .", - "fix": "eslint --fix ." - }, - "dependencies": { - "@hubspot/sdk": "link:../../dist/", - "ajv": "^8.18.0", - "@cloudflare/cabidela": "^0.2.4", - "@hono/node-server": "^1.19.10", - "@modelcontextprotocol/sdk": "^1.27.1", - "hono": "^4.12.4", - "@valtown/deno-http-worker": "^0.0.21", - "cookie-parser": "^1.4.6", - "cors": "^2.8.5", - "express": "^5.1.0", - "fuse.js": "^7.1.0", - "minisearch": "^7.2.0", - "jq-web": "https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz", - "pino": "^10.3.1", - "pino-http": "^11.0.0", - "pino-pretty": "^13.1.3", - "qs": "^6.14.1", - "typescript": "5.8.3", - "yargs": "^17.7.2", - "zod": "^3.25.20", - "zod-to-json-schema": "^3.24.5", - "zod-validation-error": "^4.0.1" - }, - "bin": { - "mcp-server": "dist/index.js" - }, - "devDependencies": { - "@anthropic-ai/mcpb": "^2.1.2", - "@types/cookie-parser": "^1.4.10", - "@types/cors": "^2.8.19", - "@types/express": "^5.0.3", - "@types/jest": "^29.4.0", - "@types/qs": "^6.14.0", - "@types/yargs": "^17.0.8", - "@typescript-eslint/eslint-plugin": "8.31.1", - "@typescript-eslint/parser": "8.31.1", - "eslint": "^9.39.1", - "eslint-plugin-prettier": "^5.4.1", - "eslint-plugin-unused-imports": "^4.1.4", - "jest": "^29.4.0", - "prettier": "^3.0.0", - "ts-jest": "^29.1.0", - "ts-morph": "^19.0.0", - "ts-node": "^10.5.0", - "tsc-multi": "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz", - "tsconfig-paths": "^4.0.0" - }, - "imports": { - "@hubspot/sdk-mcp": ".", - "@hubspot/sdk-mcp/*": "./src/*" - }, - "exports": { - ".": { - "require": "./dist/index.js", - "default": "./dist/index.mjs" - }, - "./*.mjs": "./dist/*.mjs", - "./*.js": "./dist/*.js", - "./*": { - "require": "./dist/*.js", - "default": "./dist/*.mjs" - } - } -} diff --git a/packages/mcp-server/scripts/copy-bundle-files.cjs b/packages/mcp-server/scripts/copy-bundle-files.cjs deleted file mode 100644 index 59570277..00000000 --- a/packages/mcp-server/scripts/copy-bundle-files.cjs +++ /dev/null @@ -1,36 +0,0 @@ -const fs = require('fs'); -const path = require('path'); -const pkgJson = require('../dist-bundle/package.json'); - -const distDir = path.resolve(__dirname, '..', 'dist'); -const distBundleDir = path.resolve(__dirname, '..', 'dist-bundle'); -const distBundlePkgJson = path.join(distBundleDir, 'package.json'); - -async function* walk(dir) { - for await (const d of await fs.promises.opendir(dir)) { - const entry = path.join(dir, d.name); - if (d.isDirectory()) yield* walk(entry); - else if (d.isFile()) yield entry; - } -} - -async function copyFiles() { - // copy runtime files - for await (const file of walk(distDir)) { - if (!/[cm]?js$/.test(file)) continue; - const dest = path.join(distBundleDir, path.relative(distDir, file)); - await fs.promises.mkdir(path.dirname(dest), { recursive: true }); - await fs.promises.copyFile(file, dest); - } - - // replace package.json reference with local reference - for (const dep in pkgJson.dependencies) { - if (dep === '@hubspot/sdk') { - pkgJson.dependencies[dep] = 'file:../../../dist/'; - } - } - - await fs.promises.writeFile(distBundlePkgJson, JSON.stringify(pkgJson, null, 2)); -} - -copyFiles(); diff --git a/packages/mcp-server/scripts/postprocess-dist-package-json.cjs b/packages/mcp-server/scripts/postprocess-dist-package-json.cjs deleted file mode 100644 index ad835747..00000000 --- a/packages/mcp-server/scripts/postprocess-dist-package-json.cjs +++ /dev/null @@ -1,12 +0,0 @@ -const fs = require('fs'); -const pkgJson = require('../dist/package.json'); -const parentPkgJson = require('../../../package.json'); - -for (const dep in pkgJson.dependencies) { - // ensure we point to NPM instead of a local directory - if (dep === '@hubspot/sdk') { - pkgJson.dependencies[dep] = '^' + parentPkgJson.version; - } -} - -fs.writeFileSync('dist/package.json', JSON.stringify(pkgJson, null, 2)); diff --git a/packages/mcp-server/src/auth.ts b/packages/mcp-server/src/auth.ts deleted file mode 100644 index 0b286326..00000000 --- a/packages/mcp-server/src/auth.ts +++ /dev/null @@ -1,38 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { IncomingMessage } from 'node:http'; -import { ClientOptions } from '@hubspot/sdk'; -import { McpOptions } from './options'; - -export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { - if (req.headers.authorization) { - const scheme = req.headers.authorization.split(' ')[0]!; - const value = req.headers.authorization.slice(scheme.length + 1); - switch (scheme) { - case 'Bearer': - return { accessToken: req.headers.authorization.slice('Bearer '.length) }; - default: - throw new Error( - 'Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer).', - ); - } - } else if (required) { - throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); - } - - return {}; -}; - -export const getStainlessApiKey = (req: IncomingMessage, mcpOptions: McpOptions): string | undefined => { - // Try to get the key from the x-stainless-api-key header - const headerKey = - Array.isArray(req.headers['x-stainless-api-key']) ? - req.headers['x-stainless-api-key'][0] - : req.headers['x-stainless-api-key']; - if (headerKey && typeof headerKey === 'string') { - return headerKey; - } - - // Fall back to value set in the mcpOptions (e.g. from environment variable), if provided - return mcpOptions.stainlessApiKey; -}; diff --git a/packages/mcp-server/src/code-tool-paths.cts b/packages/mcp-server/src/code-tool-paths.cts deleted file mode 100644 index 78263e45..00000000 --- a/packages/mcp-server/src/code-tool-paths.cts +++ /dev/null @@ -1,5 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -export function getWorkerPath(): string { - return require.resolve('./code-tool-worker.mjs'); -} diff --git a/packages/mcp-server/src/code-tool-types.ts b/packages/mcp-server/src/code-tool-types.ts deleted file mode 100644 index 45f914ff..00000000 --- a/packages/mcp-server/src/code-tool-types.ts +++ /dev/null @@ -1,17 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { ClientOptions } from '@hubspot/sdk'; - -export type WorkerInput = { - project_name: string; - code: string; - client_opts: ClientOptions; - intent?: string | undefined; -}; - -export type WorkerOutput = { - is_error: boolean; - result: unknown | null; - log_lines: string[]; - err_lines: string[]; -}; diff --git a/packages/mcp-server/src/code-tool-worker.ts b/packages/mcp-server/src/code-tool-worker.ts deleted file mode 100644 index 34779168..00000000 --- a/packages/mcp-server/src/code-tool-worker.ts +++ /dev/null @@ -1,1260 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import path from 'node:path'; -import util from 'node:util'; -import Fuse from 'fuse.js'; -import ts from 'typescript'; -import { WorkerOutput } from './code-tool-types'; -import { HubSpot, ClientOptions } from '@hubspot/sdk'; - -async function tseval(code: string) { - return import('data:application/typescript;charset=utf-8;base64,' + Buffer.from(code).toString('base64')); -} - -function getRunFunctionSource(code: string): { - type: 'declaration' | 'expression'; - client: string | undefined; - code: string; -} | null { - const sourceFile = ts.createSourceFile('code.ts', code, ts.ScriptTarget.Latest, true); - const printer = ts.createPrinter(); - - for (const statement of sourceFile.statements) { - // Check for top-level function declarations - if (ts.isFunctionDeclaration(statement)) { - if (statement.name?.text === 'run') { - return { - type: 'declaration', - client: statement.parameters[0]?.name.getText(), - code: printer.printNode(ts.EmitHint.Unspecified, statement.body!, sourceFile), - }; - } - } - - // Check for variable declarations: const run = () => {} or const run = function() {} - if (ts.isVariableStatement(statement)) { - for (const declaration of statement.declarationList.declarations) { - if ( - ts.isIdentifier(declaration.name) && - declaration.name.text === 'run' && - // Check if it's initialized with a function - declaration.initializer && - (ts.isFunctionExpression(declaration.initializer) || ts.isArrowFunction(declaration.initializer)) - ) { - return { - type: 'expression', - client: declaration.initializer.parameters[0]?.name.getText(), - code: printer.printNode(ts.EmitHint.Unspecified, declaration.initializer, sourceFile), - }; - } - } - } - } - - return null; -} - -function getTSDiagnostics(code: string): string[] { - const functionSource = getRunFunctionSource(code)!; - const codeWithImport = [ - 'import { HubSpot } from "@hubspot/sdk";', - functionSource.type === 'declaration' ? - `async function run(${functionSource.client}: HubSpot)` - : `const run: (${functionSource.client}: HubSpot) => Promise =`, - functionSource.code, - ].join('\n'); - const sourcePath = path.resolve('code.ts'); - const ast = ts.createSourceFile(sourcePath, codeWithImport, ts.ScriptTarget.Latest, true); - const options = ts.getDefaultCompilerOptions(); - options.target = ts.ScriptTarget.Latest; - options.module = ts.ModuleKind.NodeNext; - options.moduleResolution = ts.ModuleResolutionKind.NodeNext; - const host = ts.createCompilerHost(options, true); - const newHost: typeof host = { - ...host, - getSourceFile: (...args) => { - if (path.resolve(args[0]) === sourcePath) { - return ast; - } - return host.getSourceFile(...args); - }, - readFile: (...args) => { - if (path.resolve(args[0]) === sourcePath) { - return codeWithImport; - } - return host.readFile(...args); - }, - fileExists: (...args) => { - if (path.resolve(args[0]) === sourcePath) { - return true; - } - return host.fileExists(...args); - }, - }; - const program = ts.createProgram({ - options, - rootNames: [sourcePath], - host: newHost, - }); - const diagnostics = ts.getPreEmitDiagnostics(program, ast); - return diagnostics.map((d) => { - const message = ts.flattenDiagnosticMessageText(d.messageText, '\n'); - if (!d.file || !d.start) return `- ${message}`; - const { line: lineNumber } = ts.getLineAndCharacterOfPosition(d.file, d.start); - const line = codeWithImport.split('\n').at(lineNumber)?.trim(); - return line ? `- ${message}\n ${line}` : `- ${message}`; - }); -} - -const fuse = new Fuse( - [ - 'client.account.get', - 'client.account.getDailyPrivateAppsUsage', - 'client.account.activity.listAuditLogs', - 'client.account.activity.listLoginActivities', - 'client.account.activity.listSecurityActivities', - 'client.auth.oauth.createToken', - 'client.auth.oauth.introspectToken', - 'client.auth.oauth.revokeToken', - 'client.automation.actions.callbacks.complete', - 'client.automation.actions.callbacks.completeBatch', - 'client.automation.actions.definitions.create', - 'client.automation.actions.definitions.createRequiresObject', - 'client.automation.actions.definitions.delete', - 'client.automation.actions.definitions.get', - 'client.automation.actions.definitions.getRequiresObject', - 'client.automation.actions.definitions.list', - 'client.automation.actions.definitions.update', - 'client.automation.actions.functions.createOrReplace', - 'client.automation.actions.functions.createOrReplaceByFunctionType', - 'client.automation.actions.functions.delete', - 'client.automation.actions.functions.deleteByFunctionType', - 'client.automation.actions.functions.get', - 'client.automation.actions.functions.getByFunctionType', - 'client.automation.actions.functions.list', - 'client.automation.actions.revisions.get', - 'client.automation.actions.revisions.list', - 'client.automation.sequences.createEnrollment', - 'client.automation.sequences.get', - 'client.automation.sequences.getEnrollmentByContactID', - 'client.automation.sequences.list', - 'client.businessUnits.businessUnitEntries.getByUserID', - 'client.cms.auditLogs.export', - 'client.cms.auditLogs.list', - 'client.cms.blogs.authors.attachToLangGroup', - 'client.cms.blogs.authors.create', - 'client.cms.blogs.authors.createLanguageVariation', - 'client.cms.blogs.authors.delete', - 'client.cms.blogs.authors.detachFromLangGroup', - 'client.cms.blogs.authors.get', - 'client.cms.blogs.authors.getCursor', - 'client.cms.blogs.authors.getCursorByQuery', - 'client.cms.blogs.authors.getPostsCursor', - 'client.cms.blogs.authors.getPostsCursorByQuery', - 'client.cms.blogs.authors.getTagsCursor', - 'client.cms.blogs.authors.getTagsCursorByQuery', - 'client.cms.blogs.authors.list', - 'client.cms.blogs.authors.setNewLangPrimary', - 'client.cms.blogs.authors.update', - 'client.cms.blogs.authors.updateLanguages', - 'client.cms.blogs.authors.batch.create', - 'client.cms.blogs.authors.batch.delete', - 'client.cms.blogs.authors.batch.get', - 'client.cms.blogs.authors.batch.update', - 'client.cms.blogs.posts.clone', - 'client.cms.blogs.posts.create', - 'client.cms.blogs.posts.delete', - 'client.cms.blogs.posts.get', - 'client.cms.blogs.posts.getDraftByID', - 'client.cms.blogs.posts.list', - 'client.cms.blogs.posts.listAuthors', - 'client.cms.blogs.posts.listTags', - 'client.cms.blogs.posts.pushLive', - 'client.cms.blogs.posts.query', - 'client.cms.blogs.posts.queryAuthors', - 'client.cms.blogs.posts.queryTags', - 'client.cms.blogs.posts.resetDraft', - 'client.cms.blogs.posts.schedule', - 'client.cms.blogs.posts.update', - 'client.cms.blogs.posts.updateDraft', - 'client.cms.blogs.posts.batch.create', - 'client.cms.blogs.posts.batch.delete', - 'client.cms.blogs.posts.batch.get', - 'client.cms.blogs.posts.batch.update', - 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', - 'client.cms.blogs.posts.multiLanguage.createLangVariation', - 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', - 'client.cms.blogs.posts.multiLanguage.setLangPrimary', - 'client.cms.blogs.posts.multiLanguage.updateLangs', - 'client.cms.blogs.posts.revisions.getPreviousVersion', - 'client.cms.blogs.posts.revisions.getPreviousVersions', - 'client.cms.blogs.posts.revisions.restorePreviousVersion', - 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', - 'client.cms.blogs.settings.get', - 'client.cms.blogs.settings.getRevision', - 'client.cms.blogs.settings.list', - 'client.cms.blogs.settings.listRevisions', - 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', - 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', - 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', - 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', - 'client.cms.blogs.settings.multiLanguage.updateLanguages', - 'client.cms.blogs.tags.attachToLangGroup', - 'client.cms.blogs.tags.create', - 'client.cms.blogs.tags.createLangVariation', - 'client.cms.blogs.tags.delete', - 'client.cms.blogs.tags.detachFromLangGroup', - 'client.cms.blogs.tags.get', - 'client.cms.blogs.tags.list', - 'client.cms.blogs.tags.listAuthorsCursor', - 'client.cms.blogs.tags.listAuthorsCursorByQuery', - 'client.cms.blogs.tags.listCursor', - 'client.cms.blogs.tags.listCursorByQuery', - 'client.cms.blogs.tags.listPostsCursor', - 'client.cms.blogs.tags.listPostsCursorByQuery', - 'client.cms.blogs.tags.setLangPrimary', - 'client.cms.blogs.tags.update', - 'client.cms.blogs.tags.updateLangs', - 'client.cms.blogs.tags.batch.createBatch', - 'client.cms.blogs.tags.batch.delete', - 'client.cms.blogs.tags.batch.getBatch', - 'client.cms.blogs.tags.batch.updateBatch', - 'client.cms.domains.get', - 'client.cms.domains.list', - 'client.cms.hubdb.rows.cloneBatch', - 'client.cms.hubdb.rows.cloneDraft', - 'client.cms.hubdb.rows.create', - 'client.cms.hubdb.rows.createBatch', - 'client.cms.hubdb.rows.deleteDraft', - 'client.cms.hubdb.rows.get', - 'client.cms.hubdb.rows.getBatch', - 'client.cms.hubdb.rows.getDraft', - 'client.cms.hubdb.rows.getDraftBatch', - 'client.cms.hubdb.rows.list', - 'client.cms.hubdb.rows.purgeBatch', - 'client.cms.hubdb.rows.replaceBatch', - 'client.cms.hubdb.rows.replaceDraft', - 'client.cms.hubdb.rows.updateBatch', - 'client.cms.hubdb.rows.updateDraft', - 'client.cms.hubdb.tables.cloneDraft', - 'client.cms.hubdb.tables.create', - 'client.cms.hubdb.tables.delete', - 'client.cms.hubdb.tables.deleteVersion', - 'client.cms.hubdb.tables.export', - 'client.cms.hubdb.tables.exportDraft', - 'client.cms.hubdb.tables.get', - 'client.cms.hubdb.tables.getDraft', - 'client.cms.hubdb.tables.importDraft', - 'client.cms.hubdb.tables.list', - 'client.cms.hubdb.tables.listDraft', - 'client.cms.hubdb.tables.publishDraft', - 'client.cms.hubdb.tables.resetDraft', - 'client.cms.hubdb.tables.unpublish', - 'client.cms.hubdb.tables.updateDraft', - 'client.cms.mediaBridge.createAssociation', - 'client.cms.mediaBridge.createAttentionSpanEvent', - 'client.cms.mediaBridge.createMediaPlayedEvent', - 'client.cms.mediaBridge.createMediaPlayedPercentEvent', - 'client.cms.mediaBridge.createObjectType', - 'client.cms.mediaBridge.createOembedDomain', - 'client.cms.mediaBridge.createProperty', - 'client.cms.mediaBridge.createPropertyGroup', - 'client.cms.mediaBridge.createVideoAssociationDefinition', - 'client.cms.mediaBridge.deleteAssociation', - 'client.cms.mediaBridge.deleteOembedDomain', - 'client.cms.mediaBridge.deleteProperty', - 'client.cms.mediaBridge.deletePropertyGroup', - 'client.cms.mediaBridge.getEventVisibilitySettings', - 'client.cms.mediaBridge.getOembedDomain', - 'client.cms.mediaBridge.getProperty', - 'client.cms.mediaBridge.getPropertyGroup', - 'client.cms.mediaBridge.getSchema', - 'client.cms.mediaBridge.listObjectTypesByMediaType', - 'client.cms.mediaBridge.listOembedDomains', - 'client.cms.mediaBridge.listProperties', - 'client.cms.mediaBridge.listPropertyGroups', - 'client.cms.mediaBridge.listSchemas', - 'client.cms.mediaBridge.registerAppName', - 'client.cms.mediaBridge.updateEventVisibilitySettings', - 'client.cms.mediaBridge.updateOembedDomain', - 'client.cms.mediaBridge.updateProperty', - 'client.cms.mediaBridge.updatePropertyGroup', - 'client.cms.mediaBridge.updateSchema', - 'client.cms.mediaBridge.updateSettings', - 'client.cms.mediaBridge.batch.create', - 'client.cms.mediaBridge.batch.delete', - 'client.cms.mediaBridge.batch.get', - 'client.cms.pages.landingPages.clone', - 'client.cms.pages.landingPages.create', - 'client.cms.pages.landingPages.delete', - 'client.cms.pages.landingPages.get', - 'client.cms.pages.landingPages.list', - 'client.cms.pages.landingPages.schedule', - 'client.cms.pages.landingPages.update', - 'client.cms.pages.landingPages.abTest.createLandingPageVariation', - 'client.cms.pages.landingPages.abTest.endLandingPageTest', - 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', - 'client.cms.pages.landingPages.batch.createLandingPages', - 'client.cms.pages.landingPages.batch.deleteLandingPages', - 'client.cms.pages.landingPages.batch.getLandingPages', - 'client.cms.pages.landingPages.batch.updateLandingPages', - 'client.cms.pages.landingPages.draft.get', - 'client.cms.pages.landingPages.draft.pushLive', - 'client.cms.pages.landingPages.draft.reset', - 'client.cms.pages.landingPages.draft.update', - 'client.cms.pages.landingPages.folders.batchGet', - 'client.cms.pages.landingPages.folders.create', - 'client.cms.pages.landingPages.folders.createFolders', - 'client.cms.pages.landingPages.folders.delete', - 'client.cms.pages.landingPages.folders.deleteFolders', - 'client.cms.pages.landingPages.folders.get', - 'client.cms.pages.landingPages.folders.getRevision', - 'client.cms.pages.landingPages.folders.list', - 'client.cms.pages.landingPages.folders.listRevisions', - 'client.cms.pages.landingPages.folders.restoreRevision', - 'client.cms.pages.landingPages.folders.update', - 'client.cms.pages.landingPages.folders.updateFolders', - 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', - 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', - 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', - 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', - 'client.cms.pages.landingPages.multiLanguage.updateLanguages', - 'client.cms.pages.landingPages.revisions.getLandingPageRevision', - 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', - 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', - 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', - 'client.cms.pages.sitePages.clone', - 'client.cms.pages.sitePages.create', - 'client.cms.pages.sitePages.delete', - 'client.cms.pages.sitePages.get', - 'client.cms.pages.sitePages.list', - 'client.cms.pages.sitePages.schedule', - 'client.cms.pages.sitePages.update', - 'client.cms.pages.sitePages.abTest.createSitePageVariation', - 'client.cms.pages.sitePages.abTest.endSitePageTest', - 'client.cms.pages.sitePages.abTest.rerunSitePageTest', - 'client.cms.pages.sitePages.batch.createSitePages', - 'client.cms.pages.sitePages.batch.deleteSitePages', - 'client.cms.pages.sitePages.batch.getSitePages', - 'client.cms.pages.sitePages.batch.updateSitePages', - 'client.cms.pages.sitePages.draft.getDraft', - 'client.cms.pages.sitePages.draft.publishDraft', - 'client.cms.pages.sitePages.draft.resetSitePageDraft', - 'client.cms.pages.sitePages.draft.updateDraft', - 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', - 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', - 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', - 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', - 'client.cms.pages.sitePages.multiLanguage.updateLanguages', - 'client.cms.pages.sitePages.revisions.getSitePageRevision', - 'client.cms.pages.sitePages.revisions.listSitePageRevisions', - 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', - 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', - 'client.cms.siteSearch.getIndexedData', - 'client.cms.sourceCode.extractAsync', - 'client.cms.sourceCode.getExtractionStatus', - 'client.cms.urlMappings.create', - 'client.cms.urlMappings.delete', - 'client.cms.urlMappings.get', - 'client.cms.urlMappings.list', - 'client.cms.urlRedirects.create', - 'client.cms.urlRedirects.delete', - 'client.cms.urlRedirects.get', - 'client.cms.urlRedirects.list', - 'client.cms.urlRedirects.update', - 'client.communicationPreferences.generateLinks', - 'client.communicationPreferences.getStatuses', - 'client.communicationPreferences.getUnsubscribeAllStatus', - 'client.communicationPreferences.unsubscribeAll', - 'client.communicationPreferences.updateStatus', - 'client.communicationPreferences.definitions.list', - 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', - 'client.communicationPreferences.statuses.batch.read', - 'client.communicationPreferences.statuses.batch.unsubscribeAll', - 'client.communicationPreferences.statuses.batch.updateStatuses', - 'client.conversations.customChannels.create', - 'client.conversations.customChannels.delete', - 'client.conversations.customChannels.get', - 'client.conversations.customChannels.list', - 'client.conversations.customChannels.update', - 'client.conversations.customChannels.channelAccounts.create', - 'client.conversations.customChannels.channelAccounts.list', - 'client.conversations.customChannels.channelAccounts.update', - 'client.conversations.customChannels.channelAccounts.updateStagingToken', - 'client.conversations.customChannels.messages.create', - 'client.conversations.customChannels.messages.get', - 'client.conversations.customChannels.messages.update', - 'client.conversations.visitorIdentification.generateToken', - 'client.crm.appUninstalls.uninstall', - 'client.crm.associations.create', - 'client.crm.associations.delete', - 'client.crm.associations.list', - 'client.crm.associations.requestHighUsageReport', - 'client.crm.associations.search', - 'client.crm.associations.updateLabels', - 'client.crm.associations.batch.create', - 'client.crm.associations.batch.createDefault', - 'client.crm.associations.batch.delete', - 'client.crm.associations.batch.deleteLabels', - 'client.crm.associations.batch.get', - 'client.crm.associationsSchema.labels.batchCreate', - 'client.crm.associationsSchema.labels.createLabel', - 'client.crm.associationsSchema.labels.deleteLabel', - 'client.crm.associationsSchema.labels.listLabels', - 'client.crm.associationsSchema.labels.updateLabel', - 'client.crm.associationsSchema.limits.batchDelete', - 'client.crm.associationsSchema.limits.batchUpdate', - 'client.crm.associationsSchema.limits.getByObjectTypes', - 'client.crm.associationsSchema.limits.list', - 'client.crm.dealSplits.batch.read', - 'client.crm.dealSplits.batch.upsert', - 'client.crm.exports.createAsync', - 'client.crm.exports.get', - 'client.crm.exports.getStatus', - 'client.crm.extensions.calling.createChannelConnectionSettings', - 'client.crm.extensions.calling.createInboundCall', - 'client.crm.extensions.calling.createRecordingReady', - 'client.crm.extensions.calling.createRecordingSettings', - 'client.crm.extensions.calling.createSettings', - 'client.crm.extensions.calling.deleteChannelConnectionSettings', - 'client.crm.extensions.calling.deleteSettings', - 'client.crm.extensions.calling.getChannelConnectionSettings', - 'client.crm.extensions.calling.getRecordingSettings', - 'client.crm.extensions.calling.getSettings', - 'client.crm.extensions.calling.updateChannelConnectionSettings', - 'client.crm.extensions.calling.updateRecordingSettings', - 'client.crm.extensions.calling.updateSettings', - 'client.crm.extensions.calling.transcripts.create', - 'client.crm.extensions.calling.transcripts.createInboundCall', - 'client.crm.extensions.calling.transcripts.delete', - 'client.crm.extensions.calling.transcripts.get', - 'client.crm.extensions.cardsDev.create', - 'client.crm.extensions.cardsDev.delete', - 'client.crm.extensions.cardsDev.get', - 'client.crm.extensions.cardsDev.getByID', - 'client.crm.extensions.cardsDev.getSampleResponse', - 'client.crm.extensions.cardsDev.migrateViews', - 'client.crm.extensions.cardsDev.update', - 'client.crm.extensions.videoConferencing.delete', - 'client.crm.extensions.videoConferencing.get', - 'client.crm.extensions.videoConferencing.update', - 'client.crm.featureFlags.delete', - 'client.crm.featureFlags.deletePortalState', - 'client.crm.featureFlags.get', - 'client.crm.featureFlags.getPortalState', - 'client.crm.featureFlags.listAll', - 'client.crm.featureFlags.listPortals', - 'client.crm.featureFlags.update', - 'client.crm.featureFlags.updatePortalState', - 'client.crm.featureFlags.batch.delete', - 'client.crm.featureFlags.batch.upsert', - 'client.crm.imports.cancel', - 'client.crm.imports.create', - 'client.crm.imports.get', - 'client.crm.imports.list', - 'client.crm.imports.listErrors', - 'client.crm.limits.getAssociationLabelLimits', - 'client.crm.limits.getAssociationRecordsLimitsByObjectType', - 'client.crm.limits.getAssociationRecordsLimitsFromObjects', - 'client.crm.limits.getAssociationRecordsLimitsToObjects', - 'client.crm.limits.getCalculatedPropertyLimits', - 'client.crm.limits.getCustomObjectTypeLimits', - 'client.crm.limits.getCustomPropertyLimits', - 'client.crm.limits.getPipelineLimits', - 'client.crm.limits.getRecordLimits', - 'client.crm.lists.addAndRemoveMemberships', - 'client.crm.lists.addMemberships', - 'client.crm.lists.addMembershipsFrom', - 'client.crm.lists.batchReadMemberships', - 'client.crm.lists.create', - 'client.crm.lists.createFolder', - 'client.crm.lists.createIDMapping', - 'client.crm.lists.delete', - 'client.crm.lists.deleteFolder', - 'client.crm.lists.deleteMemberships', - 'client.crm.lists.get', - 'client.crm.lists.getByObjectTypeAndName', - 'client.crm.lists.getIDMapping', - 'client.crm.lists.getMembershipsJoinOrder', - 'client.crm.lists.getRecordMemberships', - 'client.crm.lists.getScheduleConversion', - 'client.crm.lists.getSizeAndEditsHistoryBetween', - 'client.crm.lists.list', - 'client.crm.lists.listBySearch', - 'client.crm.lists.listFolders', - 'client.crm.lists.listMemberships', - 'client.crm.lists.moveFolder', - 'client.crm.lists.moveList', - 'client.crm.lists.removeMemberships', - 'client.crm.lists.renameFolder', - 'client.crm.lists.restore', - 'client.crm.lists.scheduleConversion', - 'client.crm.lists.updateListFilters', - 'client.crm.lists.updateListName', - 'client.crm.lists.updateScheduleConversion', - 'client.crm.objectLibrary.enablement.getAll', - 'client.crm.objectLibrary.enablement.getByObjectTypeID', - 'client.crm.objectSchemas.create', - 'client.crm.objectSchemas.createAssociation', - 'client.crm.objectSchemas.delete', - 'client.crm.objectSchemas.deleteAssociation', - 'client.crm.objectSchemas.get', - 'client.crm.objectSchemas.list', - 'client.crm.objectSchemas.update', - 'client.crm.objectSchemas.batch.get', - 'client.crm.objects.calls.create', - 'client.crm.objects.calls.delete', - 'client.crm.objects.calls.get', - 'client.crm.objects.calls.list', - 'client.crm.objects.calls.search', - 'client.crm.objects.calls.update', - 'client.crm.objects.calls.batch.create', - 'client.crm.objects.calls.batch.delete', - 'client.crm.objects.calls.batch.get', - 'client.crm.objects.calls.batch.update', - 'client.crm.objects.calls.batch.upsert', - 'client.crm.objects.carts.create', - 'client.crm.objects.carts.delete', - 'client.crm.objects.carts.get', - 'client.crm.objects.carts.list', - 'client.crm.objects.carts.search', - 'client.crm.objects.carts.update', - 'client.crm.objects.carts.batch.create', - 'client.crm.objects.carts.batch.delete', - 'client.crm.objects.carts.batch.get', - 'client.crm.objects.carts.batch.update', - 'client.crm.objects.carts.batch.upsert', - 'client.crm.objects.commercePayments.create', - 'client.crm.objects.commercePayments.delete', - 'client.crm.objects.commercePayments.get', - 'client.crm.objects.commercePayments.list', - 'client.crm.objects.commercePayments.search', - 'client.crm.objects.commercePayments.update', - 'client.crm.objects.commercePayments.batch.create', - 'client.crm.objects.commercePayments.batch.delete', - 'client.crm.objects.commercePayments.batch.get', - 'client.crm.objects.commercePayments.batch.update', - 'client.crm.objects.commercePayments.batch.upsert', - 'client.crm.objects.communications.create', - 'client.crm.objects.communications.delete', - 'client.crm.objects.communications.get', - 'client.crm.objects.communications.list', - 'client.crm.objects.communications.search', - 'client.crm.objects.communications.update', - 'client.crm.objects.communications.batch.create', - 'client.crm.objects.communications.batch.delete', - 'client.crm.objects.communications.batch.get', - 'client.crm.objects.communications.batch.update', - 'client.crm.objects.communications.batch.upsert', - 'client.crm.objects.companies.create', - 'client.crm.objects.companies.delete', - 'client.crm.objects.companies.get', - 'client.crm.objects.companies.list', - 'client.crm.objects.companies.merge', - 'client.crm.objects.companies.search', - 'client.crm.objects.companies.update', - 'client.crm.objects.companies.batch.create', - 'client.crm.objects.companies.batch.delete', - 'client.crm.objects.companies.batch.get', - 'client.crm.objects.companies.batch.update', - 'client.crm.objects.companies.batch.upsert', - 'client.crm.objects.contacts.create', - 'client.crm.objects.contacts.delete', - 'client.crm.objects.contacts.gdprDelete', - 'client.crm.objects.contacts.get', - 'client.crm.objects.contacts.list', - 'client.crm.objects.contacts.merge', - 'client.crm.objects.contacts.search', - 'client.crm.objects.contacts.update', - 'client.crm.objects.contacts.batch.create', - 'client.crm.objects.contacts.batch.delete', - 'client.crm.objects.contacts.batch.get', - 'client.crm.objects.contacts.batch.update', - 'client.crm.objects.contacts.batch.upsert', - 'client.crm.objects.contracts.get', - 'client.crm.objects.contracts.list', - 'client.crm.objects.contracts.batch.get', - 'client.crm.objects.courses.create', - 'client.crm.objects.courses.delete', - 'client.crm.objects.courses.get', - 'client.crm.objects.courses.list', - 'client.crm.objects.courses.search', - 'client.crm.objects.courses.update', - 'client.crm.objects.courses.batch.create', - 'client.crm.objects.courses.batch.delete', - 'client.crm.objects.courses.batch.get', - 'client.crm.objects.courses.batch.update', - 'client.crm.objects.courses.batch.upsert', - 'client.crm.objects.custom.create', - 'client.crm.objects.custom.delete', - 'client.crm.objects.custom.get', - 'client.crm.objects.custom.list', - 'client.crm.objects.custom.merge', - 'client.crm.objects.custom.search', - 'client.crm.objects.custom.update', - 'client.crm.objects.custom.batch.create', - 'client.crm.objects.custom.batch.delete', - 'client.crm.objects.custom.batch.get', - 'client.crm.objects.custom.batch.update', - 'client.crm.objects.custom.batch.upsert', - 'client.crm.objects.deals.create', - 'client.crm.objects.deals.delete', - 'client.crm.objects.deals.get', - 'client.crm.objects.deals.list', - 'client.crm.objects.deals.merge', - 'client.crm.objects.deals.search', - 'client.crm.objects.deals.update', - 'client.crm.objects.deals.batch.create', - 'client.crm.objects.deals.batch.delete', - 'client.crm.objects.deals.batch.get', - 'client.crm.objects.deals.batch.update', - 'client.crm.objects.deals.batch.upsert', - 'client.crm.objects.discounts.create', - 'client.crm.objects.discounts.delete', - 'client.crm.objects.discounts.get', - 'client.crm.objects.discounts.list', - 'client.crm.objects.discounts.search', - 'client.crm.objects.discounts.update', - 'client.crm.objects.discounts.batch.create', - 'client.crm.objects.discounts.batch.delete', - 'client.crm.objects.discounts.batch.get', - 'client.crm.objects.discounts.batch.update', - 'client.crm.objects.discounts.batch.upsert', - 'client.crm.objects.emails.create', - 'client.crm.objects.emails.delete', - 'client.crm.objects.emails.get', - 'client.crm.objects.emails.list', - 'client.crm.objects.emails.search', - 'client.crm.objects.emails.update', - 'client.crm.objects.emails.batch.create', - 'client.crm.objects.emails.batch.delete', - 'client.crm.objects.emails.batch.get', - 'client.crm.objects.emails.batch.update', - 'client.crm.objects.emails.batch.upsert', - 'client.crm.objects.feedbackSubmissions.get', - 'client.crm.objects.feedbackSubmissions.list', - 'client.crm.objects.feedbackSubmissions.search', - 'client.crm.objects.feedbackSubmissions.batch.get', - 'client.crm.objects.fees.create', - 'client.crm.objects.fees.delete', - 'client.crm.objects.fees.get', - 'client.crm.objects.fees.list', - 'client.crm.objects.fees.search', - 'client.crm.objects.fees.update', - 'client.crm.objects.fees.batch.create', - 'client.crm.objects.fees.batch.delete', - 'client.crm.objects.fees.batch.get', - 'client.crm.objects.fees.batch.update', - 'client.crm.objects.fees.batch.upsert', - 'client.crm.objects.genericObjects.create', - 'client.crm.objects.genericObjects.delete', - 'client.crm.objects.genericObjects.get', - 'client.crm.objects.genericObjects.list', - 'client.crm.objects.genericObjects.search', - 'client.crm.objects.genericObjects.update', - 'client.crm.objects.genericObjects.batch.create', - 'client.crm.objects.genericObjects.batch.delete', - 'client.crm.objects.genericObjects.batch.get', - 'client.crm.objects.genericObjects.batch.update', - 'client.crm.objects.genericObjects.batch.upsert', - 'client.crm.objects.goalTargets.create', - 'client.crm.objects.goalTargets.delete', - 'client.crm.objects.goalTargets.get', - 'client.crm.objects.goalTargets.list', - 'client.crm.objects.goalTargets.search', - 'client.crm.objects.goalTargets.update', - 'client.crm.objects.goalTargets.batch.create', - 'client.crm.objects.goalTargets.batch.delete', - 'client.crm.objects.goalTargets.batch.get', - 'client.crm.objects.goalTargets.batch.update', - 'client.crm.objects.goalTargets.batch.upsert', - 'client.crm.objects.invoices.create', - 'client.crm.objects.invoices.delete', - 'client.crm.objects.invoices.get', - 'client.crm.objects.invoices.list', - 'client.crm.objects.invoices.search', - 'client.crm.objects.invoices.update', - 'client.crm.objects.invoices.batch.create', - 'client.crm.objects.invoices.batch.delete', - 'client.crm.objects.invoices.batch.get', - 'client.crm.objects.invoices.batch.update', - 'client.crm.objects.invoices.batch.upsert', - 'client.crm.objects.leads.create', - 'client.crm.objects.leads.delete', - 'client.crm.objects.leads.get', - 'client.crm.objects.leads.list', - 'client.crm.objects.leads.search', - 'client.crm.objects.leads.update', - 'client.crm.objects.leads.batch.create', - 'client.crm.objects.leads.batch.delete', - 'client.crm.objects.leads.batch.get', - 'client.crm.objects.leads.batch.update', - 'client.crm.objects.leads.batch.upsert', - 'client.crm.objects.lineItems.create', - 'client.crm.objects.lineItems.delete', - 'client.crm.objects.lineItems.get', - 'client.crm.objects.lineItems.list', - 'client.crm.objects.lineItems.search', - 'client.crm.objects.lineItems.update', - 'client.crm.objects.lineItems.batch.create', - 'client.crm.objects.lineItems.batch.delete', - 'client.crm.objects.lineItems.batch.get', - 'client.crm.objects.lineItems.batch.update', - 'client.crm.objects.lineItems.batch.upsert', - 'client.crm.objects.listings.create', - 'client.crm.objects.listings.delete', - 'client.crm.objects.listings.get', - 'client.crm.objects.listings.list', - 'client.crm.objects.listings.search', - 'client.crm.objects.listings.update', - 'client.crm.objects.listings.batch.create', - 'client.crm.objects.listings.batch.delete', - 'client.crm.objects.listings.batch.get', - 'client.crm.objects.listings.batch.update', - 'client.crm.objects.listings.batch.upsert', - 'client.crm.objects.meetings.create', - 'client.crm.objects.meetings.delete', - 'client.crm.objects.meetings.get', - 'client.crm.objects.meetings.list', - 'client.crm.objects.meetings.search', - 'client.crm.objects.meetings.update', - 'client.crm.objects.meetings.batch.create', - 'client.crm.objects.meetings.batch.delete', - 'client.crm.objects.meetings.batch.get', - 'client.crm.objects.meetings.batch.update', - 'client.crm.objects.meetings.batch.upsert', - 'client.crm.objects.notes.create', - 'client.crm.objects.notes.delete', - 'client.crm.objects.notes.get', - 'client.crm.objects.notes.list', - 'client.crm.objects.notes.search', - 'client.crm.objects.notes.update', - 'client.crm.objects.notes.batch.create', - 'client.crm.objects.notes.batch.delete', - 'client.crm.objects.notes.batch.get', - 'client.crm.objects.notes.batch.update', - 'client.crm.objects.notes.batch.upsert', - 'client.crm.objects.orders.create', - 'client.crm.objects.orders.delete', - 'client.crm.objects.orders.get', - 'client.crm.objects.orders.list', - 'client.crm.objects.orders.search', - 'client.crm.objects.orders.update', - 'client.crm.objects.orders.batch.create', - 'client.crm.objects.orders.batch.delete', - 'client.crm.objects.orders.batch.get', - 'client.crm.objects.orders.batch.update', - 'client.crm.objects.orders.batch.upsert', - 'client.crm.objects.partnerClients.get', - 'client.crm.objects.partnerClients.list', - 'client.crm.objects.partnerClients.listAssociations', - 'client.crm.objects.partnerClients.search', - 'client.crm.objects.partnerClients.update', - 'client.crm.objects.partnerClients.batch.get', - 'client.crm.objects.partnerClients.batch.update', - 'client.crm.objects.partnerServices.get', - 'client.crm.objects.partnerServices.list', - 'client.crm.objects.partnerServices.search', - 'client.crm.objects.partnerServices.update', - 'client.crm.objects.partnerServices.batch.get', - 'client.crm.objects.partnerServices.batch.update', - 'client.crm.objects.postalMail.create', - 'client.crm.objects.postalMail.delete', - 'client.crm.objects.postalMail.get', - 'client.crm.objects.postalMail.list', - 'client.crm.objects.postalMail.search', - 'client.crm.objects.postalMail.update', - 'client.crm.objects.postalMail.batch.create', - 'client.crm.objects.postalMail.batch.delete', - 'client.crm.objects.postalMail.batch.get', - 'client.crm.objects.postalMail.batch.update', - 'client.crm.objects.postalMail.batch.upsert', - 'client.crm.objects.products.create', - 'client.crm.objects.products.delete', - 'client.crm.objects.products.get', - 'client.crm.objects.products.list', - 'client.crm.objects.products.search', - 'client.crm.objects.products.update', - 'client.crm.objects.products.batch.create', - 'client.crm.objects.products.batch.delete', - 'client.crm.objects.products.batch.get', - 'client.crm.objects.products.batch.update', - 'client.crm.objects.products.batch.upsert', - 'client.crm.objects.projects.create', - 'client.crm.objects.projects.delete', - 'client.crm.objects.projects.get', - 'client.crm.objects.projects.list', - 'client.crm.objects.projects.merge', - 'client.crm.objects.projects.search', - 'client.crm.objects.projects.update', - 'client.crm.objects.projects.batch.create', - 'client.crm.objects.projects.batch.delete', - 'client.crm.objects.projects.batch.get', - 'client.crm.objects.projects.batch.update', - 'client.crm.objects.projects.batch.upsert', - 'client.crm.objects.quotes.create', - 'client.crm.objects.quotes.delete', - 'client.crm.objects.quotes.get', - 'client.crm.objects.quotes.list', - 'client.crm.objects.quotes.search', - 'client.crm.objects.quotes.update', - 'client.crm.objects.quotes.batch.create', - 'client.crm.objects.quotes.batch.delete', - 'client.crm.objects.quotes.batch.get', - 'client.crm.objects.quotes.batch.update', - 'client.crm.objects.quotes.batch.upsert', - 'client.crm.objects.services.create', - 'client.crm.objects.services.delete', - 'client.crm.objects.services.get', - 'client.crm.objects.services.list', - 'client.crm.objects.services.search', - 'client.crm.objects.services.update', - 'client.crm.objects.services.batch.create', - 'client.crm.objects.services.batch.delete', - 'client.crm.objects.services.batch.get', - 'client.crm.objects.services.batch.update', - 'client.crm.objects.services.batch.upsert', - 'client.crm.objects.subscriptions.create', - 'client.crm.objects.subscriptions.delete', - 'client.crm.objects.subscriptions.get', - 'client.crm.objects.subscriptions.list', - 'client.crm.objects.subscriptions.search', - 'client.crm.objects.subscriptions.update', - 'client.crm.objects.subscriptions.batch.create', - 'client.crm.objects.subscriptions.batch.delete', - 'client.crm.objects.subscriptions.batch.get', - 'client.crm.objects.subscriptions.batch.update', - 'client.crm.objects.subscriptions.batch.upsert', - 'client.crm.objects.tasks.create', - 'client.crm.objects.tasks.delete', - 'client.crm.objects.tasks.get', - 'client.crm.objects.tasks.list', - 'client.crm.objects.tasks.search', - 'client.crm.objects.tasks.update', - 'client.crm.objects.tasks.batch.create', - 'client.crm.objects.tasks.batch.delete', - 'client.crm.objects.tasks.batch.get', - 'client.crm.objects.tasks.batch.update', - 'client.crm.objects.tasks.batch.upsert', - 'client.crm.objects.taxes.create', - 'client.crm.objects.taxes.delete', - 'client.crm.objects.taxes.get', - 'client.crm.objects.taxes.list', - 'client.crm.objects.taxes.search', - 'client.crm.objects.taxes.update', - 'client.crm.objects.taxes.batch.create', - 'client.crm.objects.taxes.batch.delete', - 'client.crm.objects.taxes.batch.get', - 'client.crm.objects.taxes.batch.update', - 'client.crm.objects.taxes.batch.upsert', - 'client.crm.objects.tickets.create', - 'client.crm.objects.tickets.delete', - 'client.crm.objects.tickets.get', - 'client.crm.objects.tickets.list', - 'client.crm.objects.tickets.merge', - 'client.crm.objects.tickets.search', - 'client.crm.objects.tickets.update', - 'client.crm.objects.tickets.batch.create', - 'client.crm.objects.tickets.batch.delete', - 'client.crm.objects.tickets.batch.get', - 'client.crm.objects.tickets.batch.update', - 'client.crm.objects.tickets.batch.upsert', - 'client.crm.objects.users.create', - 'client.crm.objects.users.delete', - 'client.crm.objects.users.get', - 'client.crm.objects.users.list', - 'client.crm.objects.users.search', - 'client.crm.objects.users.update', - 'client.crm.objects.users.batch.create', - 'client.crm.objects.users.batch.delete', - 'client.crm.objects.users.batch.get', - 'client.crm.objects.users.batch.update', - 'client.crm.objects.users.batch.upsert', - 'client.crm.owners.get', - 'client.crm.owners.list', - 'client.crm.pipelines.create', - 'client.crm.pipelines.createStage', - 'client.crm.pipelines.delete', - 'client.crm.pipelines.deleteStage', - 'client.crm.pipelines.get', - 'client.crm.pipelines.getStage', - 'client.crm.pipelines.list', - 'client.crm.pipelines.listAudit', - 'client.crm.pipelines.listStageAudit', - 'client.crm.pipelines.listStages', - 'client.crm.pipelines.update', - 'client.crm.pipelines.updateAllProperties', - 'client.crm.pipelines.updateStage', - 'client.crm.pipelines.updateStageAllProperties', - 'client.crm.properties.create', - 'client.crm.properties.delete', - 'client.crm.properties.get', - 'client.crm.properties.list', - 'client.crm.properties.update', - 'client.crm.properties.batch.create', - 'client.crm.properties.batch.delete', - 'client.crm.properties.batch.get', - 'client.crm.properties.groups.create', - 'client.crm.properties.groups.delete', - 'client.crm.properties.groups.get', - 'client.crm.properties.groups.list', - 'client.crm.properties.groups.update', - 'client.crm.propertiesValidations.getByObjectTypeID', - 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', - 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', - 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', - 'client.crm.timeline.createEvent', - 'client.crm.timeline.createProjectType', - 'client.crm.timeline.batch.create', - 'client.events.definitions.create', - 'client.events.definitions.createProperty', - 'client.events.definitions.delete', - 'client.events.definitions.deleteProperty', - 'client.events.definitions.get', - 'client.events.definitions.list', - 'client.events.definitions.sendBatch', - 'client.events.definitions.update', - 'client.events.definitions.updateProperty', - 'client.events.occurrences.list', - 'client.events.occurrences.listEventTypes', - 'client.events.send.batchSend', - 'client.events.send.send', - 'client.files.fileAssets.create', - 'client.files.fileAssets.delete', - 'client.files.fileAssets.gdprDelete', - 'client.files.fileAssets.get', - 'client.files.fileAssets.getImportTaskStatus', - 'client.files.fileAssets.getSignedURL', - 'client.files.fileAssets.importFromURLAsync', - 'client.files.fileAssets.replace', - 'client.files.fileAssets.search', - 'client.files.fileAssets.update', - 'client.files.fileAssets.upload', - 'client.files.folders.deleteByID', - 'client.files.folders.deleteByPath', - 'client.files.folders.getByID', - 'client.files.folders.getByPath', - 'client.files.folders.getUpdateAsyncStatus', - 'client.files.folders.search', - 'client.files.folders.updateAsyncByID', - 'client.files.folders.updateByID', - 'client.marketing.campaigns.create', - 'client.marketing.campaigns.delete', - 'client.marketing.campaigns.get', - 'client.marketing.campaigns.list', - 'client.marketing.campaigns.update', - 'client.marketing.campaigns.assets.delete', - 'client.marketing.campaigns.assets.list', - 'client.marketing.campaigns.assets.update', - 'client.marketing.campaigns.batch.create', - 'client.marketing.campaigns.batch.delete', - 'client.marketing.campaigns.batch.get', - 'client.marketing.campaigns.batch.update', - 'client.marketing.campaigns.budget.create', - 'client.marketing.campaigns.budget.delete', - 'client.marketing.campaigns.budget.get', - 'client.marketing.campaigns.budget.getTotals', - 'client.marketing.campaigns.budget.update', - 'client.marketing.campaigns.metrics.getAttributionMetrics', - 'client.marketing.campaigns.metrics.getRevenueAttribution', - 'client.marketing.campaigns.metrics.listContactIDsByType', - 'client.marketing.campaigns.spend.create', - 'client.marketing.campaigns.spend.delete', - 'client.marketing.campaigns.spend.get', - 'client.marketing.campaigns.spend.update', - 'client.marketing.emails.clone', - 'client.marketing.emails.create', - 'client.marketing.emails.createAbTestVariation', - 'client.marketing.emails.delete', - 'client.marketing.emails.get', - 'client.marketing.emails.getAbTestVariation', - 'client.marketing.emails.getDraft', - 'client.marketing.emails.getHistogram', - 'client.marketing.emails.getRevision', - 'client.marketing.emails.list', - 'client.marketing.emails.listRevisions', - 'client.marketing.emails.publish', - 'client.marketing.emails.resetDraft', - 'client.marketing.emails.restoreRevision', - 'client.marketing.emails.restoreRevisionToDraft', - 'client.marketing.emails.unpublish', - 'client.marketing.emails.update', - 'client.marketing.emails.updateDraft', - 'client.marketing.marketingEvents.create', - 'client.marketing.marketingEvents.delete', - 'client.marketing.marketingEvents.deleteBatch', - 'client.marketing.marketingEvents.deleteBatchByExternalEventID', - 'client.marketing.marketingEvents.deleteByExternalEventID', - 'client.marketing.marketingEvents.get', - 'client.marketing.marketingEvents.getByExternalEventID', - 'client.marketing.marketingEvents.list', - 'client.marketing.marketingEvents.searchByExternalEventID', - 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', - 'client.marketing.marketingEvents.update', - 'client.marketing.marketingEvents.updateBatch', - 'client.marketing.marketingEvents.updateByExternalEventID', - 'client.marketing.marketingEvents.upsertBatch', - 'client.marketing.marketingEvents.upsertByExternalEventID', - 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', - 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', - 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', - 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', - 'client.marketing.marketingEvents.events.cancelByExternalEventID', - 'client.marketing.marketingEvents.events.completeByExternalEventID', - 'client.marketing.marketingEvents.listAssociations.associate', - 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', - 'client.marketing.marketingEvents.listAssociations.delete', - 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', - 'client.marketing.marketingEvents.listAssociations.list', - 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', - 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', - 'client.marketing.marketingEvents.participations.getByID', - 'client.marketing.marketingEvents.participations.listBreakdownByContact', - 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', - 'client.marketing.marketingEvents.participations.listBreakdownByID', - 'client.marketing.marketingEvents.settings.createOrUpdate', - 'client.marketing.marketingEvents.settings.get', - 'client.marketing.marketingEvents.subscriberState.recordByEmail', - 'client.marketing.marketingEvents.subscriberState.recordByID', - 'client.marketing.singleSend.create', - 'client.marketing.transactional.singleEmail.send', - 'client.marketing.transactional.smtpTokens.create', - 'client.marketing.transactional.smtpTokens.delete', - 'client.marketing.transactional.smtpTokens.get', - 'client.marketing.transactional.smtpTokens.list', - 'client.marketing.transactional.smtpTokens.resetPassword', - 'client.meta.origins.ipRanges.list', - 'client.meta.origins.ipRanges.listSimple', - 'client.scheduler.meetings.advanced.book', - 'client.scheduler.meetings.advanced.create', - 'client.scheduler.meetings.basic.getAvailabilityBySlug', - 'client.scheduler.meetings.basic.getBookingInfoBySlug', - 'client.scheduler.meetings.basic.list', - 'client.settings.currencies.getCompanyCurrency', - 'client.settings.currencies.listCodes', - 'client.settings.currencies.updateCompanyCurrency', - 'client.settings.currencies.centralFxRates.createCurrency', - 'client.settings.currencies.centralFxRates.getInformation', - 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', - 'client.settings.currencies.exchangeRates.createExchangeRate', - 'client.settings.currencies.exchangeRates.getExchangeRateByID', - 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', - 'client.settings.currencies.exchangeRates.listExchangeRates', - 'client.settings.currencies.exchangeRates.updateExchangeRate', - 'client.settings.currencies.exchangeRates.updateVisibility', - 'client.settings.currencies.exchangeRates.batch.create', - 'client.settings.currencies.exchangeRates.batch.get', - 'client.settings.currencies.exchangeRates.batch.update', - 'client.settings.taxRates.get', - 'client.settings.taxRates.list', - 'client.settings.users.create', - 'client.settings.users.delete', - 'client.settings.users.get', - 'client.settings.users.list', - 'client.settings.users.listRoles', - 'client.settings.users.listTeams', - 'client.settings.users.update', - 'client.webhooks.createBatchEventSubscriptions', - 'client.webhooks.createCrmSnapshots', - 'client.webhooks.createEventSubscription', - 'client.webhooks.createJournalSubscription', - 'client.webhooks.createSubscriptionFilter', - 'client.webhooks.deleteEventSubscription', - 'client.webhooks.deleteJournalSubscription', - 'client.webhooks.deleteJournalSubscriptionForPortal', - 'client.webhooks.deleteSettings', - 'client.webhooks.deleteSubscriptionFilter', - 'client.webhooks.getEarliestJournalBatch', - 'client.webhooks.getEarliestJournalEntry', - 'client.webhooks.getEarliestLocalJournalBatch', - 'client.webhooks.getEarliestLocalJournalEntry', - 'client.webhooks.getEventSubscription', - 'client.webhooks.getJournalBatchByRequest', - 'client.webhooks.getJournalBatchFromOffset', - 'client.webhooks.getJournalStatus', - 'client.webhooks.getJournalSubscription', - 'client.webhooks.getLatestJournalBatch', - 'client.webhooks.getLatestJournalEntry', - 'client.webhooks.getLatestLocalJournalBatch', - 'client.webhooks.getLatestLocalJournalEntry', - 'client.webhooks.getLocalJournalBatchByRequest', - 'client.webhooks.getLocalJournalBatchFromOffset', - 'client.webhooks.getLocalJournalStatus', - 'client.webhooks.getNextJournalEntries', - 'client.webhooks.getNextLocalJournalEntries', - 'client.webhooks.getSettings', - 'client.webhooks.getSubscriptionFilter', - 'client.webhooks.listEventSubscriptions', - 'client.webhooks.listJournalSubscriptions', - 'client.webhooks.listSubscriptionFilters', - 'client.webhooks.updateEventSubscription', - 'client.webhooks.updateSettings', - ], - { threshold: 1, shouldSort: true }, -); - -function getMethodSuggestions(fullyQualifiedMethodName: string): string[] { - return fuse - .search(fullyQualifiedMethodName) - .map(({ item }) => item) - .slice(0, 5); -} - -const proxyToObj = new WeakMap(); -const objToProxy = new WeakMap(); - -type ClientProxyConfig = { - path: string[]; - isBelievedBad?: boolean; -}; - -function makeSdkProxy(obj: T, { path, isBelievedBad = false }: ClientProxyConfig): T { - let proxy: T = objToProxy.get(obj); - - if (!proxy) { - proxy = new Proxy(obj, { - get(target, prop, receiver) { - const propPath = [...path, String(prop)]; - const value = Reflect.get(target, prop, receiver); - - if (isBelievedBad || (!(prop in target) && value === undefined)) { - // If we're accessing a path that doesn't exist, it will probably eventually error. - // Let's proxy it and mark it bad so that we can control the error message. - // We proxy an empty class so that an invocation or construction attempt is possible. - return makeSdkProxy(class {}, { path: propPath, isBelievedBad: true }); - } - - if (value !== null && (typeof value === 'object' || typeof value === 'function')) { - return makeSdkProxy(value, { path: propPath, isBelievedBad }); - } - - return value; - }, - - apply(target, thisArg, args) { - if (isBelievedBad || typeof target !== 'function') { - const fullyQualifiedMethodName = path.join('.'); - const suggestions = getMethodSuggestions(fullyQualifiedMethodName); - throw new Error( - `${fullyQualifiedMethodName} is not a function. Did you mean: ${suggestions.join(', ')}`, - ); - } - - return Reflect.apply(target, proxyToObj.get(thisArg) ?? thisArg, args); - }, - - construct(target, args, newTarget) { - if (isBelievedBad || typeof target !== 'function') { - const fullyQualifiedMethodName = path.join('.'); - const suggestions = getMethodSuggestions(fullyQualifiedMethodName); - throw new Error( - `${fullyQualifiedMethodName} is not a constructor. Did you mean: ${suggestions.join(', ')}`, - ); - } - - return Reflect.construct(target, args, newTarget); - }, - }); - - objToProxy.set(obj, proxy); - proxyToObj.set(proxy, obj); - } - - return proxy; -} - -function parseError(code: string, error: unknown): string | undefined { - if (!(error instanceof Error)) return; - const cause = error.cause instanceof Error ? `: ${error.cause.message}` : ''; - const message = error.name ? `${error.name}: ${error.message}${cause}` : `${error.message}${cause}`; - try { - // Deno uses V8; the first ":LINE:COLUMN" is the top of stack. - const lineNumber = error.stack?.match(/:([0-9]+):[0-9]+/)?.[1]; - // -1 for the zero-based indexing - const line = - lineNumber && - code - .split('\n') - .at(parseInt(lineNumber, 10) - 1) - ?.trim(); - return line ? `${message}\n at line ${lineNumber}\n ${line}` : message; - } catch { - return message; - } -} - -const fetch = async (req: Request): Promise => { - const { opts, code } = (await req.json()) as { opts: ClientOptions; code: string }; - - const runFunctionSource = code ? getRunFunctionSource(code) : null; - if (!runFunctionSource) { - const message = - code ? - 'The code is missing a top-level `run` function.' - : 'The code argument is missing. Provide one containing a top-level `run` function.'; - return Response.json( - { - is_error: true, - result: `${message} Write code within this template:\n\n\`\`\`\nasync function run(client) {\n // Fill this out\n}\n\`\`\``, - log_lines: [], - err_lines: [], - } satisfies WorkerOutput, - { status: 400, statusText: 'Code execution error' }, - ); - } - - const diagnostics = getTSDiagnostics(code); - if (diagnostics.length > 0) { - return Response.json( - { - is_error: true, - result: `The code contains TypeScript diagnostics:\n${diagnostics.join('\n')}`, - log_lines: [], - err_lines: [], - } satisfies WorkerOutput, - { status: 400, statusText: 'Code execution error' }, - ); - } - - const client = new HubSpot({ - ...opts, - }); - - const log_lines: string[] = []; - const err_lines: string[] = []; - const originalConsole = globalThis.console; - globalThis.console = { - ...originalConsole, - log: (...args: unknown[]) => { - log_lines.push(util.format(...args)); - }, - error: (...args: unknown[]) => { - err_lines.push(util.format(...args)); - }, - }; - try { - let run_ = async (client: any) => {}; - run_ = (await tseval(`${code}\nexport default run;`)).default; - const result = await run_(makeSdkProxy(client, { path: ['client'] })); - return Response.json({ - is_error: false, - result, - log_lines, - err_lines, - } satisfies WorkerOutput); - } catch (e) { - return Response.json( - { - is_error: true, - result: parseError(code, e), - log_lines, - err_lines, - } satisfies WorkerOutput, - { status: 400, statusText: 'Code execution error' }, - ); - } finally { - globalThis.console = originalConsole; - } -}; - -export default { fetch }; diff --git a/packages/mcp-server/src/code-tool.ts b/packages/mcp-server/src/code-tool.ts deleted file mode 100644 index 94d68968..00000000 --- a/packages/mcp-server/src/code-tool.ts +++ /dev/null @@ -1,392 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { - ContentBlock, - McpRequestContext, - McpTool, - Metadata, - ToolCallResult, - asErrorResult, - asTextContentResult, -} from './types'; -import { Tool } from '@modelcontextprotocol/sdk/types.js'; -import { readEnv } from './util'; -import { WorkerInput, WorkerOutput } from './code-tool-types'; -import { getLogger } from './logger'; -import { SdkMethod } from './methods'; -import { McpCodeExecutionMode } from './options'; -import { ClientOptions } from '@hubspot/sdk'; - -const prompt = `Runs JavaScript code to interact with the HubSpot API. - -You are a skilled TypeScript programmer writing code to interface with the service. -Define an async function named "run" that takes a single parameter of an initialized SDK client and it will be run. -For example: - -\`\`\` -async function run(client) { - const result = await client.crm.objects.contacts.get('contactId'); - - console.log(result.id); -} -\`\`\` - -You will be returned anything that your function returns, plus the results of any console.log statements. -Do not add try-catch blocks for single API calls. The tool will handle errors for you. -Do not add comments unless necessary for generating better code. -Code will run in a container, and cannot interact with the network outside of the given SDK client. -Variables will not persist between calls, so make sure to return or log any data you might need later. -Remember that you are writing TypeScript code, so you need to be careful with your types. -Always type dynamic key-value stores explicitly as Record instead of {}.`; - -/** - * A tool that runs code against a copy of the SDK. - * - * Instead of exposing every endpoint as its own tool, which uses up too many tokens for LLMs to use at once, - * we expose a single tool that can be used to search for endpoints by name, resource, operation, or tag, and then - * a generic endpoint that can be used to invoke any endpoint with the provided arguments. - * - * @param blockedMethods - The methods to block for code execution. Blocking is done by simple string - * matching, so it is not secure against obfuscation. For stronger security, block in the downstream API - * with limited API keys. - * @param codeExecutionMode - Whether to execute code in a local Deno environment or in a remote - * sandbox environment hosted by Stainless. - */ -export function codeTool({ - blockedMethods, - codeExecutionMode, -}: { - blockedMethods: SdkMethod[] | undefined; - codeExecutionMode: McpCodeExecutionMode; -}): McpTool { - const metadata: Metadata = { resource: 'all', operation: 'write', tags: [] }; - const tool: Tool = { - name: 'execute', - description: prompt, - inputSchema: { - type: 'object', - properties: { - code: { - type: 'string', - description: 'Code to execute.', - }, - intent: { - type: 'string', - description: 'Task you are trying to perform. Used for improving the service.', - }, - }, - required: ['code'], - }, - }; - - const logger = getLogger(); - - const handler = async ({ - reqContext, - args, - }: { - reqContext: McpRequestContext; - args: any; - }): Promise => { - const code = args.code as string; - // Do very basic blocking of code that includes forbidden method names. - // - // WARNING: This is not secure against obfuscation and other evasion methods. If - // stronger security blocks are required, then these should be enforced in the downstream - // API (e.g., by having users call the MCP server with API keys with limited permissions). - if (blockedMethods) { - const blockedMatches = blockedMethods.filter((method) => code.includes(method.fullyQualifiedName)); - if (blockedMatches.length > 0) { - return asErrorResult( - `The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches - .map((m) => m.fullyQualifiedName) - .join(', ')}`, - ); - } - } - - let result: ToolCallResult; - const startTime = Date.now(); - - if (codeExecutionMode === 'local') { - logger.debug('Executing code in local Deno environment'); - result = await localDenoHandler({ reqContext, args }); - } else { - logger.debug('Executing code in remote Stainless environment'); - result = await remoteStainlessHandler({ reqContext, args }); - } - - logger.info( - { - codeExecutionMode, - durationMs: Date.now() - startTime, - isError: result.isError, - contentRows: result.content?.length ?? 0, - }, - 'Got code tool execution result', - ); - return result; - }; - - return { metadata, tool, handler }; -} - -const remoteStainlessHandler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: any; -}): Promise => { - const code = args.code as string; - const intent = args.intent as string | undefined; - const client = reqContext.client; - - const codeModeEndpoint = readEnv('CODE_MODE_ENDPOINT_URL') ?? 'https://api.stainless.com/api/ai/code-tool'; - - const localClientEnvs = { HUBSPOT_BASE_URL: readEnv('HUBSPOT_BASE_URL') ?? client.baseURL ?? undefined }; - // Merge any upstream client envs from the request header, with upstream values taking precedence. - const mergedClientEnvs = { ...localClientEnvs, ...reqContext.upstreamClientEnvs }; - - // Setting a Stainless API key authenticates requests to the code tool endpoint. - const res = await fetch(codeModeEndpoint, { - method: 'POST', - headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), - 'Content-Type': 'application/json', - 'x-stainless-mcp-client-envs': JSON.stringify(mergedClientEnvs), - }, - body: JSON.stringify({ - project_name: 'hubspot-sdk', - code, - intent, - client_opts: { - accessToken: readEnv('HUBSPOT_ACCESS_TOKEN'), - developerAPIKey: readEnv('HUBSPOT_DEVELOPER_API_KEY'), - }, - } satisfies WorkerInput), - }); - - if (!res.ok) { - if (res.status === 404 && !reqContext.stainlessApiKey) { - throw new Error( - 'Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', - ); - } - throw new Error( - `${res.status}: ${ - res.statusText - } error when trying to contact Code Tool server. Details: ${await res.text()}`, - ); - } - - const { is_error, result, log_lines, err_lines } = (await res.json()) as WorkerOutput; - const hasLogs = log_lines.length > 0 || err_lines.length > 0; - const output = { - result, - ...(log_lines.length > 0 && { log_lines }), - ...(err_lines.length > 0 && { err_lines }), - }; - if (is_error) { - return asErrorResult(typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2)); - } - return asTextContentResult(output); -}; - -const localDenoHandler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: unknown; -}): Promise => { - const fs = await import('node:fs'); - const path = await import('node:path'); - const url = await import('node:url'); - const { newDenoHTTPWorker } = await import('@valtown/deno-http-worker'); - const { getWorkerPath } = await import('./code-tool-paths.cjs'); - const workerPath = getWorkerPath(); - - const client = reqContext.client; - const baseURLHostname = new URL(client.baseURL).hostname; - const { code } = args as { code: string }; - - let denoPath: string; - - const packageRoot = path.resolve(path.dirname(workerPath), '..'); - const packageNodeModulesPath = path.resolve(packageRoot, 'node_modules'); - - // Check if deno is in PATH - const { execSync } = await import('node:child_process'); - try { - execSync('command -v deno', { stdio: 'ignore' }); - denoPath = 'deno'; - } catch { - try { - // Use deno binary in node_modules if it's found - const denoNodeModulesPath = path.resolve(packageNodeModulesPath, 'deno', 'bin.cjs'); - await fs.promises.access(denoNodeModulesPath, fs.constants.X_OK); - denoPath = denoNodeModulesPath; - } catch { - return asErrorResult( - 'Deno is required for code execution but was not found. ' + - 'Install it from https://deno.land or run: npm install deno', - ); - } - } - - const allowReadPaths = [ - 'code-tool-worker.mjs', - `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, '$1')}/`, - packageRoot, - ]; - - // Follow symlinks in node_modules to allow read access to workspace-linked packages - try { - const sdkPkgName = '@hubspot/sdk'; - const sdkDir = path.resolve(packageNodeModulesPath, sdkPkgName); - const realSdkDir = fs.realpathSync(sdkDir); - if (realSdkDir !== sdkDir) { - allowReadPaths.push(realSdkDir); - } - } catch { - // Ignore if symlink resolution fails - } - - const allowRead = allowReadPaths.join(','); - - const worker = await newDenoHTTPWorker(url.pathToFileURL(workerPath), { - denoExecutable: denoPath, - runFlags: [ - `--node-modules-dir=manual`, - `--allow-read=${allowRead}`, - `--allow-net=${baseURLHostname}`, - // Allow environment variables because instantiating the client will try to read from them, - // even though they are not set. - '--allow-env', - ], - printOutput: true, - spawnOptions: { - cwd: path.dirname(workerPath), - // Merge any upstream client envs into the Deno subprocess environment, - // with the upstream env vars taking precedence. - env: { ...process.env, ...reqContext.upstreamClientEnvs }, - }, - }); - - try { - const resp = await new Promise((resolve, reject) => { - worker.addEventListener('exit', (exitCode) => { - reject(new Error(`Worker exited with code ${exitCode}`)); - }); - - // Strip null/undefined values so that the worker SDK client can fall back to - // reading from environment variables (including any upstreamClientEnvs). - const opts = { - ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), - ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), - ...(client.developerAPIKey != null ? { developerAPIKey: client.developerAPIKey } : undefined), - defaultHeaders: { - 'X-Stainless-MCP': 'true', - }, - } satisfies Partial as ClientOptions; - - const req = worker.request( - 'http://localhost', - { - headers: { - 'content-type': 'application/json', - }, - method: 'POST', - }, - (resp) => { - const body: Uint8Array[] = []; - resp.on('error', (err) => { - reject(err); - }); - resp.on('data', (chunk) => { - body.push(chunk); - }); - resp.on('end', () => { - resolve( - new Response(Buffer.concat(body).toString(), { - status: resp.statusCode ?? 200, - headers: resp.headers as any, - }), - ); - }); - }, - ); - - const body = JSON.stringify({ - opts, - code, - }); - - req.write(body, (err) => { - if (err != null) { - reject(err); - } - }); - - req.end(); - }); - - if (resp.status === 200) { - const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; - const returnOutput: ContentBlock | null = - result == null ? null : ( - { - type: 'text', - text: typeof result === 'string' ? result : JSON.stringify(result), - } - ); - const logOutput: ContentBlock | null = - log_lines.length === 0 ? - null - : { - type: 'text', - text: log_lines.join('\n'), - }; - const errOutput: ContentBlock | null = - err_lines.length === 0 ? - null - : { - type: 'text', - text: 'Error output:\n' + err_lines.join('\n'), - }; - return { - content: [returnOutput, logOutput, errOutput].filter((block) => block !== null), - }; - } else { - const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; - const messageOutput: ContentBlock | null = - result == null ? null : ( - { - type: 'text', - text: typeof result === 'string' ? result : JSON.stringify(result), - } - ); - const logOutput: ContentBlock | null = - log_lines.length === 0 ? - null - : { - type: 'text', - text: log_lines.join('\n'), - }; - const errOutput: ContentBlock | null = - err_lines.length === 0 ? - null - : { - type: 'text', - text: 'Error output:\n' + err_lines.join('\n'), - }; - return { - content: [messageOutput, logOutput, errOutput].filter((block) => block !== null), - isError: true, - }; - } - } finally { - worker.terminate(); - } -}; diff --git a/packages/mcp-server/src/docs-search-tool.ts b/packages/mcp-server/src/docs-search-tool.ts deleted file mode 100644 index fbdd6332..00000000 --- a/packages/mcp-server/src/docs-search-tool.ts +++ /dev/null @@ -1,138 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { Tool } from '@modelcontextprotocol/sdk/types.js'; -import { Metadata, McpRequestContext, asTextContentResult } from './types'; -import { getLogger } from './logger'; -import type { LocalDocsSearch } from './local-docs-search'; - -export const metadata: Metadata = { - resource: 'all', - operation: 'read', - tags: [], - httpMethod: 'get', -}; - -export const tool: Tool = { - name: 'search_docs', - description: - 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', - inputSchema: { - type: 'object', - properties: { - query: { - type: 'string', - description: 'The query to search for.', - }, - language: { - type: 'string', - description: 'The language for the SDK to search for.', - enum: ['http', 'python', 'go', 'typescript', 'javascript', 'terraform', 'ruby', 'java', 'kotlin'], - }, - detail: { - type: 'string', - description: 'The amount of detail to return.', - enum: ['default', 'verbose'], - }, - }, - required: ['query', 'language'], - }, - annotations: { - readOnlyHint: true, - }, -}; - -const docsSearchURL = - process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/hubspot-sdk/docs/search'; - -let _localSearch: LocalDocsSearch | undefined; - -export function setLocalSearch(search: LocalDocsSearch): void { - _localSearch = search; -} - -async function searchLocal(args: Record): Promise { - if (!_localSearch) { - throw new Error('Local search not initialized'); - } - - const query = (args['query'] as string) ?? ''; - const language = (args['language'] as string) ?? 'typescript'; - const detail = (args['detail'] as string) ?? 'default'; - - return _localSearch.search({ - query, - language, - detail, - maxResults: 10, - }).results; -} - -async function searchRemote(args: Record, reqContext: McpRequestContext): Promise { - const body = args as any; - const query = new URLSearchParams(body).toString(); - - const startTime = Date.now(); - const result = await fetch(`${docsSearchURL}?${query}`, { - headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), - ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), - ...(reqContext.mcpClientInfo && { - 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo), - }), - }, - }); - - const logger = getLogger(); - - if (!result.ok) { - const errorText = await result.text(); - logger.warn( - { - durationMs: Date.now() - startTime, - query: body.query, - status: result.status, - statusText: result.statusText, - errorText, - }, - 'Got error response from docs search tool', - ); - - if (result.status === 404 && !reqContext.stainlessApiKey) { - throw new Error( - 'Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', - ); - } - - throw new Error( - `${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`, - ); - } - - const resultBody = await result.json(); - logger.info( - { - durationMs: Date.now() - startTime, - query: body.query, - }, - 'Got docs search result', - ); - return resultBody; -} - -export const handler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: Record | undefined; -}) => { - const body = args ?? {}; - - if (_localSearch) { - return asTextContentResult(await searchLocal(body)); - } - - return asTextContentResult(await searchRemote(body, reqContext)); -}; - -export default { metadata, tool, handler }; diff --git a/packages/mcp-server/src/http.ts b/packages/mcp-server/src/http.ts deleted file mode 100644 index 524a4800..00000000 --- a/packages/mcp-server/src/http.ts +++ /dev/null @@ -1,227 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { McpServer } from '@modelcontextprotocol/sdk/server/mcp'; -import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'; -import { ClientOptions } from '@hubspot/sdk'; -import express from 'express'; -import pino from 'pino'; -import pinoHttp from 'pino-http'; -import { getStainlessApiKey, parseClientAuthHeaders } from './auth'; -import { getLogger } from './logger'; -import { McpOptions } from './options'; -import { initMcpServer, newMcpServer } from './server'; - -const newServer = async ({ - clientOptions, - mcpOptions, - req, - res, -}: { - clientOptions: ClientOptions; - mcpOptions: McpOptions; - req: express.Request; - res: express.Response; -}): Promise => { - const stainlessApiKey = getStainlessApiKey(req, mcpOptions); - const customInstructionsPath = mcpOptions.customInstructionsPath; - const server = await newMcpServer({ stainlessApiKey, customInstructionsPath }); - - const authOptions = parseClientAuthHeaders(req, false); - - let upstreamClientEnvs: Record | undefined; - const clientEnvsHeader = req.headers['x-stainless-mcp-client-envs']; - if (typeof clientEnvsHeader === 'string') { - try { - const parsed = JSON.parse(clientEnvsHeader); - if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) { - upstreamClientEnvs = parsed; - } - } catch { - // Ignore malformed header - } - } - - // Parse x-stainless-mcp-client-permissions header to override permission options - // - // Note: Permissions are best-effort and intended to prevent clients from doing unexpected things; - // they're not a hard security boundary, so we allow arbitrary, client-driven overrides. - // - // See the Stainless MCP documentation for more details. - let effectiveMcpOptions = mcpOptions; - const clientPermissionsHeader = req.headers['x-stainless-mcp-client-permissions']; - if (typeof clientPermissionsHeader === 'string') { - try { - const parsed = JSON.parse(clientPermissionsHeader); - if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) { - effectiveMcpOptions = { - ...mcpOptions, - ...(typeof parsed.allow_http_gets === 'boolean' && { codeAllowHttpGets: parsed.allow_http_gets }), - ...(Array.isArray(parsed.allowed_methods) && { codeAllowedMethods: parsed.allowed_methods }), - ...(Array.isArray(parsed.blocked_methods) && { codeBlockedMethods: parsed.blocked_methods }), - }; - getLogger().info( - { clientPermissions: parsed }, - 'Overriding code execution permissions from x-stainless-mcp-client-permissions header', - ); - } - } catch (error) { - getLogger().warn({ error }, 'Failed to parse x-stainless-mcp-client-permissions header'); - } - } - - const mcpClientInfo = - typeof req.body?.params?.clientInfo?.name === 'string' ? - { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } - : undefined; - - await initMcpServer({ - server: server, - mcpOptions: effectiveMcpOptions, - clientOptions: { - ...clientOptions, - ...authOptions, - }, - stainlessApiKey: stainlessApiKey, - upstreamClientEnvs, - mcpSessionId: (req as any).mcpSessionId, - mcpClientInfo, - }); - - if (mcpClientInfo) { - getLogger().info({ mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, 'MCP client connected'); - } - - return server; -}; - -const post = - (options: { clientOptions: ClientOptions; mcpOptions: McpOptions }) => - async (req: express.Request, res: express.Response) => { - const server = await newServer({ ...options, req, res }); - // If we return null, we already set the authorization error. - if (server === null) return; - const transport = new StreamableHTTPServerTransport(); - await server.connect(transport as any); - await transport.handleRequest(req, res, req.body); - }; - -const get = async (req: express.Request, res: express.Response) => { - res.status(405).json({ - jsonrpc: '2.0', - error: { - code: -32000, - message: 'Method not supported', - }, - }); -}; - -const del = async (req: express.Request, res: express.Response) => { - res.status(405).json({ - jsonrpc: '2.0', - error: { - code: -32000, - message: 'Method not supported', - }, - }); -}; - -const redactHeaders = (headers: Record) => { - const hiddenHeaders = /auth|cookie|key|token|x-stainless-mcp-client-envs/i; - const filtered = { ...headers }; - Object.keys(filtered).forEach((key) => { - if (hiddenHeaders.test(key)) { - filtered[key] = '[REDACTED]'; - } - }); - return filtered; -}; - -export const streamableHTTPApp = ({ - clientOptions = {}, - mcpOptions, -}: { - clientOptions?: ClientOptions; - mcpOptions: McpOptions; -}): express.Express => { - const app = express(); - app.set('query parser', 'extended'); - app.use(express.json()); - app.use((req: express.Request, res: express.Response, next: express.NextFunction) => { - const existing = req.headers['mcp-session-id']; - const sessionId = (Array.isArray(existing) ? existing[0] : existing) || crypto.randomUUID(); - (req as any).mcpSessionId = sessionId; - const origWriteHead = res.writeHead.bind(res); - res.writeHead = function (statusCode: number, ...rest: any[]) { - res.setHeader('mcp-session-id', sessionId); - return origWriteHead(statusCode, ...rest); - } as typeof res.writeHead; - next(); - }); - app.use( - pinoHttp({ - logger: getLogger(), - customProps: (req) => ({ - mcpSessionId: (req as any).mcpSessionId, - }), - customLogLevel: (req, res) => { - if (res.statusCode >= 500) { - return 'error'; - } else if (res.statusCode >= 400) { - return 'warn'; - } - return 'info'; - }, - customSuccessMessage: function (req, res) { - return `Request ${req.method} to ${req.url} completed with status ${res.statusCode}`; - }, - customErrorMessage: function (req, res, err) { - return `Request ${req.method} to ${req.url} errored with status ${res.statusCode}`; - }, - serializers: { - req: pino.stdSerializers.wrapRequestSerializer((req) => { - return { - ...req, - headers: redactHeaders(req.raw.headers), - }; - }), - res: pino.stdSerializers.wrapResponseSerializer((res) => { - return { - ...res, - headers: redactHeaders(res.headers), - }; - }), - }, - }), - ); - - app.get('/health', async (req: express.Request, res: express.Response) => { - res.status(200).send('OK'); - }); - app.get('/', get); - app.post('/', post({ clientOptions, mcpOptions })); - app.delete('/', del); - - return app; -}; - -export const launchStreamableHTTPServer = async ({ - mcpOptions, - port, -}: { - mcpOptions: McpOptions; - port: number | string | undefined; -}) => { - const app = streamableHTTPApp({ mcpOptions }); - const server = app.listen(port); - const address = server.address(); - - const logger = getLogger(); - - if (typeof address === 'string') { - logger.info(`MCP Server running on streamable HTTP at ${address}`); - } else if (address !== null) { - logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); - } else { - logger.info(`MCP Server running on streamable HTTP on port ${port}`); - } -}; diff --git a/packages/mcp-server/src/index.ts b/packages/mcp-server/src/index.ts deleted file mode 100644 index 5bca4a60..00000000 --- a/packages/mcp-server/src/index.ts +++ /dev/null @@ -1,67 +0,0 @@ -#!/usr/bin/env node - -import { selectTools } from './server'; -import { McpOptions, parseCLIOptions } from './options'; -import { launchStdioServer } from './stdio'; -import { launchStreamableHTTPServer } from './http'; -import type { McpTool } from './types'; -import { configureLogger, getLogger } from './logger'; - -async function main() { - const options = parseOptionsOrError(); - configureLogger({ - level: options.debug ? 'debug' : 'info', - pretty: options.logFormat === 'pretty', - }); - - const selectedTools = await selectToolsOrError(options); - - getLogger().info( - { tools: selectedTools.map((e) => e.tool.name) }, - `MCP Server starting with ${selectedTools.length} tools`, - ); - - switch (options.transport) { - case 'stdio': - await launchStdioServer(options); - break; - case 'http': - await launchStreamableHTTPServer({ - mcpOptions: options, - port: options.socket ?? options.port, - }); - break; - } -} - -if (require.main === module) { - main().catch((error) => { - // Logger might not be initialized yet - console.error('Fatal error in main()', error); - process.exit(1); - }); -} - -function parseOptionsOrError() { - try { - return parseCLIOptions(); - } catch (error) { - // Logger is initialized after options, so use console.error here - console.error('Error parsing options', error); - process.exit(1); - } -} - -async function selectToolsOrError(options: McpOptions): Promise { - try { - const includedTools = selectTools(options); - if (includedTools.length === 0) { - getLogger().error('No tools match the provided filters'); - process.exit(1); - } - return includedTools; - } catch (error) { - getLogger().error({ error }, 'Error filtering tools'); - process.exit(1); - } -} diff --git a/packages/mcp-server/src/instructions.ts b/packages/mcp-server/src/instructions.ts deleted file mode 100644 index d9b5c0f7..00000000 --- a/packages/mcp-server/src/instructions.ts +++ /dev/null @@ -1,83 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import fs from 'fs/promises'; -import { getLogger } from './logger'; -import { readEnv } from './util'; - -const INSTRUCTIONS_CACHE_TTL_MS = 15 * 60 * 1000; // 15 minutes - -interface InstructionsCacheEntry { - fetchedInstructions: string; - fetchedAt: number; -} - -const instructionsCache = new Map(); - -export async function getInstructions({ - stainlessApiKey, - customInstructionsPath, -}: { - stainlessApiKey?: string | undefined; - customInstructionsPath?: string | undefined; -}): Promise { - const now = Date.now(); - const cacheKey = customInstructionsPath ?? stainlessApiKey ?? ''; - const cached = instructionsCache.get(cacheKey); - - if (cached && now - cached.fetchedAt <= INSTRUCTIONS_CACHE_TTL_MS) { - return cached.fetchedInstructions; - } - - // Evict stale entries so the cache doesn't grow unboundedly. - for (const [key, entry] of instructionsCache) { - if (now - entry.fetchedAt > INSTRUCTIONS_CACHE_TTL_MS) { - instructionsCache.delete(key); - } - } - - let fetchedInstructions: string; - - if (customInstructionsPath) { - fetchedInstructions = await fetchLatestInstructionsFromFile(customInstructionsPath); - } else { - fetchedInstructions = await fetchLatestInstructionsFromApi(stainlessApiKey); - } - - instructionsCache.set(cacheKey, { fetchedInstructions, fetchedAt: now }); - return fetchedInstructions; -} - -async function fetchLatestInstructionsFromFile(path: string): Promise { - try { - return await fs.readFile(path, 'utf-8'); - } catch (error) { - getLogger().error({ error, path }, 'Error fetching instructions from file'); - throw error; - } -} - -async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefined): Promise { - // Setting the stainless API key is optional, but may be required - // to authenticate requests to the Stainless API. - const response = await fetch( - readEnv('CODE_MODE_INSTRUCTIONS_URL') ?? 'https://api.stainless.com/api/ai/instructions/hubspot-sdk', - { - method: 'GET', - headers: { ...(stainlessApiKey && { Authorization: stainlessApiKey }) }, - }, - ); - - let instructions: string | undefined; - if (!response.ok) { - getLogger().warn( - 'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...', - ); - - instructions = - '\n This is the hubspot-sdk MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n '; - } - - instructions ??= ((await response.json()) as { instructions: string }).instructions; - - return instructions; -} diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts deleted file mode 100644 index be9fa23e..00000000 --- a/packages/mcp-server/src/local-docs-search.ts +++ /dev/null @@ -1,52869 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import MiniSearch from 'minisearch'; -import * as fs from 'node:fs/promises'; -import * as path from 'node:path'; -import { getLogger } from './logger'; - -type PerLanguageData = { - method?: string; - example?: string; -}; - -type MethodEntry = { - name: string; - endpoint: string; - httpMethod: string; - summary: string; - description: string; - stainlessPath: string; - qualified: string; - params?: string[]; - response?: string; - markdown?: string; - perLanguage?: Record; -}; - -type ProseChunk = { - content: string; - tag: string; - sectionContext?: string; - source?: string; -}; - -type MiniSearchDocument = { - id: string; - kind: 'http_method' | 'prose'; - name?: string; - endpoint?: string; - summary?: string; - description?: string; - qualified?: string; - stainlessPath?: string; - content?: string; - sectionContext?: string; - _original: Record; -}; - -type SearchResult = { - results: (string | Record)[]; -}; - -const EMBEDDED_METHODS: MethodEntry[] = [ - { - name: 'get', - endpoint: '/account-info/2026-03/details', - httpMethod: 'get', - summary: 'Retrieve account details', - description: - 'Retrieve account details such as the account type, time zone, currencies, and data hosting location. ', - stainlessPath: '(resource) account > (method) get', - qualified: 'client.account.get', - response: - "{ accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }", - markdown: - "## get\n\n`client.account.get(): { accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }`\n\n**get** `/account-info/2026-03/details`\n\nRetrieve account details such as the account type, time zone, currencies, and data hosting location. \n\n### Returns\n\n- `{ accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'; additionalCurrencies: string[]; companyCurrency: string; dataHostingLocation: string; portalId: number; timeZone: string; uiDomain: string; utcOffset: string; utcOffsetMilliseconds: number; }`\n\n - `accountType: 'APP_DEVELOPER' | 'DEVELOPER_TEST' | 'SANDBOX' | 'STANDARD'`\n - `additionalCurrencies: string[]`\n - `companyCurrency: string`\n - `dataHostingLocation: string`\n - `portalId: number`\n - `timeZone: string`\n - `uiDomain: string`\n - `utcOffset: string`\n - `utcOffsetMilliseconds: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalInformationResponse = await client.account.get();\n\nconsole.log(portalInformationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.account.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalInformationResponse = await client.account.get();\n\nconsole.log(portalInformationResponse.accountType);", - }, - python: { - method: 'account.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_information_response = client.account.get()\nprint(portal_information_response.account_type)', - }, - java: { - method: 'account().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.AccountGetParams;\nimport com.hubspot.sdk.models.account.PortalInformationResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PortalInformationResponse portalInformationResponse = client.account().get();\n }\n}', - }, - go: { - method: 'client.Account.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalInformationResponse, err := client.Account.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalInformationResponse.AccountType)\n}\n', - }, - ruby: { - method: 'account.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_information_response = hubspot.account.get\n\nputs(portal_information_response)', - }, - php: { - method: 'account->get', - example: - "account->get();\n\nvar_dump($portalInformationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/account-info/2026-03/details \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_daily_private_apps_usage', - endpoint: '/account-info/2026-03/api-usage/daily/private-apps', - httpMethod: 'get', - summary: 'Retrieve private app daily API usage', - description: - 'Retrieve the daily API usage for private apps in the account, along with information about usage limits.', - stainlessPath: '(resource) account > (method) get_daily_private_apps_usage', - qualified: 'client.account.getDailyPrivateAppsUsage', - response: - "{ results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]; }", - markdown: - "## get_daily_private_apps_usage\n\n`client.account.getDailyPrivateAppsUsage(): { results: api_usage[]; }`\n\n**get** `/account-info/2026-03/api-usage/daily/private-apps`\n\nRetrieve the daily API usage for private apps in the account, along with information about usage limits.\n\n### Returns\n\n- `{ results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]; }`\n\n - `results: { collectedAt: string; currentUsage: number; fetchStatus: 'CACHED' | 'FAILURE' | 'NOTFOUND' | 'SUCCESS' | 'TIMEOUT'; name: string; usageLimit: number; resetsAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAPIUsageNoPaging = await client.account.getDailyPrivateAppsUsage();\n\nconsole.log(collectionResponseAPIUsageNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.account.getDailyPrivateAppsUsage', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAPIUsageNoPaging = await client.account.getDailyPrivateAppsUsage();\n\nconsole.log(collectionResponseAPIUsageNoPaging.results);", - }, - python: { - method: 'account.get_daily_private_apps_usage', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_api_usage_no_paging = client.account.get_daily_private_apps_usage()\nprint(collection_response_api_usage_no_paging.results)', - }, - java: { - method: 'account().getDailyPrivateAppsUsage', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.AccountGetDailyPrivateAppsUsageParams;\nimport com.hubspot.sdk.models.account.CollectionResponseApiUsageNoPaging;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseApiUsageNoPaging collectionResponseApiUsageNoPaging = client.account().getDailyPrivateAppsUsage();\n }\n}', - }, - go: { - method: 'client.Account.GetDailyPrivateAppsUsage', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAPIUsageNoPaging, err := client.Account.GetDailyPrivateAppsUsage(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAPIUsageNoPaging.Results)\n}\n', - }, - ruby: { - method: 'account.get_daily_private_apps_usage', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_api_usage_no_paging = hubspot.account.get_daily_private_apps_usage\n\nputs(collection_response_api_usage_no_paging)', - }, - php: { - method: 'account->getDailyPrivateAppsUsage', - example: - "account\n ->getDailyPrivateAppsUsage();\n\nvar_dump($collectionResponseAPIUsageNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/account-info/2026-03/api-usage/daily/private-apps \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_audit_logs', - endpoint: '/account-info/2026-03/activity/audit-logs', - httpMethod: 'get', - summary: 'Retrieve audit logs', - description: - 'Retrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log).', - stainlessPath: '(resource) account.activity > (method) list_audit_logs', - qualified: 'client.account.activity.listAuditLogs', - params: [ - 'actingUserId?: number[];', - 'after?: string;', - 'fillFinalTimestamp?: boolean;', - 'limit?: number;', - 'occurredAfter?: string;', - 'occurredBefore?: string;', - 'sort?: string[];', - ], - response: - '{ id: string; actingUser: { userId: number; userEmail?: string; }; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }', - markdown: - "## list_audit_logs\n\n`client.account.activity.listAuditLogs(actingUserId?: number[], after?: string, fillFinalTimestamp?: boolean, limit?: number, occurredAfter?: string, occurredBefore?: string, sort?: string[]): { id: string; actingUser: acting_user; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }`\n\n**get** `/account-info/2026-03/activity/audit-logs`\n\nRetrieve activity history for user actions related to approvals, content updates, CRM object updates, security activity, and more (Enterprise only). Learn more about [activities included in audit log exports](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history-in-a-centralized-audit-log?hubs_content=knowledge.hubspot.com/account-management/view-and-export-account-activity-history&hubs_content-cta=centralized%20audit%20log#data-included-in-the-centralized-audit-log).\n\n### Parameters\n\n- `actingUserId?: number[]`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fillFinalTimestamp?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `occurredAfter?: string`\n\n- `occurredBefore?: string`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; actingUser: { userId: number; userEmail?: string; }; action: string; category: string; occurredAt: string; subCategory?: string; targetObjectId?: string; }`\n\n - `id: string`\n - `actingUser: { userId: number; userEmail?: string; }`\n - `action: string`\n - `category: string`\n - `occurredAt: string`\n - `subCategory?: string`\n - `targetObjectId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicAPIUserActionEvent of client.account.activity.listAuditLogs()) {\n console.log(publicAPIUserActionEvent);\n}\n```", - perLanguage: { - typescript: { - method: 'client.account.activity.listAuditLogs', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicAPIUserActionEvent of client.account.activity.listAuditLogs()) {\n console.log(publicAPIUserActionEvent.id);\n}", - }, - python: { - method: 'account.activity.list_audit_logs', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_audit_logs()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'account().activity().listAuditLogs', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListAuditLogsPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListAuditLogsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListAuditLogsPage page = client.account().activity().listAuditLogs();\n }\n}', - }, - go: { - method: 'client.Account.Activity.ListAuditLogs', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListAuditLogs(context.TODO(), account.ActivityListAuditLogsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'account.activity.list_audit_logs', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_audit_logs\n\nputs(page)', - }, - php: { - method: 'account->activity->listAuditLogs', - example: - "account->activity->listAuditLogs(\n actingUserID: [0],\n after: 'after',\n fillFinalTimestamp: true,\n limit: 0,\n occurredAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n occurredBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n sort: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/account-info/2026-03/activity/audit-logs \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_login_activities', - endpoint: '/account-info/2026-03/activity/login', - httpMethod: 'get', - summary: 'Retrieve login activity', - description: - 'Retrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).', - stainlessPath: '(resource) account.activity > (method) list_login_activities', - qualified: 'client.account.activity.listLoginActivities', - params: ['after?: string;', 'limit?: number;', 'userId?: number;'], - response: - '{ id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }', - markdown: - "## list_login_activities\n\n`client.account.activity.listLoginActivities(after?: string, limit?: number, userId?: number): { id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }`\n\n**get** `/account-info/2026-03/activity/login`\n\nRetrieve logs of user actions related to [login activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#account-login-history).\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `userId?: number`\n\n### Returns\n\n- `{ id: string; loginAt: string; loginSucceeded: boolean; countryCode?: string; email?: string; ipAddress?: string; location?: string; regionCode?: string; userAgent?: string; userId?: number; }`\n\n - `id: string`\n - `loginAt: string`\n - `loginSucceeded: boolean`\n - `countryCode?: string`\n - `email?: string`\n - `ipAddress?: string`\n - `location?: string`\n - `regionCode?: string`\n - `userAgent?: string`\n - `userId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicLoginAudit of client.account.activity.listLoginActivities()) {\n console.log(publicLoginAudit);\n}\n```", - perLanguage: { - typescript: { - method: 'client.account.activity.listLoginActivities', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicLoginAudit of client.account.activity.listLoginActivities()) {\n console.log(publicLoginAudit.id);\n}", - }, - python: { - method: 'account.activity.list_login_activities', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_login_activities()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'account().activity().listLoginActivities', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListLoginActivitiesPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListLoginActivitiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListLoginActivitiesPage page = client.account().activity().listLoginActivities();\n }\n}', - }, - go: { - method: 'client.Account.Activity.ListLoginActivities', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListLoginActivities(context.TODO(), account.ActivityListLoginActivitiesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'account.activity.list_login_activities', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_login_activities\n\nputs(page)', - }, - php: { - method: 'account->activity->listLoginActivities', - example: - "account->activity->listLoginActivities(\n after: 'after', limit: 0, userID: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/account-info/2026-03/activity/login \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_security_activities', - endpoint: '/account-info/2026-03/activity/security', - httpMethod: 'get', - summary: 'Retrieve security history', - description: - 'Retrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).', - stainlessPath: '(resource) account.activity > (method) list_security_activities', - qualified: 'client.account.activity.listSecurityActivities', - params: [ - 'after?: string;', - 'fromTimestamp?: number;', - 'limit?: number;', - 'toTimestamp?: number;', - 'userId?: number;', - ], - response: - '{ id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }', - markdown: - "## list_security_activities\n\n`client.account.activity.listSecurityActivities(after?: string, fromTimestamp?: number, limit?: number, toTimestamp?: number, userId?: number): { id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }`\n\n**get** `/account-info/2026-03/activity/security`\n\nRetrieve logs of user actions related to [security activity](https://knowledge.hubspot.com/account-management/view-and-export-account-activity-history#security-activity-history).\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fromTimestamp?: number`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `toTimestamp?: number`\n\n- `userId?: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; type: string; userId: number; actingUser?: string; countryCode?: string; infoUrl?: string; ipAddress?: string; location?: string; objectId?: string; regionCode?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `type: string`\n - `userId: number`\n - `actingUser?: string`\n - `countryCode?: string`\n - `infoUrl?: string`\n - `ipAddress?: string`\n - `location?: string`\n - `objectId?: string`\n - `regionCode?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hydratedCriticalAction of client.account.activity.listSecurityActivities()) {\n console.log(hydratedCriticalAction);\n}\n```", - perLanguage: { - typescript: { - method: 'client.account.activity.listSecurityActivities', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hydratedCriticalAction of client.account.activity.listSecurityActivities()) {\n console.log(hydratedCriticalAction.id);\n}", - }, - python: { - method: 'account.activity.list_security_activities', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.account.activity.list_security_activities()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'account().activity().listSecurityActivities', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.account.activity.ActivityListSecurityActivitiesPage;\nimport com.hubspot.sdk.models.account.activity.ActivityListSecurityActivitiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActivityListSecurityActivitiesPage page = client.account().activity().listSecurityActivities();\n }\n}', - }, - go: { - method: 'client.Account.Activity.ListSecurityActivities', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/account"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Account.Activity.ListSecurityActivities(context.TODO(), account.ActivityListSecurityActivitiesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'account.activity.list_security_activities', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.account.activity.list_security_activities\n\nputs(page)', - }, - php: { - method: 'account->activity->listSecurityActivities', - example: - "account->activity->listSecurityActivities(\n after: 'after', fromTimestamp: 0, limit: 0, toTimestamp: 0, userID: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/account-info/2026-03/activity/security \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create_token', - endpoint: '/oauth/2026-03/token', - httpMethod: 'post', - summary: 'OAuth token endpoint', - description: 'Authenticates a client and returns access and refresh tokens.', - stainlessPath: '(resource) auth.oauth > (method) create_token', - qualified: 'client.auth.oauth.createToken', - params: [ - 'client_id?: string;', - 'client_secret?: string;', - 'code?: string;', - 'code_verifier?: string;', - "grant_type?: 'authorization_code' | 'refresh_token';", - 'redirect_uri?: string;', - 'refresh_token?: string;', - 'scope?: string;', - ], - response: 'string', - markdown: - "## create_token\n\n`client.auth.oauth.createToken(client_id?: string, client_secret?: string, code?: string, code_verifier?: string, grant_type?: 'authorization_code' | 'refresh_token', redirect_uri?: string, refresh_token?: string, scope?: string): string`\n\n**post** `/oauth/2026-03/token`\n\nAuthenticates a client and returns access and refresh tokens.\n\n### Parameters\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `code?: string`\n\n- `code_verifier?: string`\n\n- `grant_type?: 'authorization_code' | 'refresh_token'`\n\n- `redirect_uri?: string`\n\n- `refresh_token?: string`\n\n- `scope?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.auth.oauth.createToken();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.auth.oauth.createToken', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.auth.oauth.createToken();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'auth.oauth.create_token', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.auth.oauth.create_token()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'auth().oauth().createToken', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthCreateTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.auth().oauth().createToken();\n }\n}', - }, - go: { - method: 'client.Auth.OAuth.NewToken', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Auth.OAuth.NewToken(context.TODO(), auth.OAuthNewTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'auth.oauth.create_token', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.auth.oauth.create_token\n\nputs(response)', - }, - php: { - method: 'auth->oauth->createToken', - example: - "auth->oauth->createToken(\n clientID: 'client_id',\n clientSecret: 'client_secret',\n code: 'code',\n codeVerifier: 'code_verifier',\n grantType: 'authorization_code',\n redirectUri: 'redirect_uri',\n refreshToken: 'refresh_token',\n scope: 'scope',\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/oauth/2026-03/token \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'introspect_token', - endpoint: '/oauth/2026-03/token/introspect', - httpMethod: 'post', - summary: 'Token introspection endpoint', - description: 'Returns validity and metadata for access and refresh tokens.', - stainlessPath: '(resource) auth.oauth > (method) introspect_token', - qualified: 'client.auth.oauth.introspectToken', - params: [ - 'token?: string;', - 'client_id?: string;', - 'client_secret?: string;', - 'token_type_hint?: string;', - ], - response: - "{ token: string; active: boolean; app_id: number; client_id: string; expires_in: number; hub_id: number; is_private_distribution: boolean; scopes: string[]; signed_access_token: object; token_type: string; token_use: 'access_token'; user_id: number; hub_domain?: string; user?: string; } | { token: string; active: boolean; app_id: number; client_id: string; hub_id: number; scopes: string[]; token_type: string; token_use: 'refresh_token'; user_id: number; hub_domain?: string; user?: string; }", - markdown: - "## introspect_token\n\n`client.auth.oauth.introspectToken(token?: string, client_id?: string, client_secret?: string, token_type_hint?: string): object | object`\n\n**post** `/oauth/2026-03/token/introspect`\n\nReturns validity and metadata for access and refresh tokens.\n\n### Parameters\n\n- `token?: string`\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `token_type_hint?: string`\n\n### Returns\n\n- `{ token: string; active: boolean; app_id: number; client_id: string; expires_in: number; hub_id: number; is_private_distribution: boolean; scopes: string[]; signed_access_token: object; token_type: string; token_use: 'access_token'; user_id: number; hub_domain?: string; user?: string; } | { token: string; active: boolean; app_id: number; client_id: string; hub_id: number; scopes: string[]; token_type: string; token_use: 'refresh_token'; user_id: number; hub_domain?: string; user?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tokenInfoResponseBaseIf = await client.auth.oauth.introspectToken();\n\nconsole.log(tokenInfoResponseBaseIf);\n```", - perLanguage: { - typescript: { - method: 'client.auth.oauth.introspectToken', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tokenInfoResponseBaseIf = await client.auth.oauth.introspectToken();\n\nconsole.log(tokenInfoResponseBaseIf);", - }, - python: { - method: 'auth.oauth.introspect_token', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntoken_info_response_base_if = client.auth.oauth.introspect_token()\nprint(token_info_response_base_if)', - }, - java: { - method: 'auth().oauth().introspectToken', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.auth.oauth.OAuthIntrospectTokenParams;\nimport com.hubspot.sdk.models.auth.oauth.TokenInfoResponseBaseIf;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TokenInfoResponseBaseIf tokenInfoResponseBaseIf = client.auth().oauth().introspectToken();\n }\n}', - }, - go: { - method: 'client.Auth.OAuth.IntrospectToken', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttokenInfoResponseBaseIf, err := client.Auth.OAuth.IntrospectToken(context.TODO(), auth.OAuthIntrospectTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tokenInfoResponseBaseIf)\n}\n', - }, - ruby: { - method: 'auth.oauth.introspect_token', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntoken_info_response_base_if = hubspot.auth.oauth.introspect_token\n\nputs(token_info_response_base_if)', - }, - php: { - method: 'auth->oauth->introspectToken', - example: - "auth->oauth->introspectToken(\n token: 'token',\n clientID: 'client_id',\n clientSecret: 'client_secret',\n tokenTypeHint: 'token_type_hint',\n);\n\nvar_dump($tokenInfoResponseBaseIf);", - }, - http: { - example: - 'curl https://api.hubapi.com/oauth/2026-03/token/introspect \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'revoke_token', - endpoint: '/oauth/2026-03/token/revoke', - httpMethod: 'post', - summary: 'Token Revocation endpoint', - description: 'Deletes/Revokes provided Refresh Token', - stainlessPath: '(resource) auth.oauth > (method) revoke_token', - qualified: 'client.auth.oauth.revokeToken', - params: [ - 'token?: string;', - 'client_id?: string;', - 'client_secret?: string;', - 'token_type_hint?: string;', - ], - response: 'string', - markdown: - "## revoke_token\n\n`client.auth.oauth.revokeToken(token?: string, client_id?: string, client_secret?: string, token_type_hint?: string): string`\n\n**post** `/oauth/2026-03/token/revoke`\n\nDeletes/Revokes provided Refresh Token\n\n### Parameters\n\n- `token?: string`\n\n- `client_id?: string`\n\n- `client_secret?: string`\n\n- `token_type_hint?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.auth.oauth.revokeToken();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.auth.oauth.revokeToken', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.auth.oauth.revokeToken();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'auth.oauth.revoke_token', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.auth.oauth.revoke_token()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'auth().oauth().revokeToken', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthRevokeTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.auth().oauth().revokeToken();\n }\n}', - }, - go: { - method: 'client.Auth.OAuth.RevokeToken', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/auth"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Auth.OAuth.RevokeToken(context.TODO(), auth.OAuthRevokeTokenParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'auth.oauth.revoke_token', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.auth.oauth.revoke_token\n\nputs(response)', - }, - php: { - method: 'auth->oauth->revokeToken', - example: - "auth->oauth->revokeToken(\n token: 'token',\n clientID: 'client_id',\n clientSecret: 'client_secret',\n tokenTypeHint: 'token_type_hint',\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/oauth/2026-03/token/revoke \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'complete', - endpoint: '/automation/actions/callbacks/2026-03/{callbackId}/complete', - httpMethod: 'post', - summary: 'Completes a callback', - description: 'Complete a specific blocked action execution by ID.', - stainlessPath: '(resource) automation.actions.callbacks > (method) complete', - qualified: 'client.automation.actions.callbacks.complete', - params: [ - 'callbackId: string;', - 'outputFields: object;', - 'typedOutputs: object;', - 'failureReasonType?: string;', - "requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: { actionExecutionIndex: number; enrollmentId: number; }; actionId?: number; } | { agentId: number; chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; };", - ], - markdown: - "## complete\n\n`client.automation.actions.callbacks.complete(callbackId: string, outputFields: object, typedOutputs: object, failureReasonType?: string, requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }): void`\n\n**post** `/automation/actions/callbacks/2026-03/{callbackId}/complete`\n\nComplete a specific blocked action execution by ID.\n\n### Parameters\n\n- `callbackId: string`\n\n- `outputFields: object`\n Contains the output fields associated with the callback, with each field represented as a key-value pair.\n\n- `typedOutputs: object`\n Holds the typed outputs related to the callback, structured as an object.\n\n- `failureReasonType?: string`\n Indicates the reason for the failure of a callback completion.\n\n- `requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: { actionExecutionIndex: number; enrollmentId: number; }; actionId?: number; } | { agentId: number; chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: { applicationGroup: string; applicationId: string; isPrivate: boolean; metadata: object; otelContextHolder: object; unstructuredSources: string[]; complianceIds?: compliance_ids; conversationId?: string; featureId?: string; inferenceId?: string; trajectoryId?: string; }; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }`\n Specifies the context in which the request is made, which can be one of several predefined contexts.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.callbacks.complete('callbackId', {\n outputFields: { foo: 'string' },\n typedOutputs: {},\n})\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.callbacks.complete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.callbacks.complete('callbackId', {\n outputFields: { foo: 'string' },\n typedOutputs: {},\n});", - }, - python: { - method: 'automation.actions.callbacks.complete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.callbacks.complete(\n callback_id="callbackId",\n output_fields={\n "foo": "string"\n },\n typed_outputs={},\n)', - }, - java: { - method: 'automation().actions().callbacks().complete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.CallbackCompletionRequest;\nimport com.hubspot.sdk.models.automation.actions.callbacks.CallbackCompleteParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallbackCompleteParams params = CallbackCompleteParams.builder()\n .callbackId("callbackId")\n .callbackCompletionRequest(CallbackCompletionRequest.builder()\n .outputFields(CallbackCompletionRequest.OutputFields.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .typedOutputs(JsonValue.from(Map.of()))\n .build())\n .build();\n client.automation().actions().callbacks().complete(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Callbacks.Complete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Callbacks.Complete(\n\t\tcontext.TODO(),\n\t\t"callbackId",\n\t\tautomation.ActionCallbackCompleteParams{\n\t\t\tCallbackCompletionRequest: automation.CallbackCompletionRequestParam{\n\t\t\t\tOutputFields: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t\tTypedOutputs: map[string]any{},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.callbacks.complete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.callbacks.complete(\n "callbackId",\n output_fields: {foo: "string"},\n typed_outputs: {}\n)\n\nputs(result)', - }, - php: { - method: 'automation->actions->callbacks->complete', - example: - "automation->actions->callbacks->complete(\n 'callbackId',\n outputFields: ['foo' => 'string'],\n typedOutputs: (object) [],\n failureReasonType: 'failureReasonType',\n requestContext: [\n 'source' => 'WORKFLOWS',\n 'workflowID' => 0,\n 'actionExecutionIndexIdentifier' => [\n 'actionExecutionIndex' => 0, 'enrollmentID' => 0\n ],\n 'actionID' => 0,\n ],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/callbacks/2026-03/$CALLBACK_ID/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "outputFields": {\n "foo": "string"\n },\n "typedOutputs": {}\n }\'', - }, - }, - }, - { - name: 'complete_batch', - endpoint: '/automation/actions/callbacks/2026-03/complete', - httpMethod: 'post', - summary: 'Complete a batch of callbacks', - description: 'Complete a batch of blocked action executions.', - stainlessPath: '(resource) automation.actions.callbacks > (method) complete_batch', - qualified: 'client.automation.actions.callbacks.completeBatch', - params: [ - "inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }; }[];", - ], - markdown: - "## complete_batch\n\n`client.automation.actions.callbacks.completeBatch(inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: workflows_request_context | agent_request_context | copilot_request_context | standalone_request_context | test_request_context; }[]): void`\n\n**post** `/automation/actions/callbacks/2026-03/complete`\n\nComplete a batch of blocked action executions.\n\n### Parameters\n\n- `inputs: { callbackId: string; outputFields: object; typedOutputs: object; failureReasonType?: string; requestContext?: { source: 'WORKFLOWS'; workflowId: number; actionExecutionIndexIdentifier?: action_execution_index_identifier; actionId?: number; } | { agentId: number; chirpAiContextObject: chirp_ai_context_object; source: 'AGENTS'; trajectoryId?: string; } | { source: 'COPILOT'; trajectoryId?: string; } | { chirpAiContextObject: chirp_ai_context_object; source: 'STANDALONE'; trajectoryId?: string; } | { source: 'TEST'; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.callbacks.completeBatch({ inputs: [{\n callbackId: 'callbackId',\n outputFields: { foo: 'string' },\n typedOutputs: {},\n}] })\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.callbacks.completeBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.callbacks.completeBatch({\n inputs: [\n {\n callbackId: 'callbackId',\n outputFields: { foo: 'string' },\n typedOutputs: {},\n },\n ],\n});", - }, - python: { - method: 'automation.actions.callbacks.complete_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.callbacks.complete_batch(\n inputs=[{\n "callback_id": "callbackId",\n "output_fields": {\n "foo": "string"\n },\n "typed_outputs": {},\n }],\n)', - }, - java: { - method: 'automation().actions().callbacks().completeBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.BatchInputCallbackCompletionBatchRequest;\nimport com.hubspot.sdk.models.automation.actions.CallbackCompletionBatchRequest;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputCallbackCompletionBatchRequest params = BatchInputCallbackCompletionBatchRequest.builder()\n .addInput(CallbackCompletionBatchRequest.builder()\n .callbackId("callbackId")\n .outputFields(CallbackCompletionBatchRequest.OutputFields.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .typedOutputs(JsonValue.from(Map.of()))\n .build())\n .build();\n client.automation().actions().callbacks().completeBatch(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Callbacks.CompleteBatch', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Callbacks.CompleteBatch(context.TODO(), automation.ActionCallbackCompleteBatchParams{\n\t\tBatchInputCallbackCompletionBatchRequest: automation.BatchInputCallbackCompletionBatchRequestParam{\n\t\t\tInputs: []automation.CallbackCompletionBatchRequestParam{{\n\t\t\t\tCallbackID: "callbackId",\n\t\t\t\tOutputFields: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t\tTypedOutputs: map[string]any{},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.callbacks.complete_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.callbacks.complete_batch(\n inputs: [{callbackId: "callbackId", outputFields: {foo: "string"}, typedOutputs: {}}]\n)\n\nputs(result)', - }, - php: { - method: 'automation->actions->callbacks->completeBatch', - example: - "automation->actions->callbacks->completeBatch(\n inputs: [\n [\n 'callbackID' => 'callbackId',\n 'outputFields' => ['foo' => 'string'],\n 'typedOutputs' => (object) [],\n 'failureReasonType' => 'failureReasonType',\n 'requestContext' => [\n 'source' => 'WORKFLOWS',\n 'workflowID' => 0,\n 'actionExecutionIndexIdentifier' => [\n 'actionExecutionIndex' => 0, 'enrollmentID' => 0\n ],\n 'actionID' => 0,\n ],\n ],\n ],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/callbacks/2026-03/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "callbackId": "callbackId",\n "outputFields": {\n "foo": "string"\n },\n "typedOutputs": {}\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/automation/actions/2026-03/{appId}', - httpMethod: 'post', - summary: 'Create a new custom action definition', - description: 'Create a new custom workflow action.', - stainlessPath: '(resource) automation.actions.definitions > (method) create', - qualified: 'client.automation.actions.definitions.create', - params: [ - 'appId: number;', - 'actionUrl: string;', - "functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[];", - "inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[];", - 'labels: object;', - 'objectTypes: string[];', - 'published: boolean;', - 'archivedAt?: number;', - 'executionRules?: { conditions: object; labelName: string; }[];', - "inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[];", - 'objectRequestOptions?: { properties: string[]; };', - 'outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[];', - ], - response: - "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", - markdown: - "## create\n\n`client.automation.actions.definitions.create(appId: number, actionUrl: string, functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[], inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[], labels: object, objectTypes: string[], published: boolean, archivedAt?: number, executionRules?: { conditions: object; labelName: string; }[], inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[], objectRequestOptions?: { properties: string[]; }, outputFields?: { typeDefinition: field_type_definition; }[]): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**post** `/automation/actions/2026-03/{appId}`\n\nCreate a new custom workflow action.\n\n### Parameters\n\n- `appId: number`\n\n- `actionUrl: string`\n The URL endpoint where the action is executed.\n\n- `functions: { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n\n- `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n\n- `labels: object`\n Holds various labels associated with the action, including names and descriptions.\n\n- `objectTypes: string[]`\n\n- `published: boolean`\n Indicates whether the action is published and available for use.\n\n- `archivedAt?: number`\n The timestamp indicating when the action was archived.\n\n- `executionRules?: { conditions: object; labelName: string; }[]`\n\n- `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n\n- `objectRequestOptions?: { properties: string[]; }`\n - `properties: string[]`\n\n- `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.create(0, {\n actionUrl: 'actionUrl',\n functions: [{ functionSource: 'functionSource', functionType: 'POST_ACTION_EXECUTION' }],\n inputFields: [{\n isRequired: true,\n typeDefinition: {\n name: 'name',\n options: [{ label: 'label', value: 'value' }],\n type: 'bool',\n},\n}],\n labels: { foo: { actionName: 'actionName' } },\n objectTypes: ['string'],\n published: true,\n});\n\nconsole.log(publicActionDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.create(0, {\n actionUrl: 'actionUrl',\n functions: [{ functionSource: 'functionSource', functionType: 'POST_ACTION_EXECUTION' }],\n inputFields: [\n {\n isRequired: true,\n typeDefinition: {\n name: 'name',\n options: [{ label: 'label', value: 'value' }],\n type: 'bool',\n },\n },\n ],\n labels: { foo: { actionName: 'actionName' } },\n objectTypes: ['string'],\n published: true,\n});\n\nconsole.log(publicActionDefinition.id);", - }, - python: { - method: 'automation.actions.definitions.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.create(\n app_id=0,\n action_url="actionUrl",\n functions=[{\n "function_source": "functionSource",\n "function_type": "POST_ACTION_EXECUTION",\n }],\n input_fields=[{\n "is_required": True,\n "type_definition": {\n "name": "name",\n "options": [{\n "label": "label",\n "value": "value",\n }],\n "type": "bool",\n },\n }],\n labels={\n "foo": {\n "action_name": "actionName"\n }\n },\n object_types=["string"],\n published=True,\n)\nprint(public_action_definition.id)', - }, - java: { - method: 'automation().actions().definitions().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionEgg;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.PublicFieldTypeDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicInputFieldDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicOption;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionCreateParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreateParams params = DefinitionCreateParams.builder()\n .appId(0)\n .publicActionDefinitionEgg(PublicActionDefinitionEgg.builder()\n .actionUrl("actionUrl")\n .addFunction(PublicActionFunction.builder()\n .functionSource("functionSource")\n .functionType(PublicActionFunction.FunctionType.POST_ACTION_EXECUTION)\n .build())\n .addInputField(PublicInputFieldDefinition.builder()\n .isRequired(true)\n .typeDefinition(PublicFieldTypeDefinition.builder()\n .name("name")\n .addOption(PublicOption.builder()\n .label("label")\n .value("value")\n .build())\n .type(PublicFieldTypeDefinition.Type.BOOL)\n .build())\n .build())\n .labels(PublicActionDefinitionEgg.Labels.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "actionName", "actionName"\n )))\n .build())\n .addObjectType("string")\n .published(true)\n .build())\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().create(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tautomation.ActionDefinitionNewParams{\n\t\t\tPublicActionDefinitionEgg: automation.PublicActionDefinitionEggParam{\n\t\t\t\tActionURL: "actionUrl",\n\t\t\t\tFunctions: []automation.PublicActionFunctionParam{{\n\t\t\t\t\tFunctionSource: "functionSource",\n\t\t\t\t\tFunctionType: automation.PublicActionFunctionFunctionTypePostActionExecution,\n\t\t\t\t}},\n\t\t\t\tInputFields: []automation.PublicInputFieldDefinitionParam{{\n\t\t\t\t\tIsRequired: true,\n\t\t\t\t\tTypeDefinition: automation.PublicFieldTypeDefinitionParam{\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOptions: []automation.PublicOptionParam{{\n\t\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tType: automation.PublicFieldTypeDefinitionTypeBool,\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tLabels: map[string]automation.PublicActionLabelsParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tActionName: "actionName",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tObjectTypes: []string{"string"},\n\t\t\t\tPublished: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.create(\n 0,\n action_url: "actionUrl",\n functions: [{functionSource: "functionSource", functionType: :POST_ACTION_EXECUTION}],\n input_fields: [\n {isRequired: true, typeDefinition: {name: "name", options: [{label: "label", value: "value"}], type: :bool}}\n ],\n labels: {foo: {actionName: "actionName"}},\n object_types: ["string"],\n published: true\n)\n\nputs(public_action_definition)', - }, - php: { - method: 'automation->actions->definitions->create', - example: - "automation->actions->definitions->create(\n 0,\n actionURL: 'actionUrl',\n functions: [\n [\n 'functionSource' => 'functionSource',\n 'functionType' => 'POST_ACTION_EXECUTION',\n 'id' => 'id',\n ],\n ],\n inputFields: [\n [\n 'isRequired' => true,\n 'typeDefinition' => [\n 'name' => 'name',\n 'options' => [\n [\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n 'displayOrder' => 0,\n ],\n ],\n 'type' => 'bool',\n 'description' => 'description',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'OWNER',\n ],\n 'supportedValueTypes' => ['STATIC_VALUE'],\n ],\n ],\n labels: [\n 'foo' => [\n 'actionName' => 'actionName',\n 'actionCardContent' => 'actionCardContent',\n 'actionDescription' => 'actionDescription',\n 'appDisplayName' => 'appDisplayName',\n 'executionRules' => ['foo' => 'string'],\n 'inputFieldDescriptions' => ['foo' => 'string'],\n 'inputFieldLabels' => ['foo' => 'string'],\n 'inputFieldOptionLabels' => ['foo' => ['foo' => 'string']],\n 'outputFieldLabels' => ['foo' => 'string'],\n ],\n ],\n objectTypes: ['string'],\n published: true,\n archivedAt: 0,\n executionRules: [\n ['conditions' => ['foo' => (object) []], 'labelName' => 'labelName']\n ],\n inputFieldDependencies: [\n [\n 'controllingFieldName' => 'controllingFieldName',\n 'dependencyType' => 'SINGLE_FIELD',\n 'dependentFieldNames' => ['string'],\n ],\n ],\n objectRequestOptions: ['properties' => ['string']],\n outputFields: [\n [\n 'typeDefinition' => [\n 'externalOptions' => true,\n 'name' => 'name',\n 'options' => [\n [\n 'description' => 'description',\n 'displayOrder' => 0,\n 'doubleData' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'readOnly' => true,\n 'value' => 'value',\n ],\n ],\n 'schema' => ['type' => 'ARRAY', 'maximum' => 0, 'minimum' => 0],\n 'type' => 'bool',\n 'useChirp' => true,\n 'description' => 'description',\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'ABANDONED_CART',\n ],\n ],\n ],\n);\n\nvar_dump($publicActionDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "actionUrl": "actionUrl",\n "functions": [\n {\n "functionSource": "functionSource",\n "functionType": "POST_ACTION_EXECUTION"\n }\n ],\n "inputFields": [\n {\n "isRequired": true,\n "typeDefinition": {\n "name": "name",\n "options": [\n {\n "label": "label",\n "value": "value"\n }\n ],\n "type": "bool"\n }\n }\n ],\n "labels": {\n "foo": {\n "actionName": "actionName"\n }\n },\n "objectTypes": [\n "string"\n ],\n "published": true\n }\'', - }, - }, - }, - { - name: 'create_requires_object', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', - httpMethod: 'post', - summary: 'Set the object requirement for a custom action definition.', - description: 'Set whether a custom action definition requires an object.', - stainlessPath: '(resource) automation.actions.definitions > (method) create_requires_object', - qualified: 'client.automation.actions.definitions.createRequiresObject', - params: ['appId: number;', 'definitionId: string;', 'requiresObject: boolean;'], - markdown: - "## create_requires_object\n\n`client.automation.actions.definitions.createRequiresObject(appId: number, definitionId: string, requiresObject: boolean): void`\n\n**post** `/automation/actions/2026-03/{appId}/{definitionId}/requires-object`\n\nSet whether a custom action definition requires an object.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `requiresObject: boolean`\n Indicates whether a custom action definition requires an associated object.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.definitions.createRequiresObject('definitionId', { appId: 0, requiresObject: true })\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.createRequiresObject', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.definitions.createRequiresObject('definitionId', {\n appId: 0,\n requiresObject: true,\n});", - }, - python: { - method: 'automation.actions.definitions.create_requires_object', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.definitions.create_requires_object(\n definition_id="definitionId",\n app_id=0,\n requires_object=True,\n)', - }, - java: { - method: 'automation().actions().definitions().createRequiresObject', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionRequiresObjectRequest;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionCreateRequiresObjectParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreateRequiresObjectParams params = DefinitionCreateRequiresObjectParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .publicActionDefinitionRequiresObjectRequest(PublicActionDefinitionRequiresObjectRequest.builder()\n .requiresObject(true)\n .build())\n .build();\n client.automation().actions().definitions().createRequiresObject(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.NewRequiresObject', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Definitions.NewRequiresObject(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionNewRequiresObjectParams{\n\t\t\tAppID: 0,\n\t\t\tPublicActionDefinitionRequiresObjectRequest: automation.PublicActionDefinitionRequiresObjectRequestParam{\n\t\t\t\tRequiresObject: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.create_requires_object', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.definitions.create_requires_object(\n "definitionId",\n app_id: 0,\n requires_object: true\n)\n\nputs(result)', - }, - php: { - method: 'automation->actions->definitions->createRequiresObject', - example: - "automation->actions->definitions->createRequiresObject(\n 'definitionId', appID: 0, requiresObject: true\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/requires-object \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requiresObject": true\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', - httpMethod: 'delete', - summary: 'Delete an action definition', - description: 'Delete an action definition by ID.', - stainlessPath: '(resource) automation.actions.definitions > (method) delete', - qualified: 'client.automation.actions.definitions.delete', - params: ['appId: number;', 'definitionId: string;'], - markdown: - "## delete\n\n`client.automation.actions.definitions.delete(appId: number, definitionId: string): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nDelete an action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.definitions.delete('definitionId', { appId: 0 })\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.definitions.delete('definitionId', { appId: 0 });", - }, - python: { - method: 'automation.actions.definitions.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.definitions.delete(\n definition_id="definitionId",\n app_id=0,\n)', - }, - java: { - method: 'automation().actions().definitions().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionDeleteParams params = DefinitionDeleteParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n client.automation().actions().definitions().delete(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Definitions.Delete(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.definitions.delete("definitionId", app_id: 0)\n\nputs(result)', - }, - php: { - method: 'automation->actions->definitions->delete', - example: - "automation->actions->definitions->delete(\n 'definitionId', appID: 0\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', - httpMethod: 'get', - summary: 'Retrieve a custom action definition', - description: 'Retrieve a custom workflow action definition by ID.', - stainlessPath: '(resource) automation.actions.definitions > (method) get', - qualified: 'client.automation.actions.definitions.get', - params: ['appId: number;', 'definitionId: string;', 'archived?: boolean;'], - response: - "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", - markdown: - "## get\n\n`client.automation.actions.definitions.get(appId: number, definitionId: string, archived?: boolean): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nRetrieve a custom workflow action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.get('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.get('definitionId', {\n appId: 0,\n});\n\nconsole.log(publicActionDefinition.id);", - }, - python: { - method: 'automation.actions.definitions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.get(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition.id)', - }, - java: { - method: 'automation().actions().definitions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionGetParams params = DefinitionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().get(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.Get(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionGetParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.get("definitionId", app_id: 0)\n\nputs(public_action_definition)', - }, - php: { - method: 'automation->actions->definitions->get', - example: - "automation->actions->definitions->get(\n 'definitionId', appID: 0, archived: true\n);\n\nvar_dump($publicActionDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_requires_object', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', - httpMethod: 'get', - summary: 'Retrieve the object requirement status for a custom action definition.', - description: 'Retrieve whether a custom action definition requires an object.', - stainlessPath: '(resource) automation.actions.definitions > (method) get_requires_object', - qualified: 'client.automation.actions.definitions.getRequiresObject', - params: ['appId: number;', 'definitionId: string;'], - response: '{ requiresObject: boolean; }', - markdown: - "## get_requires_object\n\n`client.automation.actions.definitions.getRequiresObject(appId: number, definitionId: string): { requiresObject: boolean; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/requires-object`\n\nRetrieve whether a custom action definition requires an object.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Returns\n\n- `{ requiresObject: boolean; }`\n\n - `requiresObject: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinitionRequiresObjectResponse = await client.automation.actions.definitions.getRequiresObject('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinitionRequiresObjectResponse);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.getRequiresObject', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinitionRequiresObjectResponse =\n await client.automation.actions.definitions.getRequiresObject('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinitionRequiresObjectResponse.requiresObject);", - }, - python: { - method: 'automation.actions.definitions.get_requires_object', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition_requires_object_response = client.automation.actions.definitions.get_requires_object(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition_requires_object_response.requires_object)', - }, - java: { - method: 'automation().actions().definitions().getRequiresObject', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionRequiresObjectResponse;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionGetRequiresObjectParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionGetRequiresObjectParams params = DefinitionGetRequiresObjectParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n PublicActionDefinitionRequiresObjectResponse publicActionDefinitionRequiresObjectResponse = client.automation().actions().definitions().getRequiresObject(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.GetRequiresObject', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinitionRequiresObjectResponse, err := client.Automation.Actions.Definitions.GetRequiresObject(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionGetRequiresObjectParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinitionRequiresObjectResponse.RequiresObject)\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.get_requires_object', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition_requires_object_response = hubspot.automation.actions.definitions.get_requires_object("definitionId", app_id: 0)\n\nputs(public_action_definition_requires_object_response)', - }, - php: { - method: 'automation->actions->definitions->getRequiresObject', - example: - "automation\n ->actions\n ->definitions\n ->getRequiresObject('definitionId', appID: 0);\n\nvar_dump($publicActionDefinitionRequiresObjectResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/requires-object \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/automation/actions/2026-03/{appId}', - httpMethod: 'get', - summary: 'Retrieve custom action definitions', - description: 'Retrieve custom workflow action definitions by app ID.', - stainlessPath: '(resource) automation.actions.definitions > (method) list', - qualified: 'client.automation.actions.definitions.list', - params: ['appId: number;', 'after?: string;', 'archived?: boolean;', 'limit?: number;'], - response: - "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", - markdown: - "## list\n\n`client.automation.actions.definitions.list(appId: number, after?: string, archived?: boolean, limit?: number): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**get** `/automation/actions/2026-03/{appId}`\n\nRetrieve custom workflow action definitions by app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionDefinition of client.automation.actions.definitions.list(0)) {\n console.log(publicActionDefinition);\n}\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionDefinition of client.automation.actions.definitions.list(0)) {\n console.log(publicActionDefinition.id);\n}", - }, - python: { - method: 'automation.actions.definitions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.actions.definitions.list(\n app_id=0,\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'automation().actions().definitions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionListPage;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionListPage page = client.automation().actions().definitions().list(0);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Actions.Definitions.List(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tautomation.ActionDefinitionListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.actions.definitions.list(0)\n\nputs(page)', - }, - php: { - method: 'automation->actions->definitions->list', - example: - "automation->actions->definitions->list(\n 0, after: 'after', archived: true, limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}', - httpMethod: 'patch', - summary: 'Update an existing action definition', - description: 'Update an existing action definition by ID.', - stainlessPath: '(resource) automation.actions.definitions > (method) update', - qualified: 'client.automation.actions.definitions.update', - params: [ - 'appId: number;', - 'definitionId: string;', - 'actionUrl?: string;', - 'executionRules?: { conditions: object; labelName: string; }[];', - "inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[];", - "inputFields?: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[];", - 'labels?: object;', - 'objectRequestOptions?: { properties: string[]; };', - 'objectTypes?: string[];', - 'outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[];', - 'published?: boolean;', - ], - response: - "{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }", - markdown: - "## update\n\n`client.automation.actions.definitions.update(appId: number, definitionId: string, actionUrl?: string, executionRules?: { conditions: object; labelName: string; }[], inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[], inputFields?: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[], labels?: object, objectRequestOptions?: { properties: string[]; }, objectTypes?: string[], outputFields?: { typeDefinition: field_type_definition; }[], published?: boolean): { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }`\n\n**patch** `/automation/actions/2026-03/{appId}/{definitionId}`\n\nUpdate an existing action definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `actionUrl?: string`\n The URL endpoint where the action is executed.\n\n- `executionRules?: { conditions: object; labelName: string; }[]`\n\n- `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n\n- `inputFields?: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n\n- `labels?: object`\n Contains labels for the action, including names and descriptions.\n\n- `objectRequestOptions?: { properties: string[]; }`\n - `properties: string[]`\n\n- `objectTypes?: string[]`\n\n- `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n- `published?: boolean`\n Indicates whether the action is published and available for use.\n\n### Returns\n\n- `{ id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n\n - `id: string`\n - `actionUrl: string`\n - `functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n - `inputFields: { isRequired: boolean; typeDefinition: { name: string; options: public_option[]; type: string; description?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: 'OWNER'; }; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]`\n - `labels: object`\n - `objectTypes: string[]`\n - `published: boolean`\n - `revisionId: string`\n - `archivedAt?: number`\n - `executionRules?: { conditions: object; labelName: string; }[]`\n - `inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]`\n - `objectRequestOptions?: { properties: string[]; }`\n - `outputFields?: { typeDefinition: { externalOptions: boolean; name: string; options: automation_actions_option[]; schema: integer_field_schema | long_field_schema | double_field_schema | string_field_schema | boolean_field_schema | array_field_schema | object_field_schema; type: string; useChirp: boolean; description?: string; externalOptionsReferenceType?: string; fieldType?: string; helpText?: string; label?: string; optionsUrl?: string; referencedObjectType?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionDefinition = await client.automation.actions.definitions.update('definitionId', { appId: 0 });\n\nconsole.log(publicActionDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.definitions.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionDefinition = await client.automation.actions.definitions.update('definitionId', {\n appId: 0,\n});\n\nconsole.log(publicActionDefinition.id);", - }, - python: { - method: 'automation.actions.definitions.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_definition = client.automation.actions.definitions.update(\n definition_id="definitionId",\n app_id=0,\n)\nprint(public_action_definition.id)', - }, - java: { - method: 'automation().actions().definitions().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinition;\nimport com.hubspot.sdk.models.automation.actions.PublicActionDefinitionPatch;\nimport com.hubspot.sdk.models.automation.actions.definitions.DefinitionUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdateParams params = DefinitionUpdateParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .publicActionDefinitionPatch(PublicActionDefinitionPatch.builder().build())\n .build();\n PublicActionDefinition publicActionDefinition = client.automation().actions().definitions().update(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Definitions.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionDefinition, err := client.Automation.Actions.Definitions.Update(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionDefinitionUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tPublicActionDefinitionPatch: automation.PublicActionDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionDefinition.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.definitions.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_definition = hubspot.automation.actions.definitions.update("definitionId", app_id: 0)\n\nputs(public_action_definition)', - }, - php: { - method: 'automation->actions->definitions->update', - example: - "automation->actions->definitions->update(\n 'definitionId',\n appID: 0,\n actionURL: 'actionUrl',\n executionRules: [\n ['conditions' => ['foo' => (object) []], 'labelName' => 'labelName']\n ],\n inputFieldDependencies: [\n [\n 'controllingFieldName' => 'controllingFieldName',\n 'dependencyType' => 'SINGLE_FIELD',\n 'dependentFieldNames' => ['string'],\n ],\n ],\n inputFields: [\n [\n 'isRequired' => true,\n 'typeDefinition' => [\n 'name' => 'name',\n 'options' => [\n [\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n 'displayOrder' => 0,\n ],\n ],\n 'type' => 'bool',\n 'description' => 'description',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'OWNER',\n ],\n 'supportedValueTypes' => ['STATIC_VALUE'],\n ],\n ],\n labels: [\n 'foo' => [\n 'actionName' => 'actionName',\n 'actionCardContent' => 'actionCardContent',\n 'actionDescription' => 'actionDescription',\n 'appDisplayName' => 'appDisplayName',\n 'executionRules' => ['foo' => 'string'],\n 'inputFieldDescriptions' => ['foo' => 'string'],\n 'inputFieldLabels' => ['foo' => 'string'],\n 'inputFieldOptionLabels' => ['foo' => ['foo' => 'string']],\n 'outputFieldLabels' => ['foo' => 'string'],\n ],\n ],\n objectRequestOptions: ['properties' => ['string']],\n objectTypes: ['string'],\n outputFields: [\n [\n 'typeDefinition' => [\n 'externalOptions' => true,\n 'name' => 'name',\n 'options' => [\n [\n 'description' => 'description',\n 'displayOrder' => 0,\n 'doubleData' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'readOnly' => true,\n 'value' => 'value',\n ],\n ],\n 'schema' => ['type' => 'ARRAY', 'maximum' => 0, 'minimum' => 0],\n 'type' => 'bool',\n 'useChirp' => true,\n 'description' => 'description',\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'fieldType' => 'booleancheckbox',\n 'helpText' => 'helpText',\n 'label' => 'label',\n 'optionsURL' => 'optionsUrl',\n 'referencedObjectType' => 'ABANDONED_CART',\n ],\n ],\n ],\n published: true,\n);\n\nvar_dump($publicActionDefinition);", - }, - http: { - example: - "curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create_or_replace', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - httpMethod: 'put', - summary: 'Update a function for a definition', - description: 'Update a function for a given definition by ID.', - stainlessPath: '(resource) automation.actions.functions > (method) create_or_replace', - qualified: 'client.automation.actions.functions.createOrReplace', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - 'functionId: string;', - 'body: string;', - ], - response: - "{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", - markdown: - "## create_or_replace\n\n`client.automation.actions.functions.createOrReplace(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string, body: string): { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**put** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nUpdate a function for a given definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n- `body: string`\n\n### Returns\n\n- `{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplace('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n});\n\nconsole.log(publicActionFunctionIdentifier);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.createOrReplace', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplace(\n 'functionId',\n {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n },\n);\n\nconsole.log(publicActionFunctionIdentifier.id);", - }, - python: { - method: 'automation.actions.functions.create_or_replace', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function_identifier = client.automation.actions.functions.create_or_replace(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n body="body",\n)\nprint(public_action_function_identifier.id)', - }, - java: { - method: 'automation().actions().functions().createOrReplace', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunctionIdentifier;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionCreateOrReplaceParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionCreateOrReplaceParams params = FunctionCreateOrReplaceParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionCreateOrReplaceParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .body("body")\n .build();\n PublicActionFunctionIdentifier publicActionFunctionIdentifier = client.automation().actions().functions().createOrReplace(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.NewOrReplace', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunctionIdentifier, err := client.Automation.Actions.Functions.NewOrReplace(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionNewOrReplaceParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionNewOrReplaceParamsFunctionTypePostActionExecution,\n\t\t\tBody: "body",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunctionIdentifier.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.functions.create_or_replace', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function_identifier = hubspot.automation.actions.functions.create_or_replace(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION,\n body: "body"\n)\n\nputs(public_action_function_identifier)', - }, - php: { - method: 'automation->actions->functions->createOrReplace', - example: - "automation\n ->actions\n ->functions\n ->createOrReplace(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n body: 'body',\n);\n\nvar_dump($publicActionFunctionIdentifier);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -X PUT \\\n -H \'Content-Type: text/plain\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'"body"\'', - }, - }, - }, - { - name: 'create_or_replace_by_function_type', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - httpMethod: 'put', - summary: 'Insert a function for a definition', - description: 'Add a function for a given definition.', - stainlessPath: '(resource) automation.actions.functions > (method) create_or_replace_by_function_type', - qualified: 'client.automation.actions.functions.createOrReplaceByFunctionType', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - 'body: string;', - ], - response: - "{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", - markdown: - "## create_or_replace_by_function_type\n\n`client.automation.actions.functions.createOrReplaceByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', body: string): { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**put** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nAdd a function for a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `body: string`\n\n### Returns\n\n- `{ functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunctionIdentifier = await client.automation.actions.functions.createOrReplaceByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n body: 'body',\n});\n\nconsole.log(publicActionFunctionIdentifier);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.createOrReplaceByFunctionType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunctionIdentifier =\n await client.automation.actions.functions.createOrReplaceByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n body: 'body',\n });\n\nconsole.log(publicActionFunctionIdentifier.id);", - }, - python: { - method: 'automation.actions.functions.create_or_replace_by_function_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function_identifier = client.automation.actions.functions.create_or_replace_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n body="body",\n)\nprint(public_action_function_identifier.id)', - }, - java: { - method: 'automation().actions().functions().createOrReplaceByFunctionType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunctionIdentifier;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionCreateOrReplaceByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionCreateOrReplaceByFunctionTypeParams params = FunctionCreateOrReplaceByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionCreateOrReplaceByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .body("body")\n .build();\n PublicActionFunctionIdentifier publicActionFunctionIdentifier = client.automation().actions().functions().createOrReplaceByFunctionType(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.NewOrReplaceByFunctionType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunctionIdentifier, err := client.Automation.Actions.Functions.NewOrReplaceByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionNewOrReplaceByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionNewOrReplaceByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tBody: "body",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunctionIdentifier.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.functions.create_or_replace_by_function_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function_identifier = hubspot.automation.actions.functions.create_or_replace_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId",\n body: "body"\n)\n\nputs(public_action_function_identifier)', - }, - php: { - method: 'automation->actions->functions->createOrReplaceByFunctionType', - example: - "automation\n ->actions\n ->functions\n ->createOrReplaceByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId', body: 'body'\n);\n\nvar_dump($publicActionFunctionIdentifier);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -X PUT \\\n -H \'Content-Type: text/plain\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'"body"\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - httpMethod: 'delete', - summary: 'Archive a function for a definition', - description: 'Archive a function for a specific definition.', - stainlessPath: '(resource) automation.actions.functions > (method) delete', - qualified: 'client.automation.actions.functions.delete', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - 'functionId: string;', - ], - markdown: - "## delete\n\n`client.automation.actions.functions.delete(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nArchive a function for a specific definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.functions.delete('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n})\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.functions.delete('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});", - }, - python: { - method: 'automation.actions.functions.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.functions.delete(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n)', - }, - java: { - method: 'automation().actions().functions().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionDeleteParams params = FunctionDeleteParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionDeleteParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .build();\n client.automation().actions().functions().delete(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Functions.Delete(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionDeleteParamsFunctionTypePostActionExecution,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.functions.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.functions.delete(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION\n)\n\nputs(result)', - }, - php: { - method: 'automation->actions->functions->delete', - example: - "automation->actions->functions->delete(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_by_function_type', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - httpMethod: 'delete', - summary: 'Delete a function for a definition', - description: 'Delete a function within a given definition.', - stainlessPath: '(resource) automation.actions.functions > (method) delete_by_function_type', - qualified: 'client.automation.actions.functions.deleteByFunctionType', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - ], - markdown: - "## delete_by_function_type\n\n`client.automation.actions.functions.deleteByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'): void`\n\n**delete** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nDelete a function within a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.automation.actions.functions.deleteByFunctionType('POST_ACTION_EXECUTION', { appId: 0, definitionId: 'definitionId' })\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.deleteByFunctionType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.automation.actions.functions.deleteByFunctionType('POST_ACTION_EXECUTION', {\n appId: 0,\n definitionId: 'definitionId',\n});", - }, - python: { - method: 'automation.actions.functions.delete_by_function_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.automation.actions.functions.delete_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n)', - }, - java: { - method: 'automation().actions().functions().deleteByFunctionType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionDeleteByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionDeleteByFunctionTypeParams params = FunctionDeleteByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionDeleteByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .build();\n client.automation().actions().functions().deleteByFunctionType(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.DeleteByFunctionType', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Automation.Actions.Functions.DeleteByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionDeleteByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionDeleteByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'automation.actions.functions.delete_by_function_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.automation.actions.functions.delete_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId"\n)\n\nputs(result)', - }, - php: { - method: 'automation->actions->functions->deleteByFunctionType', - example: - "automation->actions->functions->deleteByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - httpMethod: 'get', - summary: 'Retrieve a function from a given definition', - description: 'Retrieve a specific function from a given definition.', - stainlessPath: '(resource) automation.actions.functions > (method) get', - qualified: 'client.automation.actions.functions.get', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - 'functionId: string;', - ], - response: - "{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", - markdown: - "## get\n\n`client.automation.actions.functions.get(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', functionId: string): { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}`\n\nRetrieve a specific function from a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n- `functionId: string`\n\n### Returns\n\n- `{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionSource: string`\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunction = await client.automation.actions.functions.get('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});\n\nconsole.log(publicActionFunction);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunction = await client.automation.actions.functions.get('functionId', {\n appId: 0,\n definitionId: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n});\n\nconsole.log(publicActionFunction.id);", - }, - python: { - method: 'automation.actions.functions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function = client.automation.actions.functions.get(\n function_id="functionId",\n app_id=0,\n definition_id="definitionId",\n function_type="POST_ACTION_EXECUTION",\n)\nprint(public_action_function.id)', - }, - java: { - method: 'automation().actions().functions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionGetParams params = FunctionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionGetParams.FunctionType.POST_ACTION_EXECUTION)\n .functionId("functionId")\n .build();\n PublicActionFunction publicActionFunction = client.automation().actions().functions().get(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunction, err := client.Automation.Actions.Functions.Get(\n\t\tcontext.TODO(),\n\t\t"functionId",\n\t\tautomation.ActionFunctionGetParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t\tFunctionType: automation.ActionFunctionGetParamsFunctionTypePostActionExecution,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunction.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.functions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function = hubspot.automation.actions.functions.get(\n "functionId",\n app_id: 0,\n definition_id: "definitionId",\n function_type: :POST_ACTION_EXECUTION\n)\n\nputs(public_action_function)', - }, - php: { - method: 'automation->actions->functions->get', - example: - "automation->actions->functions->get(\n 'functionId',\n appID: 0,\n definitionID: 'definitionId',\n functionType: 'POST_ACTION_EXECUTION',\n);\n\nvar_dump($publicActionFunction);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE/$FUNCTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_function_type', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - httpMethod: 'get', - summary: 'Retrieve functions by a type for a given definition', - description: 'Retrieve functions of a specific type for a given definition.', - stainlessPath: '(resource) automation.actions.functions > (method) get_by_function_type', - qualified: 'client.automation.actions.functions.getByFunctionType', - params: [ - 'appId: number;', - 'definitionId: string;', - "functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS';", - ], - response: - "{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }", - markdown: - "## get_by_function_type\n\n`client.automation.actions.functions.getByFunctionType(appId: number, definitionId: string, functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'): { functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}`\n\nRetrieve functions of a specific type for a given definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n\n### Returns\n\n- `{ functionSource: string; functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }`\n\n - `functionSource: string`\n - `functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'`\n - `id?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionFunction = await client.automation.actions.functions.getByFunctionType('POST_ACTION_EXECUTION', { appId: 0, definitionId: 'definitionId' });\n\nconsole.log(publicActionFunction);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.getByFunctionType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionFunction = await client.automation.actions.functions.getByFunctionType(\n 'POST_ACTION_EXECUTION',\n { appId: 0, definitionId: 'definitionId' },\n);\n\nconsole.log(publicActionFunction.id);", - }, - python: { - method: 'automation.actions.functions.get_by_function_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_function = client.automation.actions.functions.get_by_function_type(\n function_type="POST_ACTION_EXECUTION",\n app_id=0,\n definition_id="definitionId",\n)\nprint(public_action_function.id)', - }, - java: { - method: 'automation().actions().functions().getByFunctionType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionFunction;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionGetByFunctionTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionGetByFunctionTypeParams params = FunctionGetByFunctionTypeParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .functionType(FunctionGetByFunctionTypeParams.FunctionType.POST_ACTION_EXECUTION)\n .build();\n PublicActionFunction publicActionFunction = client.automation().actions().functions().getByFunctionType(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.GetByFunctionType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionFunction, err := client.Automation.Actions.Functions.GetByFunctionType(\n\t\tcontext.TODO(),\n\t\tautomation.ActionFunctionGetByFunctionTypeParamsFunctionTypePostActionExecution,\n\t\tautomation.ActionFunctionGetByFunctionTypeParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionFunction.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.functions.get_by_function_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_function = hubspot.automation.actions.functions.get_by_function_type(\n :POST_ACTION_EXECUTION,\n app_id: 0,\n definition_id: "definitionId"\n)\n\nputs(public_action_function)', - }, - php: { - method: 'automation->actions->functions->getByFunctionType', - example: - "automation\n ->actions\n ->functions\n ->getByFunctionType(\n 'POST_ACTION_EXECUTION', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($publicActionFunction);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions/$FUNCTION_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/functions', - httpMethod: 'get', - summary: 'Retrieve functions for a given definition', - description: 'Retrieve all functions included in a definition.', - stainlessPath: '(resource) automation.actions.functions > (method) list', - qualified: 'client.automation.actions.functions.list', - params: ['appId: number;', 'definitionId: string;'], - response: - "{ results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; }", - markdown: - "## list\n\n`client.automation.actions.functions.list(appId: number, definitionId: string): { results: public_action_function_identifier[]; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/functions`\n\nRetrieve all functions included in a definition.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n### Returns\n\n- `{ results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; }`\n\n - `results: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicActionFunctionIdentifierNoPaging = await client.automation.actions.functions.list('definitionId', { appId: 0 });\n\nconsole.log(collectionResponsePublicActionFunctionIdentifierNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.functions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicActionFunctionIdentifierNoPaging =\n await client.automation.actions.functions.list('definitionId', { appId: 0 });\n\nconsole.log(collectionResponsePublicActionFunctionIdentifierNoPaging.results);", - }, - python: { - method: 'automation.actions.functions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_action_function_identifier_no_paging = client.automation.actions.functions.list(\n definition_id="definitionId",\n app_id=0,\n)\nprint(collection_response_public_action_function_identifier_no_paging.results)', - }, - java: { - method: 'automation().actions().functions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.CollectionResponsePublicActionFunctionIdentifierNoPaging;\nimport com.hubspot.sdk.models.automation.actions.functions.FunctionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FunctionListParams params = FunctionListParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n CollectionResponsePublicActionFunctionIdentifierNoPaging collectionResponsePublicActionFunctionIdentifierNoPaging = client.automation().actions().functions().list(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Functions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicActionFunctionIdentifierNoPaging, err := client.Automation.Actions.Functions.List(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionFunctionListParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicActionFunctionIdentifierNoPaging.Results)\n}\n', - }, - ruby: { - method: 'automation.actions.functions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_action_function_identifier_no_paging = hubspot.automation.actions.functions.list("definitionId", app_id: 0)\n\nputs(collection_response_public_action_function_identifier_no_paging)', - }, - php: { - method: 'automation->actions->functions->list', - example: - "automation\n ->actions\n ->functions\n ->list('definitionId', appID: 0);\n\nvar_dump($collectionResponsePublicActionFunctionIdentifierNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/functions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Retrieve a specific revision of a definition', - description: 'Retrieve a specific revision of a definition by revision ID.', - stainlessPath: '(resource) automation.actions.revisions > (method) get', - qualified: 'client.automation.actions.revisions.get', - params: ['appId: number;', 'definitionId: string;', 'revisionId: string;'], - response: - '{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }', - markdown: - "## get\n\n`client.automation.actions.revisions.get(appId: number, definitionId: string, revisionId: string): { id: string; createdAt: string; definition: public_action_definition; revisionId: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}`\n\nRetrieve a specific revision of a definition by revision ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `definition: { id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n - `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicActionRevision = await client.automation.actions.revisions.get('revisionId', { appId: 0, definitionId: 'definitionId' });\n\nconsole.log(publicActionRevision);\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.revisions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicActionRevision = await client.automation.actions.revisions.get('revisionId', {\n appId: 0,\n definitionId: 'definitionId',\n});\n\nconsole.log(publicActionRevision.id);", - }, - python: { - method: 'automation.actions.revisions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_action_revision = client.automation.actions.revisions.get(\n revision_id="revisionId",\n app_id=0,\n definition_id="definitionId",\n)\nprint(public_action_revision.id)', - }, - java: { - method: 'automation().actions().revisions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.PublicActionRevision;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetParams params = RevisionGetParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .revisionId("revisionId")\n .build();\n PublicActionRevision publicActionRevision = client.automation().actions().revisions().get(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Revisions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicActionRevision, err := client.Automation.Actions.Revisions.Get(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tautomation.ActionRevisionGetParams{\n\t\t\tAppID: 0,\n\t\t\tDefinitionID: "definitionId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicActionRevision.ID)\n}\n', - }, - ruby: { - method: 'automation.actions.revisions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_action_revision = hubspot.automation.actions.revisions.get("revisionId", app_id: 0, definition_id: "definitionId")\n\nputs(public_action_revision)', - }, - php: { - method: 'automation->actions->revisions->get', - example: - "automation->actions->revisions->get(\n 'revisionId', appID: 0, definitionID: 'definitionId'\n);\n\nvar_dump($publicActionRevision);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/automation/actions/2026-03/{appId}/{definitionId}/revisions', - httpMethod: 'get', - summary: 'Retrieve revisions for a given definition', - description: 'Retrieve the versions of a definition by ID.', - stainlessPath: '(resource) automation.actions.revisions > (method) list', - qualified: 'client.automation.actions.revisions.list', - params: ['appId: number;', 'definitionId: string;', 'after?: string;', 'limit?: number;'], - response: - '{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }', - markdown: - "## list\n\n`client.automation.actions.revisions.list(appId: number, definitionId: string, after?: string, limit?: number): { id: string; createdAt: string; definition: public_action_definition; revisionId: string; }`\n\n**get** `/automation/actions/2026-03/{appId}/{definitionId}/revisions`\n\nRetrieve the versions of a definition by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `definitionId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: string; definition: { id: string; actionUrl: string; functions: public_action_function_identifier[]; inputFields: public_input_field_definition[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: public_execution_translation_rule[]; inputFieldDependencies?: public_single_field_dependency | public_conditional_single_field_dependency[]; objectRequestOptions?: public_object_request_options; outputFields?: output_field_definition[]; }; revisionId: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `definition: { id: string; actionUrl: string; functions: { functionType: 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS'; id?: string; }[]; inputFields: { isRequired: boolean; typeDefinition: public_field_type_definition; supportedValueTypes?: 'STATIC_VALUE' | 'OBJECT_PROPERTY'[]; }[]; labels: object; objectTypes: string[]; published: boolean; revisionId: string; archivedAt?: number; executionRules?: { conditions: object; labelName: string; }[]; inputFieldDependencies?: { controllingFieldName: string; dependencyType: 'SINGLE_FIELD'; dependentFieldNames: string[]; } | { controllingFieldName: string; controllingFieldValue: string; dependencyType: 'CONDITIONAL_SINGLE_FIELD'; dependentFieldNames: string[]; }[]; objectRequestOptions?: { properties: string[]; }; outputFields?: { typeDefinition: field_type_definition; }[]; }`\n - `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionRevision of client.automation.actions.revisions.list('definitionId', { appId: 0 })) {\n console.log(publicActionRevision);\n}\n```", - perLanguage: { - typescript: { - method: 'client.automation.actions.revisions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicActionRevision of client.automation.actions.revisions.list('definitionId', {\n appId: 0,\n})) {\n console.log(publicActionRevision.id);\n}", - }, - python: { - method: 'automation.actions.revisions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.actions.revisions.list(\n definition_id="definitionId",\n app_id=0,\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'automation().actions().revisions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionListPage;\nimport com.hubspot.sdk.models.automation.actions.revisions.RevisionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListParams params = RevisionListParams.builder()\n .appId(0)\n .definitionId("definitionId")\n .build();\n RevisionListPage page = client.automation().actions().revisions().list(params);\n }\n}', - }, - go: { - method: 'client.Automation.Actions.Revisions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Actions.Revisions.List(\n\t\tcontext.TODO(),\n\t\t"definitionId",\n\t\tautomation.ActionRevisionListParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'automation.actions.revisions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.actions.revisions.list("definitionId", app_id: 0)\n\nputs(page)', - }, - php: { - method: 'automation->actions->revisions->list', - example: - "automation->actions->revisions->list(\n 'definitionId', appID: 0, after: 'after', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/actions/2026-03/$APP_ID/$DEFINITION_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create_enrollment', - endpoint: '/automation/sequences/2026-03/enrollments', - httpMethod: 'post', - summary: 'Enroll a contact in a sequence', - description: 'Enroll a contact into a sequence using the specified user ID and sequence details.', - stainlessPath: '(resource) automation.sequences > (method) create_enrollment', - qualified: 'client.automation.sequences.createEnrollment', - params: [ - 'userId: string;', - 'contactId: string;', - 'senderEmail: string;', - 'sequenceId: string;', - 'senderAliasAddress?: string;', - ], - response: '{ id: string; enrolledAt: string; toEmail: string; updatedAt: string; }', - markdown: - "## create_enrollment\n\n`client.automation.sequences.createEnrollment(userId: string, contactId: string, senderEmail: string, sequenceId: string, senderAliasAddress?: string): { id: string; enrolledAt: string; toEmail: string; updatedAt: string; }`\n\n**post** `/automation/sequences/2026-03/enrollments`\n\nEnroll a contact into a sequence using the specified user ID and sequence details.\n\n### Parameters\n\n- `userId: string`\n\n- `contactId: string`\n The unique identifier of the contact to be enrolled in the sequence.\n\n- `senderEmail: string`\n The email address of the sender enrolling the contact in the sequence.\n\n- `sequenceId: string`\n The unique identifier of the sequence in which the contact will be enrolled.\n\n- `senderAliasAddress?: string`\n The alias email address used by the sender when enrolling the contact.\n\n### Returns\n\n- `{ id: string; enrolledAt: string; toEmail: string; updatedAt: string; }`\n\n - `id: string`\n - `enrolledAt: string`\n - `toEmail: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceEnrollmentLiteResponse = await client.automation.sequences.createEnrollment({\n userId: 'userId',\n contactId: 'contactId',\n senderEmail: 'senderEmail',\n sequenceId: 'sequenceId',\n});\n\nconsole.log(publicSequenceEnrollmentLiteResponse);\n```", - perLanguage: { - typescript: { - method: 'client.automation.sequences.createEnrollment', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceEnrollmentLiteResponse = await client.automation.sequences.createEnrollment({\n userId: 'userId',\n contactId: 'contactId',\n senderEmail: 'senderEmail',\n sequenceId: 'sequenceId',\n});\n\nconsole.log(publicSequenceEnrollmentLiteResponse.id);", - }, - python: { - method: 'automation.sequences.create_enrollment', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_enrollment_lite_response = client.automation.sequences.create_enrollment(\n user_id="userId",\n contact_id="contactId",\n sender_email="senderEmail",\n sequence_id="sequenceId",\n)\nprint(public_sequence_enrollment_lite_response.id)', - }, - java: { - method: 'automation().sequences().createEnrollment', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentLiteResponse;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentRequest;\nimport com.hubspot.sdk.models.automation.sequences.SequenceCreateEnrollmentParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceCreateEnrollmentParams params = SequenceCreateEnrollmentParams.builder()\n .userId("userId")\n .publicSequenceEnrollmentRequest(PublicSequenceEnrollmentRequest.builder()\n .contactId("contactId")\n .senderEmail("senderEmail")\n .sequenceId("sequenceId")\n .build())\n .build();\n PublicSequenceEnrollmentLiteResponse publicSequenceEnrollmentLiteResponse = client.automation().sequences().createEnrollment(params);\n }\n}', - }, - go: { - method: 'client.Automation.Sequences.NewEnrollment', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceEnrollmentLiteResponse, err := client.Automation.Sequences.NewEnrollment(context.TODO(), automation.SequenceNewEnrollmentParams{\n\t\tUserID: "userId",\n\t\tPublicSequenceEnrollmentRequest: automation.PublicSequenceEnrollmentRequestParam{\n\t\t\tContactID: "contactId",\n\t\t\tSenderEmail: "senderEmail",\n\t\t\tSequenceID: "sequenceId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceEnrollmentLiteResponse.ID)\n}\n', - }, - ruby: { - method: 'automation.sequences.create_enrollment', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_enrollment_lite_response = hubspot.automation.sequences.create_enrollment(\n user_id: "userId",\n contact_id: "contactId",\n sender_email: "senderEmail",\n sequence_id: "sequenceId"\n)\n\nputs(public_sequence_enrollment_lite_response)', - }, - php: { - method: 'automation->sequences->createEnrollment', - example: - "automation\n ->sequences\n ->createEnrollment(\n userID: 'userId',\n contactID: 'contactId',\n senderEmail: 'senderEmail',\n sequenceID: 'sequenceId',\n senderAliasAddress: 'senderAliasAddress',\n);\n\nvar_dump($publicSequenceEnrollmentLiteResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/sequences/2026-03/enrollments \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactId": "contactId",\n "senderEmail": "senderEmail",\n "sequenceId": "sequenceId"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/automation/sequences/2026-03/{sequenceId}', - httpMethod: 'get', - summary: 'Retrieve details for a sequence', - description: 'Retrieve details of a specific sequence by its ID.', - stainlessPath: '(resource) automation.sequences > (method) get', - qualified: 'client.automation.sequences.get', - params: ['sequenceId: string;', 'userId: string;'], - response: - "{ id: string; createdAt: string; dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]; name: string; steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: public_email_pattern_response; taskPattern?: public_task_pattern_response; }[]; updatedAt: string; userId: string; folderId?: string; settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }; }", - markdown: - "## get\n\n`client.automation.sequences.get(sequenceId: string, userId: string): { id: string; createdAt: string; dependencies: public_sequence_step_dependency_response[]; name: string; steps: public_sequence_step_response[]; updatedAt: string; userId: string; folderId?: string; settings?: public_sequence_settings_response; }`\n\n**get** `/automation/sequences/2026-03/{sequenceId}`\n\nRetrieve details of a specific sequence by its ID.\n\n### Parameters\n\n- `sequenceId: string`\n\n- `userId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]; name: string; steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: public_email_pattern_response; taskPattern?: public_task_pattern_response; }[]; updatedAt: string; userId: string; folderId?: string; settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `dependencies: { id: string; createdAt: string; dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION'; reliesOnSequenceStepId: string; reliesOnStepOrder: number; requiredBySequenceStepId: string; requiredByStepOrder: number; updatedAt: string; }[]`\n - `name: string`\n - `steps: { id: string; actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK'; createdAt: string; delayMillis: number; stepOrder: number; updatedAt: string; emailPattern?: { id: string; createdAt: string; templateId: string; updatedAt: string; threadEmailToStepOrder?: number; }; taskPattern?: { id: string; createdAt: string; taskPriority: 'HIGH' | 'LOW' | 'MEDIUM' | 'NONE'; taskType: 'CALL' | 'EMAIL' | 'LINKED_IN_CONNECT' | 'LINKED_IN_MESSAGE' | 'MEETING' | 'TODO'; updatedAt: string; notes?: string; queueId?: number; subject?: string; templateId?: number; threadEmailToStepOrder?: number; }; }[]`\n - `updatedAt: string`\n - `userId: string`\n - `folderId?: string`\n - `settings?: { id: string; createdAt: string; eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY'; individualTaskRemindersEnabled: boolean; sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED'; sendWindowEndMinute: number; sendWindowStartMinute: number; taskReminderMinute: number; updatedAt: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceResponse = await client.automation.sequences.get('sequenceId', { userId: 'userId' });\n\nconsole.log(publicSequenceResponse);\n```", - perLanguage: { - typescript: { - method: 'client.automation.sequences.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceResponse = await client.automation.sequences.get('sequenceId', {\n userId: 'userId',\n});\n\nconsole.log(publicSequenceResponse.id);", - }, - python: { - method: 'automation.sequences.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_response = client.automation.sequences.get(\n sequence_id="sequenceId",\n user_id="userId",\n)\nprint(public_sequence_response.id)', - }, - java: { - method: 'automation().sequences().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceResponse;\nimport com.hubspot.sdk.models.automation.sequences.SequenceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceGetParams params = SequenceGetParams.builder()\n .sequenceId("sequenceId")\n .userId("userId")\n .build();\n PublicSequenceResponse publicSequenceResponse = client.automation().sequences().get(params);\n }\n}', - }, - go: { - method: 'client.Automation.Sequences.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceResponse, err := client.Automation.Sequences.Get(\n\t\tcontext.TODO(),\n\t\t"sequenceId",\n\t\tautomation.SequenceGetParams{\n\t\t\tUserID: "userId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceResponse.ID)\n}\n', - }, - ruby: { - method: 'automation.sequences.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_response = hubspot.automation.sequences.get("sequenceId", user_id: "userId")\n\nputs(public_sequence_response)', - }, - php: { - method: 'automation->sequences->get', - example: - "automation->sequences->get(\n 'sequenceId', userID: 'userId'\n);\n\nvar_dump($publicSequenceResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/sequences/2026-03/$SEQUENCE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_enrollment_by_contact_id', - endpoint: '/automation/sequences/2026-03/enrollments/contact/{contactId}', - httpMethod: 'get', - summary: 'Retrieve the enrollment status of a contact', - description: 'Get the enrollment status of a contact in sequences by their contact ID.', - stainlessPath: '(resource) automation.sequences > (method) get_enrollment_by_contact_id', - qualified: 'client.automation.sequences.getEnrollmentByContactID', - params: ['contactId: string;'], - response: - '{ id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }', - markdown: - "## get_enrollment_by_contact_id\n\n`client.automation.sequences.getEnrollmentByContactID(contactId: string): { id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }`\n\n**get** `/automation/sequences/2026-03/enrollments/contact/{contactId}`\n\nGet the enrollment status of a contact in sequences by their contact ID.\n\n### Parameters\n\n- `contactId: string`\n\n### Returns\n\n- `{ id: string; enrolledAt: string; enrolledBy: string; enrolledByEmail: string; sequenceId: string; sequenceName: string; toEmail: string; updatedAt: string; }`\n\n - `id: string`\n - `enrolledAt: string`\n - `enrolledBy: string`\n - `enrolledByEmail: string`\n - `sequenceId: string`\n - `sequenceName: string`\n - `toEmail: string`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSequenceEnrollmentResponse = await client.automation.sequences.getEnrollmentByContactID('contactId');\n\nconsole.log(publicSequenceEnrollmentResponse);\n```", - perLanguage: { - typescript: { - method: 'client.automation.sequences.getEnrollmentByContactID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSequenceEnrollmentResponse = await client.automation.sequences.getEnrollmentByContactID(\n 'contactId',\n);\n\nconsole.log(publicSequenceEnrollmentResponse.id);", - }, - python: { - method: 'automation.sequences.get_enrollment_by_contact_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_sequence_enrollment_response = client.automation.sequences.get_enrollment_by_contact_id(\n "contactId",\n)\nprint(public_sequence_enrollment_response.id)', - }, - java: { - method: 'automation().sequences().getEnrollmentByContactId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.PublicSequenceEnrollmentResponse;\nimport com.hubspot.sdk.models.automation.sequences.SequenceGetEnrollmentByContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSequenceEnrollmentResponse publicSequenceEnrollmentResponse = client.automation().sequences().getEnrollmentByContactId("contactId");\n }\n}', - }, - go: { - method: 'client.Automation.Sequences.GetEnrollmentByContactID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSequenceEnrollmentResponse, err := client.Automation.Sequences.GetEnrollmentByContactID(context.TODO(), "contactId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSequenceEnrollmentResponse.ID)\n}\n', - }, - ruby: { - method: 'automation.sequences.get_enrollment_by_contact_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_sequence_enrollment_response = hubspot.automation.sequences.get_enrollment_by_contact_id("contactId")\n\nputs(public_sequence_enrollment_response)', - }, - php: { - method: 'automation->sequences->getEnrollmentByContactID', - example: - "automation\n ->sequences\n ->getEnrollmentByContactID('contactId');\n\nvar_dump($publicSequenceEnrollmentResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/sequences/2026-03/enrollments/contact/$CONTACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/automation/sequences/2026-03', - httpMethod: 'get', - summary: 'Retrieve sequences', - description: - 'Retrieve a list of sequences available in your HubSpot account. This endpoint allows you to filter sequences by user ID and name, and supports pagination for large result sets. Use this endpoint to manage and review your sequences effectively.', - stainlessPath: '(resource) automation.sequences > (method) list', - qualified: 'client.automation.sequences.list', - params: ['userId: string;', 'after?: string;', 'limit?: number;', 'name?: string;'], - response: - '{ id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }', - markdown: - "## list\n\n`client.automation.sequences.list(userId: string, after?: string, limit?: number, name?: string): { id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }`\n\n**get** `/automation/sequences/2026-03`\n\nRetrieve a list of sequences available in your HubSpot account. This endpoint allows you to filter sequences by user ID and name, and supports pagination for large result sets. Use this endpoint to manage and review your sequences effectively.\n\n### Parameters\n\n- `userId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; name: string; updatedAt: string; userId: string; folderId?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `name: string`\n - `updatedAt: string`\n - `userId: string`\n - `folderId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicSequenceLiteResponse of client.automation.sequences.list({ userId: 'userId' })) {\n console.log(publicSequenceLiteResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.automation.sequences.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicSequenceLiteResponse of client.automation.sequences.list({\n userId: 'userId',\n})) {\n console.log(publicSequenceLiteResponse.id);\n}", - }, - python: { - method: 'automation.sequences.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.automation.sequences.list(\n user_id="userId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'automation().sequences().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.automation.sequences.SequenceListPage;\nimport com.hubspot.sdk.models.automation.sequences.SequenceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SequenceListParams params = SequenceListParams.builder()\n .userId("userId")\n .build();\n SequenceListPage page = client.automation().sequences().list(params);\n }\n}', - }, - go: { - method: 'client.Automation.Sequences.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/automation"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Automation.Sequences.List(context.TODO(), automation.SequenceListParams{\n\t\tUserID: "userId",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'automation.sequences.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.automation.sequences.list(user_id: "userId")\n\nputs(page)', - }, - php: { - method: 'automation->sequences->list', - example: - "automation->sequences->list(\n userID: 'userId', after: 'after', limit: 0, name: 'name'\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/automation/sequences/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_user_id', - endpoint: '/business-units/public/2026-03/business-units/user/{userId}', - httpMethod: 'get', - summary: 'Retrieve brands by associated user', - description: 'Retrieve the brands that a specific user can access.', - stainlessPath: '(resource) business_units.business_unit_entries > (method) get_by_user_id', - qualified: 'client.businessUnits.businessUnitEntries.getByUserID', - params: ['userId: string;', 'name?: string[];', 'properties?: string[];'], - response: - '{ results: { id: string; name: string; logoMetadata?: public_business_unit_logo_metadata; }[]; }', - markdown: - "## get_by_user_id\n\n`client.businessUnits.businessUnitEntries.getByUserID(userId: string, name?: string[], properties?: string[]): { results: public_business_unit[]; }`\n\n**get** `/business-units/public/2026-03/business-units/user/{userId}`\n\nRetrieve the brands that a specific user can access.\n\n### Parameters\n\n- `userId: string`\n\n- `name?: string[]`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ results: { id: string; name: string; logoMetadata?: public_business_unit_logo_metadata; }[]; }`\n\n - `results: { id: string; name: string; logoMetadata?: { logoAltText?: string; logoUrl?: string; resizedUrl?: string; }; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicBusinessUnitNoPaging = await client.businessUnits.businessUnitEntries.getByUserID('userId');\n\nconsole.log(collectionResponsePublicBusinessUnitNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.businessUnits.businessUnitEntries.getByUserID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicBusinessUnitNoPaging =\n await client.businessUnits.businessUnitEntries.getByUserID('userId');\n\nconsole.log(collectionResponsePublicBusinessUnitNoPaging.results);", - }, - python: { - method: 'business_units.business_unit_entries.get_by_user_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_business_unit_no_paging = client.business_units.business_unit_entries.get_by_user_id(\n user_id="userId",\n)\nprint(collection_response_public_business_unit_no_paging.results)', - }, - java: { - method: 'businessUnits().businessUnitEntries().getByUserId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.businessunits.CollectionResponsePublicBusinessUnitNoPaging;\nimport com.hubspot.sdk.models.businessunits.businessunitentries.BusinessUnitEntryGetByUserIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicBusinessUnitNoPaging collectionResponsePublicBusinessUnitNoPaging = client.businessUnits().businessUnitEntries().getByUserId("userId");\n }\n}', - }, - go: { - method: 'client.BusinessUnits.BusinessUnitEntries.GetByUserID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/business_units"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicBusinessUnitNoPaging, err := client.BusinessUnits.BusinessUnitEntries.GetByUserID(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tbusiness_units.BusinessUnitEntryGetByUserIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicBusinessUnitNoPaging.Results)\n}\n', - }, - ruby: { - method: 'business_units.business_unit_entries.get_by_user_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_business_unit_no_paging = hubspot.business_units.business_unit_entries.get_by_user_id("userId")\n\nputs(collection_response_public_business_unit_no_paging)', - }, - php: { - method: 'businessUnits->businessUnitEntries->getByUserID', - example: - "businessUnits\n ->businessUnitEntries\n ->getByUserID('userId', name: ['string'], properties: ['string']);\n\nvar_dump($collectionResponsePublicBusinessUnitNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/business-units/public/2026-03/business-units/user/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'export', - endpoint: '/cms/audit-logs/2026-03/export', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) cms.audit_logs > (method) export', - qualified: 'client.cms.auditLogs.export', - params: [ - 'email: string;', - "format: 'CSV' | 'XLS' | 'XLSX';", - 'portalId: number;', - 'recipientUserIds: number[];', - 'shouldMarkExportFileAsSensitive: boolean;', - 'type: string;', - 'filters?: { objectType: string[]; };', - 'partition?: number;', - 'userId?: number;', - 'userTimeZone?: string;', - ], - markdown: - "## export\n\n`client.cms.auditLogs.export(email: string, format: 'CSV' | 'XLS' | 'XLSX', portalId: number, recipientUserIds: number[], shouldMarkExportFileAsSensitive: boolean, type: string, filters?: { objectType: string[]; }, partition?: number, userId?: number, userTimeZone?: string): void`\n\n**post** `/cms/audit-logs/2026-03/export`\n\n### Parameters\n\n- `email: string`\n\n- `format: 'CSV' | 'XLS' | 'XLSX'`\n\n- `portalId: number`\n\n- `recipientUserIds: number[]`\n\n- `shouldMarkExportFileAsSensitive: boolean`\n\n- `type: string`\n\n- `filters?: { objectType: string[]; }`\n - `objectType: string[]`\n\n- `partition?: number`\n\n- `userId?: number`\n\n- `userTimeZone?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.auditLogs.export({\n email: 'email',\n format: 'CSV',\n portalId: 0,\n recipientUserIds: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n})\n```", - perLanguage: { - typescript: { - method: 'client.cms.auditLogs.export', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.auditLogs.export({\n email: 'email',\n format: 'CSV',\n portalId: 0,\n recipientUserIds: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n});", - }, - python: { - method: 'cms.audit_logs.export', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.audit_logs.export(\n email="email",\n format="CSV",\n portal_id=0,\n recipient_user_ids=[0],\n should_mark_export_file_as_sensitive=True,\n type="type",\n)', - }, - java: { - method: 'cms().auditLogs().export', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.auditlogs.CmsAuditLoggingExportSettings;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CmsAuditLoggingExportSettings params = CmsAuditLoggingExportSettings.builder()\n .email("email")\n .format(CmsAuditLoggingExportSettings.Format.CSV)\n .portalId(0)\n .addRecipientUserId(0)\n .shouldMarkExportFileAsSensitive(true)\n .type("type")\n .build();\n client.cms().auditLogs().export(params);\n }\n}', - }, - go: { - method: 'client.Cms.AuditLogs.Export', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.AuditLogs.Export(context.TODO(), cms.AuditLogExportParams{\n\t\tCmsAuditLoggingExportSettings: cms.CmsAuditLoggingExportSettingsParam{\n\t\t\tEmail: "email",\n\t\t\tFormat: cms.CmsAuditLoggingExportSettingsFormatCsv,\n\t\t\tPortalID: 0,\n\t\t\tRecipientUserIDs: []int64{0},\n\t\t\tShouldMarkExportFileAsSensitive: true,\n\t\t\tType: "type",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.audit_logs.export', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.audit_logs.export(\n email: "email",\n format_: :CSV,\n portal_id: 0,\n recipient_user_ids: [0],\n should_mark_export_file_as_sensitive: true,\n type: "type"\n)\n\nputs(result)', - }, - php: { - method: 'cms->auditLogs->export', - example: - "cms->auditLogs->export(\n email: 'email',\n format: 'CSV',\n portalID: 0,\n recipientUserIDs: [0],\n shouldMarkExportFileAsSensitive: true,\n type: 'type',\n filters: ['objectType' => ['string']],\n partition: 0,\n userID: 0,\n userTimeZone: 'userTimeZone',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/audit-logs/2026-03/export \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email",\n "format": "CSV",\n "portalId": 0,\n "recipientUserIds": [\n 0\n ],\n "shouldMarkExportFileAsSensitive": true,\n "type": "type"\n }\'', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/audit-logs/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.audit_logs > (method) list', - qualified: 'client.cms.auditLogs.list', - params: [ - 'after?: string;', - 'before?: string;', - 'eventType?: string[];', - 'limit?: number;', - 'objectId?: string[];', - 'objectType?: string[];', - 'sort?: string[];', - 'userId?: string[];', - ], - response: - "{ event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }", - markdown: - "## list\n\n`client.cms.auditLogs.list(after?: string, before?: string, eventType?: string[], limit?: number, objectId?: string[], objectType?: string[], sort?: string[], userId?: string[]): { event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }`\n\n**get** `/cms/audit-logs/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `eventType?: string[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `objectId?: string[]`\n\n- `objectType?: string[]`\n\n- `sort?: string[]`\n\n- `userId?: string[]`\n\n### Returns\n\n- `{ event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'; fullName: string; meta: object; objectId: string; objectName: string; objectType: string; timestamp: string; userId: string; }`\n\n - `event: 'CREATED' | 'DELETED' | 'PUBLISHED' | 'RESTORE' | 'UNPUBLISHED' | 'UPDATED'`\n - `fullName: string`\n - `meta: object`\n - `objectId: string`\n - `objectName: string`\n - `objectType: string`\n - `timestamp: string`\n - `userId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicAuditLog of client.cms.auditLogs.list()) {\n console.log(publicAuditLog);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.auditLogs.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicAuditLog of client.cms.auditLogs.list()) {\n console.log(publicAuditLog.event);\n}", - }, - python: { - method: 'cms.audit_logs.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.audit_logs.list()\npage = page.results[0]\nprint(page.event)', - }, - java: { - method: 'cms().auditLogs().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.auditlogs.AuditLogListPage;\nimport com.hubspot.sdk.models.cms.auditlogs.AuditLogListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AuditLogListPage page = client.cms().auditLogs().list();\n }\n}', - }, - go: { - method: 'client.Cms.AuditLogs.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.AuditLogs.List(context.TODO(), cms.AuditLogListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.audit_logs.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.audit_logs.list\n\nputs(page)', - }, - php: { - method: 'cms->auditLogs->list', - example: - "cms->auditLogs->list(\n after: 'after',\n before: 'before',\n eventType: ['string'],\n limit: 0,\n objectID: ['string'],\n objectType: ['string'],\n sort: ['string'],\n userID: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/audit-logs/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Attach a Blog Author to a multi-language group', - description: 'Attach a Blog Author to a multi-language group.', - stainlessPath: '(resource) cms.blogs.authors > (method) attach_to_lang_group', - qualified: 'client.cms.blogs.authors.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.blogs.authors.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group`\n\nAttach a Blog Author to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().authors().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.AttachToLangGroup(context.TODO(), cms.BlogAuthorAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.attach_to_lang_group(id: "id", language: :aa, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->attachToLangGroup', - example: - "cms->blogs->authors->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/blogs/2026-03/authors', - httpMethod: 'post', - summary: 'Create a new Blog Author', - description: 'Create a new Blog Author.', - stainlessPath: '(resource) cms.blogs.authors > (method) create', - qualified: 'client.cms.blogs.authors.create', - params: [ - 'id: string;', - 'avatar: string;', - 'bio: string;', - 'created: string;', - 'deletedAt: string;', - 'displayName: string;', - 'email: string;', - 'facebook: string;', - 'fullName: string;', - 'language: string;', - 'linkedin: string;', - 'name: string;', - 'slug: string;', - 'translatedFromId: number;', - 'twitter: string;', - 'updated: string;', - 'website: string;', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.blogs.authors.create(id: string, avatar: string, bio: string, created: string, deletedAt: string, displayName: string, email: string, facebook: string, fullName: string, language: string, linkedin: string, name: string, slug: string, translatedFromId: number, twitter: string, updated: string, website: string): string`\n\n**post** `/cms/blogs/2026-03/authors`\n\nCreate a new Blog Author.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Author.\n\n- `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n\n- `bio: string`\n A short biography of the blog author.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n\n- `displayName: string`\n The full name of the Blog Author to be displayed.\n\n- `email: string`\n Email address of the Blog Author.\n\n- `facebook: string`\n URL to the Blog Author's Facebook page.\n\n- `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n\n- `linkedin: string`\n URL to the blog author's LinkedIn page.\n\n- `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n\n- `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n\n- `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n\n- `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n\n- `website: string`\n URL to the website of the Blog Author.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.create({\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.create({\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.create(\n id="id",\n avatar="avatar",\n bio="bio",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n display_name="displayName",\n email="email",\n facebook="facebook",\n full_name="fullName",\n language="aa",\n linkedin="linkedin",\n name="name",\n slug="slug",\n translated_from_id=0,\n twitter="twitter",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n website="website",\n)\nprint(author)\ncontent = author.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogAuthor params = BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build();\n HttpResponse author = client.cms().blogs().authors().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.New(context.TODO(), cms.BlogAuthorNewParams{\n\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\tID: "id",\n\t\t\tAvatar: "avatar",\n\t\t\tBio: "bio",\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tDisplayName: "displayName",\n\t\t\tEmail: "email",\n\t\t\tFacebook: "facebook",\n\t\t\tFullName: "fullName",\n\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\tLinkedin: "linkedin",\n\t\t\tName: "name",\n\t\t\tSlug: "slug",\n\t\t\tTranslatedFromID: 0,\n\t\t\tTwitter: "twitter",\n\t\t\tUpdated: time.Now(),\n\t\t\tWebsite: "website",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.create(\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n display_name: "displayName",\n email: "email",\n facebook: "facebook",\n full_name: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n)\n\nputs(author)', - }, - php: { - method: 'cms->blogs->authors->create', - example: - "cms->blogs->authors->create(\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n twitter: 'twitter',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n website: 'website',\n);\n\nvar_dump($author);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\'', - }, - }, - }, - { - name: 'create_language_variation', - endpoint: '/cms/blogs/2026-03/authors/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a new language variation', - description: 'Create a new language variation from an existing Blog Author.', - stainlessPath: '(resource) cms.blogs.authors > (method) create_language_variation', - qualified: 'client.cms.blogs.authors.createLanguageVariation', - params: [ - 'id: string;', - 'blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; };', - 'language?: string;', - 'primaryLanguage?: string;', - 'usePublished?: boolean;', - ], - response: 'string', - markdown: - "## create_language_variation\n\n`client.cms.blogs.authors.createLanguageVariation(id: string, blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }, language?: string, primaryLanguage?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/create-language-variation`\n\nCreate a new language variation from an existing Blog Author.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `blogAuthor: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }`\n - `id: string`\n The unique ID of the Blog Author.\n - `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n - `bio: string`\n A short biography of the blog author.\n - `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n - `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n - `displayName: string`\n The full name of the Blog Author to be displayed.\n - `email: string`\n Email address of the Blog Author.\n - `facebook: string`\n URL to the Blog Author's Facebook page.\n - `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n - `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n - `linkedin: string`\n URL to the blog author's LinkedIn page.\n - `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n - `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n - `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n - `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n - `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n - `website: string`\n URL to the website of the Blog Author.\n\n- `language?: string`\n Language of newly cloned object.\n\n- `primaryLanguage?: string`\n Primary language in multi-language group.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.createLanguageVariation({\n id: 'id',\n blogAuthor: {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n},\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.createLanguageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.createLanguageVariation({\n id: 'id',\n blogAuthor: {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n },\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.create_language_variation', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.create_language_variation(\n id="id",\n blog_author={\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "display_name": "displayName",\n "email": "email",\n "facebook": "facebook",\n "full_name": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "twitter": "twitter",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "website": "website",\n },\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().createLanguageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthorCloneRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogAuthorCloneRequestVNext params = BlogAuthorCloneRequestVNext.builder()\n .id("id")\n .blogAuthor(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse response = client.cms().blogs().authors().createLanguageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.NewLanguageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.NewLanguageVariation(context.TODO(), cms.BlogAuthorNewLanguageVariationParams{\n\t\tBlogAuthorCloneRequestVNext: cms.BlogAuthorCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.create_language_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.create_language_variation(\n id: "id",\n blog_author: {\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n displayName: "displayName",\n email: "email",\n facebook: "facebook",\n fullName: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n }\n)\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->createLanguageVariation', - example: - "cms->blogs->authors->createLanguageVariation(\n id: 'id',\n blogAuthor: [\n 'id' => 'id',\n 'avatar' => 'avatar',\n 'bio' => 'bio',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'displayName' => 'displayName',\n 'email' => 'email',\n 'facebook' => 'facebook',\n 'fullName' => 'fullName',\n 'language' => 'aa',\n 'linkedin' => 'linkedin',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'twitter' => 'twitter',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'website' => 'website',\n ],\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "blogAuthor": {\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/authors/{objectId}', - httpMethod: 'delete', - summary: 'Delete a Blog Author', - description: 'Delete the Blog Author object identified by the id in the path.', - stainlessPath: '(resource) cms.blogs.authors > (method) delete', - qualified: 'client.cms.blogs.authors.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.blogs.authors.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/authors/{objectId}`\n\nDelete the Blog Author object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.delete('objectId');", - }, - python: { - method: 'cms.blogs.authors.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().blogs().authors().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().authors().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->authors->delete', - example: - "cms->blogs->authors->delete('objectId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Detach a Blog Author from a multi-language group', - description: 'Detach a Blog Author from a multi-language group.', - stainlessPath: '(resource) cms.blogs.authors > (method) detach_from_lang_group', - qualified: 'client.cms.blogs.authors.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.blogs.authors.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group`\n\nDetach a Blog Author from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().authors().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.DetachFromLangGroup(context.TODO(), cms.BlogAuthorDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->detachFromLangGroup', - example: - "cms->blogs->authors->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blogs/2026-03/authors/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a Blog Author', - description: 'Retrieve the Blog Author object identified by the id in the path.', - stainlessPath: '(resource) cms.blogs.authors > (method) get', - qualified: 'client.cms.blogs.authors.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: 'string', - markdown: - "## get\n\n`client.cms.blogs.authors.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/{objectId}`\n\nRetrieve the Blog Author object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.get('objectId');\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.get('objectId');\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.get(\n object_id="objectId",\n)\nprint(author)\ncontent = author.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse author = client.cms().blogs().authors().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.get("objectId")\n\nputs(author)', - }, - php: { - method: 'cms->blogs->authors->get', - example: - "cms->blogs->authors->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($author);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_cursor', - endpoint: '/cms/blogs/2026-03/authors/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_cursor', - qualified: 'client.cms.blogs.authors.getCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_cursor\n\n`client.cms.blogs.authors.getCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetCursor(context.TODO(), cms.BlogAuthorGetCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getCursor', - example: - "cms->blogs->authors->getCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_cursor_by_query', - endpoint: '/cms/blogs/2026-03/authors/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_cursor_by_query', - qualified: 'client.cms.blogs.authors.getCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_cursor_by_query\n\n`client.cms.blogs.authors.getCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetCursorByQuery(context.TODO(), cms.BlogAuthorGetCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getCursorByQuery', - example: - "cms->blogs->authors->getCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_posts_cursor', - endpoint: '/cms/blogs/2026-03/posts/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_posts_cursor', - qualified: 'client.cms.blogs.authors.getPostsCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_posts_cursor\n\n`client.cms.blogs.authors.getPostsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getPostsCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_posts_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_posts_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getPostsCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetPostsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getPostsCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetPostsCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetPostsCursor(context.TODO(), cms.BlogAuthorGetPostsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_posts_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_posts_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getPostsCursor', - example: - "cms->blogs->authors->getPostsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_posts_cursor_by_query', - endpoint: '/cms/blogs/2026-03/posts/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_posts_cursor_by_query', - qualified: 'client.cms.blogs.authors.getPostsCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_posts_cursor_by_query\n\n`client.cms.blogs.authors.getPostsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getPostsCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_posts_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_posts_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getPostsCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetPostsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getPostsCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetPostsCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetPostsCursorByQuery(context.TODO(), cms.BlogAuthorGetPostsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_posts_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_posts_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getPostsCursorByQuery', - example: - "cms->blogs->authors->getPostsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_tags_cursor', - endpoint: '/cms/blogs/2026-03/tags/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_tags_cursor', - qualified: 'client.cms.blogs.authors.getTagsCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_tags_cursor\n\n`client.cms.blogs.authors.getTagsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getTagsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getTagsCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getTagsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_tags_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_tags_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getTagsCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetTagsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getTagsCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetTagsCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetTagsCursor(context.TODO(), cms.BlogAuthorGetTagsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_tags_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_tags_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getTagsCursor', - example: - "cms->blogs->authors->getTagsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_tags_cursor_by_query', - endpoint: '/cms/blogs/2026-03/tags/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.authors > (method) get_tags_cursor_by_query', - qualified: 'client.cms.blogs.authors.getTagsCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## get_tags_cursor_by_query\n\n`client.cms.blogs.authors.getTagsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.getTagsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.getTagsCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.getTagsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.get_tags_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.get_tags_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().getTagsCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorGetTagsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().authors().getTagsCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.GetTagsCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.GetTagsCursorByQuery(context.TODO(), cms.BlogAuthorGetTagsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.get_tags_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.get_tags_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->getTagsCursorByQuery', - example: - "cms->blogs->authors->getTagsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/blogs/2026-03/authors', - httpMethod: 'get', - summary: 'Get all Blog Authors', - description: - 'Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', - stainlessPath: '(resource) cms.blogs.authors > (method) list', - qualified: 'client.cms.blogs.authors.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list\n\n`client.cms.blogs.authors.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors`\n\nGet the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst authors = await client.cms.blogs.authors.list();\n\nconsole.log(authors);\n\nconst content = await authors.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst authors = await client.cms.blogs.authors.list();\n\nconsole.log(authors);\n\nconst content = await authors.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthors = client.cms.blogs.authors.list()\nprint(authors)\ncontent = authors.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse authors = client.cms().blogs().authors().list();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthors, err := client.Cms.Blogs.Authors.List(context.TODO(), cms.BlogAuthorListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", authors)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthors = hubspot.cms.blogs.authors.list\n\nputs(authors)', - }, - php: { - method: 'cms->blogs->authors->list', - example: - "cms->blogs->authors->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($authors);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'set_new_lang_primary', - endpoint: '/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set a new primary language', - description: 'Set a Blog Author as the primary language of a multi-language group.', - stainlessPath: '(resource) cms.blogs.authors > (method) set_new_lang_primary', - qualified: 'client.cms.blogs.authors.setNewLangPrimary', - params: ['id: string;'], - markdown: - "## set_new_lang_primary\n\n`client.cms.blogs.authors.setNewLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary`\n\nSet a Blog Author as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.setNewLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.setNewLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.setNewLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.blogs.authors.set_new_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.set_new_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().blogs().authors().setNewLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().authors().setNewLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.SetNewLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.SetNewLangPrimary(context.TODO(), cms.BlogAuthorSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.set_new_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.set_new_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->authors->setNewLangPrimary', - example: - "cms->blogs->authors->setNewLangPrimary(id: 'id');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/blogs/2026-03/authors/{objectId}', - httpMethod: 'patch', - summary: 'Update a Blog Author', - description: - 'Sparse updates a single Blog Author object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n', - stainlessPath: '(resource) cms.blogs.authors > (method) update', - qualified: 'client.cms.blogs.authors.update', - params: [ - 'objectId: string;', - 'id: string;', - 'avatar: string;', - 'bio: string;', - 'created: string;', - 'deletedAt: string;', - 'displayName: string;', - 'email: string;', - 'facebook: string;', - 'fullName: string;', - 'language: string;', - 'linkedin: string;', - 'name: string;', - 'slug: string;', - 'translatedFromId: number;', - 'twitter: string;', - 'updated: string;', - 'website: string;', - 'archived?: boolean;', - ], - response: 'string', - markdown: - "## update\n\n`client.cms.blogs.authors.update(objectId: string, id: string, avatar: string, bio: string, created: string, deletedAt: string, displayName: string, email: string, facebook: string, fullName: string, language: string, linkedin: string, name: string, slug: string, translatedFromId: number, twitter: string, updated: string, website: string, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/authors/{objectId}`\n\nSparse updates a single Blog Author object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Author.\n\n- `avatar: string`\n URL to the blog author's avatar, if supplying a custom one.\n\n- `bio: string`\n A short biography of the blog author.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Author was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Author was deleted.\n\n- `displayName: string`\n The full name of the Blog Author to be displayed.\n\n- `email: string`\n Email address of the Blog Author.\n\n- `facebook: string`\n URL to the Blog Author's Facebook page.\n\n- `fullName: string`\n The full, unabbreviated name of the blog author, typically their first and last name combined.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the blog author.\n\n- `linkedin: string`\n URL to the blog author's LinkedIn page.\n\n- `name: string`\n The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.)\n\n- `slug: string`\n A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores.\n\n- `translatedFromId: number`\n ID of the primary blog author this object was translated from.\n\n- `twitter: string`\n URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Author was updated.\n\n- `website: string`\n URL to the website of the Blog Author.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst author = await client.cms.blogs.authors.update('objectId', {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst author = await client.cms.blogs.authors.update('objectId', {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n});\n\nconsole.log(author);\n\nconst content = await author.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nauthor = client.cms.blogs.authors.update(\n object_id="objectId",\n id="id",\n avatar="avatar",\n bio="bio",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n display_name="displayName",\n email="email",\n facebook="facebook",\n full_name="fullName",\n language="aa",\n linkedin="linkedin",\n name="name",\n slug="slug",\n translated_from_id=0,\n twitter="twitter",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n website="website",\n)\nprint(author)\ncontent = author.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.AuthorUpdateParams;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AuthorUpdateParams params = AuthorUpdateParams.builder()\n .objectId("objectId")\n .blogAuthor(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse author = client.cms().blogs().authors().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tauthor, err := client.Cms.Blogs.Authors.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogAuthorUpdateParams{\n\t\t\tBlogAuthor: cms.BlogAuthorParam{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", author)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nauthor = hubspot.cms.blogs.authors.update(\n "objectId",\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n display_name: "displayName",\n email: "email",\n facebook: "facebook",\n full_name: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n)\n\nputs(author)', - }, - php: { - method: 'cms->blogs->authors->update', - example: - "cms->blogs->authors->update(\n 'objectId',\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n twitter: 'twitter',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n website: 'website',\n archived: true,\n);\n\nvar_dump($author);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\'', - }, - }, - }, - { - name: 'update_languages', - endpoint: '/cms/blogs/2026-03/authors/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update languages of multi-language group', - description: 'Explicitly set new languages for each Blog Author in a multi-language group.', - stainlessPath: '(resource) cms.blogs.authors > (method) update_languages', - qualified: 'client.cms.blogs.authors.updateLanguages', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_languages\n\n`client.cms.blogs.authors.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/authors/multi-language/update-languages`\n\nExplicitly set new languages for each Blog Author in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.authors.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.updateLanguages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.authors.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.update_languages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.authors.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().updateLanguages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().authors().updateLanguages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.UpdateLanguages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Authors.UpdateLanguages(context.TODO(), cms.BlogAuthorUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.update_languages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.authors.update_languages(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->authors->updateLanguages', - example: - "cms->blogs->authors->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/blogs/2026-03/authors/batch/create', - httpMethod: 'post', - summary: 'Create a batch of Blog Authors', - description: 'Create the Blog Author objects detailed in the request body.', - stainlessPath: '(resource) cms.blogs.authors.batch > (method) create', - qualified: 'client.cms.blogs.authors.batch.create', - params: [ - 'inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[];', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.blogs.authors.batch.create(inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[]): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/create`\n\nCreate the Blog Author objects detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; avatar: string; bio: string; created: string; deletedAt: string; displayName: string; email: string; facebook: string; fullName: string; language: string; linkedin: string; name: string; slug: string; translatedFromId: number; twitter: string; updated: string; website: string; }[]`\n Blog authors to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.create({ inputs: [{\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.create({\n inputs: [\n {\n id: 'id',\n avatar: 'avatar',\n bio: 'bio',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n displayName: 'displayName',\n email: 'email',\n facebook: 'facebook',\n fullName: 'fullName',\n language: 'aa',\n linkedin: 'linkedin',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n twitter: 'twitter',\n updated: '2019-12-27T18:11:19.117Z',\n website: 'website',\n },\n ],\n});\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.batch.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.create(\n inputs=[{\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "display_name": "displayName",\n "email": "email",\n "facebook": "facebook",\n "full_name": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "twitter": "twitter",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "website": "website",\n }],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.authors.BatchInputBlogAuthor;\nimport com.hubspot.sdk.models.cms.blogs.authors.BlogAuthor;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputBlogAuthor params = BatchInputBlogAuthor.builder()\n .addInput(BlogAuthor.builder()\n .id("id")\n .avatar("avatar")\n .bio("bio")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .displayName("displayName")\n .email("email")\n .facebook("facebook")\n .fullName("fullName")\n .language(BlogAuthor.Language.AA)\n .linkedin("linkedin")\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .twitter("twitter")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .website("website")\n .build())\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.New(context.TODO(), cms.BlogAuthorBatchNewParams{\n\t\tBatchInputBlogAuthor: cms.BatchInputBlogAuthorParam{\n\t\t\tInputs: []cms.BlogAuthorParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAvatar: "avatar",\n\t\t\t\tBio: "bio",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tDisplayName: "displayName",\n\t\t\t\tEmail: "email",\n\t\t\t\tFacebook: "facebook",\n\t\t\t\tFullName: "fullName",\n\t\t\t\tLanguage: cms.BlogAuthorLanguageAa,\n\t\t\t\tLinkedin: "linkedin",\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tTwitter: "twitter",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tWebsite: "website",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.create(\n inputs: [\n {\n id: "id",\n avatar: "avatar",\n bio: "bio",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n displayName: "displayName",\n email: "email",\n facebook: "facebook",\n fullName: "fullName",\n language: :aa,\n linkedin: "linkedin",\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n twitter: "twitter",\n updated: "2019-12-27T18:11:19.117Z",\n website: "website"\n }\n ]\n)\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->authors->batch->create', - example: - "cms->blogs->authors->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'avatar' => 'avatar',\n 'bio' => 'bio',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'displayName' => 'displayName',\n 'email' => 'email',\n 'facebook' => 'facebook',\n 'fullName' => 'fullName',\n 'language' => 'aa',\n 'linkedin' => 'linkedin',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'twitter' => 'twitter',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'website' => 'website',\n ],\n ],\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "avatar": "avatar",\n "bio": "bio",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "displayName": "displayName",\n "email": "email",\n "facebook": "facebook",\n "fullName": "fullName",\n "language": "aa",\n "linkedin": "linkedin",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "twitter": "twitter",\n "updated": "2019-12-27T18:11:19.117Z",\n "website": "website"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/authors/batch/archive', - httpMethod: 'post', - summary: 'Delete a batch of Blog Authors', - description: 'Delete the Blog Author objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.authors.batch > (method) delete', - qualified: 'client.cms.blogs.authors.batch.delete', - params: ['inputs: string[];'], - markdown: - "## delete\n\n`client.cms.blogs.authors.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/authors/batch/archive`\n\nDelete the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.authors.batch.delete({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.authors.batch.delete({ inputs: ['string'] });", - }, - python: { - method: 'cms.blogs.authors.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.authors.batch.delete(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().blogs().authors().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().authors().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Authors.Batch.Delete(context.TODO(), cms.BlogAuthorBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.authors.batch.delete(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->blogs->authors->batch->delete', - example: - "cms->blogs->authors->batch->delete(inputs: ['string']);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blogs/2026-03/authors/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of Blog Authors', - description: 'Retrieve the Blog Author objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.authors.batch > (method) get', - qualified: 'client.cms.blogs.authors.batch.get', - params: ['inputs: string[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## get\n\n`client.cms.blogs.authors.batch.get(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/read`\n\nRetrieve the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.get(\n inputs=["string"],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.Get(context.TODO(), cms.BlogAuthorBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.get(inputs: ["string"])\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->authors->batch->get', - example: - "cms->blogs->authors->batch->get(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/blogs/2026-03/authors/batch/update', - httpMethod: 'post', - summary: 'Update a batch of Blog Authors', - description: 'Update the Blog Author objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.authors.batch > (method) update', - qualified: 'client.cms.blogs.authors.batch.update', - params: ['inputs: object[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## update\n\n`client.cms.blogs.authors.batch.update(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/authors/batch/update`\n\nUpdate the Blog Author objects identified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.authors.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.authors.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.authors.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.authors.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.authors.batch.update(\n inputs=[{}],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().authors().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse batch = client.cms().blogs().authors().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Authors.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Authors.Batch.Update(context.TODO(), cms.BlogAuthorBatchUpdateParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.authors.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.authors.batch.update(inputs: [{}])\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->authors->batch->update', - example: - "cms->blogs->authors->batch->update(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'clone', - endpoint: '/cms/blogs/2026-03/posts/clone', - httpMethod: 'post', - summary: 'Clone a blog post', - description: 'Clone a blog post, making a copy of it in a new blog post.', - stainlessPath: '(resource) cms.blogs.posts > (method) clone', - qualified: 'client.cms.blogs.posts.clone', - params: ['id: string;', 'cloneName?: string;'], - response: 'string', - markdown: - "## clone\n\n`client.cms.blogs.posts.clone(id: string, cloneName?: string): string`\n\n**post** `/cms/blogs/2026-03/posts/clone`\n\nClone a blog post, making a copy of it in a new blog post.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.clone({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.clone', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.clone({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.clone', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.clone(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().clone', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().clone(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Clone', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Clone(context.TODO(), cms.BlogPostCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.clone_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.clone_(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->clone', - example: - "cms->blogs->posts->clone(id: 'id', cloneName: 'cloneName');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/blogs/2026-03/posts', - httpMethod: 'post', - summary: 'Create a new post', - description: 'Create a new blog post, specifying its content in the request body.', - stainlessPath: '(resource) cms.blogs.posts > (method) create', - qualified: 'client.cms.blogs.posts.create', - params: [ - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: number;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'blogAuthorId: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableGoogleAmpOutputOverride: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'password: string;', - 'postBody: string;', - 'postSummary: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'rssBody: string;', - 'rssSummary: string;', - 'slug: string;', - 'state: string;', - 'tagIds: number[];', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.blogs.posts.create(id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): string`\n\n**post** `/cms/blogs/2026-03/posts`\n\nCreate a new blog post, specifying its content in the request body.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(post)\ncontent = post.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogPost params = BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n HttpResponse post = client.cms().blogs().posts().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.New(context.TODO(), cms.BlogPostNewParams{\n\t\tBlogPost: cms.BlogPostParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: 0,\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPassword: "password",\n\t\t\tPostBody: "postBody",\n\t\t\tPostSummary: "postSummary",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tRssBody: "rssBody",\n\t\t\tRssSummary: "rssSummary",\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tTagIDs: []int64{0},\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(post)', - }, - php: { - method: 'cms->blogs->posts->create', - example: - "cms->blogs->posts->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($post);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/posts/{objectId}', - httpMethod: 'delete', - summary: 'Delete a blog post', - description: 'Delete a blog post by ID.', - stainlessPath: '(resource) cms.blogs.posts > (method) delete', - qualified: 'client.cms.blogs.posts.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.blogs.posts.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/posts/{objectId}`\n\nDelete a blog post by ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.delete('objectId');", - }, - python: { - method: 'cms.blogs.posts.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().blogs().posts().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->delete', - example: - "cms->blogs->posts->delete('objectId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blogs/2026-03/posts/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a blog post', - description: 'Retrieve a blog post by the post ID.', - stainlessPath: '(resource) cms.blogs.posts > (method) get', - qualified: 'client.cms.blogs.posts.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: 'string', - markdown: - "## get\n\n`client.cms.blogs.posts.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}`\n\nRetrieve a blog post by the post ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.get('objectId');\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.get('objectId');\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.get(\n object_id="objectId",\n)\nprint(post)\ncontent = post.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse post = client.cms().blogs().posts().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.get("objectId")\n\nputs(post)', - }, - php: { - method: 'cms->blogs->posts->get', - example: - "cms->blogs->posts->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($post);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_draft_by_id', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft', - httpMethod: 'get', - summary: 'Retrieve the full draft version of the Blog Post', - description: 'Retrieve the full draft version of a blog post.', - stainlessPath: '(resource) cms.blogs.posts > (method) get_draft_by_id', - qualified: 'client.cms.blogs.posts.getDraftByID', - params: ['objectId: string;'], - response: 'string', - markdown: - "## get_draft_by_id\n\n`client.cms.blogs.posts.getDraftByID(objectId: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/draft`\n\nRetrieve the full draft version of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.getDraftByID('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.getDraftByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.getDraftByID('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.get_draft_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.get_draft_by_id(\n "objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().getDraftById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostGetDraftByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().getDraftById("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.GetDraftByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.GetDraftByID(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.get_draft_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.get_draft_by_id("objectId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->getDraftByID', - example: - "cms->blogs->posts->getDraftByID('objectId');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/blogs/2026-03/posts/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) list', - qualified: 'client.cms.blogs.posts.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list\n\n`client.cms.blogs.posts.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst posts = await client.cms.blogs.posts.list();\n\nconsole.log(posts);\n\nconst content = await posts.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst posts = await client.cms.blogs.posts.list();\n\nconsole.log(posts);\n\nconst content = await posts.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nposts = client.cms.blogs.posts.list()\nprint(posts)\ncontent = posts.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse posts = client.cms().blogs().posts().list();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tposts, err := client.Cms.Blogs.Posts.List(context.TODO(), cms.BlogPostListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", posts)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nposts = hubspot.cms.blogs.posts.list\n\nputs(posts)', - }, - php: { - method: 'cms->blogs->posts->list', - example: - "cms->blogs->posts->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($posts);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_authors', - endpoint: '/cms/blogs/2026-03/authors/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) list_authors', - qualified: 'client.cms.blogs.posts.listAuthors', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_authors\n\n`client.cms.blogs.posts.listAuthors(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.listAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.listAuthors', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.listAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.list_authors', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.list_authors()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().listAuthors', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListAuthorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().listAuthors();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.ListAuthors', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.ListAuthors(context.TODO(), cms.BlogPostListAuthorsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.list_authors', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.list_authors\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->listAuthors', - example: - "cms->blogs->posts->listAuthors(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_tags', - endpoint: '/cms/blogs/2026-03/tags/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) list_tags', - qualified: 'client.cms.blogs.posts.listTags', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_tags\n\n`client.cms.blogs.posts.listTags(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.listTags();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.listTags', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.listTags();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.list_tags', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.list_tags()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().listTags', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostListTagsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().listTags();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.ListTags', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.ListTags(context.TODO(), cms.BlogPostListTagsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.list_tags', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.list_tags\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->listTags', - example: - "cms->blogs->posts->listTags(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'push_live', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft/push-live', - httpMethod: 'post', - summary: 'Publish blog post draft', - description: 'Publish the draft version of the blog post, sending its content to the live page.', - stainlessPath: '(resource) cms.blogs.posts > (method) push_live', - qualified: 'client.cms.blogs.posts.pushLive', - params: ['objectId: string;'], - markdown: - "## push_live\n\n`client.cms.blogs.posts.pushLive(objectId: string): void`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/draft/push-live`\n\nPublish the draft version of the blog post, sending its content to the live page.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.pushLive('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.pushLive', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.pushLive('objectId');", - }, - python: { - method: 'cms.blogs.posts.push_live', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.push_live(\n "objectId",\n)', - }, - java: { - method: 'cms().blogs().posts().pushLive', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostPushLiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().pushLive("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.PushLive', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.PushLive(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.push_live', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.push_live("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->pushLive', - example: - "cms->blogs->posts->pushLive('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'query', - endpoint: '/cms/blogs/2026-03/posts/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) query', - qualified: 'client.cms.blogs.posts.query', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## query\n\n`client.cms.blogs.posts.query(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.query();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.query', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.query();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().query', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().query();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Query', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Query(context.TODO(), cms.BlogPostQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->query', - example: - "cms->blogs->posts->query(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'query_authors', - endpoint: '/cms/blogs/2026-03/authors/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) query_authors', - qualified: 'client.cms.blogs.posts.queryAuthors', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## query_authors\n\n`client.cms.blogs.posts.queryAuthors(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.queryAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.queryAuthors', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.queryAuthors();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.query_authors', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query_authors()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().queryAuthors', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryAuthorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().queryAuthors();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.QueryAuthors', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.QueryAuthors(context.TODO(), cms.BlogPostQueryAuthorsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.query_authors', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query_authors\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->queryAuthors', - example: - "cms->blogs->posts->queryAuthors(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'query_tags', - endpoint: '/cms/blogs/2026-03/tags/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.posts > (method) query_tags', - qualified: 'client.cms.blogs.posts.queryTags', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## query_tags\n\n`client.cms.blogs.posts.queryTags(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.queryTags();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.queryTags', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.queryTags();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.query_tags', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.query_tags()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().queryTags', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostQueryTagsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().queryTags();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.QueryTags', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.QueryTags(context.TODO(), cms.BlogPostQueryTagsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.query_tags', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.query_tags\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->queryTags', - example: - "cms->blogs->posts->queryTags(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset_draft', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft/reset', - httpMethod: 'post', - summary: 'Reset post draft to the live version', - description: - 'Discard all drafted content, resetting the draft to contain the content in the currently published version.', - stainlessPath: '(resource) cms.blogs.posts > (method) reset_draft', - qualified: 'client.cms.blogs.posts.resetDraft', - params: ['objectId: string;'], - markdown: - "## reset_draft\n\n`client.cms.blogs.posts.resetDraft(objectId: string): void`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/draft/reset`\n\nDiscard all drafted content, resetting the draft to contain the content in the currently published version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.resetDraft('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.resetDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.resetDraft('objectId');", - }, - python: { - method: 'cms.blogs.posts.reset_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.reset_draft(\n "objectId",\n)', - }, - java: { - method: 'cms().blogs().posts().resetDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().posts().resetDraft("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.ResetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.ResetDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.reset_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.reset_draft("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->resetDraft', - example: - "cms->blogs->posts->resetDraft('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'schedule', - endpoint: '/cms/blogs/2026-03/posts/schedule', - httpMethod: 'post', - summary: 'Schedule a post to be published', - description: 'Schedule a blog post to be published at a specified time.', - stainlessPath: '(resource) cms.blogs.posts > (method) schedule', - qualified: 'client.cms.blogs.posts.schedule', - params: ['id: string;', 'publishDate: string;'], - markdown: - "## schedule\n\n`client.cms.blogs.posts.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/blogs/2026-03/posts/schedule`\n\nSchedule a blog post to be published at a specified time.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.schedule', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", - }, - python: { - method: 'cms.blogs.posts.schedule', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', - }, - java: { - method: 'cms().blogs().posts().schedule', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().blogs().posts().schedule(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Schedule', - example: - 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Schedule(context.TODO(), cms.BlogPostScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.schedule', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->schedule', - example: - "cms->blogs->posts->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/blogs/2026-03/posts/{objectId}', - httpMethod: 'patch', - summary: 'Update a post', - description: - 'Partially updates a single blog post by ID. You only need to specify the values that you want to update.', - stainlessPath: '(resource) cms.blogs.posts > (method) update', - qualified: 'client.cms.blogs.posts.update', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: number;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'blogAuthorId: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableGoogleAmpOutputOverride: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'password: string;', - 'postBody: string;', - 'postSummary: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'rssBody: string;', - 'rssSummary: string;', - 'slug: string;', - 'state: string;', - 'tagIds: number[];', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - 'archived?: boolean;', - ], - response: 'string', - markdown: - "## update\n\n`client.cms.blogs.posts.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/posts/{objectId}`\n\nPartially updates a single blog post by ID. You only need to specify the values that you want to update.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst post = await client.cms.blogs.posts.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst post = await client.cms.blogs.posts.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(post);\n\nconst content = await post.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npost = client.cms.blogs.posts.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(post)\ncontent = post.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostUpdateParams params = PostUpdateParams.builder()\n .objectId("objectId")\n .blogPost(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse post = client.cms().blogs().posts().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpost, err := client.Cms.Blogs.Posts.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostUpdateParams{\n\t\t\tBlogPost: cms.BlogPostParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", post)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npost = hubspot.cms.blogs.posts.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(post)', - }, - php: { - method: 'cms->blogs->posts->update', - example: - "cms->blogs->posts->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($post);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'update_draft', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/draft', - httpMethod: 'patch', - summary: 'Update the draft of a post', - description: - 'Partially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update.', - stainlessPath: '(resource) cms.blogs.posts > (method) update_draft', - qualified: 'client.cms.blogs.posts.updateDraft', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: number;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'blogAuthorId: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableGoogleAmpOutputOverride: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'password: string;', - 'postBody: string;', - 'postSummary: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'rssBody: string;', - 'rssSummary: string;', - 'slug: string;', - 'state: string;', - 'tagIds: number[];', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'string', - markdown: - "## update_draft\n\n`client.cms.blogs.posts.updateDraft(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: number, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, blogAuthorId: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableGoogleAmpOutputOverride: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, password: string, postBody: string, postSummary: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, rssBody: string, rssSummary: string, slug: string, state: string, tagIds: number[], themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): string`\n\n**patch** `/cms/blogs/2026-03/posts/{objectId}/draft`\n\nPartially updates the draft version of a single blog post by ID. You only need to specify the values that you want to update.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Post.\n\n- `abStatus: string`\n The status of the AB test associated with this blog post, if applicable\n\nAvailable options: automated_loser_variant, automated_master, automated_variant, loser_variant, mab_master, mab_variant, master, variant\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: number`\n The timestamp (ISO8601 format) when this Blog Post was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the post will not show up in your dashboard, although the post could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this blog post. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this Blog Post.\n\n- `blogAuthorId: string`\n The ID of the Blog Author associated with this Blog Post.\n\n- `campaign: string`\n The GUID of the marketing campaign this Blog Post is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The ID of the parent Blog this Blog Post is associated with.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should always be BLOG_POST.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Post was created.\n\n- `createdById: string`\n The ID of the user that created this Blog Post.\n\n- `currentlyPublished: boolean`\n Whether the post is published (true or false)\n\n- `currentState: string`\n A generated ENUM descibing the current state of this Blog Post. Should always match state.\n\n- `domain: string`\n The domain this Blog Post will resolve to. If null, the Blog Post will default to the domain of the ParentBlog.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this Blog Post references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableGoogleAmpOutputOverride: boolean`\n Boolean to allow overriding the AMP settings for the blog.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this Blog Post.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n Unique identifier of associated folder\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this Blog Post.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the Blog Post. If null, the Blog Post will default to the language of the ParentBlog.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the blog post.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n Unique identifier of the MAB Experiment\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the Blog Post.\n\n- `pageExpiryDate: number`\n The date at which this blog post should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this blog post.\n\n- `pageExpiryRedirectId: number`\n The ID of another page this blog post's url should redirect to once this blog post expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this blog post's url should redirect to once it expires. Should only set this or pageExpiryRedirectId.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `postBody: string`\n The HTML of the main post body.\n\n- `postSummary: string`\n The summary of the blog post that will appear on the main listing page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the blog post is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `rssBody: string`\n The contents of the RSS body for this Blog Post.\n\n- `rssSummary: string`\n The contents of the RSS summary for this Blog Post.\n\n- `slug: string`\n The path of the this blog post. This field is appended to the domain to construct the url of this post.\n\n- `state: string`\n An ENUM descibing the current state of this Blog Post.\n\n- `tagIds: number[]`\n List of IDs for the tags associated with this Blog Post.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the blog post.\n\n- `translatedFromId: string`\n ID of the primary blog post this object was translated from.\n\n- `translations: object`\n A map of translations for the blog post, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Post was updated.\n\n- `updatedById: string`\n The ID of the user that updated this Blog Post.\n\n- `url: string`\n A generated field representing the URL of this blog post.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this post should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.updateDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.update_draft', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.update_draft(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=0,\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n blog_author_id="blogAuthorId",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_google_amp_output_override=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n password="password",\n post_body="postBody",\n post_summary="postSummary",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n rss_body="rssBody",\n rss_summary="rssSummary",\n slug="slug",\n state="state",\n tag_ids=[0],\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().updateDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.PostUpdateDraftParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostUpdateDraftParams params = PostUpdateDraftParams.builder()\n .objectId("objectId")\n .blogPost(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse response = client.cms().blogs().posts().updateDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.UpdateDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostUpdateDraftParams{\n\t\t\tBlogPost: cms.BlogPostParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.update_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.update_draft(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: 0,\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n blog_author_id: "blogAuthorId",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_google_amp_output_override: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n password: "password",\n post_body: "postBody",\n post_summary: "postSummary",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n rss_body: "rssBody",\n rss_summary: "rssSummary",\n slug: "slug",\n state: "state",\n tag_ids: [0],\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->updateDraft', - example: - "cms->blogs->posts->updateDraft(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n blogAuthorID: 'blogAuthorId',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIDs: [0],\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/blogs/2026-03/posts/batch/create', - httpMethod: 'post', - summary: 'Create a batch of blog posts', - description: 'Create a batch of blog posts, specifying their content in the request body.', - stainlessPath: '(resource) cms.blogs.posts.batch > (method) create', - qualified: 'client.cms.blogs.posts.batch.create', - params: [ - 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.blogs.posts.batch.create(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/create`\n\nCreate a batch of blog posts, specifying their content in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: number; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; blogAuthorId: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableGoogleAmpOutputOverride: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; password: string; postBody: string; postSummary: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; rssBody: string; rssSummary: string; slug: string; state: string; tagIds: number[]; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Blog posts to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.create({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.create({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n blogAuthorId: 'blogAuthorId',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n password: 'password',\n postBody: 'postBody',\n postSummary: 'postSummary',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n rssBody: 'rssBody',\n rssSummary: 'rssSummary',\n slug: 'slug',\n state: 'state',\n tagIds: [0],\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.batch.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.create(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": 0,\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "blog_author_id": "blogAuthorId",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_google_amp_output_override": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "password": "password",\n "post_body": "postBody",\n "post_summary": "postSummary",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "rss_body": "rssBody",\n "rss_summary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tag_ids": [0],\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.blogs.posts.BatchInputBlogPost;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPost;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputBlogPost params = BatchInputBlogPost.builder()\n .addInput(BlogPost.builder()\n .id("id")\n .abStatus(BlogPost.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(0L)\n .archivedInDashboard(true)\n .addAttachedStylesheet(BlogPost.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .blogAuthorId("blogAuthorId")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(BlogPost.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(BlogPost.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableGoogleAmpOutputOverride(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(BlogPost.Language.AA)\n .layoutSections(BlogPost.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .password("password")\n .postBody("postBody")\n .postSummary("postSummary")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .rssBody("rssBody")\n .rssSummary("rssSummary")\n .slug("slug")\n .state("state")\n .addTagId(0L)\n .themeSettingsValues(BlogPost.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(BlogPost.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(BlogPost.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(BlogPost.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.New(context.TODO(), cms.BlogPostBatchNewParams{\n\t\tBatchInputBlogPost: cms.BatchInputBlogPostParam{\n\t\t\tInputs: []cms.BlogPostParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.BlogPostAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: 0,\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tBlogAuthorID: "blogAuthorId",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.BlogPostContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.BlogPostCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableGoogleAmpOutputOverride: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.BlogPostLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPassword: "password",\n\t\t\t\tPostBody: "postBody",\n\t\t\t\tPostSummary: "postSummary",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tRssBody: "rssBody",\n\t\t\t\tRssSummary: "rssSummary",\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tTagIDs: []int64{0},\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.create(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: 0,\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n blogAuthorId: "blogAuthorId",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableGoogleAmpOutputOverride: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n password: "password",\n postBody: "postBody",\n postSummary: "postSummary",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n rssBody: "rssBody",\n rssSummary: "rssSummary",\n slug: "slug",\n state: "state",\n tagIds: [0],\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->posts->batch->create', - example: - "cms->blogs->posts->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => 0,\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'blogAuthorID' => 'blogAuthorId',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableGoogleAmpOutputOverride' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'password' => 'password',\n 'postBody' => 'postBody',\n 'postSummary' => 'postSummary',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'rssBody' => 'rssBody',\n 'rssSummary' => 'rssSummary',\n 'slug' => 'slug',\n 'state' => 'state',\n 'tagIDs' => [0],\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": 0,\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "blogAuthorId": "blogAuthorId",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableGoogleAmpOutputOverride": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "password": "password",\n "postBody": "postBody",\n "postSummary": "postSummary",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "rssBody": "rssBody",\n "rssSummary": "rssSummary",\n "slug": "slug",\n "state": "state",\n "tagIds": [\n 0\n ],\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/posts/batch/archive', - httpMethod: 'post', - summary: 'Delete a batch of blog posts', - description: - 'Delete a blog post by ID. \nNote: This is not the same as the in-app `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', - stainlessPath: '(resource) cms.blogs.posts.batch > (method) delete', - qualified: 'client.cms.blogs.posts.batch.delete', - params: ['inputs: string[];'], - markdown: - "## delete\n\n`client.cms.blogs.posts.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/posts/batch/archive`\n\nDelete a blog post by ID. \nNote: This is not the same as the in-app `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.batch.delete({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.batch.delete({ inputs: ['string'] });", - }, - python: { - method: 'cms.blogs.posts.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.batch.delete(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().blogs().posts().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().posts().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.Batch.Delete(context.TODO(), cms.BlogPostBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.batch.delete(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->batch->delete', - example: - "cms->blogs->posts->batch->delete(inputs: ['string']);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blogs/2026-03/posts/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of Blog Posts', - description: 'Retrieve a batch of blog posts by ID. identified in the request body.', - stainlessPath: '(resource) cms.blogs.posts.batch > (method) get', - qualified: 'client.cms.blogs.posts.batch.get', - params: ['inputs: string[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## get\n\n`client.cms.blogs.posts.batch.get(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/read`\n\nRetrieve a batch of blog posts by ID. identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.get({ inputs: ['string'] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.get(\n inputs=["string"],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.Get(context.TODO(), cms.BlogPostBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.get(inputs: ["string"])\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->posts->batch->get', - example: - "cms->blogs->posts->batch->get(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/blogs/2026-03/posts/batch/update', - httpMethod: 'post', - summary: 'Update a batch of Blog Posts', - description: 'Update a batch of blog posts.', - stainlessPath: '(resource) cms.blogs.posts.batch > (method) update', - qualified: 'client.cms.blogs.posts.batch.update', - params: ['inputs: object[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## update\n\n`client.cms.blogs.posts.batch.update(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/batch/update`\n\nUpdate a batch of blog posts.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batch = await client.cms.blogs.posts.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batch = await client.cms.blogs.posts.batch.update({ inputs: [{}] });\n\nconsole.log(batch);\n\nconst content = await batch.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch = client.cms.blogs.posts.batch.update(\n inputs=[{}],\n)\nprint(batch)\ncontent = batch.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse batch = client.cms().blogs().posts().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatch, err := client.Cms.Blogs.Posts.Batch.Update(context.TODO(), cms.BlogPostBatchUpdateParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batch)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch = hubspot.cms.blogs.posts.batch.update(inputs: [{}])\n\nputs(batch)', - }, - php: { - method: 'cms->blogs->posts->batch->update', - example: - "cms->blogs->posts->batch->update(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batch);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Attach post to a multi-language group', - description: - 'Attach a blog post to a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', - stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) attach_to_lang_group', - qualified: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.blogs.posts.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group`\n\nAttach a blog post to a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.multi_language.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().multiLanguage().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.MultiLanguage.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.AttachToLangGroup(context.TODO(), cms.BlogPostMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.multi_language.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->multiLanguage->attachToLangGroup', - example: - "cms->blogs->posts->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create_lang_variation', - endpoint: '/cms/blogs/2026-03/posts/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a language variation', - description: 'Create a new language variation from an existing blog post', - stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) create_lang_variation', - qualified: 'client.cms.blogs.posts.multiLanguage.createLangVariation', - params: ['id: string;', 'language?: string;', 'usePublished?: boolean;'], - response: 'string', - markdown: - "## create_lang_variation\n\n`client.cms.blogs.posts.multiLanguage.createLangVariation(id: string, language?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/create-language-variation`\n\nCreate a new language variation from an existing blog post\n\n### Parameters\n\n- `id: string`\n ID of blog post to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.createLangVariation({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.multiLanguage.createLangVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.createLangVariation({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.multi_language.create_lang_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.create_lang_variation(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().multiLanguage().createLangVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.BlogPostLanguageCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogPostLanguageCloneRequestVNext params = BlogPostLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().createLangVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.MultiLanguage.NewLangVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.NewLangVariation(context.TODO(), cms.BlogPostMultiLanguageNewLangVariationParams{\n\t\tBlogPostLanguageCloneRequestVNext: cms.BlogPostLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.multi_language.create_lang_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.create_lang_variation(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->multiLanguage->createLangVariation', - example: - "cms->blogs->posts->multiLanguage->createLangVariation(\n id: 'id', language: 'language', usePublished: true\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Detach post from a multi-language group', - description: - 'Detach a blog post from a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', - stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) detach_from_lang_group', - qualified: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.blogs.posts.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group`\n\nDetach a blog post from a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.multi_language.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().multiLanguage().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.MultiLanguage.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.BlogPostMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.multi_language.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->multiLanguage->detachFromLangGroup', - example: - "cms->blogs->posts->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'set_lang_primary', - endpoint: '/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set a new primary language', - description: - 'Set the primary language of a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content) to the language of the provided post (specified as an ID in the request body)', - stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) set_lang_primary', - qualified: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', - params: ['id: string;'], - markdown: - "## set_lang_primary\n\n`client.cms.blogs.posts.multiLanguage.setLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary`\n\nSet the primary language of a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content) to the language of the provided post (specified as an ID in the request body)\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.posts.multiLanguage.setLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.posts.multiLanguage.setLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.blogs.posts.multi_language.set_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.posts.multi_language.set_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().blogs().posts().multiLanguage().setLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().posts().multiLanguage().setLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.MultiLanguage.SetLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Posts.MultiLanguage.SetLangPrimary(context.TODO(), cms.BlogPostMultiLanguageSetLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.multi_language.set_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.posts.multi_language.set_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->posts->multiLanguage->setLangPrimary', - example: - "cms->blogs->posts->multiLanguage->setLangPrimary(id: 'id');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update_langs', - endpoint: '/cms/blogs/2026-03/posts/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update languages of multi-language group', - description: - 'Explicitly set new languages for each post in a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).', - stainlessPath: '(resource) cms.blogs.posts.multi_language > (method) update_langs', - qualified: 'client.cms.blogs.posts.multiLanguage.updateLangs', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_langs\n\n`client.cms.blogs.posts.multiLanguage.updateLangs(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/posts/multi-language/update-languages`\n\nExplicitly set new languages for each post in a [multi-language group](https://developers.hubspot.com/docs/guides/cms/content/multi-language-content).\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.multiLanguage.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.multiLanguage.updateLangs', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.multiLanguage.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.multi_language.update_langs', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.multi_language.update_langs(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().multiLanguage().updateLangs', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().posts().multiLanguage().updateLangs(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.MultiLanguage.UpdateLangs', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.MultiLanguage.UpdateLangs(context.TODO(), cms.BlogPostMultiLanguageUpdateLangsParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.multi_language.update_langs', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.multi_language.update_langs(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->multiLanguage->updateLangs', - example: - "cms->blogs->posts->multiLanguage->updateLangs(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'get_previous_version', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Retrieve a previous version of a blog post', - description: 'Retrieve a previous version of a blog post.', - stainlessPath: '(resource) cms.blogs.posts.revisions > (method) get_previous_version', - qualified: 'client.cms.blogs.posts.revisions.getPreviousVersion', - params: ['objectId: string;', 'revisionId: string;'], - response: 'string', - markdown: - "## get_previous_version\n\n`client.cms.blogs.posts.revisions.getPreviousVersion(objectId: string, revisionId: string): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersion('revisionId', { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.revisions.getPreviousVersion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersion('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.revisions.get_previous_version', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.get_previous_version(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().revisions().getPreviousVersion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionGetPreviousVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetPreviousVersionParams params = RevisionGetPreviousVersionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().getPreviousVersion(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Revisions.GetPreviousVersion', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.GetPreviousVersion(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogPostRevisionGetPreviousVersionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.revisions.get_previous_version', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.get_previous_version("revisionId", object_id_: "objectId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->revisions->getPreviousVersion', - example: - "cms->blogs->posts->revisions->getPreviousVersion(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_previous_versions', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions', - httpMethod: 'get', - summary: 'Retrieves all previous versions of a post', - description: 'Retrieve all the previous versions of a blog post.', - stainlessPath: '(resource) cms.blogs.posts.revisions > (method) get_previous_versions', - qualified: 'client.cms.blogs.posts.revisions.getPreviousVersions', - params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: 'string', - markdown: - "## get_previous_versions\n\n`client.cms.blogs.posts.revisions.getPreviousVersions(objectId: string, after?: string, before?: string, limit?: number): string`\n\n**get** `/cms/blogs/2026-03/posts/{objectId}/revisions`\n\nRetrieve all the previous versions of a blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersions('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.revisions.getPreviousVersions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.getPreviousVersions('objectId');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.revisions.get_previous_versions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.get_previous_versions(\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().revisions().getPreviousVersions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionGetPreviousVersionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().posts().revisions().getPreviousVersions("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Revisions.GetPreviousVersions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.GetPreviousVersions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogPostRevisionGetPreviousVersionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.revisions.get_previous_versions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.get_previous_versions("objectId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->revisions->getPreviousVersions', - example: - "cms->blogs->posts->revisions->getPreviousVersions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_previous_version', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore', - httpMethod: 'post', - summary: 'Restore a previous version', - description: 'Restores a blog post to one of its previous versions.', - stainlessPath: '(resource) cms.blogs.posts.revisions > (method) restore_previous_version', - qualified: 'client.cms.blogs.posts.revisions.restorePreviousVersion', - params: ['objectId: string;', 'revisionId: string;'], - response: 'string', - markdown: - "## restore_previous_version\n\n`client.cms.blogs.posts.revisions.restorePreviousVersion(objectId: string, revisionId: string): string`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore`\n\nRestores a blog post to one of its previous versions.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersion('revisionId', { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.revisions.restorePreviousVersion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersion('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.revisions.restore_previous_version', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.restore_previous_version(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().revisions().restorePreviousVersion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionRestorePreviousVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestorePreviousVersionParams params = RevisionRestorePreviousVersionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().restorePreviousVersion(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Revisions.RestorePreviousVersion', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.RestorePreviousVersion(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogPostRevisionRestorePreviousVersionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.revisions.restore_previous_version', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.restore_previous_version("revisionId", object_id_: "objectId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->revisions->restorePreviousVersion', - example: - "cms->blogs->posts->revisions->restorePreviousVersion(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_previous_version_to_draft', - endpoint: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft', - httpMethod: 'post', - summary: 'Restore a draft to a previous version', - description: - 'Takes a specified version of a blog post, sets it as the new draft version of the blog post.', - stainlessPath: '(resource) cms.blogs.posts.revisions > (method) restore_previous_version_to_draft', - qualified: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', - params: ['objectId: string;', 'revisionId: number;'], - response: 'string', - markdown: - "## restore_previous_version_to_draft\n\n`client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(objectId: string, revisionId: number): string`\n\n**post** `/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nTakes a specified version of a blog post, sets it as the new draft version of the blog post.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.posts.revisions.restorePreviousVersionToDraft(0, {\n objectId: 'objectId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.posts.revisions.restore_previous_version_to_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.posts.revisions.restore_previous_version_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().posts().revisions().restorePreviousVersionToDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.posts.revisions.RevisionRestorePreviousVersionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestorePreviousVersionToDraftParams params = RevisionRestorePreviousVersionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n HttpResponse response = client.cms().blogs().posts().revisions().restorePreviousVersionToDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Posts.Revisions.RestorePreviousVersionToDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Posts.Revisions.RestorePreviousVersionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.BlogPostRevisionRestorePreviousVersionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.posts.revisions.restore_previous_version_to_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.posts.revisions.restore_previous_version_to_draft(0, object_id_: "objectId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->posts->revisions->restorePreviousVersionToDraft', - example: - "cms\n ->blogs\n ->posts\n ->revisions\n ->restorePreviousVersionToDraft(0, objectID: 'objectId');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blog-settings/2026-03/settings/{blogId}', - httpMethod: 'get', - summary: 'Retrieve a blog', - description: 'Retrieve a specific blog by its ID.', - stainlessPath: '(resource) cms.blogs.settings > (method) get', - qualified: 'client.cms.blogs.settings.get', - params: ['blogId: string;'], - response: - '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', - markdown: - "## get\n\n`client.cms.blogs.settings.get(blogId: string): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}`\n\nRetrieve a specific blog by its ID.\n\n### Parameters\n\n- `blogId: string`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blog = await client.cms.blogs.settings.get('blogId');\n\nconsole.log(blog);\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blog = await client.cms.blogs.settings.get('blogId');\n\nconsole.log(blog.id);", - }, - python: { - method: 'cms.blogs.settings.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog = client.cms.blogs.settings.get(\n "blogId",\n)\nprint(blog.id)', - }, - java: { - method: 'cms().blogs().settings().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.Blog;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Blog blog = client.cms().blogs().settings().get("blogId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblog, err := client.Cms.Blogs.Settings.Get(context.TODO(), "blogId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blog.ID)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog = hubspot.cms.blogs.settings.get("blogId")\n\nputs(blog)', - }, - php: { - method: 'cms->blogs->settings->get', - example: - "cms->blogs->settings->get('blogId');\n\nvar_dump($blog);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_revision', - endpoint: '/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Get a specific blog revision', - description: 'Get a specific blog revision.', - stainlessPath: '(resource) cms.blogs.settings > (method) get_revision', - qualified: 'client.cms.blogs.settings.getRevision', - params: ['blogId: string;', 'revisionId: string;'], - response: - '{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', - markdown: - "## get_revision\n\n`client.cms.blogs.settings.getRevision(blogId: string, revisionId: string): { id: string; object: blog; updatedAt: string; user: version_user; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}`\n\nGet a specific blog revision.\n\n### Parameters\n\n- `blogId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blogVersion = await client.cms.blogs.settings.getRevision('revisionId', { blogId: 'blogId' });\n\nconsole.log(blogVersion);\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.getRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blogVersion = await client.cms.blogs.settings.getRevision('revisionId', { blogId: 'blogId' });\n\nconsole.log(blogVersion.id);", - }, - python: { - method: 'cms.blogs.settings.get_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog_version = client.cms.blogs.settings.get_revision(\n revision_id="revisionId",\n blog_id="blogId",\n)\nprint(blog_version.id)', - }, - java: { - method: 'cms().blogs().settings().getRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.BlogVersion;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingGetRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingGetRevisionParams params = SettingGetRevisionParams.builder()\n .blogId("blogId")\n .revisionId("revisionId")\n .build();\n BlogVersion blogVersion = client.cms().blogs().settings().getRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.GetRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblogVersion, err := client.Cms.Blogs.Settings.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.BlogSettingGetRevisionParams{\n\t\t\tBlogID: "blogId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blogVersion.ID)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.get_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog_version = hubspot.cms.blogs.settings.get_revision("revisionId", blog_id: "blogId")\n\nputs(blog_version)', - }, - php: { - method: 'cms->blogs->settings->getRevision', - example: - "cms->blogs->settings->getRevision(\n 'revisionId', blogID: 'blogId'\n);\n\nvar_dump($blogVersion);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/blog-settings/2026-03/settings', - httpMethod: 'get', - summary: 'Retrieve all blogs', - description: 'Get the list of blogs. Results can be limited and filtered by creation or updated date.', - stainlessPath: '(resource) cms.blogs.settings > (method) list', - qualified: 'client.cms.blogs.settings.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', - markdown: - "## list\n\n`client.cms.blogs.settings.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**get** `/cms/blog-settings/2026-03/settings`\n\nGet the list of blogs. Results can be limited and filtered by creation or updated date.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const blog of client.cms.blogs.settings.list()) {\n console.log(blog);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const blog of client.cms.blogs.settings.list()) {\n console.log(blog.id);\n}", - }, - python: { - method: 'cms.blogs.settings.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.blogs.settings.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().blogs().settings().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListPage;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingListPage page = client.cms().blogs().settings().list();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Blogs.Settings.List(context.TODO(), cms.BlogSettingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.blogs.settings.list\n\nputs(page)', - }, - php: { - method: 'cms->blogs->settings->list', - example: - "cms->blogs->settings->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_revisions', - endpoint: '/cms/blog-settings/2026-03/settings/{blogId}/revisions', - httpMethod: 'get', - summary: 'Get all blog revisions', - description: - 'Get the list of blog revisions. Results can be limited and filtered by creation or updated date.', - stainlessPath: '(resource) cms.blogs.settings > (method) list_revisions', - qualified: 'client.cms.blogs.settings.listRevisions', - params: ['blogId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: - '{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', - markdown: - "## list_revisions\n\n`client.cms.blogs.settings.listRevisions(blogId: string, after?: string, before?: string, limit?: number): { id: string; object: blog; updatedAt: string; user: version_user; }`\n\n**get** `/cms/blog-settings/2026-03/settings/{blogId}/revisions`\n\nGet the list of blog revisions. Results can be limited and filtered by creation or updated date.\n\n### Parameters\n\n- `blogId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const versionBlog of client.cms.blogs.settings.listRevisions('blogId')) {\n console.log(versionBlog);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.listRevisions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const versionBlog of client.cms.blogs.settings.listRevisions('blogId')) {\n console.log(versionBlog.id);\n}", - }, - python: { - method: 'cms.blogs.settings.list_revisions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.blogs.settings.list_revisions(\n blog_id="blogId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().blogs().settings().listRevisions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListRevisionsPage;\nimport com.hubspot.sdk.models.cms.blogs.settings.SettingListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingListRevisionsPage page = client.cms().blogs().settings().listRevisions("blogId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.ListRevisions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Blogs.Settings.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"blogId",\n\t\tcms.BlogSettingListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.list_revisions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.blogs.settings.list_revisions("blogId")\n\nputs(page)', - }, - php: { - method: 'cms->blogs->settings->listRevisions', - example: - "cms->blogs->settings->listRevisions(\n 'blogId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/$BLOG_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Add a blog to a multi-language group', - description: 'Attach a blog to a multi-language group.', - stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) attach_to_lang_group', - qualified: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.blogs.settings.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group`\n\nAttach a blog to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.settings.multi_language.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().settings().multiLanguage().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.MultiLanguage.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.AttachToLangGroup(context.TODO(), cms.BlogSettingMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.multi_language.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->blogs->settings->multiLanguage->attachToLangGroup', - example: - "cms->blogs->settings->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create_language_variation', - endpoint: '/cms/blog-settings/2026-03/settings/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a language variation from an existing blog', - description: 'Create a new language variation from an existing blog.', - stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) create_language_variation', - qualified: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', - params: [ - 'id: string;', - 'language?: string;', - 'primaryLanguage?: string;', - 'slug?: string;', - 'usePublished?: boolean;', - ], - response: - '{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }', - markdown: - "## create_language_variation\n\n`client.cms.blogs.settings.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, slug?: string, usePublished?: boolean): { id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/create-language-variation`\n\nCreate a new language variation from an existing blog.\n\n### Parameters\n\n- `id: string`\n ID of blog to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary blog to clone.\n\n- `slug?: string`\n Path to this blog.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; absoluteUrl: string; allowComments: boolean; created: string; deletedAt: string; description: string; htmlTitle: string; language: string; listingPageId: string; name: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publicTitle: string; slug: string; translatedFromId: string; updated: string; }`\n\n - `id: string`\n - `absoluteUrl: string`\n - `allowComments: boolean`\n - `created: string`\n - `deletedAt: string`\n - `description: string`\n - `htmlTitle: string`\n - `language: string`\n - `listingPageId: string`\n - `name: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publicTitle: string`\n - `slug: string`\n - `translatedFromId: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst blog = await client.cms.blogs.settings.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(blog);\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst blog = await client.cms.blogs.settings.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(blog.id);", - }, - python: { - method: 'cms.blogs.settings.multi_language.create_language_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nblog = client.cms.blogs.settings.multi_language.create_language_variation(\n id="id",\n)\nprint(blog.id)', - }, - java: { - method: 'cms().blogs().settings().multiLanguage().createLanguageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.settings.Blog;\nimport com.hubspot.sdk.models.cms.blogs.settings.BlogLanguageCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BlogLanguageCloneRequestVNext params = BlogLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n Blog blog = client.cms().blogs().settings().multiLanguage().createLanguageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.MultiLanguage.NewLanguageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tblog, err := client.Cms.Blogs.Settings.MultiLanguage.NewLanguageVariation(context.TODO(), cms.BlogSettingMultiLanguageNewLanguageVariationParams{\n\t\tBlogLanguageCloneRequestVNext: cms.BlogLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", blog.ID)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.multi_language.create_language_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nblog = hubspot.cms.blogs.settings.multi_language.create_language_variation(id: "id")\n\nputs(blog)', - }, - php: { - method: 'cms->blogs->settings->multiLanguage->createLanguageVariation', - example: - "cms->blogs->settings->multiLanguage->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n slug: 'slug',\n usePublished: true,\n);\n\nvar_dump($blog);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/create-language-variation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Remove a blog from a multi-language group', - description: 'Detaches a blog from a multi-language group.', - stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) detach_from_lang_group', - qualified: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.blogs.settings.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group`\n\nDetaches a blog from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.settings.multi_language.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().settings().multiLanguage().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.MultiLanguage.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.BlogSettingMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.multi_language.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->settings->multiLanguage->detachFromLangGroup', - example: - "cms->blogs->settings->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'set_new_lang_primary', - endpoint: '/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set primary language to match a specific blog', - description: 'Set a blog as the primary language of a multi-language group.', - stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) set_new_lang_primary', - qualified: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', - params: ['id: string;'], - markdown: - "## set_new_lang_primary\n\n`client.cms.blogs.settings.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary`\n\nSet a blog as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.settings.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.settings.multiLanguage.setNewLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.blogs.settings.multi_language.set_new_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.settings.multi_language.set_new_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().blogs().settings().multiLanguage().setNewLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().settings().multiLanguage().setNewLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.MultiLanguage.SetNewLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Settings.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.BlogSettingMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.multi_language.set_new_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.settings.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->settings->multiLanguage->setNewLangPrimary', - example: - "cms->blogs->settings->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update_languages', - endpoint: '/cms/blog-settings/2026-03/settings/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update blog languages', - description: 'Explicitly set new languages for each blog in a multi-language group.', - stainlessPath: '(resource) cms.blogs.settings.multi_language > (method) update_languages', - qualified: 'client.cms.blogs.settings.multiLanguage.updateLanguages', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_languages\n\n`client.cms.blogs.settings.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/blog-settings/2026-03/settings/multi-language/update-languages`\n\nExplicitly set new languages for each blog in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.settings.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.settings.multiLanguage.updateLanguages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.settings.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.settings.multi_language.update_languages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.settings.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().settings().multiLanguage().updateLanguages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().settings().multiLanguage().updateLanguages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Settings.MultiLanguage.UpdateLanguages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Settings.MultiLanguage.UpdateLanguages(context.TODO(), cms.BlogSettingMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.settings.multi_language.update_languages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.settings.multi_language.update_languages(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->settings->multiLanguage->updateLanguages', - example: - "cms->blogs->settings->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blog-settings/2026-03/settings/multi-language/update-languages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Attach a Blog Tag to a multi-language group', - description: 'Attach a Blog Tag to a multi-language group.', - stainlessPath: '(resource) cms.blogs.tags > (method) attach_to_lang_group', - qualified: 'client.cms.blogs.tags.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.blogs.tags.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group`\n\nAttach a Blog Tag to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().tags().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.AttachToLangGroup(context.TODO(), cms.BlogTagAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.attach_to_lang_group(id: "id", language: :aa, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->attachToLangGroup', - example: - "cms->blogs->tags->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/blogs/2026-03/tags', - httpMethod: 'post', - summary: 'Create a new Blog Tag', - description: 'Create a new Blog Tag.', - stainlessPath: '(resource) cms.blogs.tags > (method) create', - qualified: 'client.cms.blogs.tags.create', - params: [ - 'id: string;', - 'created: string;', - 'deletedAt: string;', - 'language: string;', - 'name: string;', - 'slug: string;', - 'translatedFromId: number;', - 'updated: string;', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.blogs.tags.create(id: string, created: string, deletedAt: string, language: string, name: string, slug: string, translatedFromId: number, updated: string): string`\n\n**post** `/cms/blogs/2026-03/tags`\n\nCreate a new Blog Tag.\n\n### Parameters\n\n- `id: string`\n The unique ID of the Blog Tag.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Tag was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Tag was deleted.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the tag.\n\n- `name: string`\n The name of the tag.\n\n- `slug: string`\n\n- `translatedFromId: number`\n ID of the primary tag this object was translated from.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Tag was updated.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.create({\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.create({\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.create(\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n language="aa",\n name="name",\n slug="slug",\n translated_from_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Tag params = Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n HttpResponse tag = client.cms().blogs().tags().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.New(context.TODO(), cms.BlogTagNewParams{\n\t\tTag: cms.TagParam{\n\t\t\tID: "id",\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\tName: "name",\n\t\t\tSlug: "slug",\n\t\t\tTranslatedFromID: 0,\n\t\t\tUpdated: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.create(\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(tag)', - }, - php: { - method: 'cms->blogs->tags->create', - example: - "cms->blogs->tags->create(\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($tag);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'create_lang_variation', - endpoint: '/cms/blogs/2026-03/tags/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a new language variation', - description: 'Create a new language variation from an existing Blog Tag', - stainlessPath: '(resource) cms.blogs.tags > (method) create_lang_variation', - qualified: 'client.cms.blogs.tags.createLangVariation', - params: [ - 'id: string;', - 'name: string;', - 'language?: string;', - 'primaryLanguage?: string;', - 'usePublished?: boolean;', - ], - response: 'string', - markdown: - "## create_lang_variation\n\n`client.cms.blogs.tags.createLangVariation(id: string, name: string, language?: string, primaryLanguage?: string, usePublished?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/create-language-variation`\n\nCreate a new language variation from an existing Blog Tag\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `name: string`\n Name of newly cloned blog tag.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary blog tag to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.createLangVariation({ id: 'id', name: 'name' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.createLangVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.createLangVariation({ id: 'id', name: 'name' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.create_lang_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.create_lang_variation(\n id="id",\n name="name",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().createLangVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagCloneRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TagCloneRequestVNext params = TagCloneRequestVNext.builder()\n .id("id")\n .name("name")\n .build();\n HttpResponse response = client.cms().blogs().tags().createLangVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.NewLangVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.NewLangVariation(context.TODO(), cms.BlogTagNewLangVariationParams{\n\t\tTagCloneRequestVNext: cms.TagCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.create_lang_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.create_lang_variation(id: "id", name: "name")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->createLangVariation', - example: - "cms->blogs->tags->createLangVariation(\n id: 'id',\n name: 'name',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/tags/{objectId}', - httpMethod: 'delete', - summary: 'Delete a Blog Tag', - description: 'Delete the Blog Tag object identified by the id in the path.', - stainlessPath: '(resource) cms.blogs.tags > (method) delete', - qualified: 'client.cms.blogs.tags.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.blogs.tags.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/blogs/2026-03/tags/{objectId}`\n\nDelete the Blog Tag object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.delete('objectId');", - }, - python: { - method: 'cms.blogs.tags.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().blogs().tags().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().blogs().tags().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->tags->delete', - example: - "cms->blogs->tags->delete('objectId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Detach a Blog Tag from a multi-language group', - description: 'Detach a Blog Tag from a multi-language group.', - stainlessPath: '(resource) cms.blogs.tags > (method) detach_from_lang_group', - qualified: 'client.cms.blogs.tags.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.blogs.tags.detachFromLangGroup(id: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group`\n\nDetach a Blog Tag from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().blogs().tags().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.DetachFromLangGroup(context.TODO(), cms.BlogTagDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->detachFromLangGroup', - example: - "cms->blogs->tags->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/blogs/2026-03/tags/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a Blog Tag', - description: 'Retrieve the Blog Tag object identified by the id in the path.', - stainlessPath: '(resource) cms.blogs.tags > (method) get', - qualified: 'client.cms.blogs.tags.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: 'string', - markdown: - "## get\n\n`client.cms.blogs.tags.get(objectId: string, archived?: boolean, property?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/{objectId}`\n\nRetrieve the Blog Tag object identified by the id in the path.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.get('objectId');\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.get('objectId');\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.get(\n object_id="objectId",\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse tag = client.cms().blogs().tags().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.get("objectId")\n\nputs(tag)', - }, - php: { - method: 'cms->blogs->tags->get', - example: - "cms->blogs->tags->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($tag);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/blogs/2026-03/tags', - httpMethod: 'get', - summary: 'Get all Blog Tags', - description: - 'Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', - stainlessPath: '(resource) cms.blogs.tags > (method) list', - qualified: 'client.cms.blogs.tags.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list\n\n`client.cms.blogs.tags.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags`\n\nGet the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tags = await client.cms.blogs.tags.list();\n\nconsole.log(tags);\n\nconst content = await tags.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tags = await client.cms.blogs.tags.list();\n\nconsole.log(tags);\n\nconst content = await tags.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntags = client.cms.blogs.tags.list()\nprint(tags)\ncontent = tags.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse tags = client.cms().blogs().tags().list();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttags, err := client.Cms.Blogs.Tags.List(context.TODO(), cms.BlogTagListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tags)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntags = hubspot.cms.blogs.tags.list\n\nputs(tags)', - }, - php: { - method: 'cms->blogs->tags->list', - example: - "cms->blogs->tags->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($tags);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_authors_cursor', - endpoint: '/cms/blogs/2026-03/authors/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_authors_cursor', - qualified: 'client.cms.blogs.tags.listAuthorsCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_authors_cursor\n\n`client.cms.blogs.tags.listAuthorsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listAuthorsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listAuthorsCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listAuthorsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_authors_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_authors_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listAuthorsCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListAuthorsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listAuthorsCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListAuthorsCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListAuthorsCursor(context.TODO(), cms.BlogTagListAuthorsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_authors_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_authors_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listAuthorsCursor', - example: - "cms->blogs->tags->listAuthorsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_authors_cursor_by_query', - endpoint: '/cms/blogs/2026-03/authors/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_authors_cursor_by_query', - qualified: 'client.cms.blogs.tags.listAuthorsCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_authors_cursor_by_query\n\n`client.cms.blogs.tags.listAuthorsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/authors/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listAuthorsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listAuthorsCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listAuthorsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_authors_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_authors_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listAuthorsCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListAuthorsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listAuthorsCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListAuthorsCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListAuthorsCursorByQuery(context.TODO(), cms.BlogTagListAuthorsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_authors_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_authors_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listAuthorsCursorByQuery', - example: - "cms->blogs->tags->listAuthorsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/authors/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_cursor', - endpoint: '/cms/blogs/2026-03/tags/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_cursor', - qualified: 'client.cms.blogs.tags.listCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_cursor\n\n`client.cms.blogs.tags.listCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListCursor(context.TODO(), cms.BlogTagListCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listCursor', - example: - "cms->blogs->tags->listCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_cursor_by_query', - endpoint: '/cms/blogs/2026-03/tags/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_cursor_by_query', - qualified: 'client.cms.blogs.tags.listCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_cursor_by_query\n\n`client.cms.blogs.tags.listCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/tags/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListCursorByQuery(context.TODO(), cms.BlogTagListCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listCursorByQuery', - example: - "cms->blogs->tags->listCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_posts_cursor', - endpoint: '/cms/blogs/2026-03/posts/cursor', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_posts_cursor', - qualified: 'client.cms.blogs.tags.listPostsCursor', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_posts_cursor\n\n`client.cms.blogs.tags.listPostsCursor(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listPostsCursor', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listPostsCursor();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_posts_cursor', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_posts_cursor()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listPostsCursor', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListPostsCursorParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listPostsCursor();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListPostsCursor', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListPostsCursor(context.TODO(), cms.BlogTagListPostsCursorParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_posts_cursor', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_posts_cursor\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listPostsCursor', - example: - "cms->blogs->tags->listPostsCursor(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_posts_cursor_by_query', - endpoint: '/cms/blogs/2026-03/posts/cursor/query', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.blogs.tags > (method) list_posts_cursor_by_query', - qualified: 'client.cms.blogs.tags.listPostsCursorByQuery', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'string', - markdown: - "## list_posts_cursor_by_query\n\n`client.cms.blogs.tags.listPostsCursorByQuery(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): string`\n\n**get** `/cms/blogs/2026-03/posts/cursor/query`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.listPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.listPostsCursorByQuery', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.listPostsCursorByQuery();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.list_posts_cursor_by_query', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.list_posts_cursor_by_query()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().listPostsCursorByQuery', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagListPostsCursorByQueryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().blogs().tags().listPostsCursorByQuery();\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.ListPostsCursorByQuery', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.ListPostsCursorByQuery(context.TODO(), cms.BlogTagListPostsCursorByQueryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.list_posts_cursor_by_query', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.list_posts_cursor_by_query\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->listPostsCursorByQuery', - example: - "cms->blogs->tags->listPostsCursorByQuery(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/posts/cursor/query \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'set_lang_primary', - endpoint: '/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set a new primary language', - description: 'Set a Blog Tag as the primary language of a multi-language group.', - stainlessPath: '(resource) cms.blogs.tags > (method) set_lang_primary', - qualified: 'client.cms.blogs.tags.setLangPrimary', - params: ['id: string;'], - markdown: - "## set_lang_primary\n\n`client.cms.blogs.tags.setLangPrimary(id: string): void`\n\n**put** `/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary`\n\nSet a Blog Tag as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.setLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.setLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.setLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.blogs.tags.set_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.set_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().blogs().tags().setLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().blogs().tags().setLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.SetLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.SetLangPrimary(context.TODO(), cms.BlogTagSetLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.set_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.set_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->blogs->tags->setLangPrimary', - example: - "cms->blogs->tags->setLangPrimary(id: 'id');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/blogs/2026-03/tags/{objectId}', - httpMethod: 'patch', - summary: 'Update a Blog Tag', - description: - 'Sparse updates a single Blog Tag object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n', - stainlessPath: '(resource) cms.blogs.tags > (method) update', - qualified: 'client.cms.blogs.tags.update', - params: [ - 'objectId: string;', - 'id: string;', - 'created: string;', - 'deletedAt: string;', - 'language: string;', - 'name: string;', - 'slug: string;', - 'translatedFromId: number;', - 'updated: string;', - 'archived?: boolean;', - ], - response: 'string', - markdown: - "## update\n\n`client.cms.blogs.tags.update(objectId: string, id: string, created: string, deletedAt: string, language: string, name: string, slug: string, translatedFromId: number, updated: string, archived?: boolean): string`\n\n**patch** `/cms/blogs/2026-03/tags/{objectId}`\n\nSparse updates a single Blog Tag object identified by the id in the path.\nAll the column values need not be specified. Only the that need to be modified can be specified.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the Blog Tag.\n\n- `created: string`\n The timestamp (ISO8601 format) when this Blog Tag was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this Blog Tag was deleted.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the tag.\n\n- `name: string`\n The name of the tag.\n\n- `slug: string`\n\n- `translatedFromId: number`\n ID of the primary tag this object was translated from.\n\n- `updated: string`\n The timestamp (ISO8601 format) when this Blog Tag was updated.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst tag = await client.cms.blogs.tags.update('objectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst tag = await client.cms.blogs.tags.update('objectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(tag);\n\nconst content = await tag.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntag = client.cms.blogs.tags.update(\n object_id="objectId",\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n language="aa",\n name="name",\n slug="slug",\n translated_from_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(tag)\ncontent = tag.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport com.hubspot.sdk.models.cms.blogs.tags.TagUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TagUpdateParams params = TagUpdateParams.builder()\n .objectId("objectId")\n .tag(Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n HttpResponse tag = client.cms().blogs().tags().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttag, err := client.Cms.Blogs.Tags.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.BlogTagUpdateParams{\n\t\t\tTag: cms.TagParam{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", tag)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntag = hubspot.cms.blogs.tags.update(\n "objectId",\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translated_from_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(tag)', - }, - php: { - method: 'cms->blogs->tags->update', - example: - "cms->blogs->tags->update(\n 'objectId',\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archived: true,\n);\n\nvar_dump($tag);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'update_langs', - endpoint: '/cms/blogs/2026-03/tags/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update languages of multi-language group', - description: 'Explicitly set new languages for each Blog Tag in a multi-language group.', - stainlessPath: '(resource) cms.blogs.tags > (method) update_langs', - qualified: 'client.cms.blogs.tags.updateLangs', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_langs\n\n`client.cms.blogs.tags.updateLangs(languages: object, primaryId: string): string`\n\n**post** `/cms/blogs/2026-03/tags/multi-language/update-languages`\n\nExplicitly set new languages for each Blog Tag in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.updateLangs', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.updateLangs({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.update_langs', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.update_langs(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().updateLangs', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().blogs().tags().updateLangs(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.UpdateLangs', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.UpdateLangs(context.TODO(), cms.BlogTagUpdateLangsParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.update_langs', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.update_langs(languages: {foo: :aa}, primary_id: "primaryId")\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->updateLangs', - example: - "cms->blogs->tags->updateLangs(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create_batch', - endpoint: '/cms/blogs/2026-03/tags/batch/create', - httpMethod: 'post', - summary: 'Create a batch of Blog Tags', - description: 'Create the Blog Tag objects detailed in the request body.', - stainlessPath: '(resource) cms.blogs.tags.batch > (method) create_batch', - qualified: 'client.cms.blogs.tags.batch.createBatch', - params: [ - 'inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[];', - ], - response: 'string', - markdown: - "## create_batch\n\n`client.cms.blogs.tags.batch.createBatch(inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[]): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/create`\n\nCreate the Blog Tag objects detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; created: string; deletedAt: string; language: string; name: string; slug: string; translatedFromId: number; updated: string; }[]`\n Blog tags to input.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.createBatch({ inputs: [{\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.batch.createBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.createBatch({\n inputs: [\n {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n language: 'aa',\n name: 'name',\n slug: 'slug',\n translatedFromId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n },\n ],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.batch.create_batch', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.create_batch(\n inputs=[{\n "id": "id",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translated_from_id": 0,\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().batch().createBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.blogs.tags.BatchInputTag;\nimport com.hubspot.sdk.models.cms.blogs.tags.Tag;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputTag params = BatchInputTag.builder()\n .addInput(Tag.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .language(Tag.Language.AA)\n .name("name")\n .slug("slug")\n .translatedFromId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().createBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Batch.NewBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.NewBatch(context.TODO(), cms.BlogTagBatchNewBatchParams{\n\t\tBatchInputTag: cms.BatchInputTagParam{\n\t\t\tInputs: []cms.TagParam{{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tLanguage: cms.TagLanguageAa,\n\t\t\t\tName: "name",\n\t\t\t\tSlug: "slug",\n\t\t\t\tTranslatedFromID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.batch.create_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.create_batch(\n inputs: [\n {\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n language: :aa,\n name: "name",\n slug: "slug",\n translatedFromId: 0,\n updated: "2019-12-27T18:11:19.117Z"\n }\n ]\n)\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->batch->createBatch', - example: - "cms->blogs->tags->batch->createBatch(\n inputs: [\n [\n 'id' => 'id',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'language' => 'aa',\n 'name' => 'name',\n 'slug' => 'slug',\n 'translatedFromID' => 0,\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "language": "aa",\n "name": "name",\n "slug": "slug",\n "translatedFromId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/blogs/2026-03/tags/batch/archive', - httpMethod: 'post', - summary: 'Delete a batch of Blog Tags', - description: 'Delete the Blog Tag objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.tags.batch > (method) delete', - qualified: 'client.cms.blogs.tags.batch.delete', - params: ['inputs: string[];'], - markdown: - "## delete\n\n`client.cms.blogs.tags.batch.delete(inputs: string[]): void`\n\n**post** `/cms/blogs/2026-03/tags/batch/archive`\n\nDelete the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.blogs.tags.batch.delete({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.blogs.tags.batch.delete({ inputs: ['string'] });", - }, - python: { - method: 'cms.blogs.tags.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.blogs.tags.batch.delete(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().blogs().tags().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().blogs().tags().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Blogs.Tags.Batch.Delete(context.TODO(), cms.BlogTagBatchDeleteParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.blogs.tags.batch.delete(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->blogs->tags->batch->delete', - example: - "cms->blogs->tags->batch->delete(inputs: ['string']);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_batch', - endpoint: '/cms/blogs/2026-03/tags/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of Blog Tags', - description: 'Retrieve the Blog Tag objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.tags.batch > (method) get_batch', - qualified: 'client.cms.blogs.tags.batch.getBatch', - params: ['inputs: string[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## get_batch\n\n`client.cms.blogs.tags.batch.getBatch(inputs: string[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/read`\n\nRetrieve the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.getBatch({ inputs: ['string'] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.batch.getBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.getBatch({ inputs: ['string'] });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.batch.get_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.get_batch(\n inputs=["string"],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().batch().getBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().getBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Batch.GetBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.GetBatch(context.TODO(), cms.BlogTagBatchGetBatchParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.batch.get_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.get_batch(inputs: ["string"])\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->batch->getBatch', - example: - "cms->blogs->tags->batch->getBatch(\n inputs: ['string'], archived: true\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update_batch', - endpoint: '/cms/blogs/2026-03/tags/batch/update', - httpMethod: 'post', - summary: 'Update a batch of Blog Tags', - description: 'Update the Blog Tag objects identified in the request body.', - stainlessPath: '(resource) cms.blogs.tags.batch > (method) update_batch', - qualified: 'client.cms.blogs.tags.batch.updateBatch', - params: ['inputs: object[];', 'archived?: boolean;'], - response: 'string', - markdown: - "## update_batch\n\n`client.cms.blogs.tags.batch.updateBatch(inputs: object[], archived?: boolean): string`\n\n**post** `/cms/blogs/2026-03/tags/batch/update`\n\nUpdate the Blog Tag objects identified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.blogs.tags.batch.updateBatch({ inputs: [{}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.blogs.tags.batch.updateBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.blogs.tags.batch.updateBatch({ inputs: [{}] });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.blogs.tags.batch.update_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.blogs.tags.batch.update_batch(\n inputs=[{}],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().blogs().tags().batch().updateBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n HttpResponse response = client.cms().blogs().tags().batch().updateBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Blogs.Tags.Batch.UpdateBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Blogs.Tags.Batch.UpdateBatch(context.TODO(), cms.BlogTagBatchUpdateBatchParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.blogs.tags.batch.update_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.blogs.tags.batch.update_batch(inputs: [{}])\n\nputs(response)', - }, - php: { - method: 'cms->blogs->tags->batch->updateBatch', - example: - "cms->blogs->tags->batch->updateBatch(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/blogs/2026-03/tags/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/domains/2026-03/{domainId}', - httpMethod: 'get', - summary: 'Get a single domain', - description: 'Returns a single domains with the id specified.', - stainlessPath: '(resource) cms.domains > (method) get', - qualified: 'client.cms.domains.get', - params: ['domainId: string;'], - response: - '{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }', - markdown: - "## get\n\n`client.cms.domains.get(domainId: string): { id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n**get** `/cms/domains/2026-03/{domainId}`\n\nReturns a single domains with the id specified.\n\n### Parameters\n\n- `domainId: string`\n\n### Returns\n\n- `{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n - `id: string`\n - `correctCname: string`\n - `created: string`\n - `domain: string`\n - `isResolving: boolean`\n - `isSslEnabled: boolean`\n - `isSslOnly: boolean`\n - `isUsedForBlogPost: boolean`\n - `isUsedForEmail: boolean`\n - `isUsedForKnowledge: boolean`\n - `isUsedForLandingPage: boolean`\n - `isUsedForSitePage: boolean`\n - `manuallyMarkedAsResolving: boolean`\n - `primaryBlogPost: boolean`\n - `primaryEmail: boolean`\n - `primaryKnowledge: boolean`\n - `primaryLandingPage: boolean`\n - `primarySitePage: boolean`\n - `secondaryToDomain: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst domain = await client.cms.domains.get('domainId');\n\nconsole.log(domain);\n```", - perLanguage: { - typescript: { - method: 'client.cms.domains.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst domain = await client.cms.domains.get('domainId');\n\nconsole.log(domain.id);", - }, - python: { - method: 'cms.domains.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ndomain = client.cms.domains.get(\n "domainId",\n)\nprint(domain.id)', - }, - java: { - method: 'cms().domains().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.domains.Domain;\nimport com.hubspot.sdk.models.cms.domains.DomainGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Domain domain = client.cms().domains().get("domainId");\n }\n}', - }, - go: { - method: 'client.Cms.Domains.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdomain, err := client.Cms.Domains.Get(context.TODO(), "domainId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", domain.ID)\n}\n', - }, - ruby: { - method: 'cms.domains.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ndomain = hubspot.cms.domains.get("domainId")\n\nputs(domain)', - }, - php: { - method: 'cms->domains->get', - example: - "cms->domains->get('domainId');\n\nvar_dump($domain);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/domains/2026-03/$DOMAIN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/domains/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) cms.domains > (method) list', - qualified: 'client.cms.domains.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }', - markdown: - "## list\n\n`client.cms.domains.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n**get** `/cms/domains/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; correctCname: string; created: string; domain: string; isResolving: boolean; isSslEnabled: boolean; isSslOnly: boolean; isUsedForBlogPost: boolean; isUsedForEmail: boolean; isUsedForKnowledge: boolean; isUsedForLandingPage: boolean; isUsedForSitePage: boolean; manuallyMarkedAsResolving: boolean; primaryBlogPost: boolean; primaryEmail: boolean; primaryKnowledge: boolean; primaryLandingPage: boolean; primarySitePage: boolean; secondaryToDomain: string; updated: string; }`\n\n - `id: string`\n - `correctCname: string`\n - `created: string`\n - `domain: string`\n - `isResolving: boolean`\n - `isSslEnabled: boolean`\n - `isSslOnly: boolean`\n - `isUsedForBlogPost: boolean`\n - `isUsedForEmail: boolean`\n - `isUsedForKnowledge: boolean`\n - `isUsedForLandingPage: boolean`\n - `isUsedForSitePage: boolean`\n - `manuallyMarkedAsResolving: boolean`\n - `primaryBlogPost: boolean`\n - `primaryEmail: boolean`\n - `primaryKnowledge: boolean`\n - `primaryLandingPage: boolean`\n - `primarySitePage: boolean`\n - `secondaryToDomain: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const domain of client.cms.domains.list()) {\n console.log(domain);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.domains.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const domain of client.cms.domains.list()) {\n console.log(domain.id);\n}", - }, - python: { - method: 'cms.domains.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.domains.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().domains().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.domains.DomainListPage;\nimport com.hubspot.sdk.models.cms.domains.DomainListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DomainListPage page = client.cms().domains().list();\n }\n}', - }, - go: { - method: 'client.Cms.Domains.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Domains.List(context.TODO(), cms.DomainListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.domains.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.domains.list\n\nputs(page)', - }, - php: { - method: 'cms->domains->list', - example: - "cms->domains->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/domains/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'clone_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone', - httpMethod: 'post', - summary: 'Clone rows in batch', - description: - 'Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.', - stainlessPath: '(resource) cms.hubdb.rows > (method) clone_batch', - qualified: 'client.cms.hubdb.rows.cloneBatch', - params: ['tableIdOrName: string;', 'inputs: { id: string; name?: string; }[];'], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## clone_batch\n\n`client.cms.hubdb.rows.cloneBatch(tableIdOrName: string, inputs: { id: string; name?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone`\n\nClones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { id: string; name?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.cloneBatch('tableIdOrName', { inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.cloneBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.cloneBatch('tableIdOrName', {\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.clone_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.clone_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().cloneBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowBatchCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowBatchCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCloneBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCloneBatchParams params = RowCloneBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowBatchCloneRequest(BatchInputHubDbTableRowBatchCloneRequest.builder()\n .addInput(HubDbTableRowBatchCloneRequest.builder()\n .id("id")\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().cloneBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.CloneBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.CloneBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowCloneBatchParams{\n\t\t\tBatchInputHubDBTableRowBatchCloneRequest: cms.BatchInputHubDBTableRowBatchCloneRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowBatchCloneRequestParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.clone_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.clone_batch("tableIdOrName", inputs: [{id: "id"}])\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->cloneBatch', - example: - "cms->hubdb->rows->cloneBatch(\n 'tableIdOrName', inputs: [['id' => 'id', 'name' => 'name']]\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'clone_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone', - httpMethod: 'post', - summary: 'Clone a row', - description: 'Clones a single row in the draft version of a table.', - stainlessPath: '(resource) cms.hubdb.rows > (method) clone_draft', - qualified: 'client.cms.hubdb.rows.cloneDraft', - params: ['tableIdOrName: string;', 'rowId: string;', 'name?: string;'], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## clone_draft\n\n`client.cms.hubdb.rows.cloneDraft(tableIdOrName: string, rowId: string, name?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone`\n\nClones a single row in the draft version of a table.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.cloneDraft('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.cloneDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.cloneDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.clone_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.clone_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().cloneDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCloneDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCloneDraftParams params = RowCloneDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().cloneDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.CloneDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.CloneDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowCloneDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.clone_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.clone_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->cloneDraft', - example: - "cms->hubdb->rows->cloneDraft(\n '321669910225', tableIDOrName: 'tableIdOrName', name: 'name'\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft/clone \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', - httpMethod: 'post', - summary: 'Add a row to a table', - description: - 'Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use the `/publish` endpoint to push these changes to published version.', - stainlessPath: '(resource) cms.hubdb.rows > (method) create', - qualified: 'client.cms.hubdb.rows.create', - params: [ - 'tableIdOrName: string;', - 'childTableId: number;', - 'displayIndex: number;', - 'values: object;', - 'name?: string;', - 'path?: string;', - ], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## create\n\n`client.cms.hubdb.rows.create(tableIdOrName: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows`\n\nAdd a new row to a HubDB table. New rows will be added to the draft version of the table. Use the `/publish` endpoint to push these changes to published version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.create('tableIdOrName', {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.create('tableIdOrName', {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.create(\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCreateParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCreateParams params = RowCreateParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.New(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowNewParams{\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.create(\n "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->create', - example: - "cms->hubdb->rows->create(\n 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', - }, - }, - }, - { - name: 'create_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create', - httpMethod: 'post', - summary: 'Create rows in batch', - description: - 'Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.', - stainlessPath: '(resource) cms.hubdb.rows > (method) create_batch', - qualified: 'client.cms.hubdb.rows.createBatch', - params: [ - 'tableIdOrName: string;', - 'inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create_batch\n\n`client.cms.hubdb.rows.createBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create`\n\nCreates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.createBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.createBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.createBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.create_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.create_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().createBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowCreateBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowCreateBatchParams params = RowCreateBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3Request(BatchInputHubDbTableRowV3Request.builder()\n .addInput(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().createBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.NewBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.NewBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowNewBatchParams{\n\t\t\tBatchInputHubDBTableRowV3Request: cms.BatchInputHubDBTableRowV3RequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3RequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.create_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.create_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->createBatch', - example: - "cms->hubdb->rows->createBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - httpMethod: 'delete', - summary: 'Permanently deletes a row', - description: "Permanently deletes a row from a table's draft version.", - stainlessPath: '(resource) cms.hubdb.rows > (method) delete_draft', - qualified: 'client.cms.hubdb.rows.deleteDraft', - params: ['tableIdOrName: string;', 'rowId: string;'], - markdown: - "## delete_draft\n\n`client.cms.hubdb.rows.deleteDraft(tableIdOrName: string, rowId: string): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nPermanently deletes a row from a table's draft version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.rows.deleteDraft('321669910225', { tableIdOrName: 'tableIdOrName' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.deleteDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.rows.deleteDraft('321669910225', { tableIdOrName: 'tableIdOrName' });", - }, - python: { - method: 'cms.hubdb.rows.delete_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.rows.delete_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)', - }, - java: { - method: 'cms().hubdb().rows().deleteDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowDeleteDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowDeleteDraftParams params = RowDeleteDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n client.cms().hubdb().rows().deleteDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.DeleteDraft', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Rows.DeleteDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowDeleteDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.delete_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.rows.delete_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(result)', - }, - php: { - method: 'cms->hubdb->rows->deleteDraft', - example: - "cms->hubdb->rows->deleteDraft(\n '321669910225', tableIDOrName: 'tableIdOrName'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}', - httpMethod: 'get', - summary: 'Get a table row', - description: - 'Get a single row by ID from the published version of a table.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.', - stainlessPath: '(resource) cms.hubdb.rows > (method) get', - qualified: 'client.cms.hubdb.rows.get', - params: ['tableIdOrName: string;', 'rowId: string;', 'archived?: boolean;'], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## get\n\n`client.cms.hubdb.rows.get(tableIdOrName: string, rowId: string, archived?: boolean): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}`\n\nGet a single row by ID from the published version of a table.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.get('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.get('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.get(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetParams params = RowGetParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().get(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.Get(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowGetParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.get("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->get', - example: - "cms->hubdb->rows->get(\n '321669910225', tableIDOrName: 'tableIdOrName', archived: true\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read', - httpMethod: 'post', - summary: 'Get a set of rows', - description: - 'Returns rows in the published version of the specified table, given a set of row IDs.\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.', - stainlessPath: '(resource) cms.hubdb.rows > (method) get_batch', - qualified: 'client.cms.hubdb.rows.getBatch', - params: ['tableIdOrName: string;', 'inputs: string[];'], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_batch\n\n`client.cms.hubdb.rows.getBatch(tableIdOrName: string, inputs: string[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read`\n\nReturns rows in the published version of the specified table, given a set of row IDs.\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getBatch('tableIdOrName', { inputs: ['string'] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.getBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getBatch('tableIdOrName', {\n inputs: ['string'],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.get_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.get_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().getBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetBatchParams params = RowGetBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().getBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.GetBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowGetBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.get_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_batch("tableIdOrName", inputs: ["string"])\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->getBatch', - example: - "cms->hubdb->rows->getBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - httpMethod: 'get', - summary: 'Get a row from the draft table', - description: "Get a single row by ID from a table's draft version.", - stainlessPath: '(resource) cms.hubdb.rows > (method) get_draft', - qualified: 'client.cms.hubdb.rows.getDraft', - params: ['tableIdOrName: string;', 'rowId: string;', 'archived?: boolean;'], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## get_draft\n\n`client.cms.hubdb.rows.getDraft(tableIdOrName: string, rowId: string, archived?: boolean): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nGet a single row by ID from a table's draft version.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.getDraft('321669910225', { tableIdOrName: 'tableIdOrName' });\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.getDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.getDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.get_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.get_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().getDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetDraftParams params = RowGetDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().getDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.GetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowGetDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.get_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_draft("321669910225", table_id_or_name: "tableIdOrName")\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->getDraft', - example: - "cms->hubdb->rows->getDraft(\n '321669910225', tableIDOrName: 'tableIdOrName', archived: true\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_draft_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read', - httpMethod: 'post', - summary: 'Get a set of rows from draft table', - description: 'Returns rows in the draft version of the specified table, given a set of row IDs.', - stainlessPath: '(resource) cms.hubdb.rows > (method) get_draft_batch', - qualified: 'client.cms.hubdb.rows.getDraftBatch', - params: ['tableIdOrName: string;', 'inputs: string[];'], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_draft_batch\n\n`client.cms.hubdb.rows.getDraftBatch(tableIdOrName: string, inputs: string[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read`\n\nReturns rows in the draft version of the specified table, given a set of row IDs.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getDraftBatch('tableIdOrName', { inputs: ['string'] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.getDraftBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.getDraftBatch('tableIdOrName', {\n inputs: ['string'],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.get_draft_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.get_draft_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().getDraftBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowGetDraftBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowGetDraftBatchParams params = RowGetDraftBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().getDraftBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.GetDraftBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.GetDraftBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowGetDraftBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.get_draft_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.get_draft_batch("tableIdOrName", inputs: ["string"])\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->getDraftBatch', - example: - "cms->hubdb->rows->getDraftBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', - httpMethod: 'get', - summary: 'Get rows for a table', - description: - 'Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.', - stainlessPath: '(resource) cms.hubdb.rows > (method) list', - qualified: 'client.cms.hubdb.rows.list', - params: [ - 'tableIdOrName: string;', - 'after?: string;', - 'archived?: boolean;', - 'limit?: number;', - 'offset?: number;', - 'properties?: string[];', - 'sort?: string[];', - ], - response: - "{ results: object[]; total: number; type: 'RANDOM_ACCESS'; paging?: object; } | { results: object[]; total: number; type: 'STREAMING'; paging?: object; }", - markdown: - "## list\n\n`client.cms.hubdb.rows.list(tableIdOrName: string, after?: string, archived?: boolean, limit?: number, offset?: number, properties?: string[], sort?: string[]): object | object`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows`\n\nReturns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.\n**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `offset?: number`\n\n- `properties?: string[]`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ results: object[]; total: number; type: 'RANDOM_ACCESS'; paging?: object; } | { results: object[]; total: number; type: 'STREAMING'; paging?: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst unifiedCollectionResponseWithTotalBaseHubDBTableRowV3 = await client.cms.hubdb.rows.list('tableIdOrName');\n\nconsole.log(unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst unifiedCollectionResponseWithTotalBaseHubDBTableRowV3 = await client.cms.hubdb.rows.list(\n 'tableIdOrName',\n);\n\nconsole.log(unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);", - }, - python: { - method: 'cms.hubdb.rows.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nunified_collection_response_with_total_base_hub_db_table_row_v3 = client.cms.hubdb.rows.list(\n table_id_or_name="tableIdOrName",\n)\nprint(unified_collection_response_with_total_base_hub_db_table_row_v3)', - }, - java: { - method: 'cms().hubdb().rows().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UnifiedCollectionResponseWithTotalBaseHubDbTableRowV3 unifiedCollectionResponseWithTotalBaseHubDbTableRowV3 = client.cms().hubdb().rows().list("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunifiedCollectionResponseWithTotalBaseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.List(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unifiedCollectionResponseWithTotalBaseHubDBTableRowV3)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nunified_collection_response_with_total_base_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.list("tableIdOrName")\n\nputs(unified_collection_response_with_total_base_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->list', - example: - "cms\n ->hubdb\n ->rows\n ->list(\n 'tableIdOrName',\n after: 'after',\n archived: true,\n limit: 0,\n offset: 0,\n properties: ['string'],\n sort: ['string'],\n);\n\nvar_dump($unifiedCollectionResponseWithTotalBaseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'purge_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge', - httpMethod: 'post', - summary: 'Delete rows', - description: - 'Permanently delete rows from the draft version of a table, given a set of row IDs. Maximum of 100 row IDs per call.', - stainlessPath: '(resource) cms.hubdb.rows > (method) purge_batch', - qualified: 'client.cms.hubdb.rows.purgeBatch', - params: ['tableIdOrName: string;', 'inputs: string[];'], - markdown: - "## purge_batch\n\n`client.cms.hubdb.rows.purgeBatch(tableIdOrName: string, inputs: string[]): void`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge`\n\nPermanently delete rows from the draft version of a table, given a set of row IDs. Maximum of 100 row IDs per call.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.rows.purgeBatch('tableIdOrName', { inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.purgeBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.rows.purgeBatch('tableIdOrName', { inputs: ['string'] });", - }, - python: { - method: 'cms.hubdb.rows.purge_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.rows.purge_batch(\n table_id_or_name="tableIdOrName",\n inputs=["string"],\n)', - }, - java: { - method: 'cms().hubdb().rows().purgeBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowPurgeBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowPurgeBatchParams params = RowPurgeBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n client.cms().hubdb().rows().purgeBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.PurgeBatch', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Rows.PurgeBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowPurgeBatchParams{\n\t\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\t\tInputs: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.purge_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.rows.purge_batch("tableIdOrName", inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->hubdb->rows->purgeBatch', - example: - "cms->hubdb->rows->purgeBatch(\n 'tableIdOrName', inputs: ['string']\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/purge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'replace_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace', - httpMethod: 'post', - summary: 'Replace rows in batch in draft table', - description: - 'Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PUT /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.', - stainlessPath: '(resource) cms.hubdb.rows > (method) replace_batch', - qualified: 'client.cms.hubdb.rows.replaceBatch', - params: [ - 'tableIdOrName: string;', - 'inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## replace_batch\n\n`client.cms.hubdb.rows.replaceBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace`\n\nReplaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PUT /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.replaceBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.replaceBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.replaceBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.replace_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.replace_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().replaceBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowReplaceBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowReplaceBatchParams params = RowReplaceBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3BatchUpdateRequest(BatchInputHubDbTableRowV3BatchUpdateRequest.builder()\n .addInput(HubDbTableRowV3BatchUpdateRequest.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3BatchUpdateRequest.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().replaceBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.ReplaceBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.ReplaceBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowReplaceBatchParams{\n\t\t\tBatchInputHubDBTableRowV3BatchUpdateRequest: cms.BatchInputHubDBTableRowV3BatchUpdateRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3BatchUpdateRequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.replace_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.replace_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->replaceBatch', - example: - "cms->hubdb->rows->replaceBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'id' => 'id',\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/replace \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'replace_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - httpMethod: 'put', - summary: 'Replace an existing row', - description: - 'Replace a single row in the draft version of a table. All column values must be specified. If a column has a value in the target table and this request doesn\'t define that value, it will be deleted.\nSee the "Create a row" endpoint for instructions on how to format the JSON row definitions.', - stainlessPath: '(resource) cms.hubdb.rows > (method) replace_draft', - qualified: 'client.cms.hubdb.rows.replaceDraft', - params: [ - 'tableIdOrName: string;', - 'rowId: string;', - 'childTableId: number;', - 'displayIndex: number;', - 'values: object;', - 'name?: string;', - 'path?: string;', - ], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## replace_draft\n\n`client.cms.hubdb.rows.replaceDraft(tableIdOrName: string, rowId: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**put** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nReplace a single row in the draft version of a table. All column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted.\nSee the \"Create a row\" endpoint for instructions on how to format the JSON row definitions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.replaceDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.replaceDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.replaceDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.replace_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.replace_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().replaceDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowReplaceDraftParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowReplaceDraftParams params = RowReplaceDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().replaceDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.ReplaceDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.ReplaceDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowReplaceDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.replace_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.replace_draft(\n "321669910225",\n table_id_or_name: "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->replaceDraft', - example: - "cms->hubdb->rows->replaceDraft(\n '321669910225',\n tableIDOrName: 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', - }, - }, - }, - { - name: 'update_batch', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update', - httpMethod: 'post', - summary: 'Update rows in batch in draft table', - description: - 'Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PATCH /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.', - stainlessPath: '(resource) cms.hubdb.rows > (method) update_batch', - qualified: 'client.cms.hubdb.rows.updateBatch', - params: [ - 'tableIdOrName: string;', - 'inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update_batch\n\n`client.cms.hubdb.rows.updateBatch(tableIdOrName: string, inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]): { completedAt: string; results: hub_db_table_row_v3[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update`\n\nUpdates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint `PATCH /tables/{tableIdOrName}/rows/{rowId}/draft` for details on updating a single row.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `inputs: { childTableId: number; displayIndex: number; values: object; id?: string; name?: string; path?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.updateBatch('tableIdOrName', { inputs: [{\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n}] });\n\nconsole.log(batchResponseHubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.updateBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseHubDBTableRowV3 = await client.cms.hubdb.rows.updateBatch('tableIdOrName', {\n inputs: [\n {\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n },\n ],\n});\n\nconsole.log(batchResponseHubDBTableRowV3.completedAt);", - }, - python: { - method: 'cms.hubdb.rows.update_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_hub_db_table_row_v3 = client.cms.hubdb.rows.update_batch(\n table_id_or_name="tableIdOrName",\n inputs=[{\n "child_table_id": 0,\n "display_index": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n },\n }],\n)\nprint(batch_response_hub_db_table_row_v3.completed_at)', - }, - java: { - method: 'cms().hubdb().rows().updateBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.BatchInputHubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.BatchResponseHubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3BatchUpdateRequest;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowUpdateBatchParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowUpdateBatchParams params = RowUpdateBatchParams.builder()\n .tableIdOrName("tableIdOrName")\n .batchInputHubDbTableRowV3BatchUpdateRequest(BatchInputHubDbTableRowV3BatchUpdateRequest.builder()\n .addInput(HubDbTableRowV3BatchUpdateRequest.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3BatchUpdateRequest.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build())\n .build();\n BatchResponseHubDbTableRowV3 batchResponseHubDbTableRowV3 = client.cms().hubdb().rows().updateBatch(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.UpdateBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseHubDBTableRowV3, err := client.Cms.Hubdb.Rows.UpdateBatch(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbRowUpdateBatchParams{\n\t\t\tBatchInputHubDBTableRowV3BatchUpdateRequest: cms.BatchInputHubDBTableRowV3BatchUpdateRequestParam{\n\t\t\t\tInputs: []cms.HubDBTableRowV3BatchUpdateRequestParam{{\n\t\t\t\t\tChildTableID: 0,\n\t\t\t\t\tDisplayIndex: 0,\n\t\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t\t"foo": {\n\t\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseHubDBTableRowV3.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.update_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_hub_db_table_row_v3 = hubspot.cms.hubdb.rows.update_batch(\n "tableIdOrName",\n inputs: [{childTableId: 0, displayIndex: 0, values: {foo: {foo: "bar"}}}]\n)\n\nputs(batch_response_hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->updateBatch', - example: - "cms->hubdb->rows->updateBatch(\n 'tableIdOrName',\n inputs: [\n [\n 'childTableID' => 0,\n 'displayIndex' => 0,\n 'values' => ['foo' => ['foo' => 'bar']],\n 'id' => 'id',\n 'name' => 'name',\n 'path' => 'path',\n ],\n ],\n);\n\nvar_dump($batchResponseHubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/draft/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - httpMethod: 'patch', - summary: 'Update a row', - description: - 'Partially update a single row in the table\'s draft version.\nAll the column values need not be specified. Only the columns or fields that needs to be modified can be specified.\nSee the "Create a row" endpoint for instructions on how to format the JSON row definitions.', - stainlessPath: '(resource) cms.hubdb.rows > (method) update_draft', - qualified: 'client.cms.hubdb.rows.updateDraft', - params: [ - 'tableIdOrName: string;', - 'rowId: string;', - 'childTableId: number;', - 'displayIndex: number;', - 'values: object;', - 'name?: string;', - 'path?: string;', - ], - response: - '{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }', - markdown: - "## update_draft\n\n`client.cms.hubdb.rows.updateDraft(tableIdOrName: string, rowId: string, childTableId: number, displayIndex: number, values: object, name?: string, path?: string): { id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n**patch** `/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft`\n\nPartially update a single row in the table's draft version.\nAll the column values need not be specified. Only the columns or fields that needs to be modified can be specified.\nSee the \"Create a row\" endpoint for instructions on how to format the JSON row definitions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `rowId: string`\n\n- `childTableId: number`\n Specifies the value for the column child table id\n\n- `displayIndex: number`\n The index position for displaying the row within the table.\n\n- `values: object`\n List of key value pairs with the column name and column value\n\n- `name?: string`\n Specifies the value for `hs_name` column, which will be used as title in the dynamic pages\n\n- `path?: string`\n Specifies the value for `hs_path` column, which will be used as slug in the dynamic pages\n\n### Returns\n\n- `{ id: string; childTableId: string; createdAt: string; name: string; path: string; publishedAt: string; updatedAt: string; values: object; }`\n\n - `id: string`\n - `childTableId: string`\n - `createdAt: string`\n - `name: string`\n - `path: string`\n - `publishedAt: string`\n - `updatedAt: string`\n - `values: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.updateDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.rows.updateDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableRowV3 = await client.cms.hubdb.rows.updateDraft('321669910225', {\n tableIdOrName: 'tableIdOrName',\n childTableId: 0,\n displayIndex: 0,\n values: { foo: { foo: 'bar' } },\n});\n\nconsole.log(hubDBTableRowV3.id);", - }, - python: { - method: 'cms.hubdb.rows.update_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_row_v3 = client.cms.hubdb.rows.update_draft(\n row_id="321669910225",\n table_id_or_name="tableIdOrName",\n child_table_id=0,\n display_index=0,\n values={\n "foo": {\n "foo": "bar"\n }\n },\n)\nprint(hub_db_table_row_v3.id)', - }, - java: { - method: 'cms().hubdb().rows().updateDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableRowV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.rows.RowUpdateDraftParams;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RowUpdateDraftParams params = RowUpdateDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .rowId("321669910225")\n .hubDbTableRowV3Request(HubDbTableRowV3Request.builder()\n .childTableId(0L)\n .displayIndex(0)\n .values(HubDbTableRowV3Request.Values.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "foo", "bar"\n )))\n .build())\n .build())\n .build();\n HubDbTableRowV3 hubDbTableRowV3 = client.cms().hubdb().rows().updateDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Rows.UpdateDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableRowV3, err := client.Cms.Hubdb.Rows.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tcms.HubdbRowUpdateDraftParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t\tHubDBTableRowV3Request: cms.HubDBTableRowV3RequestParam{\n\t\t\t\tChildTableID: 0,\n\t\t\t\tDisplayIndex: 0,\n\t\t\t\tValues: map[string]cms.Variant{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\t"foo": "bar",\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableRowV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.rows.update_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_row_v3 = hubspot.cms.hubdb.rows.update_draft(\n "321669910225",\n table_id_or_name: "tableIdOrName",\n child_table_id: 0,\n display_index: 0,\n values: {foo: {foo: "bar"}}\n)\n\nputs(hub_db_table_row_v3)', - }, - php: { - method: 'cms->hubdb->rows->updateDraft', - example: - "cms->hubdb->rows->updateDraft(\n '321669910225',\n tableIDOrName: 'tableIdOrName',\n childTableID: 0,\n displayIndex: 0,\n values: ['foo' => ['foo' => 'bar']],\n name: 'name',\n path: 'path',\n);\n\nvar_dump($hubDBTableRowV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/rows/$ROW_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "childTableId": 0,\n "displayIndex": 0,\n "values": {\n "foo": {\n "foo": "bar"\n }\n }\n }\'', - }, - }, - }, - { - name: 'clone_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone', - httpMethod: 'post', - summary: 'Clone a table', - description: - 'Clone an existing HubDB table. The `newName` and `newLabel` of the new table can be sent as JSON in the request body. This will create the cloned table as a draft.', - stainlessPath: '(resource) cms.hubdb.tables > (method) clone_draft', - qualified: 'client.cms.hubdb.tables.cloneDraft', - params: [ - 'tableIdOrName: string;', - 'copyRows: boolean;', - 'isHubspotDefined: boolean;', - 'newLabel?: string;', - 'newName?: string;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## clone_draft\n\n`client.cms.hubdb.tables.cloneDraft(tableIdOrName: string, copyRows: boolean, isHubspotDefined: boolean, newLabel?: string, newName?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone`\n\nClone an existing HubDB table. The `newName` and `newLabel` of the new table can be sent as JSON in the request body. This will create the cloned table as a draft.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `copyRows: boolean`\n Specifies whether to copy the rows during clone\n\n- `isHubspotDefined: boolean`\n Indicates whether the table is defined by HubSpot.\n\n- `newLabel?: string`\n The new label for the cloned table\n\n- `newName?: string`\n The new name for the cloned table\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', { copyRows: true, isHubspotDefined: true });\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.cloneDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', {\n copyRows: true,\n isHubspotDefined: true,\n});\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.clone_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.clone_draft(\n table_id_or_name="tableIdOrName",\n copy_rows=True,\n is_hubspot_defined=True,\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().cloneDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableCloneRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableCloneDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableCloneDraftParams params = TableCloneDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableCloneRequest(HubDbTableCloneRequest.builder()\n .copyRows(true)\n .isHubSpotDefined(true)\n .build())\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().cloneDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.CloneDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.CloneDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableCloneDraftParams{\n\t\t\tHubDBTableCloneRequest: cms.HubDBTableCloneRequestParam{\n\t\t\t\tCopyRows: true,\n\t\t\t\tIsHubSpotDefined: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.clone_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.clone_draft("tableIdOrName", copy_rows: true, is_hubspot_defined: true)\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->cloneDraft', - example: - "cms->hubdb->tables->cloneDraft(\n 'tableIdOrName',\n copyRows: true,\n isHubSpotDefined: true,\n newLabel: 'newLabel',\n newName: 'newName',\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "copyRows": true,\n "isHubspotDefined": true\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/hubdb/2026-03/tables', - httpMethod: 'post', - summary: 'Create a table', - description: - 'Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.', - stainlessPath: '(resource) cms.hubdb.tables > (method) create', - qualified: 'client.cms.hubdb.tables.create', - params: [ - 'allowChildTables: boolean;', - 'allowPublicApiAccess: boolean;', - 'columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[];', - 'dynamicMetaTags: object;', - 'enableChildTablePages: boolean;', - 'label: string;', - 'name: string;', - 'useForPages: boolean;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## create\n\n`client.cms.hubdb.tables.create(allowChildTables: boolean, allowPublicApiAccess: boolean, columns: { id: number; label: string; name: string; options: hubdb_option[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[], dynamicMetaTags: object, enableChildTablePages: boolean, label: string, name: string, useForPages: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables`\n\nCreates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.\n\n### Parameters\n\n- `allowChildTables: boolean`\n Specifies whether child tables can be created\n\n- `allowPublicApiAccess: boolean`\n Specifies whether the table can be read by public without authorization\n\n- `columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[]`\n List of columns in the table\n\n- `dynamicMetaTags: object`\n Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.\n\n- `enableChildTablePages: boolean`\n Specifies creation of multi-level dynamic pages using child tables\n\n- `label: string`\n Label of the table\n\n- `name: string`\n Name of the table\n\n- `useForPages: boolean`\n Specifies whether the table can be used for creation of dynamic pages\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.create({\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [{\n id: 0,\n label: 'label',\n name: 'name',\n options: [{\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n}],\n type: 'BOOLEAN',\n}],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.create({\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [\n {\n id: 0,\n label: 'label',\n name: 'name',\n options: [\n {\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n },\n ],\n type: 'BOOLEAN',\n },\n ],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.create(\n allow_child_tables=True,\n allow_public_api_access=True,\n columns=[{\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [{\n "id": "id",\n "created_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updated_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n "type": "BOOLEAN",\n }],\n dynamic_meta_tags={\n "foo": 0\n },\n enable_child_table_pages=True,\n label="label",\n name="name",\n use_for_pages=True,\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.ColumnRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.HubdbOption;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3Request params = HubDbTableV3Request.builder()\n .allowChildTables(true)\n .allowPublicApiAccess(true)\n .addColumn(ColumnRequest.builder()\n .id(0)\n .label("label")\n .name("name")\n .addOption(HubdbOption.builder()\n .id("id")\n .createdAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .label("label")\n .name("name")\n .order(0)\n .type("type")\n .updatedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .type(ColumnRequest.Type.BOOLEAN)\n .build())\n .dynamicMetaTags(HubDbTableV3Request.DynamicMetaTags.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .enableChildTablePages(true)\n .label("label")\n .name("name")\n .useForPages(true)\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.New(context.TODO(), cms.HubdbTableNewParams{\n\t\tHubDBTableV3Request: cms.HubDBTableV3RequestParam{\n\t\t\tAllowChildTables: true,\n\t\t\tAllowPublicAPIAccess: true,\n\t\t\tColumns: []cms.ColumnRequestParam{{\n\t\t\t\tID: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tOptions: []cms.HubdbOptionParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tCreatedAt: time.Now(),\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tOrder: 0,\n\t\t\t\t\tType: "type",\n\t\t\t\t\tUpdatedAt: time.Now(),\n\t\t\t\t}},\n\t\t\t\tType: cms.ColumnRequestTypeBoolean,\n\t\t\t}},\n\t\t\tDynamicMetaTags: map[string]int64{\n\t\t\t\t"foo": 0,\n\t\t\t},\n\t\t\tEnableChildTablePages: true,\n\t\t\tLabel: "label",\n\t\t\tName: "name",\n\t\t\tUseForPages: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.create(\n allow_child_tables: true,\n allow_public_api_access: true,\n columns: [\n {\n id: 0,\n label: "label",\n name: "name",\n options: [\n {\n id: "id",\n createdAt: "2019-12-27T18:11:19.117Z",\n label: "label",\n name: "name",\n order: 0,\n type: "type",\n updatedAt: "2019-12-27T18:11:19.117Z"\n }\n ],\n type: :BOOLEAN\n }\n ],\n dynamic_meta_tags: {foo: 0},\n enable_child_table_pages: true,\n label: "label",\n name: "name",\n use_for_pages: true\n)\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->create', - example: - "cms->hubdb->tables->create(\n allowChildTables: true,\n allowPublicAPIAccess: true,\n columns: [\n [\n 'id' => 0,\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n [\n 'id' => 'id',\n 'createdAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'label' => 'label',\n 'name' => 'name',\n 'order' => 0,\n 'type' => 'type',\n 'updatedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'createdByUserID' => 0,\n 'updatedBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'updatedByUserID' => 0,\n ],\n ],\n 'type' => 'BOOLEAN',\n 'foreignColumnID' => 0,\n 'foreignTableID' => 0,\n 'maxNumberOfCharacters' => 0,\n 'maxNumberOfOptions' => 0,\n ],\n ],\n dynamicMetaTags: ['foo' => 0],\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowChildTables": true,\n "allowPublicApiAccess": true,\n "columns": [\n {\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [\n {\n "id": "id",\n "createdAt": "2019-12-27T18:11:19.117Z",\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updatedAt": "2019-12-27T18:11:19.117Z"\n }\n ],\n "type": "BOOLEAN"\n }\n ],\n "dynamicMetaTags": {\n "foo": 0\n },\n "enableChildTablePages": true,\n "label": "label",\n "name": "name",\n "useForPages": true\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}', - httpMethod: 'delete', - summary: 'Archive a table', - description: - 'Archive (soft delete) an existing HubDB table. This archives both the published and draft versions.', - stainlessPath: '(resource) cms.hubdb.tables > (method) delete', - qualified: 'client.cms.hubdb.tables.delete', - params: ['tableIdOrName: string;'], - markdown: - "## delete\n\n`client.cms.hubdb.tables.delete(tableIdOrName: string): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}`\n\nArchive (soft delete) an existing HubDB table. This archives both the published and draft versions.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.tables.delete('tableIdOrName')\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.tables.delete('tableIdOrName');", - }, - python: { - method: 'cms.hubdb.tables.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.tables.delete(\n "tableIdOrName",\n)', - }, - java: { - method: 'cms().hubdb().tables().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().hubdb().tables().delete("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Tables.Delete(context.TODO(), "tableIdOrName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.tables.delete("tableIdOrName")\n\nputs(result)', - }, - php: { - method: 'cms->hubdb->tables->delete', - example: - "cms->hubdb->tables->delete('tableIdOrName');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_version', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}', - httpMethod: 'delete', - summary: 'Delete a table version', - description: 'Delete a specific version of a table', - stainlessPath: '(resource) cms.hubdb.tables > (method) delete_version', - qualified: 'client.cms.hubdb.tables.deleteVersion', - params: ['tableIdOrName: string;', 'versionId: number;'], - markdown: - "## delete_version\n\n`client.cms.hubdb.tables.deleteVersion(tableIdOrName: string, versionId: number): void`\n\n**delete** `/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}`\n\nDelete a specific version of a table\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `versionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.hubdb.tables.deleteVersion(0, { tableIdOrName: 'tableIdOrName' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.deleteVersion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.hubdb.tables.deleteVersion(0, { tableIdOrName: 'tableIdOrName' });", - }, - python: { - method: 'cms.hubdb.tables.delete_version', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.hubdb.tables.delete_version(\n version_id=0,\n table_id_or_name="tableIdOrName",\n)', - }, - java: { - method: 'cms().hubdb().tables().deleteVersion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableDeleteVersionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableDeleteVersionParams params = TableDeleteVersionParams.builder()\n .tableIdOrName("tableIdOrName")\n .versionId(0L)\n .build();\n client.cms().hubdb().tables().deleteVersion(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.DeleteVersion', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Hubdb.Tables.DeleteVersion(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.HubdbTableDeleteVersionParams{\n\t\t\tTableIDOrName: "tableIdOrName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.delete_version', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.hubdb.tables.delete_version(0, table_id_or_name: "tableIdOrName")\n\nputs(result)', - }, - php: { - method: 'cms->hubdb->tables->deleteVersion', - example: - "cms->hubdb->tables->deleteVersion(\n 0, tableIDOrName: 'tableIdOrName'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/versions/$VERSION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'export', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/export', - httpMethod: 'get', - summary: 'Export a published version of a table', - description: 'Exports the published version of a table in a specified format.', - stainlessPath: '(resource) cms.hubdb.tables > (method) export', - qualified: 'client.cms.hubdb.tables.export', - params: ['tableIdOrName: string;', 'format?: string;'], - response: 'string', - markdown: - "## export\n\n`client.cms.hubdb.tables.export(tableIdOrName: string, format?: string): string`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/export`\n\nExports the published version of a table in a specified format.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `format?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.hubdb.tables.export('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.export', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.hubdb.tables.export('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.hubdb.tables.export', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.hubdb.tables.export(\n table_id_or_name="tableIdOrName",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().hubdb().tables().export', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableExportParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().hubdb().tables().export("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.Export', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Hubdb.Tables.Export(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableExportParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.export', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.hubdb.tables.export("tableIdOrName")\n\nputs(response)', - }, - php: { - method: 'cms->hubdb->tables->export', - example: - "cms->hubdb->tables->export(\n 'tableIdOrName', format: 'format'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/export \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'export_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export', - httpMethod: 'get', - summary: 'Export a draft table', - description: 'Exports the draft version of a table to CSV / EXCEL format.', - stainlessPath: '(resource) cms.hubdb.tables > (method) export_draft', - qualified: 'client.cms.hubdb.tables.exportDraft', - params: ['tableIdOrName: string;', 'format?: string;'], - response: 'string', - markdown: - "## export_draft\n\n`client.cms.hubdb.tables.exportDraft(tableIdOrName: string, format?: string): string`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export`\n\nExports the draft version of a table to CSV / EXCEL format.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `format?: string`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.hubdb.tables.exportDraft('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.exportDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.hubdb.tables.exportDraft('tableIdOrName');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.hubdb.tables.export_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.hubdb.tables.export_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().hubdb().tables().exportDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableExportDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.cms().hubdb().tables().exportDraft("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.ExportDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Hubdb.Tables.ExportDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableExportDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.export_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.hubdb.tables.export_draft("tableIdOrName")\n\nputs(response)', - }, - php: { - method: 'cms->hubdb->tables->exportDraft', - example: - "cms->hubdb->tables->exportDraft(\n 'tableIdOrName', format: 'format'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/export \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}', - httpMethod: 'get', - summary: 'Get details of a published table', - description: - "Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a `portalId` query parameter.", - stainlessPath: '(resource) cms.hubdb.tables > (method) get', - qualified: 'client.cms.hubdb.tables.get', - params: [ - 'tableIdOrName: string;', - 'archived?: boolean;', - 'includeForeignIds?: boolean;', - 'isGetLocalizedSchema?: boolean;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## get\n\n`client.cms.hubdb.tables.get(tableIdOrName: string, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}`\n\nReturns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n**Note:** This endpoint can be accessed without any authentication if the table is set to be allowed for public access. To do so, you'll need to include the HubSpot account ID in a `portalId` query parameter.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.get('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.get('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.get(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().get("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.Get(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.get("tableIdOrName")\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->get', - example: - "cms->hubdb->tables->get(\n 'tableIdOrName',\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', - httpMethod: 'get', - summary: 'Get details for a draft table', - description: - 'Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.', - stainlessPath: '(resource) cms.hubdb.tables > (method) get_draft', - qualified: 'client.cms.hubdb.tables.getDraft', - params: [ - 'tableIdOrName: string;', - 'archived?: boolean;', - 'includeForeignIds?: boolean;', - 'isGetLocalizedSchema?: boolean;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## get_draft\n\n`client.cms.hubdb.tables.getDraft(tableIdOrName: string, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft`\n\nGet the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.getDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.getDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.getDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.get_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.get_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().getDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().getDraft("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.GetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.GetDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableGetDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.get_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.get_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->getDraft', - example: - "cms->hubdb->tables->getDraft(\n 'tableIdOrName',\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'import_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import', - httpMethod: 'post', - summary: 'Import data into draft table', - description: - 'Import the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use the `/publish` endpoint to push these changes to the published version.\nThis endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as `config`. The second part will be the CSV file you want to import and you can specify this with the name as `file`. Refer the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables) to check the details and format of the JSON-formatted options for the import.', - stainlessPath: '(resource) cms.hubdb.tables > (method) import_draft', - qualified: 'client.cms.hubdb.tables.importDraft', - params: ['tableIdOrName: string;', 'config?: string;', 'file?: string;'], - response: - '{ duplicateRows: number; errors: { category: string; correlationId: string; message: string; context?: object; errors?: error_detail[]; links?: object; subCategory?: string; }[]; rowLimitExceeded: boolean; rowsImported: number; }', - markdown: - "## import_draft\n\n`client.cms.hubdb.tables.importDraft(tableIdOrName: string, config?: string, file?: string): { duplicateRows: number; errors: error_data[]; rowLimitExceeded: boolean; rowsImported: number; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import`\n\nImport the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use the `/publish` endpoint to push these changes to the published version.\nThis endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as `config`. The second part will be the CSV file you want to import and you can specify this with the name as `file`. Refer the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#importing-tables) to check the details and format of the JSON-formatted options for the import.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `config?: string`\n\n- `file?: string`\n\n### Returns\n\n- `{ duplicateRows: number; errors: { category: string; correlationId: string; message: string; context?: object; errors?: error_detail[]; links?: object; subCategory?: string; }[]; rowLimitExceeded: boolean; rowsImported: number; }`\n\n - `duplicateRows: number`\n - `errors: { category: string; correlationId: string; message: string; context?: object; errors?: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links?: object; subCategory?: string; }[]`\n - `rowLimitExceeded: boolean`\n - `rowsImported: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst importResult = await client.cms.hubdb.tables.importDraft('tableIdOrName');\n\nconsole.log(importResult);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.importDraft', - example: - "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst importResult = await client.cms.hubdb.tables.importDraft('tableIdOrName');\n\nconsole.log(importResult.duplicateRows);", - }, - python: { - method: 'cms.hubdb.tables.import_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nimport_result = client.cms.hubdb.tables.import_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(import_result.duplicate_rows)', - }, - java: { - method: 'cms().hubdb().tables().importDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportResult importResult = client.cms().hubdb().tables().importDraft("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.ImportDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\timportResult, err := client.Cms.Hubdb.Tables.ImportDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableImportDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", importResult.DuplicateRows)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.import_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nimport_result = hubspot.cms.hubdb.tables.import_draft("tableIdOrName")\n\nputs(import_result)', - }, - php: { - method: 'cms->hubdb->tables->importDraft', - example: - "cms->hubdb->tables->importDraft(\n 'tableIdOrName',\n config: 'config',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n);\n\nvar_dump($importResult);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/import \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/hubdb/2026-03/tables', - httpMethod: 'get', - summary: 'Get all published tables', - description: - 'Returns the details for the published version of each table defined in an account, including column definitions.', - stainlessPath: '(resource) cms.hubdb.tables > (method) list', - qualified: 'client.cms.hubdb.tables.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'contentType?: string;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'isGetLocalizedSchema?: boolean;', - 'limit?: number;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## list\n\n`client.cms.hubdb.tables.list(after?: string, archived?: boolean, contentType?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, isGetLocalizedSchema?: boolean, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables`\n\nReturns the details for the published version of each table defined in an account, including column definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `contentType?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `isGetLocalizedSchema?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.list()) {\n console.log(hubDBTableV3);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.list()) {\n console.log(hubDBTableV3.id);\n}", - }, - python: { - method: 'cms.hubdb.tables.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.hubdb.tables.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().hubdb().tables().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListPage;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableListPage page = client.cms().hubdb().tables().list();\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Hubdb.Tables.List(context.TODO(), cms.HubdbTableListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.hubdb.tables.list\n\nputs(page)', - }, - php: { - method: 'cms->hubdb->tables->list', - example: - "cms->hubdb->tables->list(\n after: 'after',\n archived: true,\n contentType: 'contentType',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isGetLocalizedSchema: true,\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_draft', - endpoint: '/cms/hubdb/2026-03/tables/draft', - httpMethod: 'get', - summary: 'Return all draft tables', - description: - 'Returns the details for each draft table defined in the specified account, including column definitions.', - stainlessPath: '(resource) cms.hubdb.tables > (method) list_draft', - qualified: 'client.cms.hubdb.tables.listDraft', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'contentType?: string;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'isGetLocalizedSchema?: boolean;', - 'limit?: number;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## list_draft\n\n`client.cms.hubdb.tables.listDraft(after?: string, archived?: boolean, contentType?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, isGetLocalizedSchema?: boolean, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**get** `/cms/hubdb/2026-03/tables/draft`\n\nReturns the details for each draft table defined in the specified account, including column definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `contentType?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `isGetLocalizedSchema?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.listDraft()) {\n console.log(hubDBTableV3);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.listDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const hubDBTableV3 of client.cms.hubdb.tables.listDraft()) {\n console.log(hubDBTableV3.id);\n}", - }, - python: { - method: 'cms.hubdb.tables.list_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.hubdb.tables.list_draft()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().hubdb().tables().listDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListDraftPage;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableListDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableListDraftPage page = client.cms().hubdb().tables().listDraft();\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.ListDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Hubdb.Tables.ListDraft(context.TODO(), cms.HubdbTableListDraftParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.list_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.hubdb.tables.list_draft\n\nputs(page)', - }, - php: { - method: 'cms->hubdb->tables->listDraft', - example: - "cms->hubdb->tables->listDraft(\n after: 'after',\n archived: true,\n contentType: 'contentType',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isGetLocalizedSchema: true,\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'publish_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish', - httpMethod: 'post', - summary: 'Publish a table from draft', - description: - 'Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.', - stainlessPath: '(resource) cms.hubdb.tables > (method) publish_draft', - qualified: 'client.cms.hubdb.tables.publishDraft', - params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## publish_draft\n\n`client.cms.hubdb.tables.publishDraft(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish`\n\nPublishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.publishDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.publishDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.publishDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.publish_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.publish_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().publishDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TablePublishDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().publishDraft("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.PublishDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.PublishDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTablePublishDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.publish_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.publish_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->publishDraft', - example: - "cms->hubdb->tables->publishDraft(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/publish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset', - httpMethod: 'post', - summary: 'Reset a table draft', - description: - 'Replaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.', - stainlessPath: '(resource) cms.hubdb.tables > (method) reset_draft', - qualified: 'client.cms.hubdb.tables.resetDraft', - params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## reset_draft\n\n`client.cms.hubdb.tables.resetDraft(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset`\n\nReplaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.resetDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.resetDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.resetDraft('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.reset_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.reset_draft(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().resetDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().resetDraft("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.ResetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.ResetDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableResetDraftParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.reset_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.reset_draft("tableIdOrName")\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->resetDraft', - example: - "cms->hubdb->tables->resetDraft(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'unpublish', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish', - httpMethod: 'post', - summary: 'Unpublish a table', - description: - 'Unpublishes the table, meaning any website pages using data from the table will not render any data.', - stainlessPath: '(resource) cms.hubdb.tables > (method) unpublish', - qualified: 'client.cms.hubdb.tables.unpublish', - params: ['tableIdOrName: string;', 'includeForeignIds?: boolean;'], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## unpublish\n\n`client.cms.hubdb.tables.unpublish(tableIdOrName: string, includeForeignIds?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**post** `/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish`\n\nUnpublishes the table, meaning any website pages using data from the table will not render any data.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `includeForeignIds?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.unpublish('tableIdOrName');\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.unpublish', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.unpublish('tableIdOrName');\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.unpublish', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.unpublish(\n table_id_or_name="tableIdOrName",\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().unpublish', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableUnpublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().unpublish("tableIdOrName");\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.Unpublish', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.Unpublish(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableUnpublishParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.unpublish', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.unpublish("tableIdOrName")\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->unpublish', - example: - "cms->hubdb->tables->unpublish(\n 'tableIdOrName', includeForeignIDs: true\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/unpublish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_draft', - endpoint: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', - httpMethod: 'patch', - summary: 'Update an existing table', - description: - 'Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the `/publish` endpoint to push all the changes to the published version. To restore a table, include the query parameter `archived=true` and `"archived": false` in the json body.\n**Note:** You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.', - stainlessPath: '(resource) cms.hubdb.tables > (method) update_draft', - qualified: 'client.cms.hubdb.tables.updateDraft', - params: [ - 'tableIdOrName: string;', - 'allowChildTables: boolean;', - 'allowPublicApiAccess: boolean;', - 'columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[];', - 'dynamicMetaTags: object;', - 'enableChildTablePages: boolean;', - 'label: string;', - 'name: string;', - 'useForPages: boolean;', - 'archived?: boolean;', - 'includeForeignIds?: boolean;', - 'isGetLocalizedSchema?: boolean;', - ], - response: - '{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }', - markdown: - "## update_draft\n\n`client.cms.hubdb.tables.updateDraft(tableIdOrName: string, allowChildTables: boolean, allowPublicApiAccess: boolean, columns: { id: number; label: string; name: string; options: hubdb_option[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[], dynamicMetaTags: object, enableChildTablePages: boolean, label: string, name: string, useForPages: boolean, archived?: boolean, includeForeignIds?: boolean, isGetLocalizedSchema?: boolean): { id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: column[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: simple_user; isOrderedManually?: boolean; updatedBy?: simple_user; }`\n\n**patch** `/cms/hubdb/2026-03/tables/{tableIdOrName}/draft`\n\nUpdate an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use the `/publish` endpoint to push all the changes to the published version. To restore a table, include the query parameter `archived=true` and `\"archived\": false` in the json body.\n**Note:** You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.\n\n### Parameters\n\n- `tableIdOrName: string`\n\n- `allowChildTables: boolean`\n Specifies whether child tables can be created\n\n- `allowPublicApiAccess: boolean`\n Specifies whether the table can be read by public without authorization\n\n- `columns: { id: number; label: string; name: string; options: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; type: string; foreignColumnId?: number; foreignTableId?: number; maxNumberOfCharacters?: number; maxNumberOfOptions?: number; }[]`\n List of columns in the table\n\n- `dynamicMetaTags: object`\n Specifies the key value pairs of the [metadata fields](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages) with the associated column IDs.\n\n- `enableChildTablePages: boolean`\n Specifies creation of multi-level dynamic pages using child tables\n\n- `label: string`\n Label of the table\n\n- `name: string`\n Name of the table\n\n- `useForPages: boolean`\n Specifies whether the table can be used for creation of dynamic pages\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeForeignIds?: boolean`\n\n- `isGetLocalizedSchema?: boolean`\n\n### Returns\n\n- `{ id: string; allowChildTables: boolean; allowPublicApiAccess: boolean; columnCount: number; columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: simple_user; createdByUserId?: number; foreignColumnId?: number; foreignIds?: foreign_id[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: hubdb_option[]; updatedAt?: string; updatedBy?: simple_user; updatedByUserId?: number; width?: number; }[]; createdAt: string; deleted: boolean; deletedAt: string; dynamicMetaTags: object; enableChildTablePages: boolean; label: string; name: string; published: boolean; publishedAt: string; rowCount: number; updatedAt: string; useForPages: boolean; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; isOrderedManually?: boolean; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; }`\n\n - `id: string`\n - `allowChildTables: boolean`\n - `allowPublicApiAccess: boolean`\n - `columnCount: number`\n - `columns: { id: string; deleted: boolean; description: string; label: string; name: string; type: string; createdAt?: string; createdBy?: { id: string; email: string; firstName: string; lastName: string; }; createdByUserId?: number; foreignColumnId?: number; foreignIds?: { id: string; name: string; type: string; }[]; foreignIdsById?: object; foreignIdsByName?: object; foreignTableId?: number; optionCount?: number; options?: { id: string; createdAt: string; label: string; name: string; order: number; type: string; updatedAt: string; createdBy?: simple_user; createdByUserId?: number; updatedBy?: simple_user; updatedByUserId?: number; }[]; updatedAt?: string; updatedBy?: { id: string; email: string; firstName: string; lastName: string; }; updatedByUserId?: number; width?: number; }[]`\n - `createdAt: string`\n - `deleted: boolean`\n - `deletedAt: string`\n - `dynamicMetaTags: object`\n - `enableChildTablePages: boolean`\n - `label: string`\n - `name: string`\n - `published: boolean`\n - `publishedAt: string`\n - `rowCount: number`\n - `updatedAt: string`\n - `useForPages: boolean`\n - `createdBy?: { id: string; email: string; firstName: string; lastName: string; }`\n - `isOrderedManually?: boolean`\n - `updatedBy?: { id: string; email: string; firstName: string; lastName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.updateDraft('tableIdOrName', {\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [{\n id: 0,\n label: 'label',\n name: 'name',\n options: [{\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n}],\n type: 'BOOLEAN',\n}],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3);\n```", - perLanguage: { - typescript: { - method: 'client.cms.hubdb.tables.updateDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst hubDBTableV3 = await client.cms.hubdb.tables.updateDraft('tableIdOrName', {\n allowChildTables: true,\n allowPublicApiAccess: true,\n columns: [\n {\n id: 0,\n label: 'label',\n name: 'name',\n options: [\n {\n id: 'id',\n createdAt: '2019-12-27T18:11:19.117Z',\n label: 'label',\n name: 'name',\n order: 0,\n type: 'type',\n updatedAt: '2019-12-27T18:11:19.117Z',\n },\n ],\n type: 'BOOLEAN',\n },\n ],\n dynamicMetaTags: { foo: 0 },\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n});\n\nconsole.log(hubDBTableV3.id);", - }, - python: { - method: 'cms.hubdb.tables.update_draft', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nhub_db_table_v3 = client.cms.hubdb.tables.update_draft(\n table_id_or_name="tableIdOrName",\n allow_child_tables=True,\n allow_public_api_access=True,\n columns=[{\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [{\n "id": "id",\n "created_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updated_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n "type": "BOOLEAN",\n }],\n dynamic_meta_tags={\n "foo": 0\n },\n enable_child_table_pages=True,\n label="label",\n name="name",\n use_for_pages=True,\n)\nprint(hub_db_table_v3.id)', - }, - java: { - method: 'cms().hubdb().tables().updateDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.hubdb.ColumnRequest;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3;\nimport com.hubspot.sdk.models.cms.hubdb.HubDbTableV3Request;\nimport com.hubspot.sdk.models.cms.hubdb.HubdbOption;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableUpdateDraftParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TableUpdateDraftParams params = TableUpdateDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .hubDbTableV3Request(HubDbTableV3Request.builder()\n .allowChildTables(true)\n .allowPublicApiAccess(true)\n .addColumn(ColumnRequest.builder()\n .id(0)\n .label("label")\n .name("name")\n .addOption(HubdbOption.builder()\n .id("id")\n .createdAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .label("label")\n .name("name")\n .order(0)\n .type("type")\n .updatedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .type(ColumnRequest.Type.BOOLEAN)\n .build())\n .dynamicMetaTags(HubDbTableV3Request.DynamicMetaTags.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .enableChildTablePages(true)\n .label("label")\n .name("name")\n .useForPages(true)\n .build())\n .build();\n HubDbTableV3 hubDbTableV3 = client.cms().hubdb().tables().updateDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Hubdb.Tables.UpdateDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\thubDBTableV3, err := client.Cms.Hubdb.Tables.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"tableIdOrName",\n\t\tcms.HubdbTableUpdateDraftParams{\n\t\t\tHubDBTableV3Request: cms.HubDBTableV3RequestParam{\n\t\t\t\tAllowChildTables: true,\n\t\t\t\tAllowPublicAPIAccess: true,\n\t\t\t\tColumns: []cms.ColumnRequestParam{{\n\t\t\t\t\tID: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tOptions: []cms.HubdbOptionParam{{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\tCreatedAt: time.Now(),\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOrder: 0,\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tUpdatedAt: time.Now(),\n\t\t\t\t\t}},\n\t\t\t\t\tType: cms.ColumnRequestTypeBoolean,\n\t\t\t\t}},\n\t\t\t\tDynamicMetaTags: map[string]int64{\n\t\t\t\t\t"foo": 0,\n\t\t\t\t},\n\t\t\t\tEnableChildTablePages: true,\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tUseForPages: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", hubDBTableV3.ID)\n}\n', - }, - ruby: { - method: 'cms.hubdb.tables.update_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nhub_db_table_v3 = hubspot.cms.hubdb.tables.update_draft(\n "tableIdOrName",\n allow_child_tables: true,\n allow_public_api_access: true,\n columns: [\n {\n id: 0,\n label: "label",\n name: "name",\n options: [\n {\n id: "id",\n createdAt: "2019-12-27T18:11:19.117Z",\n label: "label",\n name: "name",\n order: 0,\n type: "type",\n updatedAt: "2019-12-27T18:11:19.117Z"\n }\n ],\n type: :BOOLEAN\n }\n ],\n dynamic_meta_tags: {foo: 0},\n enable_child_table_pages: true,\n label: "label",\n name: "name",\n use_for_pages: true\n)\n\nputs(hub_db_table_v3)', - }, - php: { - method: 'cms->hubdb->tables->updateDraft', - example: - "cms->hubdb->tables->updateDraft(\n 'tableIdOrName',\n allowChildTables: true,\n allowPublicAPIAccess: true,\n columns: [\n [\n 'id' => 0,\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n [\n 'id' => 'id',\n 'createdAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'label' => 'label',\n 'name' => 'name',\n 'order' => 0,\n 'type' => 'type',\n 'updatedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'createdByUserID' => 0,\n 'updatedBy' => [\n 'id' => 'id',\n 'email' => 'email',\n 'firstName' => 'firstName',\n 'lastName' => 'lastName',\n ],\n 'updatedByUserID' => 0,\n ],\n ],\n 'type' => 'BOOLEAN',\n 'foreignColumnID' => 0,\n 'foreignTableID' => 0,\n 'maxNumberOfCharacters' => 0,\n 'maxNumberOfOptions' => 0,\n ],\n ],\n dynamicMetaTags: ['foo' => 0],\n enableChildTablePages: true,\n label: 'label',\n name: 'name',\n useForPages: true,\n archived: true,\n includeForeignIDs: true,\n isGetLocalizedSchema: true,\n);\n\nvar_dump($hubDBTableV3);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/hubdb/2026-03/tables/$TABLE_ID_OR_NAME/draft \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowChildTables": true,\n "allowPublicApiAccess": true,\n "columns": [\n {\n "id": 0,\n "label": "label",\n "name": "name",\n "options": [\n {\n "id": "id",\n "createdAt": "2019-12-27T18:11:19.117Z",\n "label": "label",\n "name": "name",\n "order": 0,\n "type": "type",\n "updatedAt": "2019-12-27T18:11:19.117Z"\n }\n ],\n "type": "BOOLEAN"\n }\n ],\n "dynamicMetaTags": {\n "foo": 0\n },\n "enableChildTablePages": true,\n "label": "label",\n "name": "name",\n "useForPages": true\n }\'', - }, - }, - }, - { - name: 'create_association', - endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations', - httpMethod: 'post', - summary: 'Create association definition', - description: 'Create a new association definition for the specified object type.', - stainlessPath: '(resource) cms.media_bridge > (method) create_association', - qualified: 'client.cms.mediaBridge.createAssociation', - params: [ - 'appId: number;', - 'objectType: string;', - 'fromObjectTypeId: string;', - 'toObjectTypeId: string;', - 'name?: string;', - ], - response: - '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', - markdown: - "## create_association\n\n`client.cms.mediaBridge.createAssociation(appId: number, objectType: string, fromObjectTypeId: string, toObjectTypeId: string, name?: string): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/schemas/{objectType}/associations`\n\nCreate a new association definition for the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.cms.mediaBridge.createAssociation('objectType', {\n appId: 0,\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createAssociation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.cms.mediaBridge.createAssociation('objectType', {\n appId: 0,\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition.id);", - }, - python: { - method: 'cms.media_bridge.create_association', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.cms.media_bridge.create_association(\n object_type="objectType",\n app_id=0,\n from_object_type_id="fromObjectTypeId",\n to_object_type_id="toObjectTypeId",\n)\nprint(association_definition.id)', - }, - java: { - method: 'cms().mediaBridge().createAssociation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.AssociationDefinitionEgg;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateAssociationParams params = MediaBridgeCreateAssociationParams.builder()\n .appId(0)\n .objectType("objectType")\n .associationDefinitionEgg(AssociationDefinitionEgg.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build())\n .build();\n AssociationDefinition associationDefinition = client.cms().mediaBridge().createAssociation(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewAssociation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Cms.MediaBridge.NewAssociation(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewAssociationParams{\n\t\t\tAppID: 0,\n\t\t\tAssociationDefinitionEgg: shared.AssociationDefinitionEggParam{\n\t\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t\t\tToObjectTypeID: "toObjectTypeId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_association', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.cms.media_bridge.create_association(\n "objectType",\n app_id: 0,\n from_object_type_id: "fromObjectTypeId",\n to_object_type_id: "toObjectTypeId"\n)\n\nputs(association_definition)', - }, - php: { - method: 'cms->mediaBridge->createAssociation', - example: - "cms->mediaBridge->createAssociation(\n 'objectType',\n appID: 0,\n fromObjectTypeID: 'fromObjectTypeId',\n toObjectTypeID: 'toObjectTypeId',\n name: 'name',\n);\n\nvar_dump($associationDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE/associations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromObjectTypeId": "fromObjectTypeId",\n "toObjectTypeId": "toObjectTypeId"\n }\'', - }, - }, - }, - { - name: 'create_attention_span_event', - endpoint: '/media-bridge/2026-03/events/attention-span', - httpMethod: 'post', - summary: 'Create an attention span event', - description: 'Create an event containing the viewers attention span details for the media.', - stainlessPath: '(resource) cms.media_bridge > (method) create_attention_span_event', - qualified: 'client.cms.mediaBridge.createAttentionSpanEvent', - params: [ - "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", - 'occurredTimestamp: number;', - 'rawDataMap: object;', - 'sessionId: string;', - '_hsenc?: string;', - 'contactId?: number;', - 'contactUtk?: string;', - 'derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; };', - 'externalId?: string;', - "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", - 'mediaBridgeId?: number;', - 'mediaName?: string;', - 'mediaUrl?: string;', - 'pageId?: number;', - 'pageName?: string;', - 'pageUrl?: string;', - 'rawDataString?: string;', - ], - response: - "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }", - markdown: - "## create_attention_span_event\n\n`client.cms.mediaBridge.createAttentionSpanEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, rawDataMap: object, sessionId: string, _hsenc?: string, contactId?: number, contactUtk?: string, derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; }, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string, rawDataString?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }`\n\n**post** `/media-bridge/2026-03/events/attention-span`\n\nCreate an event containing the viewers attention span details for the media.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `rawDataMap: object`\n\n- `sessionId: string`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `derivedValues?: { totalPercentPlayed: number; totalSecondsPlayed: number; }`\n - `totalPercentPlayed: number`\n - `totalSecondsPlayed: number`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n- `rawDataString?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; percentRange: string; portalId: number; providerId: number; sessionId: string; totalPercentPlayed: number; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; rawData?: string; totalSecondsPlayed?: number; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `percentRange: string`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `totalPercentPlayed: number`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n - `rawData?: string`\n - `totalSecondsPlayed?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attentionSpanEvent = await client.cms.mediaBridge.createAttentionSpanEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: { foo: 0 },\n sessionId: 'sessionId',\n});\n\nconsole.log(attentionSpanEvent);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createAttentionSpanEvent', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attentionSpanEvent = await client.cms.mediaBridge.createAttentionSpanEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: { foo: 0 },\n sessionId: 'sessionId',\n});\n\nconsole.log(attentionSpanEvent.mediaBridgeId);", - }, - python: { - method: 'cms.media_bridge.create_attention_span_event', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattention_span_event = client.cms.media_bridge.create_attention_span_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n raw_data_map={\n "foo": 0\n },\n session_id="sessionId",\n)\nprint(attention_span_event.media_bridge_id)', - }, - java: { - method: 'cms().mediaBridge().createAttentionSpanEvent', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.mediabridge.AttentionSpanEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.AttentionSpanEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttentionSpanEventRequest params = AttentionSpanEventRequest.builder()\n .mediaType(AttentionSpanEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .rawDataMap(AttentionSpanEventRequest.RawDataMap.builder()\n .putAdditionalProperty("foo", JsonValue.from(0))\n .build())\n .sessionId("sessionId")\n .build();\n AttentionSpanEvent attentionSpanEvent = client.cms().mediaBridge().createAttentionSpanEvent(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewAttentionSpanEvent', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattentionSpanEvent, err := client.Cms.MediaBridge.NewAttentionSpanEvent(context.TODO(), cms.MediaBridgeNewAttentionSpanEventParams{\n\t\tAttentionSpanEventRequest: cms.AttentionSpanEventRequestParam{\n\t\t\tMediaType: cms.AttentionSpanEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tRawDataMap: map[string]int64{\n\t\t\t\t"foo": 0,\n\t\t\t},\n\t\t\tSessionID: "sessionId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attentionSpanEvent.MediaBridgeID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_attention_span_event', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattention_span_event = hubspot.cms.media_bridge.create_attention_span_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n raw_data_map: {foo: 0},\n session_id: "sessionId"\n)\n\nputs(attention_span_event)', - }, - php: { - method: 'cms->mediaBridge->createAttentionSpanEvent', - example: - "cms->mediaBridge->createAttentionSpanEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n rawDataMap: ['foo' => 0],\n sessionID: 'sessionId',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n derivedValues: ['totalPercentPlayed' => 0, 'totalSecondsPlayed' => 0],\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n rawDataString: 'rawDataString',\n);\n\nvar_dump($attentionSpanEvent);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/events/attention-span \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "rawDataMap": {\n "foo": 0\n },\n "sessionId": "sessionId"\n }\'', - }, - }, - }, - { - name: 'create_media_played_event', - endpoint: '/media-bridge/2026-03/events/media-played', - httpMethod: 'post', - summary: 'Create a played event', - description: 'Create an event for when a user begins playing a piece of media.', - stainlessPath: '(resource) cms.media_bridge > (method) create_media_played_event', - qualified: 'client.cms.mediaBridge.createMediaPlayedEvent', - params: [ - "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", - 'occurredTimestamp: number;', - 'sessionId: string;', - "state: 'STARTED' | 'VIEWED';", - '_hsenc?: string;', - 'contactId?: number;', - 'contactUtk?: string;', - 'externalId?: string;', - "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", - 'iframeUrl?: string;', - 'mediaBridgeId?: number;', - 'mediaName?: string;', - 'mediaUrl?: string;', - 'pageId?: number;', - 'pageName?: string;', - 'pageUrl?: string;', - ], - response: - "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }", - markdown: - "## create_media_played_event\n\n`client.cms.mediaBridge.createMediaPlayedEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, sessionId: string, state: 'STARTED' | 'VIEWED', _hsenc?: string, contactId?: number, contactUtk?: string, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', iframeUrl?: string, mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n**post** `/media-bridge/2026-03/events/media-played`\n\nCreate an event for when a user begins playing a piece of media.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `sessionId: string`\n\n- `state: 'STARTED' | 'VIEWED'`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `iframeUrl?: string`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; portalId: number; providerId: number; sessionId: string; state: 'STARTED' | 'VIEWED'; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; iframeUrl?: string; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `state: 'STARTED' | 'VIEWED'`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `iframeUrl?: string`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaPlayedEvent = await client.cms.mediaBridge.createMediaPlayedEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionId: 'sessionId',\n state: 'STARTED',\n});\n\nconsole.log(mediaPlayedEvent);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createMediaPlayedEvent', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaPlayedEvent = await client.cms.mediaBridge.createMediaPlayedEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionId: 'sessionId',\n state: 'STARTED',\n});\n\nconsole.log(mediaPlayedEvent.mediaBridgeId);", - }, - python: { - method: 'cms.media_bridge.create_media_played_event', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_played_event = client.cms.media_bridge.create_media_played_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n session_id="sessionId",\n state="STARTED",\n)\nprint(media_played_event.media_bridge_id)', - }, - java: { - method: 'cms().mediaBridge().createMediaPlayedEvent', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaPlayedEventRequest params = MediaPlayedEventRequest.builder()\n .mediaType(MediaPlayedEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .sessionId("sessionId")\n .state(MediaPlayedEventRequest.State.STARTED)\n .build();\n MediaPlayedEvent mediaPlayedEvent = client.cms().mediaBridge().createMediaPlayedEvent(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewMediaPlayedEvent', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaPlayedEvent, err := client.Cms.MediaBridge.NewMediaPlayedEvent(context.TODO(), cms.MediaBridgeNewMediaPlayedEventParams{\n\t\tMediaPlayedEventRequest: cms.MediaPlayedEventRequestParam{\n\t\t\tMediaType: cms.MediaPlayedEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tSessionID: "sessionId",\n\t\t\tState: cms.MediaPlayedEventRequestStateStarted,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaPlayedEvent.MediaBridgeID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_media_played_event', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_played_event = hubspot.cms.media_bridge.create_media_played_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n session_id: "sessionId",\n state: :STARTED\n)\n\nputs(media_played_event)', - }, - php: { - method: 'cms->mediaBridge->createMediaPlayedEvent', - example: - "cms->mediaBridge->createMediaPlayedEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n sessionID: 'sessionId',\n state: 'STARTED',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n iframeURL: 'iframeUrl',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n);\n\nvar_dump($mediaPlayedEvent);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/events/media-played \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "sessionId": "sessionId",\n "state": "STARTED"\n }\'', - }, - }, - }, - { - name: 'create_media_played_percent_event', - endpoint: '/media-bridge/2026-03/events/media-played-percent', - httpMethod: 'post', - summary: 'Create a quartile event', - description: - "Create an event representing a user reaching quarterly milestones in a piece of media they're viewing.", - stainlessPath: '(resource) cms.media_bridge > (method) create_media_played_percent_event', - qualified: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', - params: [ - "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", - 'occurredTimestamp: number;', - 'playedPercent: number;', - 'sessionId: string;', - '_hsenc?: string;', - 'contactId?: number;', - 'contactUtk?: string;', - 'externalId?: string;', - "externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE';", - 'mediaBridgeId?: number;', - 'mediaName?: string;', - 'mediaUrl?: string;', - 'pageId?: number;', - 'pageName?: string;', - 'pageUrl?: string;', - ], - response: - "{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }", - markdown: - "## create_media_played_percent_event\n\n`client.cms.mediaBridge.createMediaPlayedPercentEvent(mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', occurredTimestamp: number, playedPercent: number, sessionId: string, _hsenc?: string, contactId?: number, contactUtk?: string, externalId?: string, externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE', mediaBridgeId?: number, mediaName?: string, mediaUrl?: string, pageId?: number, pageName?: string, pageUrl?: string): { contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n**post** `/media-bridge/2026-03/events/media-played-percent`\n\nCreate an event representing a user reaching quarterly milestones in a piece of media they're viewing.\n\n### Parameters\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `occurredTimestamp: number`\n\n- `playedPercent: number`\n\n- `sessionId: string`\n\n- `_hsenc?: string`\n\n- `contactId?: number`\n\n- `contactUtk?: string`\n\n- `externalId?: string`\n\n- `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n\n- `mediaBridgeId?: number`\n\n- `mediaName?: string`\n\n- `mediaUrl?: string`\n\n- `pageId?: number`\n\n- `pageName?: string`\n\n- `pageUrl?: string`\n\n### Returns\n\n- `{ contactId: number; mediaBridgeId: number; mediaBridgeObjectCoordinates: string; mediaBridgeObjectTypeId: string; mediaName: string; mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'; occurredTimestamp: number; playedPercent: number; portalId: number; providerId: number; sessionId: string; externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'; mediaUrl?: string; pageId?: number; pageName?: string; pageObjectCoordinates?: string; pageUrl?: string; }`\n\n - `contactId: number`\n - `mediaBridgeId: number`\n - `mediaBridgeObjectCoordinates: string`\n - `mediaBridgeObjectTypeId: string`\n - `mediaName: string`\n - `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n - `occurredTimestamp: number`\n - `playedPercent: number`\n - `portalId: number`\n - `providerId: number`\n - `sessionId: string`\n - `externalPlayContext?: 'EMAIL' | 'EXTERNAL_PAGE'`\n - `mediaUrl?: string`\n - `pageId?: number`\n - `pageName?: string`\n - `pageObjectCoordinates?: string`\n - `pageUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaPlayedPercentageEvent = await client.cms.mediaBridge.createMediaPlayedPercentEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionId: 'sessionId',\n});\n\nconsole.log(mediaPlayedPercentageEvent);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaPlayedPercentageEvent = await client.cms.mediaBridge.createMediaPlayedPercentEvent({\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionId: 'sessionId',\n});\n\nconsole.log(mediaPlayedPercentageEvent.mediaBridgeId);", - }, - python: { - method: 'cms.media_bridge.create_media_played_percent_event', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_played_percentage_event = client.cms.media_bridge.create_media_played_percent_event(\n media_type="AUDIO",\n occurred_timestamp=0,\n played_percent=0,\n session_id="sessionId",\n)\nprint(media_played_percentage_event.media_bridge_id)', - }, - java: { - method: 'cms().mediaBridge().createMediaPlayedPercentEvent', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedPercentageEvent;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaPlayedPercentageEventRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaPlayedPercentageEventRequest params = MediaPlayedPercentageEventRequest.builder()\n .mediaType(MediaPlayedPercentageEventRequest.MediaType.AUDIO)\n .occurredTimestamp(0L)\n .playedPercent(0)\n .sessionId("sessionId")\n .build();\n MediaPlayedPercentageEvent mediaPlayedPercentageEvent = client.cms().mediaBridge().createMediaPlayedPercentEvent(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewMediaPlayedPercentEvent', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaPlayedPercentageEvent, err := client.Cms.MediaBridge.NewMediaPlayedPercentEvent(context.TODO(), cms.MediaBridgeNewMediaPlayedPercentEventParams{\n\t\tMediaPlayedPercentageEventRequest: cms.MediaPlayedPercentageEventRequestParam{\n\t\t\tMediaType: cms.MediaPlayedPercentageEventRequestMediaTypeAudio,\n\t\t\tOccurredTimestamp: 0,\n\t\t\tPlayedPercent: 0,\n\t\t\tSessionID: "sessionId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaPlayedPercentageEvent.MediaBridgeID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_media_played_percent_event', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_played_percentage_event = hubspot.cms.media_bridge.create_media_played_percent_event(\n media_type: :AUDIO,\n occurred_timestamp: 0,\n played_percent: 0,\n session_id: "sessionId"\n)\n\nputs(media_played_percentage_event)', - }, - php: { - method: 'cms->mediaBridge->createMediaPlayedPercentEvent', - example: - "cms\n ->mediaBridge\n ->createMediaPlayedPercentEvent(\n mediaType: 'AUDIO',\n occurredTimestamp: 0,\n playedPercent: 0,\n sessionID: 'sessionId',\n _hsenc: '_hsenc',\n contactID: 0,\n contactUtk: 'contactUtk',\n externalID: 'externalId',\n externalPlayContext: 'EMAIL',\n mediaBridgeID: 0,\n mediaName: 'mediaName',\n mediaURL: 'mediaUrl',\n pageID: 0,\n pageName: 'pageName',\n pageURL: 'pageUrl',\n);\n\nvar_dump($mediaPlayedPercentageEvent);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/events/media-played-percent \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaType": "AUDIO",\n "occurredTimestamp": 0,\n "playedPercent": 0,\n "sessionId": "sessionId"\n }\'', - }, - }, - }, - { - name: 'create_object_type', - endpoint: '/media-bridge/2026-03/{appId}/settings/object-definitions', - httpMethod: 'post', - summary: 'Create a new object type', - description: 'Create a new media object type', - stainlessPath: '(resource) cms.media_bridge > (method) create_object_type', - qualified: 'client.cms.mediaBridge.createObjectType', - params: ['appId: number;', "mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[];"], - response: '{ createdObjects: object; }', - markdown: - "## create_object_type\n\n`client.cms.mediaBridge.createObjectType(appId: number, mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[]): { createdObjects: object; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/object-definitions`\n\nCreate a new media object type\n\n### Parameters\n\n- `appId: number`\n\n- `mediaTypes: 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'OTHER' | 'IMAGE'[]`\n\n### Returns\n\n- `{ createdObjects: object; }`\n\n - `createdObjects: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst bulkIntegratorObjectCreationResponse = await client.cms.mediaBridge.createObjectType(0, { mediaTypes: ['VIDEO'] });\n\nconsole.log(bulkIntegratorObjectCreationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createObjectType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst bulkIntegratorObjectCreationResponse = await client.cms.mediaBridge.createObjectType(0, {\n mediaTypes: ['VIDEO'],\n});\n\nconsole.log(bulkIntegratorObjectCreationResponse.createdObjects);", - }, - python: { - method: 'cms.media_bridge.create_object_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbulk_integrator_object_creation_response = client.cms.media_bridge.create_object_type(\n app_id=0,\n media_types=["VIDEO"],\n)\nprint(bulk_integrator_object_creation_response.created_objects)', - }, - java: { - method: 'cms().mediaBridge().createObjectType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.BulkIntegratorObjectCreationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorObjectCreationRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateObjectTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateObjectTypeParams params = MediaBridgeCreateObjectTypeParams.builder()\n .appId(0)\n .integratorObjectCreationRequest(IntegratorObjectCreationRequest.builder()\n .addMediaType(IntegratorObjectCreationRequest.MediaType.VIDEO)\n .build())\n .build();\n BulkIntegratorObjectCreationResponse bulkIntegratorObjectCreationResponse = client.cms().mediaBridge().createObjectType(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewObjectType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbulkIntegratorObjectCreationResponse, err := client.Cms.MediaBridge.NewObjectType(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeNewObjectTypeParams{\n\t\t\tIntegratorObjectCreationRequest: cms.IntegratorObjectCreationRequestParam{\n\t\t\t\tMediaTypes: []string{"VIDEO"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", bulkIntegratorObjectCreationResponse.CreatedObjects)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_object_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbulk_integrator_object_creation_response = hubspot.cms.media_bridge.create_object_type(0, media_types: [:VIDEO])\n\nputs(bulk_integrator_object_creation_response)', - }, - php: { - method: 'cms->mediaBridge->createObjectType', - example: - "cms\n ->mediaBridge\n ->createObjectType(0, mediaTypes: ['VIDEO']);\n\nvar_dump($bulkIntegratorObjectCreationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/object-definitions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "mediaTypes": [\n "VIDEO"\n ]\n }\'', - }, - }, - }, - { - name: 'create_oembed_domain', - endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - httpMethod: 'post', - summary: 'Set up a new oEmbed domain', - description: 'Set up a new oEmbed domain for your media bridge app.', - stainlessPath: '(resource) cms.media_bridge > (method) create_oembed_domain', - qualified: 'client.cms.mediaBridge.createOembedDomain', - params: [ - 'appId: number;', - 'endpoints: { discovery: boolean; schemes: string[]; url: string; };', - 'portalId?: number;', - ], - response: - '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', - markdown: - "## create_oembed_domain\n\n`client.cms.mediaBridge.createOembedDomain(appId: number, endpoints: { discovery: boolean; schemes: string[]; url: string; }, portalId?: number): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nSet up a new oEmbed domain for your media bridge app.\n\n### Parameters\n\n- `appId: number`\n\n- `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `discovery: boolean`\n - `schemes: string[]`\n - `url: string`\n\n- `portalId?: number`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.createOembedDomain(0, { endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n} });\n\nconsole.log(integratorOEmbedDomainModel);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createOembedDomain', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.createOembedDomain(0, {\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n },\n});\n\nconsole.log(integratorOEmbedDomainModel.id);", - }, - python: { - method: 'cms.media_bridge.create_oembed_domain', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.create_oembed_domain(\n app_id=0,\n endpoints={\n "discovery": True,\n "schemes": ["string"],\n "url": "url",\n },\n)\nprint(integrator_o_embed_domain_model.id)', - }, - java: { - method: 'cms().mediaBridge().createOembedDomain', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.Endpoints;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreateOembedDomainParams params = MediaBridgeCreateOembedDomainParams.builder()\n .appId(0)\n .integratorOEmbedDomainRequest(IntegratorOEmbedDomainRequest.builder()\n .endpoints(Endpoints.builder()\n .discovery(true)\n .addScheme("string")\n .url("url")\n .build())\n .build())\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().createOembedDomain(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewOembedDomain', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.NewOembedDomain(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeNewOembedDomainParams{\n\t\t\tIntegratorOEmbedDomainRequest: cms.IntegratorOEmbedDomainRequestParam{\n\t\t\t\tEndpoints: cms.EndpointsParam{\n\t\t\t\t\tDiscovery: true,\n\t\t\t\t\tSchemes: []string{"string"},\n\t\t\t\t\tURL: "url",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_oembed_domain', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.create_oembed_domain(\n 0,\n endpoints: {discovery: true, schemes: ["string"], url: "url"}\n)\n\nputs(integrator_o_embed_domain_model)', - }, - php: { - method: 'cms->mediaBridge->createOembedDomain', - example: - "cms->mediaBridge->createOembedDomain(\n 0,\n endpoints: ['discovery' => true, 'schemes' => ['string'], 'url' => 'url'],\n portalID: 0,\n);\n\nvar_dump($integratorOEmbedDomainModel);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endpoints": {\n "discovery": true,\n "schemes": [\n "string"\n ],\n "url": "url"\n }\n }\'', - }, - }, - }, - { - name: 'create_property', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}', - httpMethod: 'post', - summary: 'Create a new property', - description: 'Create a new property for the specified media type', - stainlessPath: '(resource) cms.media_bridge > (method) create_property', - qualified: 'client.cms.mediaBridge.createProperty', - params: [ - 'appId: number;', - 'objectType: string;', - 'fieldType: string;', - 'groupName: string;', - 'label: string;', - 'name: string;', - "type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", - 'calculationFormula?: string;', - 'currencyPropertyName?: string;', - "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'description?: string;', - 'displayOrder?: number;', - 'externalOptions?: boolean;', - 'formField?: boolean;', - 'hasUniqueValue?: boolean;', - 'hidden?: boolean;', - "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - 'referencedObjectType?: string;', - 'showCurrencySymbol?: boolean;', - ], - response: 'object', - markdown: - "## create_property\n\n`client.cms.mediaBridge.createProperty(appId: number, objectType: string, fieldType: string, groupName: string, label: string, name: string, type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string', calculationFormula?: string, currencyPropertyName?: string, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', description?: string, displayOrder?: number, externalOptions?: boolean, formField?: boolean, hasUniqueValue?: boolean, hidden?: boolean, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], referencedObjectType?: string, showCurrencySymbol?: boolean): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}`\n\nCreate a new property for the specified media type\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `fieldType: string`\n\n- `groupName: string`\n\n- `label: string`\n\n- `name: string`\n\n- `type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `externalOptions?: boolean`\n\n- `formField?: boolean`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `referencedObjectType?: string`\n\n- `showCurrencySymbol?: boolean`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.createProperty('objectType', {\n appId: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(mediaBridgeProperty);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.createProperty('objectType', {\n appId: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", - }, - python: { - method: 'cms.media_bridge.create_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.create_property(\n object_type="objectType",\n app_id=0,\n field_type="booleancheckbox",\n group_name="groupName",\n label="label",\n name="name",\n type="bool",\n)\nprint(media_bridge_property.hidden)', - }, - java: { - method: 'cms().mediaBridge().createProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreatePropertyParams;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreatePropertyParams params = MediaBridgeCreatePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyCreate(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().createProperty(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewProperty', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.NewProperty(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewPropertyParams{\n\t\t\tAppID: 0,\n\t\t\tPropertyCreate: shared.PropertyCreateParam{\n\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\tGroupName: "groupName",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.create_property(\n "objectType",\n app_id: 0,\n field_type: :booleancheckbox,\n group_name: "groupName",\n label: "label",\n name: "name",\n type: :bool\n)\n\nputs(media_bridge_property)', - }, - php: { - method: 'cms->mediaBridge->createProperty', - example: - "cms->mediaBridge->createProperty(\n 'objectType',\n appID: 0,\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n dataSensitivity: 'highly_sensitive',\n description: 'description',\n displayOrder: 0,\n externalOptions: true,\n formField: true,\n hasUniqueValue: true,\n hidden: true,\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n referencedObjectType: 'referencedObjectType',\n showCurrencySymbol: true,\n);\n\nvar_dump($mediaBridgeProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\'', - }, - }, - }, - { - name: 'create_property_group', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', - httpMethod: 'post', - summary: 'Create a new property group', - description: 'Create a new property group for the specified object type.', - stainlessPath: '(resource) cms.media_bridge > (method) create_property_group', - qualified: 'client.cms.mediaBridge.createPropertyGroup', - params: [ - 'appId: number;', - 'objectType: string;', - 'label: string;', - 'name: string;', - 'displayOrder?: number;', - ], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## create_property_group\n\n`client.cms.mediaBridge.createPropertyGroup(appId: number, objectType: string, label: string, name: string, displayOrder?: number): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups`\n\nCreate a new property group for the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `label: string`\n\n- `name: string`\n\n- `displayOrder?: number`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.createPropertyGroup('objectType', {\n appId: 0,\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createPropertyGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.createPropertyGroup('objectType', {\n appId: 0,\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'cms.media_bridge.create_property_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.create_property_group(\n object_type="objectType",\n app_id=0,\n label="label",\n name="name",\n)\nprint(property_group.archived)', - }, - java: { - method: 'cms().mediaBridge().createPropertyGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreatePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeCreatePropertyGroupParams params = MediaBridgeCreatePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyGroupCreate(PropertyGroupCreate.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().createPropertyGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewPropertyGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.NewPropertyGroup(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeNewPropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tPropertyGroupCreate: shared.PropertyGroupCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_property_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.create_property_group("objectType", app_id: 0, label: "label", name: "name")\n\nputs(property_group)', - }, - php: { - method: 'cms->mediaBridge->createPropertyGroup', - example: - "cms->mediaBridge->createPropertyGroup(\n 'objectType', appID: 0, label: 'label', name: 'name', displayOrder: 0\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'create_video_association_definition', - endpoint: '/media-bridge/2026-03/{appId}/settings/video-association-definition', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) cms.media_bridge > (method) create_video_association_definition', - qualified: 'client.cms.mediaBridge.createVideoAssociationDefinition', - params: ['appId: number;'], - response: - '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', - markdown: - "## create_video_association_definition\n\n`client.cms.mediaBridge.createVideoAssociationDefinition(appId: number): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/video-association-definition`\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.cms.mediaBridge.createVideoAssociationDefinition(0);\n\nconsole.log(associationDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.createVideoAssociationDefinition', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.cms.mediaBridge.createVideoAssociationDefinition(0);\n\nconsole.log(associationDefinition.id);", - }, - python: { - method: 'cms.media_bridge.create_video_association_definition', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.cms.media_bridge.create_video_association_definition(\n 0,\n)\nprint(association_definition.id)', - }, - java: { - method: 'cms().mediaBridge().createVideoAssociationDefinition', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeCreateVideoAssociationDefinitionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationDefinition associationDefinition = client.cms().mediaBridge().createVideoAssociationDefinition(0);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.NewVideoAssociationDefinition', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Cms.MediaBridge.NewVideoAssociationDefinition(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.create_video_association_definition', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.cms.media_bridge.create_video_association_definition(0)\n\nputs(association_definition)', - }, - php: { - method: 'cms->mediaBridge->createVideoAssociationDefinition', - example: - "cms\n ->mediaBridge\n ->createVideoAssociationDefinition(0);\n\nvar_dump($associationDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/video-association-definition \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_association', - endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}', - httpMethod: 'delete', - summary: 'Delete an association definition', - description: 'Delete an existing association definition for an object type.', - stainlessPath: '(resource) cms.media_bridge > (method) delete_association', - qualified: 'client.cms.mediaBridge.deleteAssociation', - params: ['appId: number;', 'objectType: string;', 'associationId: string;'], - markdown: - "## delete_association\n\n`client.cms.mediaBridge.deleteAssociation(appId: number, objectType: string, associationId: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}`\n\nDelete an existing association definition for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `associationId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteAssociation('associationId', { appId: 0, objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.deleteAssociation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteAssociation('associationId', {\n appId: 0,\n objectType: 'objectType',\n});", - }, - python: { - method: 'cms.media_bridge.delete_association', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_association(\n association_id="associationId",\n app_id=0,\n object_type="objectType",\n)', - }, - java: { - method: 'cms().mediaBridge().deleteAssociation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeleteAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeleteAssociationParams params = MediaBridgeDeleteAssociationParams.builder()\n .appId(0)\n .objectType("objectType")\n .associationId("associationId")\n .build();\n client.cms().mediaBridge().deleteAssociation(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.DeleteAssociation', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteAssociation(\n\t\tcontext.TODO(),\n\t\t"associationId",\n\t\tcms.MediaBridgeDeleteAssociationParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.media_bridge.delete_association', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_association("associationId", app_id: 0, object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'cms->mediaBridge->deleteAssociation', - example: - "cms->mediaBridge->deleteAssociation(\n 'associationId', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE/associations/$ASSOCIATION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_oembed_domain', - endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - httpMethod: 'delete', - summary: 'Delete an oEmbed domain', - description: 'Delete an existing oEmbed domain.', - stainlessPath: '(resource) cms.media_bridge > (method) delete_oembed_domain', - qualified: 'client.cms.mediaBridge.deleteOembedDomain', - params: ['appId: number;', 'id?: number;', 'domainPortalId?: number;'], - markdown: - "## delete_oembed_domain\n\n`client.cms.mediaBridge.deleteOembedDomain(appId: number, id?: number, domainPortalId?: number): void`\n\n**delete** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nDelete an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `id?: number`\n\n- `domainPortalId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteOembedDomain(0)\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.deleteOembedDomain', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteOembedDomain(0);", - }, - python: { - method: 'cms.media_bridge.delete_oembed_domain', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_oembed_domain(\n app_id=0,\n)', - }, - java: { - method: 'cms().mediaBridge().deleteOembedDomain', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeleteOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().mediaBridge().deleteOembedDomain(0);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.DeleteOembedDomain', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteOembedDomain(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeDeleteOembedDomainParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.media_bridge.delete_oembed_domain', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_oembed_domain(0)\n\nputs(result)', - }, - php: { - method: 'cms->mediaBridge->deleteOembedDomain', - example: - "cms->mediaBridge->deleteOembedDomain(\n 0, id: 0, domainPortalID: 0\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_property', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - httpMethod: 'delete', - summary: 'Delete a property', - description: 'Delete an existing property for an object type.', - stainlessPath: '(resource) cms.media_bridge > (method) delete_property', - qualified: 'client.cms.mediaBridge.deleteProperty', - params: ['appId: number;', 'objectType: string;', 'propertyName: string;'], - markdown: - "## delete_property\n\n`client.cms.mediaBridge.deleteProperty(appId: number, objectType: string, propertyName: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nDelete an existing property for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deleteProperty('propertyName', { appId: 0, objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.deleteProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deleteProperty('propertyName', { appId: 0, objectType: 'objectType' });", - }, - python: { - method: 'cms.media_bridge.delete_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)', - }, - java: { - method: 'cms().mediaBridge().deleteProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeletePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeletePropertyParams params = MediaBridgeDeletePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n client.cms().mediaBridge().deleteProperty(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.DeleteProperty', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeleteProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeDeletePropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.media_bridge.delete_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'cms->mediaBridge->deleteProperty', - example: - "cms->mediaBridge->deleteProperty(\n 'propertyName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_property_group', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - httpMethod: 'delete', - summary: 'Delete a property group', - description: 'Delete an existing property group by name', - stainlessPath: '(resource) cms.media_bridge > (method) delete_property_group', - qualified: 'client.cms.mediaBridge.deletePropertyGroup', - params: ['appId: number;', 'objectType: string;', 'groupName: string;'], - markdown: - "## delete_property_group\n\n`client.cms.mediaBridge.deletePropertyGroup(appId: number, objectType: string, groupName: string): void`\n\n**delete** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nDelete an existing property group by name\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.deletePropertyGroup('groupName', { appId: 0, objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.deletePropertyGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.deletePropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});", - }, - python: { - method: 'cms.media_bridge.delete_property_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.delete_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)', - }, - java: { - method: 'cms().mediaBridge().deletePropertyGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeDeletePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeDeletePropertyGroupParams params = MediaBridgeDeletePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .build();\n client.cms().mediaBridge().deletePropertyGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.DeletePropertyGroup', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.DeletePropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeDeletePropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.media_bridge.delete_property_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.delete_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'cms->mediaBridge->deletePropertyGroup', - example: - "cms->mediaBridge->deletePropertyGroup(\n 'groupName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_event_visibility_settings', - endpoint: '/media-bridge/2026-03/{appId}/settings/event-visibility', - httpMethod: 'get', - summary: 'View event visibility settings', - description: 'Get the visibility settings for media bridge events for your apps.', - stainlessPath: '(resource) cms.media_bridge > (method) get_event_visibility_settings', - qualified: 'client.cms.mediaBridge.getEventVisibilitySettings', - params: ['appId: number;'], - response: - "{ createdAt: string; visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]; }", - markdown: - "## get_event_visibility_settings\n\n`client.cms.mediaBridge.getEventVisibilitySettings(appId: number): { createdAt: string; visibilitySettings: event_visibility_change[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/event-visibility`\n\nGet the visibility settings for media bridge events for your apps.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]; }`\n\n - `createdAt: string`\n - `visibilitySettings: { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventVisibilityResponse = await client.cms.mediaBridge.getEventVisibilitySettings(0);\n\nconsole.log(eventVisibilityResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.getEventVisibilitySettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventVisibilityResponse = await client.cms.mediaBridge.getEventVisibilitySettings(0);\n\nconsole.log(eventVisibilityResponse.createdAt);", - }, - python: { - method: 'cms.media_bridge.get_event_visibility_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_visibility_response = client.cms.media_bridge.get_event_visibility_settings(\n 0,\n)\nprint(event_visibility_response.created_at)', - }, - java: { - method: 'cms().mediaBridge().getEventVisibilitySettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.EventVisibilityResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetEventVisibilitySettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventVisibilityResponse eventVisibilityResponse = client.cms().mediaBridge().getEventVisibilitySettings(0);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.GetEventVisibilitySettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventVisibilityResponse, err := client.Cms.MediaBridge.GetEventVisibilitySettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventVisibilityResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.get_event_visibility_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_visibility_response = hubspot.cms.media_bridge.get_event_visibility_settings(0)\n\nputs(event_visibility_response)', - }, - php: { - method: 'cms->mediaBridge->getEventVisibilitySettings', - example: - "cms\n ->mediaBridge\n ->getEventVisibilitySettings(0);\n\nvar_dump($eventVisibilityResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/event-visibility \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_oembed_domain', - endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', - httpMethod: 'get', - summary: 'Get an oEmbed domain', - description: 'Get the details for an existing oEmbed domain.', - stainlessPath: '(resource) cms.media_bridge > (method) get_oembed_domain', - qualified: 'client.cms.mediaBridge.getOembedDomain', - params: ['appId: number;', 'oEmbedDomainId: string;'], - response: - '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', - markdown: - "## get_oembed_domain\n\n`client.cms.mediaBridge.getOembedDomain(appId: number, oEmbedDomainId: string): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}`\n\nGet the details for an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `oEmbedDomainId: string`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.getOembedDomain('oEmbedDomainId', { appId: 0 });\n\nconsole.log(integratorOEmbedDomainModel);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.getOembedDomain', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.getOembedDomain('oEmbedDomainId', {\n appId: 0,\n});\n\nconsole.log(integratorOEmbedDomainModel.id);", - }, - python: { - method: 'cms.media_bridge.get_oembed_domain', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.get_oembed_domain(\n o_embed_domain_id="oEmbedDomainId",\n app_id=0,\n)\nprint(integrator_o_embed_domain_model.id)', - }, - java: { - method: 'cms().mediaBridge().getOembedDomain', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetOembedDomainParams params = MediaBridgeGetOembedDomainParams.builder()\n .appId(0)\n .oEmbedDomainId("oEmbedDomainId")\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().getOembedDomain(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.GetOembedDomain', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.GetOembedDomain(\n\t\tcontext.TODO(),\n\t\t"oEmbedDomainId",\n\t\tcms.MediaBridgeGetOembedDomainParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.get_oembed_domain', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.get_oembed_domain("oEmbedDomainId", app_id: 0)\n\nputs(integrator_o_embed_domain_model)', - }, - php: { - method: 'cms->mediaBridge->getOembedDomain', - example: - "cms->mediaBridge->getOembedDomain(\n 'oEmbedDomainId', appID: 0\n);\n\nvar_dump($integratorOEmbedDomainModel);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains/$O_EMBED_DOMAIN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_property', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - httpMethod: 'get', - summary: 'Get the details for a property', - description: 'Get the details for an existing property by name.', - stainlessPath: '(resource) cms.media_bridge > (method) get_property', - qualified: 'client.cms.mediaBridge.getProperty', - params: [ - 'appId: number;', - 'objectType: string;', - 'propertyName: string;', - 'archived?: boolean;', - 'properties?: string;', - ], - response: 'object', - markdown: - "## get_property\n\n`client.cms.mediaBridge.getProperty(appId: number, objectType: string, propertyName: string, archived?: boolean, properties?: string): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nGet the details for an existing property by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `properties?: string`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.getProperty('propertyName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(mediaBridgeProperty);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.getProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.getProperty('propertyName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", - }, - python: { - method: 'cms.media_bridge.get_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.get_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)\nprint(media_bridge_property.hidden)', - }, - java: { - method: 'cms().mediaBridge().getProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetPropertyParams;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetPropertyParams params = MediaBridgeGetPropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().getProperty(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.GetProperty', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.GetProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeGetPropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.get_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.get_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(media_bridge_property)', - }, - php: { - method: 'cms->mediaBridge->getProperty', - example: - "cms->mediaBridge->getProperty(\n 'propertyName',\n appID: 0,\n objectType: 'objectType',\n archived: true,\n properties: 'properties',\n);\n\nvar_dump($mediaBridgeProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_property_group', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - httpMethod: 'get', - summary: 'Get a specific property group', - description: 'Get the details of an existing property group by name.', - stainlessPath: '(resource) cms.media_bridge > (method) get_property_group', - qualified: 'client.cms.mediaBridge.getPropertyGroup', - params: ['appId: number;', 'objectType: string;', 'groupName: string;'], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## get_property_group\n\n`client.cms.mediaBridge.getPropertyGroup(appId: number, objectType: string, groupName: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nGet the details of an existing property group by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.getPropertyGroup('groupName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.getPropertyGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.getPropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'cms.media_bridge.get_property_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.get_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)\nprint(property_group.archived)', - }, - java: { - method: 'cms().mediaBridge().getPropertyGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetPropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetPropertyGroupParams params = MediaBridgeGetPropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().getPropertyGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.GetPropertyGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.GetPropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeGetPropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.get_property_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.get_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(property_group)', - }, - php: { - method: 'cms->mediaBridge->getPropertyGroup', - example: - "cms->mediaBridge->getPropertyGroup(\n 'groupName', appID: 0, objectType: 'objectType'\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_schema', - endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}', - httpMethod: 'get', - summary: 'Get the schema for an object type', - description: 'Get the schema for a specified object type.', - stainlessPath: '(resource) cms.media_bridge > (method) get_schema', - qualified: 'client.cms.mediaBridge.getSchema', - params: ['appId: number;', 'objectType: string;'], - response: - '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', - markdown: - "## get_schema\n\n`client.cms.mediaBridge.getSchema(appId: number, objectType: string): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/schemas/{objectType}`\n\nGet the schema for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.cms.mediaBridge.getSchema('objectType', { appId: 0 });\n\nconsole.log(objectSchema);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.getSchema', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.cms.mediaBridge.getSchema('objectType', { appId: 0 });\n\nconsole.log(objectSchema.id);", - }, - python: { - method: 'cms.media_bridge.get_schema', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.cms.media_bridge.get_schema(\n object_type="objectType",\n app_id=0,\n)\nprint(object_schema.id)', - }, - java: { - method: 'cms().mediaBridge().getSchema', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeGetSchemaParams;\nimport com.hubspot.sdk.models.cms.mediabridge.ObjectSchema;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeGetSchemaParams params = MediaBridgeGetSchemaParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n ObjectSchema objectSchema = client.cms().mediaBridge().getSchema(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.GetSchema', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Cms.MediaBridge.GetSchema(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeGetSchemaParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.get_schema', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.cms.media_bridge.get_schema("objectType", app_id: 0)\n\nputs(object_schema)', - }, - php: { - method: 'cms->mediaBridge->getSchema', - example: - "cms->mediaBridge->getSchema('objectType', appID: 0);\n\nvar_dump($objectSchema);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_object_types_by_media_type', - endpoint: '/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}', - httpMethod: 'get', - summary: 'Get object types for a supported media', - description: 'Get the existing objects types that belong to the specified media type.', - stainlessPath: '(resource) cms.media_bridge > (method) list_object_types_by_media_type', - qualified: 'client.cms.mediaBridge.listObjectTypesByMediaType', - params: [ - 'appId: number;', - "mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO';", - 'includeFullDefinition?: boolean;', - ], - response: - '{ objectTypeId: string; objectTypeName: string; properties: object[]; propertyGroups: object[]; schema?: object; }', - markdown: - "## list_object_types_by_media_type\n\n`client.cms.mediaBridge.listObjectTypesByMediaType(appId: number, mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO', includeFullDefinition?: boolean): { objectTypeId: string; objectTypeName: string; properties: property_definition[]; propertyGroups: group_view[]; schema?: inbound_db_object_type; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}`\n\nGet the existing objects types that belong to the specified media type.\n\n### Parameters\n\n- `appId: number`\n\n- `mediaType: 'AUDIO' | 'DOCUMENT' | 'IMAGE' | 'OTHER' | 'VIDEO'`\n\n- `includeFullDefinition?: boolean`\n\n### Returns\n\n- `{ objectTypeId: string; objectTypeName: string; properties: { objectTypeId: string; property: media_bridge_property; calculationExpression?: object; calculationFormula?: string; definitionSource?: property_definition_source; extensionData?: extension_data; externalOptionsMetaData?: external_options_meta_data; fulcrumPortalId?: number; fulcrumTimestamp?: number; janusGroup?: string; lookupAssociationSpec?: lookup_association_spec; permission?: field_level_permission; propertyDefinitionSource?: definition_source; propertyRequirements?: default_requirements; rollupExpression?: rollup_expression; }[]; propertyGroups: { displayName: string; displayOrder: number; fulcrumPortalId: number; fulcrumTimestamp: number; hubspotDefined: boolean; name: string; }[]; schema?: { id: number; allowsSensitiveProperties: boolean; createDatePropertyName: string; defaultSearchPropertyNames: string[]; deleted: boolean; fullyQualifiedName: string; hasCustomProperties: boolean; hasDefaultProperties: boolean; hasExternalObjectIds: boolean; hasOwners: boolean; hasPipelines: boolean; indexedForFiltersAndReports: boolean; lastModifiedPropertyName: string; metaType: string; metaTypeId: number; name: string; objectTypeId: string; objectTypeIdString: string; permissioningType: 'ALL_OR_NONE' | 'DO_NOT_CHECK_PERMISSIONS' | 'EXPLICIT' | 'OWNER_BASED' | 'TEAM_BASED'; pipelinePropertyName: string; pipelineStagePropertyName: string; requiredProperties: string[]; restorable: boolean; scopeMappings: scope_mapping[]; secondaryDisplayLabelPropertyNames: string[]; accessScopeName?: string; createdAt?: number; description?: string; integrationAppId?: number; janusGroup?: string; ownerPortalId?: number; pipelineCloseDatePropertyName?: string; pipelineTimeToClosePropertyName?: string; pluralForm?: string; primaryDisplayLabelPropertyName?: string; readScopeName?: string; singularForm?: string; status?: 'Deprecated' | 'In development' | 'Live'; visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; writeScopeName?: string; }; }`\n\n - `objectTypeId: string`\n - `objectTypeName: string`\n - `properties: { objectTypeId: string; property: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }; calculationExpression?: object; calculationFormula?: string; definitionSource?: { type: 'GLOBAL' | 'HAVEN_BRANCH' | 'OBJECT_TYPE' | 'PORTAL'; name?: string; }; extensionData?: { extensionStatusMap: object; tags: string[]; caseChangeTestExtensionData?: case_change_test_extension_data; optionDecoratorsExtensionData?: option_decorators_extension_data; requiredPropertiesExtensionData?: required_properties_extension_data; softRequiredPropertiesExtensionData?: soft_required_properties_extension_data; }; externalOptionsMetaData?: { filter?: filtering_meta_data; relatedObjectTypeId?: string; }; fulcrumPortalId?: number; fulcrumTimestamp?: number; janusGroup?: string; lookupAssociationSpec?: { associationSpec: association_spec; cardinality?: 'ONE_TO_MANY' | 'ONE_TO_ONE'; maxToObjectIds?: number; toObjectTypeId?: string; }; permission?: { accessLevel: string; }; propertyDefinitionSource?: { type: 'GLOBAL' | 'HAVEN_BRANCH' | 'OBJECT_TYPE' | 'PORTAL'; name?: string; }; propertyRequirements?: { gates: string[]; operator: 'AND' | 'OR'; scopeNames: string[]; settings: string[]; }; rollupExpression?: { associationTypes: association_spec[]; rollupOperator: string; sourceObjectTypeId: string; sourcePropertyName: string; conditionalExpression?: object; conditionalFormula?: string; emptyRollupValue?: string; sourceCompareByPropertyName?: string; }; }[]`\n - `propertyGroups: { displayName: string; displayOrder: number; fulcrumPortalId: number; fulcrumTimestamp: number; hubspotDefined: boolean; name: string; }[]`\n - `schema?: { id: number; allowsSensitiveProperties: boolean; createDatePropertyName: string; defaultSearchPropertyNames: string[]; deleted: boolean; fullyQualifiedName: string; hasCustomProperties: boolean; hasDefaultProperties: boolean; hasExternalObjectIds: boolean; hasOwners: boolean; hasPipelines: boolean; indexedForFiltersAndReports: boolean; lastModifiedPropertyName: string; metaType: string; metaTypeId: number; name: string; objectTypeId: string; objectTypeIdString: string; permissioningType: 'ALL_OR_NONE' | 'DO_NOT_CHECK_PERMISSIONS' | 'EXPLICIT' | 'OWNER_BASED' | 'TEAM_BASED'; pipelinePropertyName: string; pipelineStagePropertyName: string; requiredProperties: string[]; restorable: boolean; scopeMappings: { accessLevel: 'ALL' | 'OWNED' | 'TEAM_OWNED' | 'UNASSIGNED'; requestAction: 'COMMUNICATE' | 'DELETE' | 'EDIT' | 'EDIT_ASSOCIATION' | 'MERGE' | 'VIEW'; scopeName: string; }[]; secondaryDisplayLabelPropertyNames: string[]; accessScopeName?: string; createdAt?: number; description?: string; integrationAppId?: number; janusGroup?: string; ownerPortalId?: number; pipelineCloseDatePropertyName?: string; pipelineTimeToClosePropertyName?: string; pluralForm?: string; primaryDisplayLabelPropertyName?: string; readScopeName?: string; singularForm?: string; status?: 'Deprecated' | 'In development' | 'Live'; visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; writeScopeName?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectDefinitionResponse = await client.cms.mediaBridge.listObjectTypesByMediaType('AUDIO', { appId: 0 });\n\nconsole.log(objectDefinitionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.listObjectTypesByMediaType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectDefinitionResponse = await client.cms.mediaBridge.listObjectTypesByMediaType('AUDIO', {\n appId: 0,\n});\n\nconsole.log(objectDefinitionResponse.objectTypeId);", - }, - python: { - method: 'cms.media_bridge.list_object_types_by_media_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_definition_response = client.cms.media_bridge.list_object_types_by_media_type(\n media_type="AUDIO",\n app_id=0,\n)\nprint(object_definition_response.object_type_id)', - }, - java: { - method: 'cms().mediaBridge().listObjectTypesByMediaType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListObjectTypesByMediaTypeParams;\nimport com.hubspot.sdk.models.cms.mediabridge.ObjectDefinitionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListObjectTypesByMediaTypeParams params = MediaBridgeListObjectTypesByMediaTypeParams.builder()\n .appId(0)\n .mediaType(MediaBridgeListObjectTypesByMediaTypeParams.MediaType.AUDIO)\n .build();\n ObjectDefinitionResponse objectDefinitionResponse = client.cms().mediaBridge().listObjectTypesByMediaType(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.ListObjectTypesByMediaType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectDefinitionResponse, err := client.Cms.MediaBridge.ListObjectTypesByMediaType(\n\t\tcontext.TODO(),\n\t\tcms.MediaBridgeListObjectTypesByMediaTypeParamsMediaTypeAudio,\n\t\tcms.MediaBridgeListObjectTypesByMediaTypeParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectDefinitionResponse.ObjectTypeID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.list_object_types_by_media_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_definition_response = hubspot.cms.media_bridge.list_object_types_by_media_type(:AUDIO, app_id: 0)\n\nputs(object_definition_response)', - }, - php: { - method: 'cms->mediaBridge->listObjectTypesByMediaType', - example: - "cms\n ->mediaBridge\n ->listObjectTypesByMediaType('AUDIO', appID: 0, includeFullDefinition: true);\n\nvar_dump($objectDefinitionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/object-definitions/$MEDIA_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_oembed_domains', - endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - httpMethod: 'get', - summary: 'Get oEmbed domains', - description: 'Get the details for existing oEmbed domains for your app', - stainlessPath: '(resource) cms.media_bridge > (method) list_oembed_domains', - qualified: 'client.cms.mediaBridge.listOembedDomains', - params: ['appId: number;', 'domainPortalId?: number;'], - response: - '{ results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }[]; totalCount?: number; }', - markdown: - "## list_oembed_domains\n\n`client.cms.mediaBridge.listOembedDomains(appId: number, domainPortalId?: number): { results: integrator_o_embed_domain_model[]; totalCount?: number; }`\n\n**get** `/media-bridge/2026-03/{appId}/settings/oembed-domains`\n\nGet the details for existing oEmbed domains for your app\n\n### Parameters\n\n- `appId: number`\n\n- `domainPortalId?: number`\n\n### Returns\n\n- `{ results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }[]; totalCount?: number; }`\n\n - `results: { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }[]`\n - `totalCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst oEmbedDomainsCollectionResponse = await client.cms.mediaBridge.listOembedDomains(0);\n\nconsole.log(oEmbedDomainsCollectionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.listOembedDomains', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst oEmbedDomainsCollectionResponse = await client.cms.mediaBridge.listOembedDomains(0);\n\nconsole.log(oEmbedDomainsCollectionResponse.results);", - }, - python: { - method: 'cms.media_bridge.list_oembed_domains', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\no_embed_domains_collection_response = client.cms.media_bridge.list_oembed_domains(\n app_id=0,\n)\nprint(o_embed_domains_collection_response.results)', - }, - java: { - method: 'cms().mediaBridge().listOembedDomains', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListOembedDomainsParams;\nimport com.hubspot.sdk.models.cms.mediabridge.OEmbedDomainsCollectionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OEmbedDomainsCollectionResponse oEmbedDomainsCollectionResponse = client.cms().mediaBridge().listOembedDomains(0);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.ListOembedDomains', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\toEmbedDomainsCollectionResponse, err := client.Cms.MediaBridge.ListOembedDomains(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeListOembedDomainsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", oEmbedDomainsCollectionResponse.Results)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.list_oembed_domains', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\no_embed_domains_collection_response = hubspot.cms.media_bridge.list_oembed_domains(0)\n\nputs(o_embed_domains_collection_response)', - }, - php: { - method: 'cms->mediaBridge->listOembedDomains', - example: - "cms->mediaBridge->listOembedDomains(\n 0, domainPortalID: 0\n);\n\nvar_dump($oEmbedDomainsCollectionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_properties', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}', - httpMethod: 'get', - summary: 'Get the properties for an object type.', - description: 'Get the existing properties defined for a media object type.', - stainlessPath: '(resource) cms.media_bridge > (method) list_properties', - qualified: 'client.cms.mediaBridge.listProperties', - params: ['appId: number;', 'objectType: string;', 'archived?: boolean;', 'properties?: string;'], - response: - "{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }", - markdown: - "## list_properties\n\n`client.cms.mediaBridge.listProperties(appId: number, objectType: string, archived?: boolean, properties?: string): { results: property_1[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}`\n\nGet the existing properties defined for a media object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `properties?: string`\n\n### Returns\n\n- `{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }`\n\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyNoPaging = await client.cms.mediaBridge.listProperties('objectType', { appId: 0 });\n\nconsole.log(collectionResponsePropertyNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.listProperties', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyNoPaging = await client.cms.mediaBridge.listProperties(\n 'objectType',\n { appId: 0 },\n);\n\nconsole.log(collectionResponsePropertyNoPaging.results);", - }, - python: { - method: 'cms.media_bridge.list_properties', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_no_paging = client.cms.media_bridge.list_properties(\n object_type="objectType",\n app_id=0,\n)\nprint(collection_response_property_no_paging.results)', - }, - java: { - method: 'cms().mediaBridge().listProperties', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.CollectionResponsePropertyNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListPropertiesParams params = MediaBridgeListPropertiesParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n CollectionResponsePropertyNoPaging collectionResponsePropertyNoPaging = client.cms().mediaBridge().listProperties(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.ListProperties', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyNoPaging, err := client.Cms.MediaBridge.ListProperties(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeListPropertiesParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyNoPaging.Results)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.list_properties', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_no_paging = hubspot.cms.media_bridge.list_properties("objectType", app_id: 0)\n\nputs(collection_response_property_no_paging)', - }, - php: { - method: 'cms->mediaBridge->listProperties', - example: - "cms->mediaBridge->listProperties(\n 'objectType', appID: 0, archived: true, properties: 'properties'\n);\n\nvar_dump($collectionResponsePropertyNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_property_groups', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', - httpMethod: 'get', - summary: 'Get property groups', - description: 'Get the property groups for a specified object type.', - stainlessPath: '(resource) cms.media_bridge > (method) list_property_groups', - qualified: 'client.cms.mediaBridge.listPropertyGroups', - params: ['appId: number;', 'objectType: string;'], - response: '{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }', - markdown: - "## list_property_groups\n\n`client.cms.mediaBridge.listPropertyGroups(appId: number, objectType: string): { results: property_group[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups`\n\nGet the property groups for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n### Returns\n\n- `{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }`\n\n - `results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyGroupNoPaging = await client.cms.mediaBridge.listPropertyGroups('objectType', { appId: 0 });\n\nconsole.log(collectionResponsePropertyGroupNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.listPropertyGroups', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyGroupNoPaging = await client.cms.mediaBridge.listPropertyGroups(\n 'objectType',\n { appId: 0 },\n);\n\nconsole.log(collectionResponsePropertyGroupNoPaging.results);", - }, - python: { - method: 'cms.media_bridge.list_property_groups', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_group_no_paging = client.cms.media_bridge.list_property_groups(\n object_type="objectType",\n app_id=0,\n)\nprint(collection_response_property_group_no_paging.results)', - }, - java: { - method: 'cms().mediaBridge().listPropertyGroups', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.CollectionResponsePropertyGroupNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListPropertyGroupsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeListPropertyGroupsParams params = MediaBridgeListPropertyGroupsParams.builder()\n .appId(0)\n .objectType("objectType")\n .build();\n CollectionResponsePropertyGroupNoPaging collectionResponsePropertyGroupNoPaging = client.cms().mediaBridge().listPropertyGroups(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.ListPropertyGroups', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyGroupNoPaging, err := client.Cms.MediaBridge.ListPropertyGroups(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeListPropertyGroupsParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyGroupNoPaging.Results)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.list_property_groups', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_group_no_paging = hubspot.cms.media_bridge.list_property_groups("objectType", app_id: 0)\n\nputs(collection_response_property_group_no_paging)', - }, - php: { - method: 'cms->mediaBridge->listPropertyGroups', - example: - "cms\n ->mediaBridge\n ->listPropertyGroups('objectType', appID: 0);\n\nvar_dump($collectionResponsePropertyGroupNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_schemas', - endpoint: '/media-bridge/2026-03/{appId}/schemas', - httpMethod: 'get', - summary: 'Get all schemas ', - description: 'Get the schemas for all object types.', - stainlessPath: '(resource) cms.media_bridge > (method) list_schemas', - qualified: 'client.cms.mediaBridge.listSchemas', - params: ['appId: number;', 'archived?: boolean;'], - response: - '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', - markdown: - "## list_schemas\n\n`client.cms.mediaBridge.listSchemas(appId: number, archived?: boolean): { results: object_schema[]; }`\n\n**get** `/media-bridge/2026-03/{appId}/schemas`\n\nGet the schemas for all object types.\n\n### Parameters\n\n- `appId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property_1[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option_1[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.cms.mediaBridge.listSchemas(0);\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.listSchemas', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.cms.mediaBridge.listSchemas(0);\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", - }, - python: { - method: 'cms.media_bridge.list_schemas', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.cms.media_bridge.list_schemas(\n app_id=0,\n)\nprint(collection_response_object_schema_no_paging.results)', - }, - java: { - method: 'cms().mediaBridge().listSchemas', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeListSchemasParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.cms().mediaBridge().listSchemas(0);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.ListSchemas', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Cms.MediaBridge.ListSchemas(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeListSchemasParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.list_schemas', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.cms.media_bridge.list_schemas(0)\n\nputs(collection_response_object_schema_no_paging)', - }, - php: { - method: 'cms->mediaBridge->listSchemas', - example: - "cms\n ->mediaBridge\n ->listSchemas(0, archived: true);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'register_app_name', - endpoint: '/media-bridge/2026-03/{appId}/settings/register', - httpMethod: 'post', - summary: 'Register the media bridge app name', - description: 'Register the name that your app will display when a user is selecting media bridge items.', - stainlessPath: '(resource) cms.media_bridge > (method) register_app_name', - qualified: 'client.cms.mediaBridge.registerAppName', - params: [ - 'appId: number;', - 'updatedAt: number;', - 'allowImportOnDisconnect?: boolean;', - 'moduleName?: string;', - 'name?: string;', - ], - response: '{ appId: number; name: string; }', - markdown: - "## register_app_name\n\n`client.cms.mediaBridge.registerAppName(appId: number, updatedAt: number, allowImportOnDisconnect?: boolean, moduleName?: string, name?: string): { appId: number; name: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/settings/register`\n\nRegister the name that your app will display when a user is selecting media bridge items.\n\n### Parameters\n\n- `appId: number`\n\n- `updatedAt: number`\n\n- `allowImportOnDisconnect?: boolean`\n\n- `moduleName?: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ appId: number; name: string; }`\n\n - `appId: number`\n - `name: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.registerAppName(0, { updatedAt: 0 });\n\nconsole.log(mediaBridgeProviderRegistrationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.registerAppName', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.registerAppName(0, {\n updatedAt: 0,\n});\n\nconsole.log(mediaBridgeProviderRegistrationResponse.appId);", - }, - python: { - method: 'cms.media_bridge.register_app_name', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_provider_registration_response = client.cms.media_bridge.register_app_name(\n app_id=0,\n updated_at=0,\n)\nprint(media_bridge_provider_registration_response.app_id)', - }, - java: { - method: 'cms().mediaBridge().registerAppName', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderPartial;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderRegistrationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeRegisterAppNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeRegisterAppNameParams params = MediaBridgeRegisterAppNameParams.builder()\n .appId(0)\n .mediaBridgeProviderPartial(MediaBridgeProviderPartial.builder()\n .updatedAt(0L)\n .build())\n .build();\n MediaBridgeProviderRegistrationResponse mediaBridgeProviderRegistrationResponse = client.cms().mediaBridge().registerAppName(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.RegisterAppName', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProviderRegistrationResponse, err := client.Cms.MediaBridge.RegisterAppName(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeRegisterAppNameParams{\n\t\t\tMediaBridgeProviderPartial: cms.MediaBridgeProviderPartialParam{\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProviderRegistrationResponse.AppID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.register_app_name', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_provider_registration_response = hubspot.cms.media_bridge.register_app_name(0, updated_at: 0)\n\nputs(media_bridge_provider_registration_response)', - }, - php: { - method: 'cms->mediaBridge->registerAppName', - example: - "cms\n ->mediaBridge\n ->registerAppName(\n 0,\n updatedAt: 0,\n allowImportOnDisconnect: true,\n moduleName: 'moduleName',\n name: 'name',\n);\n\nvar_dump($mediaBridgeProviderRegistrationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/register \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "updatedAt": 0\n }\'', - }, - }, - }, - { - name: 'update_event_visibility_settings', - endpoint: '/media-bridge/2026-03/{appId}/settings/event-visibility', - httpMethod: 'patch', - summary: 'Create or update event visibility settings', - description: 'Set the visibility settings for media bridge events created by your app.', - stainlessPath: '(resource) cms.media_bridge > (method) update_event_visibility_settings', - qualified: 'client.cms.mediaBridge.updateEventVisibilitySettings', - params: [ - 'appId: number;', - "eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT';", - 'updatedAt: number;', - 'showInReporting?: boolean;', - 'showInTimeline?: boolean;', - 'showInWorkflows?: boolean;', - ], - response: - "{ eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }", - markdown: - "## update_event_visibility_settings\n\n`client.cms.mediaBridge.updateEventVisibilitySettings(appId: number, eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT', updatedAt: number, showInReporting?: boolean, showInTimeline?: boolean, showInWorkflows?: boolean): { eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }`\n\n**patch** `/media-bridge/2026-03/{appId}/settings/event-visibility`\n\nSet the visibility settings for media bridge events created by your app.\n\n### Parameters\n\n- `appId: number`\n\n- `eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'`\n\n- `updatedAt: number`\n\n- `showInReporting?: boolean`\n\n- `showInTimeline?: boolean`\n\n- `showInWorkflows?: boolean`\n\n### Returns\n\n- `{ eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'; updatedAt: number; showInReporting?: boolean; showInTimeline?: boolean; showInWorkflows?: boolean; }`\n\n - `eventType: 'ALL' | 'ATTENTION_SPAN' | 'MEDIA_PLAYS' | 'MEDIA_PLAYS_PERCENT'`\n - `updatedAt: number`\n - `showInReporting?: boolean`\n - `showInTimeline?: boolean`\n - `showInWorkflows?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventVisibilityChange = await client.cms.mediaBridge.updateEventVisibilitySettings(0, { eventType: 'ALL', updatedAt: 0 });\n\nconsole.log(eventVisibilityChange);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updateEventVisibilitySettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventVisibilityChange = await client.cms.mediaBridge.updateEventVisibilitySettings(0, {\n eventType: 'ALL',\n updatedAt: 0,\n});\n\nconsole.log(eventVisibilityChange.eventType);", - }, - python: { - method: 'cms.media_bridge.update_event_visibility_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_visibility_change = client.cms.media_bridge.update_event_visibility_settings(\n app_id=0,\n event_type="ALL",\n updated_at=0,\n)\nprint(event_visibility_change.event_type)', - }, - java: { - method: 'cms().mediaBridge().updateEventVisibilitySettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.EventVisibilityChange;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateEventVisibilitySettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateEventVisibilitySettingsParams params = MediaBridgeUpdateEventVisibilitySettingsParams.builder()\n .appId(0)\n .eventVisibilityChange(EventVisibilityChange.builder()\n .eventType(EventVisibilityChange.EventType.ALL)\n .updatedAt(0L)\n .build())\n .build();\n EventVisibilityChange eventVisibilityChange = client.cms().mediaBridge().updateEventVisibilitySettings(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdateEventVisibilitySettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventVisibilityChange, err := client.Cms.MediaBridge.UpdateEventVisibilitySettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeUpdateEventVisibilitySettingsParams{\n\t\t\tEventVisibilityChange: cms.EventVisibilityChangeParam{\n\t\t\t\tEventType: cms.EventVisibilityChangeEventTypeAll,\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventVisibilityChange.EventType)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_event_visibility_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_visibility_change = hubspot.cms.media_bridge.update_event_visibility_settings(0, event_type: :ALL, updated_at: 0)\n\nputs(event_visibility_change)', - }, - php: { - method: 'cms->mediaBridge->updateEventVisibilitySettings', - example: - "cms\n ->mediaBridge\n ->updateEventVisibilitySettings(\n 0,\n eventType: 'ALL',\n updatedAt: 0,\n showInReporting: true,\n showInTimeline: true,\n showInWorkflows: true,\n);\n\nvar_dump($eventVisibilityChange);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/event-visibility \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventType": "ALL",\n "updatedAt": 0\n }\'', - }, - }, - }, - { - name: 'update_oembed_domain', - endpoint: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', - httpMethod: 'patch', - summary: 'Update an oEmbed domain', - description: 'Update an existing oEmbed domain.', - stainlessPath: '(resource) cms.media_bridge > (method) update_oembed_domain', - qualified: 'client.cms.mediaBridge.updateOembedDomain', - params: [ - 'appId: number;', - 'oEmbedDomainId: string;', - 'endpoints: { discovery: boolean; schemes: string[]; url: string; };', - 'portalId?: number;', - ], - response: - '{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }', - markdown: - "## update_oembed_domain\n\n`client.cms.mediaBridge.updateOembedDomain(appId: number, oEmbedDomainId: string, endpoints: { discovery: boolean; schemes: string[]; url: string; }, portalId?: number): { id: number; appId: number; createdAt: number; deletedAt: number; endpoints: endpoints; portalId: number; updatedAt: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}`\n\nUpdate an existing oEmbed domain.\n\n### Parameters\n\n- `appId: number`\n\n- `oEmbedDomainId: string`\n\n- `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `discovery: boolean`\n - `schemes: string[]`\n - `url: string`\n\n- `portalId?: number`\n\n### Returns\n\n- `{ id: number; appId: number; createdAt: number; deletedAt: number; endpoints: { discovery: boolean; schemes: string[]; url: string; }; portalId: number; updatedAt: number; }`\n\n - `id: number`\n - `appId: number`\n - `createdAt: number`\n - `deletedAt: number`\n - `endpoints: { discovery: boolean; schemes: string[]; url: string; }`\n - `portalId: number`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.updateOembedDomain('oEmbedDomainId', {\n appId: 0,\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n},\n});\n\nconsole.log(integratorOEmbedDomainModel);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updateOembedDomain', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorOEmbedDomainModel = await client.cms.mediaBridge.updateOembedDomain(\n 'oEmbedDomainId',\n {\n appId: 0,\n endpoints: {\n discovery: true,\n schemes: ['string'],\n url: 'url',\n },\n },\n);\n\nconsole.log(integratorOEmbedDomainModel.id);", - }, - python: { - method: 'cms.media_bridge.update_oembed_domain', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_o_embed_domain_model = client.cms.media_bridge.update_oembed_domain(\n o_embed_domain_id="oEmbedDomainId",\n app_id=0,\n endpoints={\n "discovery": True,\n "schemes": ["string"],\n "url": "url",\n },\n)\nprint(integrator_o_embed_domain_model.id)', - }, - java: { - method: 'cms().mediaBridge().updateOembedDomain', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.Endpoints;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainModel;\nimport com.hubspot.sdk.models.cms.mediabridge.IntegratorOEmbedDomainRequest;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateOembedDomainParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateOembedDomainParams params = MediaBridgeUpdateOembedDomainParams.builder()\n .appId(0)\n .oEmbedDomainId("oEmbedDomainId")\n .integratorOEmbedDomainRequest(IntegratorOEmbedDomainRequest.builder()\n .endpoints(Endpoints.builder()\n .discovery(true)\n .addScheme("string")\n .url("url")\n .build())\n .build())\n .build();\n IntegratorOEmbedDomainModel integratorOEmbedDomainModel = client.cms().mediaBridge().updateOembedDomain(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdateOembedDomain', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorOEmbedDomainModel, err := client.Cms.MediaBridge.UpdateOembedDomain(\n\t\tcontext.TODO(),\n\t\t"oEmbedDomainId",\n\t\tcms.MediaBridgeUpdateOembedDomainParams{\n\t\t\tAppID: 0,\n\t\t\tIntegratorOEmbedDomainRequest: cms.IntegratorOEmbedDomainRequestParam{\n\t\t\t\tEndpoints: cms.EndpointsParam{\n\t\t\t\t\tDiscovery: true,\n\t\t\t\t\tSchemes: []string{"string"},\n\t\t\t\t\tURL: "url",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorOEmbedDomainModel.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_oembed_domain', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_o_embed_domain_model = hubspot.cms.media_bridge.update_oembed_domain(\n "oEmbedDomainId",\n app_id: 0,\n endpoints: {discovery: true, schemes: ["string"], url: "url"}\n)\n\nputs(integrator_o_embed_domain_model)', - }, - php: { - method: 'cms->mediaBridge->updateOembedDomain', - example: - "cms->mediaBridge->updateOembedDomain(\n 'oEmbedDomainId',\n appID: 0,\n endpoints: ['discovery' => true, 'schemes' => ['string'], 'url' => 'url'],\n portalID: 0,\n);\n\nvar_dump($integratorOEmbedDomainModel);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings/oembed-domains/$O_EMBED_DOMAIN_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endpoints": {\n "discovery": true,\n "schemes": [\n "string"\n ],\n "url": "url"\n }\n }\'', - }, - }, - }, - { - name: 'update_property', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - httpMethod: 'patch', - summary: 'Update a property', - description: 'Update an existing property for an object type.', - stainlessPath: '(resource) cms.media_bridge > (method) update_property', - qualified: 'client.cms.mediaBridge.updateProperty', - params: [ - 'appId: number;', - 'objectType: string;', - 'propertyName: string;', - 'calculationFormula?: string;', - 'currencyPropertyName?: string;', - 'description?: string;', - 'displayOrder?: number;', - 'fieldType?: string;', - 'formField?: boolean;', - 'groupName?: string;', - 'hasUniqueValue?: boolean;', - 'hidden?: boolean;', - 'label?: string;', - "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - 'showCurrencySymbol?: boolean;', - "type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", - ], - response: 'object', - markdown: - "## update_property\n\n`client.cms.mediaBridge.updateProperty(appId: number, objectType: string, propertyName: string, calculationFormula?: string, currencyPropertyName?: string, description?: string, displayOrder?: number, fieldType?: string, formField?: boolean, groupName?: string, hasUniqueValue?: boolean, hidden?: boolean, label?: string, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], showCurrencySymbol?: boolean, type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'): { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}`\n\nUpdate an existing property for an object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `fieldType?: string`\n\n- `formField?: boolean`\n\n- `groupName?: string`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `label?: string`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `showCurrencySymbol?: boolean`\n\n- `type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n### Returns\n\n- `{ allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }`\n A HubSpot property\n\n - `allowedObjectTypes: { innerId: number; metaTypeId: number; }[]`\n - `calculated: boolean`\n - `canArchive: boolean`\n - `canRestore: boolean`\n - `createdAt: number`\n - `createdUserId: number`\n - `currencyPropertyName: string`\n - `dataSensitivity: 'high' | 'none' | 'standard'`\n - `dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `deleted: boolean`\n - `description: string`\n - `displayMode: 'all_unique_versions' | 'current_value'`\n - `displayOrder: number`\n - `enforceMultivalueUniqueness: boolean`\n - `externalOptions: boolean`\n - `externalOptionsReferenceType: string`\n - `favorited: boolean`\n - `favoritedOrder: number`\n - `fieldType: string`\n - `formField: boolean`\n - `fromUserId: number`\n - `groupName: string`\n - `hasUniqueValue: boolean`\n - `hidden: boolean`\n - `hubspotDefined: boolean`\n - `isCustomizedDefault: boolean`\n - `isMultiValued: boolean`\n - `isPartial: boolean`\n - `label: string`\n - `mutableDefinitionNotDeletable: boolean`\n - `name: string`\n - `numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]`\n - `optionsAreMutable: boolean`\n - `optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'`\n - `owningAppId: number`\n - `portalId: number`\n - `readOnlyDefinition: boolean`\n - `readOnlyValue: boolean`\n - `referencedObjectType: string`\n - `searchableInGlobalSearch: boolean`\n - `searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'`\n - `sensitiveDataCategories: string[]`\n - `showCurrencySymbol: boolean`\n - `textDisplayHint: string`\n - `type: string`\n - `updatedAt: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.updateProperty('propertyName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(mediaBridgeProperty);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updateProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProperty = await client.cms.mediaBridge.updateProperty('propertyName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(mediaBridgeProperty.hidden);", - }, - python: { - method: 'cms.media_bridge.update_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_property = client.cms.media_bridge.update_property(\n property_name="propertyName",\n app_id=0,\n object_type="objectType",\n)\nprint(media_bridge_property.hidden)', - }, - java: { - method: 'cms().mediaBridge().updateProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgePropertyUpdate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdatePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdatePropertyParams params = MediaBridgeUpdatePropertyParams.builder()\n .appId(0)\n .objectType("objectType")\n .propertyName("propertyName")\n .mediaBridgePropertyUpdate(MediaBridgePropertyUpdate.builder().build())\n .build();\n MediaBridgeProperty mediaBridgeProperty = client.cms().mediaBridge().updateProperty(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdateProperty', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProperty, err := client.Cms.MediaBridge.UpdateProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcms.MediaBridgeUpdatePropertyParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t\tMediaBridgePropertyUpdate: cms.MediaBridgePropertyUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProperty.Hidden)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_property = hubspot.cms.media_bridge.update_property("propertyName", app_id: 0, object_type: "objectType")\n\nputs(media_bridge_property)', - }, - php: { - method: 'cms->mediaBridge->updateProperty', - example: - "cms->mediaBridge->updateProperty(\n 'propertyName',\n appID: 0,\n objectType: 'objectType',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n description: 'description',\n displayOrder: 0,\n fieldType: 'booleancheckbox',\n formField: true,\n groupName: 'groupName',\n hasUniqueValue: true,\n hidden: true,\n label: 'label',\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n showCurrencySymbol: true,\n type: 'bool',\n);\n\nvar_dump($mediaBridgeProperty);", - }, - http: { - example: - "curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_property_group', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - httpMethod: 'patch', - summary: 'Update a property group', - description: 'Update an existing property group by name.', - stainlessPath: '(resource) cms.media_bridge > (method) update_property_group', - qualified: 'client.cms.mediaBridge.updatePropertyGroup', - params: [ - 'appId: number;', - 'objectType: string;', - 'groupName: string;', - 'displayOrder?: number;', - 'label?: string;', - ], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## update_property_group\n\n`client.cms.mediaBridge.updatePropertyGroup(appId: number, objectType: string, groupName: string, displayOrder?: number, label?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**patch** `/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}`\n\nUpdate an existing property group by name.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `displayOrder?: number`\n\n- `label?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.cms.mediaBridge.updatePropertyGroup('groupName', { appId: 0, objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updatePropertyGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.cms.mediaBridge.updatePropertyGroup('groupName', {\n appId: 0,\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'cms.media_bridge.update_property_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.cms.media_bridge.update_property_group(\n group_name="groupName",\n app_id=0,\n object_type="objectType",\n)\nprint(property_group.archived)', - }, - java: { - method: 'cms().mediaBridge().updatePropertyGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupUpdate;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdatePropertyGroupParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdatePropertyGroupParams params = MediaBridgeUpdatePropertyGroupParams.builder()\n .appId(0)\n .objectType("objectType")\n .groupName("groupName")\n .propertyGroupUpdate(PropertyGroupUpdate.builder().build())\n .build();\n PropertyGroup propertyGroup = client.cms().mediaBridge().updatePropertyGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdatePropertyGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Cms.MediaBridge.UpdatePropertyGroup(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcms.MediaBridgeUpdatePropertyGroupParams{\n\t\t\tAppID: 0,\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyGroupUpdate: shared.PropertyGroupUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_property_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.cms.media_bridge.update_property_group("groupName", app_id: 0, object_type: "objectType")\n\nputs(property_group)', - }, - php: { - method: 'cms->mediaBridge->updatePropertyGroup', - example: - "cms->mediaBridge->updatePropertyGroup(\n 'groupName',\n appID: 0,\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - "curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_schema', - endpoint: '/media-bridge/2026-03/{appId}/schemas/{objectType}', - httpMethod: 'patch', - summary: 'Update the schema for an object type', - description: 'Update the schema for an existing object type', - stainlessPath: '(resource) cms.media_bridge > (method) update_schema', - qualified: 'client.cms.mediaBridge.updateSchema', - params: [ - 'appId: number;', - 'objectType: string;', - 'clearDescription: boolean;', - 'allowsSensitiveProperties?: boolean;', - 'description?: string;', - 'labels?: { plural?: string; singular?: string; };', - 'primaryDisplayProperty?: string;', - 'requiredProperties?: string[];', - 'restorable?: boolean;', - 'searchableProperties?: string[];', - 'secondaryDisplayProperties?: string[];', - ], - response: - '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }', - markdown: - "## update_schema\n\n`client.cms.mediaBridge.updateSchema(appId: number, objectType: string, clearDescription: boolean, allowsSensitiveProperties?: boolean, description?: string, labels?: { plural?: string; singular?: string; }, primaryDisplayProperty?: string, requiredProperties?: string[], restorable?: boolean, searchableProperties?: string[], secondaryDisplayProperties?: string[]): { id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n**patch** `/media-bridge/2026-03/{appId}/schemas/{objectType}`\n\nUpdate the schema for an existing object type\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `clearDescription: boolean`\n\n- `allowsSensitiveProperties?: boolean`\n\n- `description?: string`\n\n- `labels?: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `primaryDisplayProperty?: string`\n\n- `requiredProperties?: string[]`\n\n- `restorable?: boolean`\n\n- `searchableProperties?: string[]`\n\n- `secondaryDisplayProperties?: string[]`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `description?: string`\n - `portalId?: number`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeDefinition = await client.cms.mediaBridge.updateSchema('objectType', { appId: 0, clearDescription: true });\n\nconsole.log(objectTypeDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updateSchema', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeDefinition = await client.cms.mediaBridge.updateSchema('objectType', {\n appId: 0,\n clearDescription: true,\n});\n\nconsole.log(objectTypeDefinition.id);", - }, - python: { - method: 'cms.media_bridge.update_schema', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_definition = client.cms.media_bridge.update_schema(\n object_type="objectType",\n app_id=0,\n clear_description=True,\n)\nprint(object_type_definition.id)', - }, - java: { - method: 'cms().mediaBridge().updateSchema', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinition;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionPatch;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateSchemaParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateSchemaParams params = MediaBridgeUpdateSchemaParams.builder()\n .appId(0)\n .objectType("objectType")\n .objectTypeDefinitionPatch(ObjectTypeDefinitionPatch.builder()\n .clearDescription(true)\n .build())\n .build();\n ObjectTypeDefinition objectTypeDefinition = client.cms().mediaBridge().updateSchema(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdateSchema', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeDefinition, err := client.Cms.MediaBridge.UpdateSchema(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeUpdateSchemaParams{\n\t\t\tAppID: 0,\n\t\t\tObjectTypeDefinitionPatch: shared.ObjectTypeDefinitionPatchParam{\n\t\t\t\tClearDescription: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeDefinition.ID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_schema', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_definition = hubspot.cms.media_bridge.update_schema("objectType", app_id: 0, clear_description: true)\n\nputs(object_type_definition)', - }, - php: { - method: 'cms->mediaBridge->updateSchema', - example: - "cms->mediaBridge->updateSchema(\n 'objectType',\n appID: 0,\n clearDescription: true,\n allowsSensitiveProperties: true,\n description: 'description',\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n primaryDisplayProperty: 'primaryDisplayProperty',\n requiredProperties: ['string'],\n restorable: true,\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n);\n\nvar_dump($objectTypeDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/schemas/$OBJECT_TYPE \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearDescription": true\n }\'', - }, - }, - }, - { - name: 'update_settings', - endpoint: '/media-bridge/2026-03/{appId}/settings', - httpMethod: 'put', - summary: 'Update the media bridge app name', - description: 'Update the name that your app will display when a user is selecting media bridge items.', - stainlessPath: '(resource) cms.media_bridge > (method) update_settings', - qualified: 'client.cms.mediaBridge.updateSettings', - params: [ - 'appId: number;', - 'updatedAt: number;', - 'allowImportOnDisconnect?: boolean;', - 'moduleName?: string;', - 'name?: string;', - ], - response: '{ appId: number; name: string; }', - markdown: - "## update_settings\n\n`client.cms.mediaBridge.updateSettings(appId: number, updatedAt: number, allowImportOnDisconnect?: boolean, moduleName?: string, name?: string): { appId: number; name: string; }`\n\n**put** `/media-bridge/2026-03/{appId}/settings`\n\nUpdate the name that your app will display when a user is selecting media bridge items.\n\n### Parameters\n\n- `appId: number`\n\n- `updatedAt: number`\n\n- `allowImportOnDisconnect?: boolean`\n\n- `moduleName?: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ appId: number; name: string; }`\n\n - `appId: number`\n - `name: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.updateSettings(0, { updatedAt: 0 });\n\nconsole.log(mediaBridgeProviderRegistrationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.updateSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst mediaBridgeProviderRegistrationResponse = await client.cms.mediaBridge.updateSettings(0, {\n updatedAt: 0,\n});\n\nconsole.log(mediaBridgeProviderRegistrationResponse.appId);", - }, - python: { - method: 'cms.media_bridge.update_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmedia_bridge_provider_registration_response = client.cms.media_bridge.update_settings(\n app_id=0,\n updated_at=0,\n)\nprint(media_bridge_provider_registration_response.app_id)', - }, - java: { - method: 'cms().mediaBridge().updateSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderPartial;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeProviderRegistrationResponse;\nimport com.hubspot.sdk.models.cms.mediabridge.MediaBridgeUpdateSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MediaBridgeUpdateSettingsParams params = MediaBridgeUpdateSettingsParams.builder()\n .appId(0)\n .mediaBridgeProviderPartial(MediaBridgeProviderPartial.builder()\n .updatedAt(0L)\n .build())\n .build();\n MediaBridgeProviderRegistrationResponse mediaBridgeProviderRegistrationResponse = client.cms().mediaBridge().updateSettings(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.UpdateSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmediaBridgeProviderRegistrationResponse, err := client.Cms.MediaBridge.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.MediaBridgeUpdateSettingsParams{\n\t\t\tMediaBridgeProviderPartial: cms.MediaBridgeProviderPartialParam{\n\t\t\t\tUpdatedAt: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", mediaBridgeProviderRegistrationResponse.AppID)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.update_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmedia_bridge_provider_registration_response = hubspot.cms.media_bridge.update_settings(0, updated_at: 0)\n\nputs(media_bridge_provider_registration_response)', - }, - php: { - method: 'cms->mediaBridge->updateSettings', - example: - "cms\n ->mediaBridge\n ->updateSettings(\n 0,\n updatedAt: 0,\n allowImportOnDisconnect: true,\n moduleName: 'moduleName',\n name: 'name',\n);\n\nvar_dump($mediaBridgeProviderRegistrationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/settings \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "updatedAt": 0\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create', - httpMethod: 'post', - summary: 'Create multiple properties', - description: 'Create a batch of properties of the specified object type.', - stainlessPath: '(resource) cms.media_bridge.batch > (method) create', - qualified: 'client.cms.mediaBridge.batch.create', - params: [ - 'appId: number;', - 'objectType: string;', - "inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[];", - ], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.cms.mediaBridge.batch.create(appId: number, objectType: string, inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]): { completedAt: string; results: media_bridge_property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create`\n\nCreate a batch of properties of the specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.create('objectType', { appId: 0, inputs: [{\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n}] });\n\nconsole.log(batchResponseProperty);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.create('objectType', {\n appId: 0,\n inputs: [\n {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n});\n\nconsole.log(batchResponseProperty.completedAt);", - }, - python: { - method: 'cms.media_bridge.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.cms.media_bridge.batch.create(\n object_type="objectType",\n app_id=0,\n inputs=[{\n "field_type": "booleancheckbox",\n "group_name": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n)\nprint(batch_response_property.completed_at)', - }, - java: { - method: 'cms().mediaBridge().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyCreate;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.cms.mediabridge.BatchResponseProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchInputPropertyCreate(BatchInputPropertyCreate.builder()\n .addInput(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.cms().mediaBridge().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Cms.MediaBridge.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchNewParams{\n\t\t\tAppID: 0,\n\t\t\tBatchInputPropertyCreate: shared.BatchInputPropertyCreateParam{\n\t\t\t\tInputs: []shared.PropertyCreateParam{{\n\t\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\t\tGroupName: "groupName",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.cms.media_bridge.batch.create(\n "objectType",\n app_id: 0,\n inputs: [{fieldType: :booleancheckbox, groupName: "groupName", label: "label", name: "name", type: :bool}]\n)\n\nputs(batch_response_property)', - }, - php: { - method: 'cms->mediaBridge->batch->create', - example: - "cms->mediaBridge->batch->create(\n 'objectType',\n appID: 0,\n inputs: [\n [\n 'fieldType' => 'booleancheckbox',\n 'groupName' => 'groupName',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'calculationFormula' => 'calculationFormula',\n 'currencyPropertyName' => 'currencyPropertyName',\n 'dataSensitivity' => 'highly_sensitive',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptions' => true,\n 'formField' => true,\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'referencedObjectType' => 'referencedObjectType',\n 'showCurrencySymbol' => true,\n ],\n ],\n);\n\nvar_dump($batchResponseProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive', - httpMethod: 'post', - summary: 'Archive multiple properties', - description: 'Archive a batch of existing properties for the specified types.', - stainlessPath: '(resource) cms.media_bridge.batch > (method) delete', - qualified: 'client.cms.mediaBridge.batch.delete', - params: ['appId: number;', 'objectType: string;', 'inputs: { name: string; }[];'], - markdown: - "## delete\n\n`client.cms.mediaBridge.batch.delete(appId: number, objectType: string, inputs: { name: string; }[]): void`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive`\n\nArchive a batch of existing properties for the specified types.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `inputs: { name: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.mediaBridge.batch.delete('objectType', { appId: 0, inputs: [{ name: 'name' }] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.mediaBridge.batch.delete('objectType', { appId: 0, inputs: [{ name: 'name' }] });", - }, - python: { - method: 'cms.media_bridge.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.media_bridge.batch.delete(\n object_type="objectType",\n app_id=0,\n inputs=[{\n "name": "name"\n }],\n)', - }, - java: { - method: 'cms().mediaBridge().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchInputPropertyName(BatchInputPropertyName.builder()\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n client.cms().mediaBridge().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.MediaBridge.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tBatchInputPropertyName: shared.BatchInputPropertyNameParam{\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.media_bridge.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.media_bridge.batch.delete("objectType", app_id: 0, inputs: [{name: "name"}])\n\nputs(result)', - }, - php: { - method: 'cms->mediaBridge->batch->delete', - example: - "cms->mediaBridge->batch->delete(\n 'objectType', appID: 0, inputs: [['name' => 'name']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read', - httpMethod: 'post', - summary: 'Get the details for multiple properties', - description: 'Get the details for a batch of properties for a specified object type.', - stainlessPath: '(resource) cms.media_bridge.batch > (method) get', - qualified: 'client.cms.mediaBridge.batch.get', - params: [ - 'appId: number;', - 'objectType: string;', - 'archived: boolean;', - "dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'inputs: { name: string; }[];', - ], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.cms.mediaBridge.batch.get(appId: number, objectType: string, archived: boolean, dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive', inputs: { name: string; }[]): { completedAt: string; results: media_bridge_property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read`\n\nGet the details for a batch of properties for a specified object type.\n\n### Parameters\n\n- `appId: number`\n\n- `objectType: string`\n\n- `archived: boolean`\n\n- `dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `inputs: { name: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { allowedObjectTypes: object_type_id_proto[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: automation_actions_option[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { allowedObjectTypes: { innerId: number; metaTypeId: number; }[]; calculated: boolean; canArchive: boolean; canRestore: boolean; createdAt: number; createdUserId: number; currencyPropertyName: string; dataSensitivity: 'high' | 'none' | 'standard'; dateDisplayHint: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; deleted: boolean; description: string; displayMode: 'all_unique_versions' | 'current_value'; displayOrder: number; enforceMultivalueUniqueness: boolean; externalOptions: boolean; externalOptionsReferenceType: string; favorited: boolean; favoritedOrder: number; fieldType: string; formField: boolean; fromUserId: number; groupName: string; hasUniqueValue: boolean; hidden: boolean; hubspotDefined: boolean; isCustomizedDefault: boolean; isMultiValued: boolean; isPartial: boolean; label: string; mutableDefinitionNotDeletable: boolean; name: string; numberDisplayHint: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options: { description: string; displayOrder: number; doubleData: number; hidden: boolean; label: string; readOnly: boolean; value: string; }[]; optionsAreMutable: boolean; optionSortStrategy: 'ALPHABETICAL' | 'DISPLAY_ORDER'; owningAppId: number; portalId: number; readOnlyDefinition: boolean; readOnlyValue: boolean; referencedObjectType: string; searchableInGlobalSearch: boolean; searchTextAnalysisMode: 'NONE' | 'NOT_ANALYZED_TEXT'; sensitiveDataCategories: string[]; showCurrencySymbol: boolean; textDisplayHint: string; type: string; updatedAt: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.get('objectType', {\n appId: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty);\n```", - perLanguage: { - typescript: { - method: 'client.cms.mediaBridge.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.cms.mediaBridge.batch.get('objectType', {\n appId: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty.completedAt);", - }, - python: { - method: 'cms.media_bridge.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.cms.media_bridge.batch.get(\n object_type="objectType",\n app_id=0,\n archived=True,\n data_sensitivity="highly_sensitive",\n inputs=[{\n "name": "name"\n }],\n)\nprint(batch_response_property.completed_at)', - }, - java: { - method: 'cms().mediaBridge().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchReadInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.cms.mediabridge.BatchResponseProperty;\nimport com.hubspot.sdk.models.cms.mediabridge.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .appId(0)\n .objectType("objectType")\n .batchReadInputPropertyName(BatchReadInputPropertyName.builder()\n .archived(true)\n .dataSensitivity(BatchReadInputPropertyName.DataSensitivity.HIGHLY_SENSITIVE)\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.cms().mediaBridge().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Cms.MediaBridge.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Cms.MediaBridge.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcms.MediaBridgeBatchGetParams{\n\t\t\tAppID: 0,\n\t\t\tBatchReadInputPropertyName: shared.BatchReadInputPropertyNameParam{\n\t\t\t\tArchived: true,\n\t\t\t\tDataSensitivity: shared.BatchReadInputPropertyNameDataSensitivityHighlySensitive,\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.media_bridge.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.cms.media_bridge.batch.get(\n "objectType",\n app_id: 0,\n archived: true,\n data_sensitivity: :highly_sensitive,\n inputs: [{name: "name"}]\n)\n\nputs(batch_response_property)', - }, - php: { - method: 'cms->mediaBridge->batch->get', - example: - "cms->mediaBridge->batch->get(\n 'objectType',\n appID: 0,\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [['name' => 'name']],\n);\n\nvar_dump($batchResponseProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/media-bridge/2026-03/$APP_ID/properties/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "archived": true,\n "dataSensitivity": "highly_sensitive",\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'clone', - endpoint: '/cms/pages/2026-03/landing-pages/clone', - httpMethod: 'post', - summary: 'Clone a landing page', - description: 'Create a copy of an existing landing page.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) clone', - qualified: 'client.cms.pages.landingPages.clone', - params: ['id: string;', 'cloneName?: string;'], - response: 'object', - markdown: - "## clone\n\n`client.cms.pages.landingPages.clone(id: string, cloneName?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/clone`\n\nCreate a copy of an existing landing page.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.clone({ id: 'id' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.clone', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.clone({ id: 'id' });\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.clone', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.clone(\n id="id",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().clone', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().clone(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Clone', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Clone(context.TODO(), cms.PageLandingPageCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.clone_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.clone_(id: "id")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->clone', - example: - "cms->pages->landingPages->clone(\n id: 'id', cloneName: 'cloneName'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/pages/2026-03/landing-pages', - httpMethod: 'post', - summary: 'Create a landing page', - description: 'Create a new landing page.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) create', - qualified: 'client.cms.pages.landingPages.create', - params: [ - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'object', - markdown: - "## create\n\n`client.cms.pages.landingPages.create(id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages`\n\nCreate a new landing page.\n\n### Parameters\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage params = PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.New(context.TODO(), cms.PageLandingPageNewParams{\n\t\tPagesPage: cms.PagesPageParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: time.Now(),\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPageRedirected: true,\n\t\t\tPassword: "password",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tSubcategory: "subcategory",\n\t\t\tTemplatePath: "templatePath",\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->create', - example: - "cms->pages->landingPages->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', - httpMethod: 'delete', - summary: 'Delete a landing page', - description: 'Delete a landing page, specified by its ID.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) delete', - qualified: 'client.cms.pages.landingPages.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.pages.landingPages.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nDelete a landing page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.delete('objectId');", - }, - python: { - method: 'cms.pages.landing_pages.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().pages().landingPages().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->delete', - example: - "cms->pages->landingPages->delete('objectId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a landing page', - description: 'Retrieve a landing page, specified by its ID.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) get', - qualified: 'client.cms.pages.landingPages.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: 'object', - markdown: - "## get\n\n`client.cms.pages.landingPages.get(objectId: string, archived?: boolean, property?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nRetrieve a landing page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n A specific property of the landing page to include in the response.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.get('objectId');\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.get('objectId');\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.get(\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().landingPages().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.get("objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->get', - example: - "cms->pages->landingPages->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/pages/2026-03/landing-pages', - httpMethod: 'get', - summary: 'List landing pages', - description: - 'Retrieve a list of landing pages in your HubSpot account. This endpoint allows you to filter landing pages based on creation and update timestamps, sort them, and paginate through results. You can also choose to include archived pages or specify certain properties to be included in the response.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) list', - qualified: 'client.cms.pages.landingPages.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'object', - markdown: - "## list\n\n`client.cms.pages.landingPages.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages`\n\nRetrieve a list of landing pages in your HubSpot account. This endpoint allows you to filter landing pages based on creation and update timestamps, sort them, and paginate through results. You can also choose to include archived pages or specify certain properties to be included in the response.\n\n### Parameters\n\n- `after?: string`\n A cursor token for pagination. Use the value from the previous response's paging.next.after field.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter landing pages created after a specific date and time.\n\n- `createdAt?: string`\n Filter landing pages by their creation timestamp.\n\n- `createdBefore?: string`\n Filter landing pages created before a specific date and time.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify which properties of the landing pages to include in the response.\n\n- `sort?: string[]`\n Specify the order in which results are returned. Accepts an array of strings.\n\n- `updatedAfter?: string`\n Filter landing pages updated after a specific date and time.\n\n- `updatedAt?: string`\n Filter landing pages by their last updated timestamp.\n\n- `updatedBefore?: string`\n Filter landing pages updated before a specific date and time.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.landingPages.list()) {\n console.log(pagesPage);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.landingPages.list()) {\n console.log(pagesPage.id);\n}", - }, - python: { - method: 'cms.pages.landing_pages.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().landingPages().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageListPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LandingPageListPage page = client.cms().pages().landingPages().list();\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.List(context.TODO(), cms.PageLandingPageListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.list\n\nputs(page)', - }, - php: { - method: 'cms->pages->landingPages->list', - example: - "cms->pages->landingPages->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'schedule', - endpoint: '/cms/pages/2026-03/landing-pages/schedule', - httpMethod: 'post', - summary: 'Schedule landing page publishing', - description: 'Schedule a landing page to be published.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) schedule', - qualified: 'client.cms.pages.landingPages.schedule', - params: ['id: string;', 'publishDate: string;'], - markdown: - "## schedule\n\n`client.cms.pages.landingPages.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/schedule`\n\nSchedule a landing page to be published.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.schedule', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", - }, - python: { - method: 'cms.pages.landing_pages.schedule', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', - }, - java: { - method: 'cms().pages().landingPages().schedule', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().pages().landingPages().schedule(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Schedule', - example: - 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Schedule(context.TODO(), cms.PageLandingPageScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.schedule', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->schedule', - example: - "cms->pages->landingPages->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}', - httpMethod: 'patch', - summary: 'Update a landing page', - description: - 'Sparse updates a single Landing Page object identified by the id in the path.\nYou only need to specify the column values that you are modifying.', - stainlessPath: '(resource) cms.pages.landing-pages > (method) update', - qualified: 'client.cms.pages.landingPages.update', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - 'archived?: boolean;', - ], - response: 'object', - markdown: - "## update\n\n`client.cms.pages.landingPages.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/{objectId}`\n\nSparse updates a single Landing Page object identified by the id in the path.\nYou only need to specify the column values that you are modifying.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.LandingPageUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LandingPageUpdateParams params = LandingPageUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->update', - example: - "cms->pages->landingPages->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'create_landing_page_variation', - endpoint: '/cms/pages/2026-03/landing-pages/ab-test/create-variation', - httpMethod: 'post', - summary: 'Create a new A/B test variation', - description: 'Create a new A/B test variation based on the information provided in the request body.\n', - stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) create_landing_page_variation', - qualified: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', - params: ['contentId: string;', 'variationName: string;'], - response: 'object', - markdown: - "## create_landing_page_variation\n\n`client.cms.pages.landingPages.abTest.createLandingPageVariation(contentId: string, variationName: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/create-variation`\n\nCreate a new A/B test variation based on the information provided in the request body.\n\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.abTest.createLandingPageVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.abTest.createLandingPageVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.ab_test.create_landing_page_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.ab_test.create_landing_page_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().abTest().createLandingPageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().abTest().createLandingPageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.AbTest.NewLandingPageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.AbTest.NewLandingPageVariation(context.TODO(), cms.PageLandingPageAbTestNewLandingPageVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.ab_test.create_landing_page_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.ab_test.create_landing_page_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->abTest->createLandingPageVariation', - example: - "cms\n ->pages\n ->landingPages\n ->abTest\n ->createLandingPageVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/create-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', - }, - }, - }, - { - name: 'end_landing_page_test', - endpoint: '/cms/pages/2026-03/landing-pages/ab-test/end', - httpMethod: 'post', - summary: 'End an active A/B test', - description: 'End an active A/B test and designate a winner.', - stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) end_landing_page_test', - qualified: 'client.cms.pages.landingPages.abTest.endLandingPageTest', - params: ['abTestId: string;', 'winnerId: string;'], - markdown: - "## end_landing_page_test\n\n`client.cms.pages.landingPages.abTest.endLandingPageTest(abTestId: string, winnerId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/end`\n\nEnd an active A/B test and designate a winner.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to end.\n\n- `winnerId: string`\n ID of the object to designate as the test winner.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.abTest.endLandingPageTest({ abTestId: 'abTestId', winnerId: 'winnerId' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.abTest.endLandingPageTest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.abTest.endLandingPageTest({\n abTestId: 'abTestId',\n winnerId: 'winnerId',\n});", - }, - python: { - method: 'cms.pages.landing_pages.ab_test.end_landing_page_test', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.ab_test.end_landing_page_test(\n ab_test_id="abTestId",\n winner_id="winnerId",\n)', - }, - java: { - method: 'cms().pages().landingPages().abTest().endLandingPageTest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestEndRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestEndRequestVNext params = AbTestEndRequestVNext.builder()\n .abTestId("abTestId")\n .winnerId("winnerId")\n .build();\n client.cms().pages().landingPages().abTest().endLandingPageTest(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.AbTest.EndLandingPageTest', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.AbTest.EndLandingPageTest(context.TODO(), cms.PageLandingPageAbTestEndLandingPageTestParams{\n\t\tAbTestEndRequestVNext: cms.AbTestEndRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tWinnerID: "winnerId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.ab_test.end_landing_page_test', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.ab_test.end_landing_page_test(\n ab_test_id: "abTestId",\n winner_id: "winnerId"\n)\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->abTest->endLandingPageTest', - example: - "cms->pages->landingPages->abTest->endLandingPageTest(\n abTestID: 'abTestId', winnerID: 'winnerId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/end \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "winnerId": "winnerId"\n }\'', - }, - }, - }, - { - name: 'rerun_landing_page_test', - endpoint: '/cms/pages/2026-03/landing-pages/ab-test/rerun', - httpMethod: 'post', - summary: 'Rerun a previous A/B test', - description: 'Rerun a previous A/B test.', - stainlessPath: '(resource) cms.pages.landing-pages.ab-test > (method) rerun_landing_page_test', - qualified: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', - params: ['abTestId: string;', 'variationId: string;'], - markdown: - "## rerun_landing_page_test\n\n`client.cms.pages.landingPages.abTest.rerunLandingPageTest(abTestId: string, variationId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/ab-test/rerun`\n\nRerun a previous A/B test.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to rerun.\n\n- `variationId: string`\n ID of the object to reactivate as a test variation.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.abTest.rerunLandingPageTest({ abTestId: 'abTestId', variationId: 'variationId' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.abTest.rerunLandingPageTest({\n abTestId: 'abTestId',\n variationId: 'variationId',\n});", - }, - python: { - method: 'cms.pages.landing_pages.ab_test.rerun_landing_page_test', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.ab_test.rerun_landing_page_test(\n ab_test_id="abTestId",\n variation_id="variationId",\n)', - }, - java: { - method: 'cms().pages().landingPages().abTest().rerunLandingPageTest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestRerunRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestRerunRequestVNext params = AbTestRerunRequestVNext.builder()\n .abTestId("abTestId")\n .variationId("variationId")\n .build();\n client.cms().pages().landingPages().abTest().rerunLandingPageTest(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.AbTest.RerunLandingPageTest', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.AbTest.RerunLandingPageTest(context.TODO(), cms.PageLandingPageAbTestRerunLandingPageTestParams{\n\t\tAbTestRerunRequestVNext: cms.AbTestRerunRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tVariationID: "variationId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.ab_test.rerun_landing_page_test', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.ab_test.rerun_landing_page_test(\n ab_test_id: "abTestId",\n variation_id: "variationId"\n)\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->abTest->rerunLandingPageTest', - example: - "cms->pages->landingPages->abTest->rerunLandingPageTest(\n abTestID: 'abTestId', variationID: 'variationId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/ab-test/rerun \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "variationId": "variationId"\n }\'', - }, - }, - }, - { - name: 'create_landing_pages', - endpoint: '/cms/pages/2026-03/landing-pages/batch/create', - httpMethod: 'post', - summary: 'Create landing pages', - description: 'Create a batch of landing pages as detailed in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) create_landing_pages', - qualified: 'client.cms.pages.landingPages.batch.createLandingPages', - params: [ - 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', - ], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create_landing_pages\n\n`client.cms.pages.landingPages.batch.createLandingPages(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/create`\n\nCreate a batch of landing pages as detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Pages to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.createLandingPages({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.batch.createLandingPages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.createLandingPages({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.batch.create_landing_pages', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.create_landing_pages(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "page_redirected": True,\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "template_path": "templatePath",\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().batch().createLandingPages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.BatchInputPage;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPage params = BatchInputPage.builder()\n .addInput(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().createLandingPages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Batch.NewLandingPages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.NewLandingPages(context.TODO(), cms.PageLandingPageBatchNewLandingPagesParams{\n\t\tBatchInputPage: cms.BatchInputPageParam{\n\t\t\tInputs: []cms.PagesPageParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.batch.create_landing_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.create_landing_pages(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: "2019-12-27T18:11:19.117Z",\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n pageRedirected: true,\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n templatePath: "templatePath",\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->landingPages->batch->createLandingPages', - example: - "cms\n ->pages\n ->landingPages\n ->batch\n ->createLandingPages(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'pageRedirected' => true,\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'slug' => 'slug',\n 'state' => 'state',\n 'subcategory' => 'subcategory',\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_landing_pages', - endpoint: '/cms/pages/2026-03/landing-pages/batch/archive', - httpMethod: 'post', - summary: 'Delete landing pages', - description: - 'Delete landing pages specified by ID in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', - stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) delete_landing_pages', - qualified: 'client.cms.pages.landingPages.batch.deleteLandingPages', - params: ['inputs: string[];'], - markdown: - "## delete_landing_pages\n\n`client.cms.pages.landingPages.batch.deleteLandingPages(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/archive`\n\nDelete landing pages specified by ID in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.batch.deleteLandingPages({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.batch.deleteLandingPages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.batch.deleteLandingPages({ inputs: ['string'] });", - }, - python: { - method: 'cms.pages.landing_pages.batch.delete_landing_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.batch.delete_landing_pages(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().pages().landingPages().batch().deleteLandingPages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().landingPages().batch().deleteLandingPages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Batch.DeleteLandingPages', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Batch.DeleteLandingPages(context.TODO(), cms.PageLandingPageBatchDeleteLandingPagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.batch.delete_landing_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.batch.delete_landing_pages(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->batch->deleteLandingPages', - example: - "cms->pages->landingPages->batch->deleteLandingPages(\n inputs: ['string']\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_landing_pages', - endpoint: '/cms/pages/2026-03/landing-pages/batch/read', - httpMethod: 'post', - summary: 'Retrieve landing pages', - description: 'Retrieve a batch of landing pages as specified in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) get_landing_pages', - qualified: 'client.cms.pages.landingPages.batch.getLandingPages', - params: ['inputs: string[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_landing_pages\n\n`client.cms.pages.landingPages.batch.getLandingPages(inputs: string[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/read`\n\nRetrieve a batch of landing pages as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.getLandingPages({ inputs: ['string'] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.batch.getLandingPages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.getLandingPages({\n inputs: ['string'],\n});\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.batch.get_landing_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.get_landing_pages(\n inputs=["string"],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().batch().getLandingPages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().getLandingPages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Batch.GetLandingPages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.GetLandingPages(context.TODO(), cms.PageLandingPageBatchGetLandingPagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.batch.get_landing_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.get_landing_pages(inputs: ["string"])\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->landingPages->batch->getLandingPages', - example: - "cms->pages->landingPages->batch->getLandingPages(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update_landing_pages', - endpoint: '/cms/pages/2026-03/landing-pages/batch/update', - httpMethod: 'post', - summary: 'Update landing pages', - description: 'Update a batch of landing pages as specified in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.batch > (method) update_landing_pages', - qualified: 'client.cms.pages.landingPages.batch.updateLandingPages', - params: ['inputs: object[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update_landing_pages\n\n`client.cms.pages.landingPages.batch.updateLandingPages(inputs: object[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/batch/update`\n\nUpdate a batch of landing pages as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.updateLandingPages({ inputs: [{}] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.batch.updateLandingPages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.landingPages.batch.updateLandingPages({\n inputs: [{}],\n});\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.batch.update_landing_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.landing_pages.batch.update_landing_pages(\n inputs=[{}],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().batch().updateLandingPages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().landingPages().batch().updateLandingPages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Batch.UpdateLandingPages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.LandingPages.Batch.UpdateLandingPages(context.TODO(), cms.PageLandingPageBatchUpdateLandingPagesParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.batch.update_landing_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.landing_pages.batch.update_landing_pages(inputs: [{}])\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->landingPages->batch->updateLandingPages', - example: - "cms\n ->pages\n ->landingPages\n ->batch\n ->updateLandingPages(inputs: [(object) []], archived: true);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft', - httpMethod: 'get', - summary: 'Retrieve a landing page draft', - description: 'Retrieve the full draft version of a landing page, specified by page ID.', - stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) get', - qualified: 'client.cms.pages.landingPages.draft.get', - params: ['objectId: string;'], - response: 'object', - markdown: - "## get\n\n`client.cms.pages.landingPages.draft.get(objectId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/draft`\n\nRetrieve the full draft version of a landing page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.draft.get('objectId');\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.draft.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.draft.get('objectId');\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.draft.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.draft.get(\n "objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().draft().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().landingPages().draft().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Draft.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Draft.Get(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.draft.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.draft.get("objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->draft->get', - example: - "cms->pages->landingPages->draft->get('objectId');\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'push_live', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live', - httpMethod: 'post', - summary: 'Push Landing Page draft edits live', - description: - 'Take any changes from the draft version of the Landing Page and apply them to the live version.', - stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) push_live', - qualified: 'client.cms.pages.landingPages.draft.pushLive', - params: ['objectId: string;'], - markdown: - "## push_live\n\n`client.cms.pages.landingPages.draft.pushLive(objectId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live`\n\nTake any changes from the draft version of the Landing Page and apply them to the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.draft.pushLive('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.draft.pushLive', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.draft.pushLive('objectId');", - }, - python: { - method: 'cms.pages.landing_pages.draft.push_live', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.draft.push_live(\n "objectId",\n)', - }, - java: { - method: 'cms().pages().landingPages().draft().pushLive', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftPushLiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().draft().pushLive("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Draft.PushLive', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Draft.PushLive(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.draft.push_live', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.draft.push_live("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->draft->pushLive', - example: - "cms->pages->landingPages->draft->pushLive('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft/reset', - httpMethod: 'post', - summary: 'Reset a landing page draft', - description: 'Discards any edits and resets the draft to match the live version.', - stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) reset', - qualified: 'client.cms.pages.landingPages.draft.reset', - params: ['objectId: string;'], - markdown: - "## reset\n\n`client.cms.pages.landingPages.draft.reset(objectId: string): void`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/draft/reset`\n\nDiscards any edits and resets the draft to match the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.draft.reset('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.draft.reset', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.draft.reset('objectId');", - }, - python: { - method: 'cms.pages.landing_pages.draft.reset', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.draft.reset(\n "objectId",\n)', - }, - java: { - method: 'cms().pages().landingPages().draft().reset', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftResetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().draft().reset("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Draft.Reset', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Draft.Reset(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.draft.reset', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.draft.reset("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->draft->reset', - example: - "cms->pages->landingPages->draft->reset('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/draft', - httpMethod: 'patch', - summary: 'Update the draft of a landing page', - description: - 'Partially updates the draft version of a single landing page, specified by its ID. You only need to specify the column values that you are modifying.\n', - stainlessPath: '(resource) cms.pages.landing-pages.draft > (method) update', - qualified: 'client.cms.pages.landingPages.draft.update', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'object', - markdown: - "## update\n\n`client.cms.pages.landingPages.draft.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/{objectId}/draft`\n\nPartially updates the draft version of a single landing page, specified by its ID. You only need to specify the column values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.draft.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.draft.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.draft.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.draft.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.draft.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().draft().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.draft.DraftUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DraftUpdateParams params = DraftUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().draft().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Draft.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Draft.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageDraftUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.draft.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.draft.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->draft->update', - example: - "cms->pages->landingPages->draft->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'batch_get', - endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/read', - httpMethod: 'post', - summary: 'Retrieve folders', - description: 'Retrieve a batch of landing page folders as identified in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) batch_get', - qualified: 'client.cms.pages.landingPages.folders.batchGet', - params: ['inputs: string[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## batch_get\n\n`client.cms.pages.landingPages.folders.batchGet(inputs: string[], archived?: boolean): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/read`\n\nRetrieve a batch of landing page folders as identified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.batchGet({ inputs: ['string'] });\n\nconsole.log(batchResponseContentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.batchGet', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.batchGet({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.folders.batch_get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.batch_get(\n inputs=["string"],\n)\nprint(batch_response_content_folder.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().folders().batchGet', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().batchGet(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.BatchGet', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.BatchGet(context.TODO(), cms.PageLandingPageFolderBatchGetParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.batch_get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.batch_get(inputs: ["string"])\n\nputs(batch_response_content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->batchGet', - example: - "cms\n ->pages\n ->landingPages\n ->folders\n ->batchGet(inputs: ['string'], archived: true);\n\nvar_dump($batchResponseContentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/pages/2026-03/landing-pages/folders', - httpMethod: 'post', - summary: 'Create a landing page folder', - description: 'Create a new folder for landing pages.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) create', - qualified: 'client.cms.pages.landingPages.folders.create', - params: [ - 'id: string;', - 'category: number;', - 'created: string;', - 'deletedAt: string;', - 'name: string;', - 'parentFolderId: number;', - 'updated: string;', - ], - response: - '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', - markdown: - "## create\n\n`client.cms.pages.landingPages.folders.create(id: string, category: number, created: string, deletedAt: string, name: string, parentFolderId: number, updated: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders`\n\nCreate a new folder for landing pages.\n\n### Parameters\n\n- `id: string`\n The unique ID of the content folder.\n\n- `category: number`\n The type of object this folder applies to. Should always be LANDING_PAGE.\n\n- `created: string`\n The timestamp indicating when the content folder was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this content folder was deleted.\n\n- `name: string`\n The name of the folder which will show up in the app dashboard\n\n- `parentFolderId: number`\n The ID of the content folder this folder is nested under\n\n- `updated: string`\n The timestamp indicating when the content folder was last updated.\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.create({\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.create({\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder.id);", - }, - python: { - method: 'cms.pages.landing_pages.folders.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.create(\n id="id",\n category=0,\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n name="name",\n parent_folder_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(content_folder.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentFolder params = ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.New(context.TODO(), cms.PageLandingPageFolderNewParams{\n\t\tContentFolder: cms.ContentFolderParam{\n\t\t\tID: "id",\n\t\t\tCategory: 0,\n\t\t\tCreated: time.Now(),\n\t\t\tDeletedAt: time.Now(),\n\t\t\tName: "name",\n\t\t\tParentFolderID: 0,\n\t\t\tUpdated: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.create(\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n name: "name",\n parent_folder_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->create', - example: - "cms->pages->landingPages->folders->create(\n id: 'id',\n category: 0,\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n name: 'name',\n parentFolderID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($contentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'create_folders', - endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/create', - httpMethod: 'post', - summary: 'Create folders', - description: 'Create a batch of folders as detailed in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) create_folders', - qualified: 'client.cms.pages.landingPages.folders.createFolders', - params: [ - 'inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create_folders\n\n`client.cms.pages.landingPages.folders.createFolders(inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/create`\n\nCreate a batch of folders as detailed in the request body.\n\n### Parameters\n\n- `inputs: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n Content folders to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.createFolders({ inputs: [{\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n}] });\n\nconsole.log(batchResponseContentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.createFolders', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.createFolders({\n inputs: [\n {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n },\n ],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.folders.create_folders', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.create_folders(\n inputs=[{\n "id": "id",\n "category": 0,\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "deleted_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "parent_folder_id": 0,\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }],\n)\nprint(batch_response_content_folder.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().folders().createFolders', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.BatchInputContentFolder;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputContentFolder params = BatchInputContentFolder.builder()\n .addInput(ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().createFolders(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.NewFolders', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.NewFolders(context.TODO(), cms.PageLandingPageFolderNewFoldersParams{\n\t\tBatchInputContentFolder: cms.BatchInputContentFolderParam{\n\t\t\tInputs: []cms.ContentFolderParam{{\n\t\t\t\tID: "id",\n\t\t\t\tCategory: 0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tName: "name",\n\t\t\t\tParentFolderID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.create_folders', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.create_folders(\n inputs: [\n {\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deletedAt: "2019-12-27T18:11:19.117Z",\n name: "name",\n parentFolderId: 0,\n updated: "2019-12-27T18:11:19.117Z"\n }\n ]\n)\n\nputs(batch_response_content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->createFolders', - example: - "cms\n ->pages\n ->landingPages\n ->folders\n ->createFolders(\n inputs: [\n [\n 'id' => 'id',\n 'category' => 0,\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'deletedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'parentFolderID' => 0,\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseContentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - httpMethod: 'delete', - summary: 'Delete a landing page folder', - description: 'Delete a landing page folder, specified by its ID.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) delete', - qualified: 'client.cms.pages.landingPages.folders.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.pages.landingPages.folders.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nDelete a landing page folder, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.folders.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.folders.delete('objectId');", - }, - python: { - method: 'cms.pages.landing_pages.folders.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.folders.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().pages().landingPages().folders().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().landingPages().folders().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Folders.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.folders.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->folders->delete', - example: - "cms->pages->landingPages->folders->delete(\n 'objectId', archived: true\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_folders', - endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/archive', - httpMethod: 'post', - summary: 'Delete folders', - description: 'Delete a batch of folders as specified in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) delete_folders', - qualified: 'client.cms.pages.landingPages.folders.deleteFolders', - params: ['inputs: string[];'], - markdown: - "## delete_folders\n\n`client.cms.pages.landingPages.folders.deleteFolders(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/archive`\n\nDelete a batch of folders as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.folders.deleteFolders({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.deleteFolders', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.folders.deleteFolders({ inputs: ['string'] });", - }, - python: { - method: 'cms.pages.landing_pages.folders.delete_folders', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.folders.delete_folders(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().pages().landingPages().folders().deleteFolders', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().landingPages().folders().deleteFolders(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.DeleteFolders', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.Folders.DeleteFolders(context.TODO(), cms.PageLandingPageFolderDeleteFoldersParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.delete_folders', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.folders.delete_folders(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->folders->deleteFolders', - example: - "cms->pages->landingPages->folders->deleteFolders(\n inputs: ['string']\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a landing page folder', - description: 'Retrieve a landing page folder, specified by its ID.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) get', - qualified: 'client.cms.pages.landingPages.folders.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: - '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', - markdown: - "## get\n\n`client.cms.pages.landingPages.folders.get(objectId: string, archived?: boolean, property?: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nRetrieve a landing page folder, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.get('objectId');\n\nconsole.log(contentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.get('objectId');\n\nconsole.log(contentFolder.id);", - }, - python: { - method: 'cms.pages.landing_pages.folders.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.get(\n object_id="objectId",\n)\nprint(content_folder.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.get("objectId")\n\nputs(content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->get', - example: - "cms->pages->landingPages->folders->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($contentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_revision', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Retrieve a previous version of a folder', - description: 'Retrieve a previous version of a folder, specified by the folder ID and revision ID.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) get_revision', - qualified: 'client.cms.pages.landingPages.folders.getRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: - '{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', - markdown: - "## get_revision\n\n`client.cms.pages.landingPages.folders.getRevision(objectId: string, revisionId: string): { id: string; object: content_folder; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a folder, specified by the folder ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolderVersion = await client.cms.pages.landingPages.folders.getRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(contentFolderVersion);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.getRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolderVersion = await client.cms.pages.landingPages.folders.getRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(contentFolderVersion.id);", - }, - python: { - method: 'cms.pages.landing_pages.folders.get_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder_version = client.cms.pages.landing_pages.folders.get_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(content_folder_version.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().getRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolderVersion;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderGetRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderGetRevisionParams params = FolderGetRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n ContentFolderVersion contentFolderVersion = client.cms().pages().landingPages().folders().getRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.GetRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolderVersion, err := client.Cms.Pages.LandingPages.Folders.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageFolderGetRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolderVersion.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.get_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder_version = hubspot.cms.pages.landing_pages.folders.get_revision("revisionId", object_id_: "objectId")\n\nputs(content_folder_version)', - }, - php: { - method: 'cms->pages->landingPages->folders->getRevision', - example: - "cms->pages->landingPages->folders->getRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($contentFolderVersion);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/pages/2026-03/landing-pages/folders', - httpMethod: 'get', - summary: 'Get all landing page folders', - description: - 'Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) list', - qualified: 'client.cms.pages.landingPages.folders.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', - markdown: - "## list\n\n`client.cms.pages.landingPages.folders.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders`\n\nGet the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter folders created after the specified date and time.\n\n- `createdAt?: string`\n Filter folders by their exact creation date and time.\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify a property to include in the response.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolder of client.cms.pages.landingPages.folders.list()) {\n console.log(contentFolder);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolder of client.cms.pages.landingPages.folders.list()) {\n console.log(contentFolder.id);\n}", - }, - python: { - method: 'cms.pages.landing_pages.folders.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.folders.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderListPage page = client.cms().pages().landingPages().folders().list();\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Folders.List(context.TODO(), cms.PageLandingPageFolderListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.folders.list\n\nputs(page)', - }, - php: { - method: 'cms->pages->landingPages->folders->list', - example: - "cms->pages->landingPages->folders->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_revisions', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions', - httpMethod: 'get', - summary: 'Retrieves previous versions of a folder', - description: 'Retrieves all the previous versions of a landing page folder.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) list_revisions', - qualified: 'client.cms.pages.landingPages.folders.listRevisions', - params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: - '{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }', - markdown: - "## list_revisions\n\n`client.cms.pages.landingPages.folders.listRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: content_folder; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions`\n\nRetrieves all the previous versions of a landing page folder.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolderVersion of client.cms.pages.landingPages.folders.listRevisions('objectId')) {\n console.log(contentFolderVersion);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.listRevisions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contentFolderVersion of client.cms.pages.landingPages.folders.listRevisions(\n 'objectId',\n)) {\n console.log(contentFolderVersion.id);\n}", - }, - python: { - method: 'cms.pages.landing_pages.folders.list_revisions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.folders.list_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().listRevisions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderListRevisionsPage page = client.cms().pages().landingPages().folders().listRevisions("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.ListRevisions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Folders.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.list_revisions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.folders.list_revisions("objectId")\n\nputs(page)', - }, - php: { - method: 'cms->pages->landingPages->folders->listRevisions', - example: - "cms->pages->landingPages->folders->listRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_revision', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore', - httpMethod: 'post', - summary: 'Restore a previous version of a folder', - description: 'Takes a specified version of a landing page folder and restores it.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) restore_revision', - qualified: 'client.cms.pages.landingPages.folders.restoreRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: - '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', - markdown: - "## restore_revision\n\n`client.cms.pages.landingPages.folders.restoreRevision(objectId: string, revisionId: string): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore`\n\nTakes a specified version of a landing page folder and restores it.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.restoreRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(contentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.restoreRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.restoreRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(contentFolder.id);", - }, - python: { - method: 'cms.pages.landing_pages.folders.restore_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.restore_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(content_folder.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().restoreRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderRestoreRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderRestoreRevisionParams params = FolderRestoreRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().restoreRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.RestoreRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.RestoreRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageFolderRestoreRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.restore_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.restore_revision("revisionId", object_id_: "objectId")\n\nputs(content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->restoreRevision', - example: - "cms->pages->landingPages->folders->restoreRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($contentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - httpMethod: 'patch', - summary: 'Update a landing page folder', - description: - 'Partially update a landing page folder, specified by the folder ID. You only need to specify the details values that you are modifying.\n', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) update', - qualified: 'client.cms.pages.landingPages.folders.update', - params: [ - 'objectId: string;', - 'id: string;', - 'category: number;', - 'created: string;', - 'deletedAt: string;', - 'name: string;', - 'parentFolderId: number;', - 'updated: string;', - 'archived?: boolean;', - ], - response: - '{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }', - markdown: - "## update\n\n`client.cms.pages.landingPages.folders.update(objectId: string, id: string, category: number, created: string, deletedAt: string, name: string, parentFolderId: number, updated: string, archived?: boolean): { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n**patch** `/cms/pages/2026-03/landing-pages/folders/{objectId}`\n\nPartially update a landing page folder, specified by the folder ID. You only need to specify the details values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the content folder.\n\n- `category: number`\n The type of object this folder applies to. Should always be LANDING_PAGE.\n\n- `created: string`\n The timestamp indicating when the content folder was created.\n\n- `deletedAt: string`\n The timestamp (ISO8601 format) when this content folder was deleted.\n\n- `name: string`\n The name of the folder which will show up in the app dashboard\n\n- `parentFolderId: number`\n The ID of the content folder this folder is nested under\n\n- `updated: string`\n The timestamp indicating when the content folder was last updated.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }`\n\n - `id: string`\n - `category: number`\n - `created: string`\n - `deletedAt: string`\n - `name: string`\n - `parentFolderId: number`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst contentFolder = await client.cms.pages.landingPages.folders.update('objectId', {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst contentFolder = await client.cms.pages.landingPages.folders.update('objectId', {\n id: 'id',\n category: 0,\n created: '2019-12-27T18:11:19.117Z',\n deletedAt: '2019-12-27T18:11:19.117Z',\n name: 'name',\n parentFolderId: 0,\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(contentFolder.id);", - }, - python: { - method: 'cms.pages.landing_pages.folders.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncontent_folder = client.cms.pages.landing_pages.folders.update(\n object_id="objectId",\n id="id",\n category=0,\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n deleted_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n name="name",\n parent_folder_id=0,\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(content_folder.id)', - }, - java: { - method: 'cms().pages().landingPages().folders().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentFolder;\nimport com.hubspot.sdk.models.cms.pages.landingpages.folders.FolderUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateParams params = FolderUpdateParams.builder()\n .objectId("objectId")\n .contentFolder(ContentFolder.builder()\n .id("id")\n .category(0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .deletedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .name("name")\n .parentFolderId(0L)\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n ContentFolder contentFolder = client.cms().pages().landingPages().folders().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcontentFolder, err := client.Cms.Pages.LandingPages.Folders.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageFolderUpdateParams{\n\t\t\tContentFolder: cms.ContentFolderParam{\n\t\t\t\tID: "id",\n\t\t\t\tCategory: 0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDeletedAt: time.Now(),\n\t\t\t\tName: "name",\n\t\t\t\tParentFolderID: 0,\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", contentFolder.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncontent_folder = hubspot.cms.pages.landing_pages.folders.update(\n "objectId",\n id: "id",\n category: 0,\n created: "2019-12-27T18:11:19.117Z",\n deleted_at: "2019-12-27T18:11:19.117Z",\n name: "name",\n parent_folder_id: 0,\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->update', - example: - "cms->pages->landingPages->folders->update(\n 'objectId',\n id: 'id',\n category: 0,\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n deletedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n name: 'name',\n parentFolderID: 0,\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archived: true,\n);\n\nvar_dump($contentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "category": 0,\n "created": "2019-12-27T18:11:19.117Z",\n "deletedAt": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "parentFolderId": 0,\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'update_folders', - endpoint: '/cms/pages/2026-03/landing-pages/folders/batch/update', - httpMethod: 'post', - summary: 'Update folders', - description: 'Update a batch of landing page folders as specified in the request body.', - stainlessPath: '(resource) cms.pages.landing-pages.folders > (method) update_folders', - qualified: 'client.cms.pages.landingPages.folders.updateFolders', - params: ['inputs: object[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update_folders\n\n`client.cms.pages.landingPages.folders.updateFolders(inputs: object[], archived?: boolean): { completedAt: string; results: content_folder[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/landing-pages/folders/batch/update`\n\nUpdate a batch of landing page folders as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; category: number; created: string; deletedAt: string; name: string; parentFolderId: number; updated: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.updateFolders({ inputs: [{}] });\n\nconsole.log(batchResponseContentFolder);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.folders.updateFolders', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseContentFolder = await client.cms.pages.landingPages.folders.updateFolders({\n inputs: [{}],\n});\n\nconsole.log(batchResponseContentFolder.completedAt);", - }, - python: { - method: 'cms.pages.landing_pages.folders.update_folders', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_content_folder = client.cms.pages.landing_pages.folders.update_folders(\n inputs=[{}],\n)\nprint(batch_response_content_folder.completed_at)', - }, - java: { - method: 'cms().pages().landingPages().folders().updateFolders', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponseContentFolder;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponseContentFolder batchResponseContentFolder = client.cms().pages().landingPages().folders().updateFolders(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Folders.UpdateFolders', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseContentFolder, err := client.Cms.Pages.LandingPages.Folders.UpdateFolders(context.TODO(), cms.PageLandingPageFolderUpdateFoldersParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseContentFolder.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.folders.update_folders', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_content_folder = hubspot.cms.pages.landing_pages.folders.update_folders(inputs: [{}])\n\nputs(batch_response_content_folder)', - }, - php: { - method: 'cms->pages->landingPages->folders->updateFolders', - example: - "cms\n ->pages\n ->landingPages\n ->folders\n ->updateFolders(inputs: [(object) []], archived: true);\n\nvar_dump($batchResponseContentFolder);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/folders/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Add a landing page to a multi-language group', - description: 'Attach a landing page to a multi-language group.', - stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) attach_to_lang_group', - qualified: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.pages.landingPages.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group`\n\nAttach a landing page to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.landing_pages.multi_language.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().landingPages().multiLanguage().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.MultiLanguage.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.AttachToLangGroup(context.TODO(), cms.PageLandingPageMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.multi_language.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->pages->landingPages->multiLanguage->attachToLangGroup', - example: - "cms->pages->landingPages->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create_language_variation', - endpoint: '/cms/pages/2026-03/landing-pages/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a new language variation', - description: - 'Create a new language variation from an existing landing page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source landing page](/api-reference/latest/cms/pages/landing-pages/drafts/get-landing-page-draft).', - stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) create_language_variation', - qualified: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', - params: ['id: string;', 'language?: string;', 'primaryLanguage?: string;', 'usePublished?: boolean;'], - response: 'object', - markdown: - "## create_language_variation\n\n`client.cms.pages.landingPages.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, usePublished?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/create-language-variation`\n\nCreate a new language variation from an existing landing page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source landing page](/api-reference/latest/cms/pages/landing-pages/drafts/get-landing-page-draft).\n\n### Parameters\n\n- `id: string`\n ID of content to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary content to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.multiLanguage.createLanguageVariation({\n id: 'id',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.multi_language.create_language_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.multi_language.create_language_variation(\n id="id",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().multiLanguage().createLanguageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentLanguageCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentLanguageCloneRequestVNext params = ContentLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().multiLanguage().createLanguageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.MultiLanguage.NewLanguageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.MultiLanguage.NewLanguageVariation(context.TODO(), cms.PageLandingPageMultiLanguageNewLanguageVariationParams{\n\t\tContentLanguageCloneRequestVNext: cms.ContentLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.multi_language.create_language_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.multi_language.create_language_variation(id: "id")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->multiLanguage->createLanguageVariation', - example: - "cms\n ->pages\n ->landingPages\n ->multiLanguage\n ->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Remove a landing page from a multi-language group', - description: 'Detach a landing page from a multi-language group.', - stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) detach_from_lang_group', - qualified: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.pages.landingPages.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group`\n\nDetach a landing page from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.detachFromLangGroup({\n id: 'id',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.landing_pages.multi_language.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().landingPages().multiLanguage().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.MultiLanguage.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.PageLandingPageMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.multi_language.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->pages->landingPages->multiLanguage->detachFromLangGroup', - example: - "cms\n ->pages\n ->landingPages\n ->multiLanguage\n ->detachFromLangGroup(id: 'id');\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'set_new_lang_primary', - endpoint: '/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set a new primary language', - description: 'Set a landing page as the primary language of a multi-language group.', - stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) set_new_lang_primary', - qualified: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', - params: ['id: string;'], - markdown: - "## set_new_lang_primary\n\n`client.cms.pages.landingPages.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary`\n\nSet a landing page as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.landingPages.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.landingPages.multiLanguage.setNewLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.pages.landing_pages.multi_language.set_new_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.landing_pages.multi_language.set_new_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().pages().landingPages().multiLanguage().setNewLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().pages().landingPages().multiLanguage().setNewLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.MultiLanguage.SetNewLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.LandingPages.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.PageLandingPageMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.multi_language.set_new_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.landing_pages.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->pages->landingPages->multiLanguage->setNewLangPrimary', - example: - "cms->pages->landingPages->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update_languages', - endpoint: '/cms/pages/2026-03/landing-pages/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update languages of multi-language group', - description: 'Explicitly set new languages for each landing page in a multi-language group.', - stainlessPath: '(resource) cms.pages.landing-pages.multi-language > (method) update_languages', - qualified: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_languages\n\n`client.cms.pages.landingPages.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/pages/2026-03/landing-pages/multi-language/update-languages`\n\nExplicitly set new languages for each landing page in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.landingPages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.landingPages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.landing_pages.multi_language.update_languages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.landing_pages.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().landingPages().multiLanguage().updateLanguages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().landingPages().multiLanguage().updateLanguages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.MultiLanguage.UpdateLanguages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.LandingPages.MultiLanguage.UpdateLanguages(context.TODO(), cms.PageLandingPageMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.multi_language.update_languages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.landing_pages.multi_language.update_languages(\n languages: {foo: :aa},\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->pages->landingPages->multiLanguage->updateLanguages', - example: - "cms->pages->landingPages->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'get_landing_page_revision', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Retrieve a previous version of a landing page', - description: 'Retrieve a previous version of a landing page, specified by page ID and revision ID.', - stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) get_landing_page_revision', - qualified: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## get_landing_page_revision\n\n`client.cms.pages.landingPages.revisions.getLandingPageRevision(objectId: string, revisionId: string): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a landing page, specified by page ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pageVersion = await client.cms.pages.landingPages.revisions.getLandingPageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pageVersion);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pageVersion = await client.cms.pages.landingPages.revisions.getLandingPageRevision(\n 'revisionId',\n { objectId: 'objectId' },\n);\n\nconsole.log(pageVersion.id);", - }, - python: { - method: 'cms.pages.landing_pages.revisions.get_landing_page_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage_version = client.cms.pages.landing_pages.revisions.get_landing_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(page_version.id)', - }, - java: { - method: 'cms().pages().landingPages().revisions().getLandingPageRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PageVersion;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionGetLandingPageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetLandingPageRevisionParams params = RevisionGetLandingPageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PageVersion pageVersion = client.cms().pages().landingPages().revisions().getLandingPageRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Revisions.GetLandingPageRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpageVersion, err := client.Cms.Pages.LandingPages.Revisions.GetLandingPageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageRevisionGetLandingPageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pageVersion.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.revisions.get_landing_page_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage_version = hubspot.cms.pages.landing_pages.revisions.get_landing_page_revision("revisionId", object_id_: "objectId")\n\nputs(page_version)', - }, - php: { - method: 'cms->pages->landingPages->revisions->getLandingPageRevision', - example: - "cms\n ->pages\n ->landingPages\n ->revisions\n ->getLandingPageRevision('revisionId', objectID: 'objectId');\n\nvar_dump($pageVersion);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_landing_page_revisions', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions', - httpMethod: 'get', - summary: 'Retrieve all previous versions of a landing page', - description: 'Retrieve all the previous versions of a landing page, specified by page ID.', - stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) list_landing_page_revisions', - qualified: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', - params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## list_landing_page_revisions\n\n`client.cms.pages.landingPages.revisions.listLandingPageRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/landing-pages/{objectId}/revisions`\n\nRetrieve all the previous versions of a landing page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.landingPages.revisions.listLandingPageRevisions('objectId')) {\n console.log(pageVersion);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.landingPages.revisions.listLandingPageRevisions(\n 'objectId',\n)) {\n console.log(pageVersion.id);\n}", - }, - python: { - method: 'cms.pages.landing_pages.revisions.list_landing_page_revisions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.landing_pages.revisions.list_landing_page_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().landingPages().revisions().listLandingPageRevisions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionListLandingPageRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionListLandingPageRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListLandingPageRevisionsPage page = client.cms().pages().landingPages().revisions().listLandingPageRevisions("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Revisions.ListLandingPageRevisions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.LandingPages.Revisions.ListLandingPageRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageLandingPageRevisionListLandingPageRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.revisions.list_landing_page_revisions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.landing_pages.revisions.list_landing_page_revisions("objectId")\n\nputs(page)', - }, - php: { - method: 'cms->pages->landingPages->revisions->listLandingPageRevisions', - example: - "cms->pages->landingPages->revisions->listLandingPageRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_landing_page_revision', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore', - httpMethod: 'post', - summary: 'Restore a previous version of a landing page', - description: 'Restores a previous version of a landing page, specified by page ID and revision ID.', - stainlessPath: '(resource) cms.pages.landing-pages.revisions > (method) restore_landing_page_revision', - qualified: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: 'object', - markdown: - "## restore_landing_page_revision\n\n`client.cms.pages.landingPages.revisions.restoreLandingPageRevision(objectId: string, revisionId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore`\n\nRestores a previous version of a landing page, specified by page ID and revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevision(\n 'revisionId',\n { objectId: 'objectId' },\n);\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.revisions.restore_landing_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().revisions().restoreLandingPageRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionRestoreLandingPageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreLandingPageRevisionParams params = RevisionRestoreLandingPageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().revisions().restoreLandingPageRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageLandingPageRevisionRestoreLandingPageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.revisions.restore_landing_page_revision(\n "revisionId",\n object_id_: "objectId"\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->revisions->restoreLandingPageRevision', - example: - "cms\n ->pages\n ->landingPages\n ->revisions\n ->restoreLandingPageRevision('revisionId', objectID: 'objectId');\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_landing_page_revision_to_draft', - endpoint: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft', - httpMethod: 'post', - summary: 'Restore a previous version of a landing page', - description: 'Specify a previous version of a landing page to set as the page draft.', - stainlessPath: - '(resource) cms.pages.landing-pages.revisions > (method) restore_landing_page_revision_to_draft', - qualified: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', - params: ['objectId: string;', 'revisionId: number;'], - response: 'object', - markdown: - "## restore_landing_page_revision_to_draft\n\n`client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(objectId: string, revisionId: number): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nSpecify a previous version of a landing page to set as the page draft.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft(\n 0,\n { objectId: 'objectId' },\n);\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().landingPages().revisions().restoreLandingPageRevisionToDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.landingpages.revisions.RevisionRestoreLandingPageRevisionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreLandingPageRevisionToDraftParams params = RevisionRestoreLandingPageRevisionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n PagesPage pagesPage = client.cms().pages().landingPages().revisions().restoreLandingPageRevisionToDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevisionToDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.LandingPages.Revisions.RestoreLandingPageRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.PageLandingPageRevisionRestoreLandingPageRevisionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.landing_pages.revisions.restore_landing_page_revision_to_draft(\n 0,\n object_id_: "objectId"\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->landingPages->revisions->restoreLandingPageRevisionToDraft', - example: - "cms\n ->pages\n ->landingPages\n ->revisions\n ->restoreLandingPageRevisionToDraft(0, objectID: 'objectId');\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/landing-pages/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'clone', - endpoint: '/cms/pages/2026-03/site-pages/clone', - httpMethod: 'post', - summary: 'Clone a website page', - description: 'Create a copy of an existing website page.', - stainlessPath: '(resource) cms.pages.site-pages > (method) clone', - qualified: 'client.cms.pages.sitePages.clone', - params: ['id: string;', 'cloneName?: string;'], - response: 'object', - markdown: - "## clone\n\n`client.cms.pages.sitePages.clone(id: string, cloneName?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/clone`\n\nCreate a copy of an existing website page.\n\n### Parameters\n\n- `id: string`\n ID of the object to be cloned.\n\n- `cloneName?: string`\n Name of the cloned object.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.clone({ id: 'id' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.clone', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.clone({ id: 'id' });\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.clone', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.clone(\n id="id",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().clone', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentCloneRequestVNext params = ContentCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().clone(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Clone', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Clone(context.TODO(), cms.PageSitePageCloneParams{\n\t\tContentCloneRequestVNext: cms.ContentCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.clone_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.clone_(id: "id")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->clone', - example: - "cms->pages->sitePages->clone(\n id: 'id', cloneName: 'cloneName'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/clone \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/pages/2026-03/site-pages', - httpMethod: 'post', - summary: 'Create a website page', - description: 'Create a new website page.', - stainlessPath: '(resource) cms.pages.site-pages > (method) create', - qualified: 'client.cms.pages.sitePages.create', - params: [ - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'object', - markdown: - "## create\n\n`client.cms.pages.sitePages.create(id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages`\n\nCreate a new website page.\n\n### Parameters\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.create({\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.create(\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage params = PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.New(context.TODO(), cms.PageSitePageNewParams{\n\t\tPagesPage: cms.PagesPageParam{\n\t\t\tID: "id",\n\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\tAbTestID: "abTestId",\n\t\t\tArchivedAt: time.Now(),\n\t\t\tArchivedInDashboard: true,\n\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t}},\n\t\t\tAuthorName: "authorName",\n\t\t\tCampaign: "campaign",\n\t\t\tCategoryID: 0,\n\t\t\tContentGroupID: "contentGroupId",\n\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\tCreated: time.Now(),\n\t\t\tCreatedByID: "createdById",\n\t\t\tCurrentlyPublished: true,\n\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\tDomain: "domain",\n\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\tDynamicPageDataSourceType: 0,\n\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\tEnableDomainStylesheets: true,\n\t\t\tEnableLayoutStylesheets: true,\n\t\t\tFeaturedImage: "featuredImage",\n\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\tFolderID: "folderId",\n\t\t\tFooterHTML: "footerHtml",\n\t\t\tHeadHTML: "headHtml",\n\t\t\tHTMLTitle: "htmlTitle",\n\t\t\tIncludeDefaultCustomCss: true,\n\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t},\n\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t}},\n\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t},\n\t\t\t\t\tType: "type",\n\t\t\t\t\tW: 0,\n\t\t\t\t\tX: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\tMetaDescription: "metaDescription",\n\t\t\tName: "name",\n\t\t\tPageExpiryDate: 0,\n\t\t\tPageExpiryEnabled: true,\n\t\t\tPageExpiryRedirectID: 0,\n\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\tPageRedirected: true,\n\t\t\tPassword: "password",\n\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\tPublicAccessRulesEnabled: true,\n\t\t\tPublishDate: time.Now(),\n\t\t\tPublishImmediately: true,\n\t\t\tSlug: "slug",\n\t\t\tState: "state",\n\t\t\tSubcategory: "subcategory",\n\t\t\tTemplatePath: "templatePath",\n\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t"foo": {\n\t\t\t\t\tID: 0,\n\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPassword: "password",\n\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\tSlug: "slug",\n\t\t\t\t\tState: "state",\n\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t},\n\t\t\t},\n\t\t\tUpdated: time.Now(),\n\t\t\tUpdatedByID: "updatedById",\n\t\t\tURL: "url",\n\t\t\tUseFeaturedImage: true,\n\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tWidgets: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.create(\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->create', - example: - "cms->pages->sitePages->create(\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}', - httpMethod: 'delete', - summary: 'Delete a website page', - description: 'Delete a website page, specified by its ID.', - stainlessPath: '(resource) cms.pages.site-pages > (method) delete', - qualified: 'client.cms.pages.sitePages.delete', - params: ['objectId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.cms.pages.sitePages.delete(objectId: string, archived?: boolean): void`\n\n**delete** `/cms/pages/2026-03/site-pages/{objectId}`\n\nDelete a website page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.delete('objectId');", - }, - python: { - method: 'cms.pages.site_pages.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.delete(\n object_id="objectId",\n)', - }, - java: { - method: 'cms().pages().sitePages().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->delete', - example: - "cms->pages->sitePages->delete('objectId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}', - httpMethod: 'get', - summary: 'Retrieve a website page', - description: 'Retrieve a website page by its ID.', - stainlessPath: '(resource) cms.pages.site-pages > (method) get', - qualified: 'client.cms.pages.sitePages.get', - params: ['objectId: string;', 'archived?: boolean;', 'property?: string;'], - response: 'object', - markdown: - "## get\n\n`client.cms.pages.sitePages.get(objectId: string, archived?: boolean, property?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}`\n\nRetrieve a website page by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `property?: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.get('objectId');\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.get('objectId');\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.get(\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().sitePages().get("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.get("objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->get', - example: - "cms->pages->sitePages->get(\n 'objectId', archived: true, property: 'property'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/pages/2026-03/site-pages', - httpMethod: 'get', - summary: 'Retrieve all website pages', - description: - 'Retrieve all website pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.', - stainlessPath: '(resource) cms.pages.site-pages > (method) list', - qualified: 'client.cms.pages.sitePages.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'property?: string;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: 'object', - markdown: - "## list\n\n`client.cms.pages.sitePages.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, property?: string, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages`\n\nRetrieve all website pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n Filter pages created after a specific date and time.\n\n- `createdAt?: string`\n Filter pages by the exact creation timestamp. Format is date-time.\n\n- `createdBefore?: string`\n Filter pages created before a specific date-time.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `property?: string`\n Specify properties to include in the response.\n\n- `sort?: string[]`\n Specify the order of results. Accepts an array of field names to sort by.\n\n- `updatedAfter?: string`\n Filter pages updated after the specified date-time.\n\n- `updatedAt?: string`\n Filter pages by their exact update timestamp in ISO 8601 format.\n\n- `updatedBefore?: string`\n Filter pages updated before a specific date and time. Format should be date-time.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.sitePages.list()) {\n console.log(pagesPage);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pagesPage of client.cms.pages.sitePages.list()) {\n console.log(pagesPage.id);\n}", - }, - python: { - method: 'cms.pages.site_pages.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.site_pages.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().sitePages().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageListPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SitePageListPage page = client.cms().pages().sitePages().list();\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.SitePages.List(context.TODO(), cms.PageSitePageListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.site_pages.list\n\nputs(page)', - }, - php: { - method: 'cms->pages->sitePages->list', - example: - "cms->pages->sitePages->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n property: 'property',\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'schedule', - endpoint: '/cms/pages/2026-03/site-pages/schedule', - httpMethod: 'post', - summary: 'Schedule a website page to be published', - description: 'Schedule a website page to published at a future time.', - stainlessPath: '(resource) cms.pages.site-pages > (method) schedule', - qualified: 'client.cms.pages.sitePages.schedule', - params: ['id: string;', 'publishDate: string;'], - markdown: - "## schedule\n\n`client.cms.pages.sitePages.schedule(id: string, publishDate: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/schedule`\n\nSchedule a website page to published at a future time.\n\n### Parameters\n\n- `id: string`\n The ID of the object to be scheduled.\n\n- `publishDate: string`\n The date the object should transition from scheduled to published.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.schedule', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.schedule({ id: 'id', publishDate: '2019-12-27T18:11:19.117Z' });", - }, - python: { - method: 'cms.pages.site_pages.schedule', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.schedule(\n id="id",\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)', - }, - java: { - method: 'cms().pages().sitePages().schedule', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.ContentScheduleRequestVNext;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentScheduleRequestVNext params = ContentScheduleRequestVNext.builder()\n .id("id")\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n client.cms().pages().sitePages().schedule(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Schedule', - example: - 'package main\n\nimport (\n\t"context"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Schedule(context.TODO(), cms.PageSitePageScheduleParams{\n\t\tContentScheduleRequestVNext: cms.ContentScheduleRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tPublishDate: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.schedule', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.schedule(id: "id", publish_date: "2019-12-27T18:11:19.117Z")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->schedule', - example: - "cms->pages->sitePages->schedule(\n id: 'id', publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z')\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/schedule \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "publishDate": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}', - httpMethod: 'patch', - summary: 'Update a website page', - description: - 'Partially updates a single website page, specified by its ID. You only need to specify the column values that you are modifying.\n', - stainlessPath: '(resource) cms.pages.site-pages > (method) update', - qualified: 'client.cms.pages.sitePages.update', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - 'archived?: boolean;', - ], - response: 'object', - markdown: - "## update\n\n`client.cms.pages.sitePages.update(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object, archived?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/site-pages/{objectId}`\n\nPartially updates a single website page, specified by its ID. You only need to specify the column values that you are modifying.\n\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.update('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.update(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.SitePageUpdateParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SitePageUpdateParams params = SitePageUpdateParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageUpdateParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.update(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->update', - example: - "cms->pages->sitePages->update(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n archived: true,\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'create_site_page_variation', - endpoint: '/cms/pages/2026-03/site-pages/ab-test/create-variation', - httpMethod: 'post', - summary: 'Create a new A/B test variation', - description: 'Create a new A/B test variation based on the information provided in the request body.\n', - stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) create_site_page_variation', - qualified: 'client.cms.pages.sitePages.abTest.createSitePageVariation', - params: ['contentId: string;', 'variationName: string;'], - response: 'object', - markdown: - "## create_site_page_variation\n\n`client.cms.pages.sitePages.abTest.createSitePageVariation(contentId: string, variationName: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/create-variation`\n\nCreate a new A/B test variation based on the information provided in the request body.\n\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.abTest.createSitePageVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.abTest.createSitePageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.abTest.createSitePageVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.ab_test.create_site_page_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.ab_test.create_site_page_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().abTest().createSitePageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().abTest().createSitePageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.AbTest.NewSitePageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.AbTest.NewSitePageVariation(context.TODO(), cms.PageSitePageAbTestNewSitePageVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.ab_test.create_site_page_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.ab_test.create_site_page_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->abTest->createSitePageVariation', - example: - "cms->pages->sitePages->abTest->createSitePageVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/create-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', - }, - }, - }, - { - name: 'end_site_page_test', - endpoint: '/cms/pages/2026-03/site-pages/ab-test/end', - httpMethod: 'post', - summary: 'End an active A/B test', - description: 'End an active A/B test and designate a winner.', - stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) end_site_page_test', - qualified: 'client.cms.pages.sitePages.abTest.endSitePageTest', - params: ['abTestId: string;', 'winnerId: string;'], - markdown: - "## end_site_page_test\n\n`client.cms.pages.sitePages.abTest.endSitePageTest(abTestId: string, winnerId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/end`\n\nEnd an active A/B test and designate a winner.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to end.\n\n- `winnerId: string`\n ID of the object to designate as the test winner.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.abTest.endSitePageTest({ abTestId: 'abTestId', winnerId: 'winnerId' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.abTest.endSitePageTest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.abTest.endSitePageTest({\n abTestId: 'abTestId',\n winnerId: 'winnerId',\n});", - }, - python: { - method: 'cms.pages.site_pages.ab_test.end_site_page_test', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.ab_test.end_site_page_test(\n ab_test_id="abTestId",\n winner_id="winnerId",\n)', - }, - java: { - method: 'cms().pages().sitePages().abTest().endSitePageTest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestEndRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestEndRequestVNext params = AbTestEndRequestVNext.builder()\n .abTestId("abTestId")\n .winnerId("winnerId")\n .build();\n client.cms().pages().sitePages().abTest().endSitePageTest(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.AbTest.EndSitePageTest', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.AbTest.EndSitePageTest(context.TODO(), cms.PageSitePageAbTestEndSitePageTestParams{\n\t\tAbTestEndRequestVNext: cms.AbTestEndRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tWinnerID: "winnerId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.ab_test.end_site_page_test', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.ab_test.end_site_page_test(ab_test_id: "abTestId", winner_id: "winnerId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->abTest->endSitePageTest', - example: - "cms->pages->sitePages->abTest->endSitePageTest(\n abTestID: 'abTestId', winnerID: 'winnerId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/end \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "winnerId": "winnerId"\n }\'', - }, - }, - }, - { - name: 'rerun_site_page_test', - endpoint: '/cms/pages/2026-03/site-pages/ab-test/rerun', - httpMethod: 'post', - summary: 'Rerun a previous A/B test', - description: 'Rerun a previous A/B test.', - stainlessPath: '(resource) cms.pages.site-pages.ab-test > (method) rerun_site_page_test', - qualified: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', - params: ['abTestId: string;', 'variationId: string;'], - markdown: - "## rerun_site_page_test\n\n`client.cms.pages.sitePages.abTest.rerunSitePageTest(abTestId: string, variationId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/ab-test/rerun`\n\nRerun a previous A/B test.\n\n### Parameters\n\n- `abTestId: string`\n ID of the test to rerun.\n\n- `variationId: string`\n ID of the object to reactivate as a test variation.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.abTest.rerunSitePageTest({ abTestId: 'abTestId', variationId: 'variationId' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.abTest.rerunSitePageTest({\n abTestId: 'abTestId',\n variationId: 'variationId',\n});", - }, - python: { - method: 'cms.pages.site_pages.ab_test.rerun_site_page_test', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.ab_test.rerun_site_page_test(\n ab_test_id="abTestId",\n variation_id="variationId",\n)', - }, - java: { - method: 'cms().pages().sitePages().abTest().rerunSitePageTest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.AbTestRerunRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestRerunRequestVNext params = AbTestRerunRequestVNext.builder()\n .abTestId("abTestId")\n .variationId("variationId")\n .build();\n client.cms().pages().sitePages().abTest().rerunSitePageTest(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.AbTest.RerunSitePageTest', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.AbTest.RerunSitePageTest(context.TODO(), cms.PageSitePageAbTestRerunSitePageTestParams{\n\t\tAbTestRerunRequestVNext: cms.AbTestRerunRequestVNextParam{\n\t\t\tAbTestID: "abTestId",\n\t\t\tVariationID: "variationId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.ab_test.rerun_site_page_test', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.ab_test.rerun_site_page_test(\n ab_test_id: "abTestId",\n variation_id: "variationId"\n)\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->abTest->rerunSitePageTest', - example: - "cms->pages->sitePages->abTest->rerunSitePageTest(\n abTestID: 'abTestId', variationID: 'variationId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/ab-test/rerun \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "abTestId": "abTestId",\n "variationId": "variationId"\n }\'', - }, - }, - }, - { - name: 'create_site_pages', - endpoint: '/cms/pages/2026-03/site-pages/batch/create', - httpMethod: 'post', - summary: 'Create website pages', - description: 'Create a batch of website pages as specified in the request body.', - stainlessPath: '(resource) cms.pages.site-pages.batch > (method) create_site_pages', - qualified: 'client.cms.pages.sitePages.batch.createSitePages', - params: [ - 'inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[];', - ], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create_site_pages\n\n`client.cms.pages.sitePages.batch.createSitePages(inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/create`\n\nCreate a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n Pages to input.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.createSitePages({ inputs: [{\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n}] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.batch.createSitePages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.createSitePages({\n inputs: [\n {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n },\n ],\n});\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.site_pages.batch.create_site_pages', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.create_site_pages(\n inputs=[{\n "id": "id",\n "ab_status": "automated_loser_variant",\n "ab_test_id": "abTestId",\n "archived_at": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "archived_in_dashboard": True,\n "attached_stylesheets": [{\n "foo": {}\n }],\n "author_name": "authorName",\n "campaign": "campaign",\n "category_id": 0,\n "content_group_id": "contentGroupId",\n "content_type_category": "0",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "created_by_id": "createdById",\n "currently_published": True,\n "current_state": "AGENT_GENERATED",\n "domain": "domain",\n "dynamic_page_data_source_id": "dynamicPageDataSourceId",\n "dynamic_page_data_source_type": 0,\n "dynamic_page_hub_db_table_id": "dynamicPageHubDbTableId",\n "enable_domain_stylesheets": True,\n "enable_layout_stylesheets": True,\n "featured_image": "featuredImage",\n "featured_image_alt_text": "featuredImageAltText",\n "folder_id": "folderId",\n "footer_html": "footerHtml",\n "head_html": "headHtml",\n "html_title": "htmlTitle",\n "include_default_custom_css": True,\n "language": "aa",\n "layout_sections": {\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n "link_rel_canonical_url": "linkRelCanonicalUrl",\n "mab_experiment_id": "mabExperimentId",\n "meta_description": "metaDescription",\n "name": "name",\n "page_expiry_date": 0,\n "page_expiry_enabled": True,\n "page_expiry_redirect_id": 0,\n "page_expiry_redirect_url": "pageExpiryRedirectUrl",\n "page_redirected": True,\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "publish_immediately": True,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "template_path": "templatePath",\n "theme_settings_values": {\n "foo": {}\n },\n "translated_from_id": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "updated_by_id": "updatedById",\n "url": "url",\n "use_featured_image": True,\n "widget_containers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n },\n }],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().sitePages().batch().createSitePages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.BatchInputPage;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPage params = BatchInputPage.builder()\n .addInput(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().createSitePages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Batch.NewSitePages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.NewSitePages(context.TODO(), cms.PageSitePageBatchNewSitePagesParams{\n\t\tBatchInputPage: cms.BatchInputPageParam{\n\t\t\tInputs: []cms.PagesPageParam{{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.batch.create_site_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.create_site_pages(\n inputs: [\n {\n id: "id",\n abStatus: :automated_loser_variant,\n abTestId: "abTestId",\n archivedAt: "2019-12-27T18:11:19.117Z",\n archivedInDashboard: true,\n attachedStylesheets: [{foo: {}}],\n authorName: "authorName",\n campaign: "campaign",\n categoryId: 0,\n contentGroupId: "contentGroupId",\n contentTypeCategory: :"0",\n created: "2019-12-27T18:11:19.117Z",\n createdById: "createdById",\n currentlyPublished: true,\n currentState: :AGENT_GENERATED,\n domain: "domain",\n dynamicPageDataSourceId: "dynamicPageDataSourceId",\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: "dynamicPageHubDbTableId",\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: "featuredImage",\n featuredImageAltText: "featuredImageAltText",\n folderId: "folderId",\n footerHtml: "footerHtml",\n headHtml: "headHtml",\n htmlTitle: "htmlTitle",\n includeDefaultCustomCss: true,\n language: :aa,\n layoutSections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n linkRelCanonicalUrl: "linkRelCanonicalUrl",\n mabExperimentId: "mabExperimentId",\n metaDescription: "metaDescription",\n name: "name",\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: "pageExpiryRedirectUrl",\n pageRedirected: true,\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n publishImmediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n templatePath: "templatePath",\n themeSettingsValues: {foo: {}},\n translatedFromId: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updatedById: "updatedById",\n url: "url",\n useFeaturedImage: true,\n widgetContainers: {foo: {}},\n widgets: {foo: {}}\n }\n ]\n)\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->sitePages->batch->createSitePages', - example: - "cms->pages->sitePages->batch->createSitePages(\n inputs: [\n [\n 'id' => 'id',\n 'abStatus' => 'automated_loser_variant',\n 'abTestID' => 'abTestId',\n 'archivedAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'archivedInDashboard' => true,\n 'attachedStylesheets' => [['foo' => (object) []]],\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'categoryID' => 0,\n 'contentGroupID' => 'contentGroupId',\n 'contentTypeCategory' => '0',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'createdByID' => 'createdById',\n 'currentlyPublished' => true,\n 'currentState' => 'AGENT_GENERATED',\n 'domain' => 'domain',\n 'dynamicPageDataSourceID' => 'dynamicPageDataSourceId',\n 'dynamicPageDataSourceType' => 0,\n 'dynamicPageHubDBTableID' => 'dynamicPageHubDbTableId',\n 'enableDomainStylesheets' => true,\n 'enableLayoutStylesheets' => true,\n 'featuredImage' => 'featuredImage',\n 'featuredImageAltText' => 'featuredImageAltText',\n 'folderID' => 'folderId',\n 'footerHTML' => 'footerHtml',\n 'headHTML' => 'headHtml',\n 'htmlTitle' => 'htmlTitle',\n 'includeDefaultCustomCss' => true,\n 'language' => 'aa',\n 'layoutSections' => [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n 'linkRelCanonicalURL' => 'linkRelCanonicalUrl',\n 'mabExperimentID' => 'mabExperimentId',\n 'metaDescription' => 'metaDescription',\n 'name' => 'name',\n 'pageExpiryDate' => 0,\n 'pageExpiryEnabled' => true,\n 'pageExpiryRedirectID' => 0,\n 'pageExpiryRedirectURL' => 'pageExpiryRedirectUrl',\n 'pageRedirected' => true,\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'publishImmediately' => true,\n 'slug' => 'slug',\n 'state' => 'state',\n 'subcategory' => 'subcategory',\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'translatedFromID' => 'translatedFromId',\n 'translations' => [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'updatedByID' => 'updatedById',\n 'url' => 'url',\n 'useFeaturedImage' => true,\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n ],\n);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/create \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_site_pages', - endpoint: '/cms/pages/2026-03/site-pages/batch/archive', - httpMethod: 'post', - summary: 'Delete website pages', - description: - 'Delete a batch of website pages as specified in the request body. Note that this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.', - stainlessPath: '(resource) cms.pages.site-pages.batch > (method) delete_site_pages', - qualified: 'client.cms.pages.sitePages.batch.deleteSitePages', - params: ['inputs: string[];'], - markdown: - "## delete_site_pages\n\n`client.cms.pages.sitePages.batch.deleteSitePages(inputs: string[]): void`\n\n**post** `/cms/pages/2026-03/site-pages/batch/archive`\n\nDelete a batch of website pages as specified in the request body. Note that this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.batch.deleteSitePages({ inputs: ['string'] })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.batch.deleteSitePages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.batch.deleteSitePages({ inputs: ['string'] });", - }, - python: { - method: 'cms.pages.site_pages.batch.delete_site_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.batch.delete_site_pages(\n inputs=["string"],\n)', - }, - java: { - method: 'cms().pages().sitePages().batch().deleteSitePages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n client.cms().pages().sitePages().batch().deleteSitePages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Batch.DeleteSitePages', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Batch.DeleteSitePages(context.TODO(), cms.PageSitePageBatchDeleteSitePagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.batch.delete_site_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.batch.delete_site_pages(inputs: ["string"])\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->batch->deleteSitePages', - example: - "cms->pages->sitePages->batch->deleteSitePages(\n inputs: ['string']\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/archive \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_site_pages', - endpoint: '/cms/pages/2026-03/site-pages/batch/read', - httpMethod: 'post', - summary: 'Retrieve website pages', - description: 'Retrieve a batch of website pages as specified in the request body.', - stainlessPath: '(resource) cms.pages.site-pages.batch > (method) get_site_pages', - qualified: 'client.cms.pages.sitePages.batch.getSitePages', - params: ['inputs: string[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_site_pages\n\n`client.cms.pages.sitePages.batch.getSitePages(inputs: string[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/read`\n\nRetrieve a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.getSitePages({ inputs: ['string'] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.batch.getSitePages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.getSitePages({\n inputs: ['string'],\n});\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.site_pages.batch.get_site_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.get_site_pages(\n inputs=["string"],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().sitePages().batch().getSitePages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().getSitePages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Batch.GetSitePages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.GetSitePages(context.TODO(), cms.PageSitePageBatchGetSitePagesParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.batch.get_site_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.get_site_pages(inputs: ["string"])\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->sitePages->batch->getSitePages', - example: - "cms->pages->sitePages->batch->getSitePages(\n inputs: ['string'], archived: true\n);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/read \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update_site_pages', - endpoint: '/cms/pages/2026-03/site-pages/batch/update', - httpMethod: 'post', - summary: 'Update website pages', - description: 'Update a batch of website pages as specified in the request body.', - stainlessPath: '(resource) cms.pages.site-pages.batch > (method) update_site_pages', - qualified: 'client.cms.pages.sitePages.batch.updateSitePages', - params: ['inputs: object[];', 'archived?: boolean;'], - response: - "{ completedAt: string; results: object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update_site_pages\n\n`client.cms.pages.sitePages.batch.updateSitePages(inputs: object[], archived?: boolean): { completedAt: string; results: pages_page[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/cms/pages/2026-03/site-pages/batch/update`\n\nUpdate a batch of website pages as specified in the request body.\n\n### Parameters\n\n- `inputs: object[]`\n JSON nodes to input.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.updateSitePages({ inputs: [{}] });\n\nconsole.log(batchResponsePage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.batch.updateSitePages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePage = await client.cms.pages.sitePages.batch.updateSitePages({ inputs: [{}] });\n\nconsole.log(batchResponsePage.completedAt);", - }, - python: { - method: 'cms.pages.site_pages.batch.update_site_pages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_page = client.cms.pages.site_pages.batch.update_site_pages(\n inputs=[{}],\n)\nprint(batch_response_page.completed_at)', - }, - java: { - method: 'cms().pages().sitePages().batch().updateSitePages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.BatchInputJsonNode;\nimport com.hubspot.sdk.models.cms.pages.BatchResponsePage;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputJsonNode params = BatchInputJsonNode.builder()\n .addInput(JsonValue.from(Map.of()))\n .build();\n BatchResponsePage batchResponsePage = client.cms().pages().sitePages().batch().updateSitePages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Batch.UpdateSitePages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePage, err := client.Cms.Pages.SitePages.Batch.UpdateSitePages(context.TODO(), cms.PageSitePageBatchUpdateSitePagesParams{\n\t\tBatchInputJsonNode: cms.BatchInputJsonNodeParam{\n\t\t\tInputs: []any{map[string]any{}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePage.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.batch.update_site_pages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_page = hubspot.cms.pages.site_pages.batch.update_site_pages(inputs: [{}])\n\nputs(batch_response_page)', - }, - php: { - method: 'cms->pages->sitePages->batch->updateSitePages', - example: - "cms->pages->sitePages->batch->updateSitePages(\n inputs: [(object) []], archived: true\n);\n\nvar_dump($batchResponsePage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/batch/update \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {}\n ]\n }\'', - }, - }, - }, - { - name: 'get_draft', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft', - httpMethod: 'get', - summary: 'Retrieve a website page draft', - description: 'Retrieve the full draft version of a website page, specified by its ID.', - stainlessPath: '(resource) cms.pages.site-pages.draft > (method) get_draft', - qualified: 'client.cms.pages.sitePages.draft.getDraft', - params: ['objectId: string;'], - response: 'object', - markdown: - "## get_draft\n\n`client.cms.pages.sitePages.draft.getDraft(objectId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/draft`\n\nRetrieve the full draft version of a website page, specified by its ID.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.draft.getDraft('objectId');\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.draft.getDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.draft.getDraft('objectId');\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.draft.get_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.draft.get_draft(\n "objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().draft().getDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftGetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PagesPage pagesPage = client.cms().pages().sitePages().draft().getDraft("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Draft.GetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Draft.GetDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.draft.get_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.draft.get_draft("objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->draft->getDraft', - example: - "cms->pages->sitePages->draft->getDraft('objectId');\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'publish_draft', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft/push-live', - httpMethod: 'post', - summary: 'Publish website page draft', - description: - 'Take any changes from the draft version of the website page and apply them to the live version.', - stainlessPath: '(resource) cms.pages.site-pages.draft > (method) publish_draft', - qualified: 'client.cms.pages.sitePages.draft.publishDraft', - params: ['objectId: string;'], - markdown: - "## publish_draft\n\n`client.cms.pages.sitePages.draft.publishDraft(objectId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/draft/push-live`\n\nTake any changes from the draft version of the website page and apply them to the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.draft.publishDraft('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.draft.publishDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.draft.publishDraft('objectId');", - }, - python: { - method: 'cms.pages.site_pages.draft.publish_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.draft.publish_draft(\n "objectId",\n)', - }, - java: { - method: 'cms().pages().sitePages().draft().publishDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftPublishDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().draft().publishDraft("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Draft.PublishDraft', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Draft.PublishDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.draft.publish_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.draft.publish_draft("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->draft->publishDraft', - example: - "cms->pages->sitePages->draft->publishDraft('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft/push-live \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset_site_page_draft', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft/reset', - httpMethod: 'post', - summary: 'Reset the draft of a website page', - description: 'Discards any edits and resets the draft to match the live version.', - stainlessPath: '(resource) cms.pages.site-pages.draft > (method) reset_site_page_draft', - qualified: 'client.cms.pages.sitePages.draft.resetSitePageDraft', - params: ['objectId: string;'], - markdown: - "## reset_site_page_draft\n\n`client.cms.pages.sitePages.draft.resetSitePageDraft(objectId: string): void`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/draft/reset`\n\nDiscards any edits and resets the draft to match the live version.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.draft.resetSitePageDraft('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.draft.resetSitePageDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.draft.resetSitePageDraft('objectId');", - }, - python: { - method: 'cms.pages.site_pages.draft.reset_site_page_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.draft.reset_site_page_draft(\n "objectId",\n)', - }, - java: { - method: 'cms().pages().sitePages().draft().resetSitePageDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftResetSitePageDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().pages().sitePages().draft().resetSitePageDraft("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Draft.ResetSitePageDraft', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.Draft.ResetSitePageDraft(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.draft.reset_site_page_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.draft.reset_site_page_draft("objectId")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->draft->resetSitePageDraft', - example: - "cms->pages->sitePages->draft->resetSitePageDraft('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_draft', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/draft', - httpMethod: 'patch', - summary: 'Update a website page draft', - description: - "Partially update the draft version of a website page, specified by page ID. You only need to specify the values for the details that you're modifying.", - stainlessPath: '(resource) cms.pages.site-pages.draft > (method) update_draft', - qualified: 'client.cms.pages.sitePages.draft.updateDraft', - params: [ - 'objectId: string;', - 'id: string;', - 'abStatus: string;', - 'abTestId: string;', - 'archivedAt: string;', - 'archivedInDashboard: boolean;', - 'attachedStylesheets: object[];', - 'authorName: string;', - 'campaign: string;', - 'categoryId: number;', - 'contentGroupId: string;', - 'contentTypeCategory: string;', - 'created: string;', - 'createdById: string;', - 'currentlyPublished: boolean;', - 'currentState: string;', - 'domain: string;', - 'dynamicPageDataSourceId: string;', - 'dynamicPageDataSourceType: number;', - 'dynamicPageHubDbTableId: string;', - 'enableDomainStylesheets: boolean;', - 'enableLayoutStylesheets: boolean;', - 'featuredImage: string;', - 'featuredImageAltText: string;', - 'folderId: string;', - 'footerHtml: string;', - 'headHtml: string;', - 'htmlTitle: string;', - 'includeDefaultCustomCss: boolean;', - 'language: string;', - 'layoutSections: object;', - 'linkRelCanonicalUrl: string;', - 'mabExperimentId: string;', - 'metaDescription: string;', - 'name: string;', - 'pageExpiryDate: number;', - 'pageExpiryEnabled: boolean;', - 'pageExpiryRedirectId: number;', - 'pageExpiryRedirectUrl: string;', - 'pageRedirected: boolean;', - 'password: string;', - 'publicAccessRules: object[];', - 'publicAccessRulesEnabled: boolean;', - 'publishDate: string;', - 'publishImmediately: boolean;', - 'slug: string;', - 'state: string;', - 'subcategory: string;', - 'templatePath: string;', - 'themeSettingsValues: object;', - 'translatedFromId: string;', - 'translations: object;', - 'updated: string;', - 'updatedById: string;', - 'url: string;', - 'useFeaturedImage: boolean;', - 'widgetContainers: object;', - 'widgets: object;', - ], - response: 'object', - markdown: - "## update_draft\n\n`client.cms.pages.sitePages.draft.updateDraft(objectId: string, id: string, abStatus: string, abTestId: string, archivedAt: string, archivedInDashboard: boolean, attachedStylesheets: object[], authorName: string, campaign: string, categoryId: number, contentGroupId: string, contentTypeCategory: string, created: string, createdById: string, currentlyPublished: boolean, currentState: string, domain: string, dynamicPageDataSourceId: string, dynamicPageDataSourceType: number, dynamicPageHubDbTableId: string, enableDomainStylesheets: boolean, enableLayoutStylesheets: boolean, featuredImage: string, featuredImageAltText: string, folderId: string, footerHtml: string, headHtml: string, htmlTitle: string, includeDefaultCustomCss: boolean, language: string, layoutSections: object, linkRelCanonicalUrl: string, mabExperimentId: string, metaDescription: string, name: string, pageExpiryDate: number, pageExpiryEnabled: boolean, pageExpiryRedirectId: number, pageExpiryRedirectUrl: string, pageRedirected: boolean, password: string, publicAccessRules: object[], publicAccessRulesEnabled: boolean, publishDate: string, publishImmediately: boolean, slug: string, state: string, subcategory: string, templatePath: string, themeSettingsValues: object, translatedFromId: string, translations: object, updated: string, updatedById: string, url: string, useFeaturedImage: boolean, widgetContainers: object, widgets: object): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**patch** `/cms/pages/2026-03/site-pages/{objectId}/draft`\n\nPartially update the draft version of a website page, specified by page ID. You only need to specify the values for the details that you're modifying.\n\n### Parameters\n\n- `objectId: string`\n\n- `id: string`\n The unique ID of the page.\n\n- `abStatus: string`\n The status of the AB test associated with this page, if applicable\n\n- `abTestId: string`\n The ID of the AB test associated with this page, if applicable\n\n- `archivedAt: string`\n The timestamp (ISO8601 format) when this page was deleted.\n\n- `archivedInDashboard: boolean`\n If True, the page will not show up in your dashboard, although the page could still be live.\n\n- `attachedStylesheets: object[]`\n List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.\n\n- `authorName: string`\n The name of the user that updated this page.\n\n- `campaign: string`\n The GUID of the marketing campaign this page is a part of.\n\n- `categoryId: number`\n ID of the type of object this is. Should always .\n\n- `contentGroupId: string`\n The unique identifier for the content group associated with the page.\n\n- `contentTypeCategory: string`\n An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.\n\n- `created: string`\n The timestamp indicating when the page was created.\n\n- `createdById: string`\n The ID of the user that created this page.\n\n- `currentlyPublished: boolean`\n Indicates whether the page is currently published.\n\n- `currentState: string`\n A generated ENUM descibing the current state of this page.\n\n- `domain: string`\n The domain this page will resolve to. If null, the page will default to the primary domain for this content type.\n\n- `dynamicPageDataSourceId: string`\n The identifier for the data source used by the dynamic page.\n\n- `dynamicPageDataSourceType: number`\n The type of data source used by the dynamic page.\n\n- `dynamicPageHubDbTableId: string`\n The ID of the HubDB table this page references, if applicable\n\n- `enableDomainStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `enableLayoutStylesheets: boolean`\n Boolean to determine whether or not the styles from the template should be applied.\n\n- `featuredImage: string`\n The featuredImage of this page.\n\n- `featuredImageAltText: string`\n Alt Text of the featuredImage.\n\n- `folderId: string`\n The ID of the associated folder this landing page is organized under in the app dashboard.\n\n- `footerHtml: string`\n Custom HTML for embed codes, javascript that should be placed before the tag of the page.\n\n- `headHtml: string`\n Custom HTML for embed codes, javascript, etc. that goes in the tag of the page.\n\n- `htmlTitle: string`\n The html title of this page.\n\n- `includeDefaultCustomCss: boolean`\n Boolean to determine whether or not the Primary CSS Files should be applied.\n\n- `language: string`\n The explicitly defined ISO 639 language code of the page. If null, the page will default to the language of the Domain.\n\n- `layoutSections: object`\n A structure detailing the layout sections of the page.\n\n- `linkRelCanonicalUrl: string`\n Optional override to set the URL to be used in the rel=canonical link tag on the page.\n\n- `mabExperimentId: string`\n The ID of the MAB test (or dynamic test) associated with this page, if applicable\n\n- `metaDescription: string`\n A description that goes in tag on the page.\n\n- `name: string`\n The internal name of the page.\n\n- `pageExpiryDate: number`\n The date at which this page should expire and begin redirecting to another url or page.\n\n- `pageExpiryEnabled: boolean`\n Boolean describing if the page expiration feature is enabled for this page\n\n- `pageExpiryRedirectId: number`\n The ID of another page this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectUrl.\n\n- `pageExpiryRedirectUrl: string`\n The URL this page's url should redirect to once this page expires. Should only set this or pageExpiryRedirectId.\n\n- `pageRedirected: boolean`\n A generated Boolean describing whether or not this page is currently expired and being redirected.\n\n- `password: string`\n Set this to create a password protected page. Entering the password will be required to view the page.\n\n- `publicAccessRules: object[]`\n Rules for require member registration to access private content.\n\n- `publicAccessRulesEnabled: boolean`\n Boolean to determine whether or not to respect publicAccessRules.\n\n- `publishDate: string`\n The date (ISO8601 format) the page is to be published at.\n\n- `publishImmediately: boolean`\n Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting.\n\n- `slug: string`\n The path of the this page. This field is appended to the domain to construct the url of this page.\n\n- `state: string`\n An ENUM descibing the current state of this page.\n\n- `subcategory: string`\n Details the type of page this is. Should always be landing_page or site_page\n\n- `templatePath: string`\n String detailing the path of the template used for this page.\n\n- `themeSettingsValues: object`\n A collection of settings specific to the theme applied to the page.\n\n- `translatedFromId: string`\n ID of the primary page this object was translated from.\n\n- `translations: object`\n A map of translations for the page, each associated with a specific language variation.\n\n- `updated: string`\n The timestamp indicating when the page was last updated.\n\n- `updatedById: string`\n The ID of the user that updated this page.\n\n- `url: string`\n A generated field representing the URL of this page.\n\n- `useFeaturedImage: boolean`\n Boolean to determine if this page should use a featuredImage.\n\n- `widgetContainers: object`\n A data structure containing the data for all the modules inside the containers for this page. This will only be populated if the page has widget containers.\n\n- `widgets: object`\n A data structure containing the data for all the modules for this page.\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.draft.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: { foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [{\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n}],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n},\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [{ color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n} }],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n},\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n},\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n},\n type: 'type',\n w: 0,\n x: 0,\n} },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: { foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n} },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.draft.updateDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.draft.updateDraft('objectId', {\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestId: 'abTestId',\n archivedAt: '2019-12-27T18:11:19.117Z',\n archivedInDashboard: true,\n attachedStylesheets: [{ foo: {} }],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryId: 0,\n contentGroupId: 'contentGroupId',\n contentTypeCategory: '0',\n created: '2019-12-27T18:11:19.117Z',\n createdById: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceId: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDbTableId: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderId: 'folderId',\n footerHtml: 'footerHtml',\n headHtml: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: {\n foo: {\n cells: [],\n cssClass: 'cssClass',\n cssId: 'cssId',\n cssStyle: 'cssStyle',\n label: 'label',\n name: 'name',\n params: { foo: {} },\n rowMetaData: [\n {\n cssClass: 'cssClass',\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n },\n ],\n rows: [{}],\n styles: {\n backgroundColor: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n backgroundGradient: {\n angle: { units: 'DEGREES', value: 0 },\n colors: [\n {\n color: {\n a: 0,\n b: 0,\n g: 0,\n r: 0,\n },\n },\n ],\n sideOrCorner: { horizontalSide: 'CENTER', verticalSide: 'BOTTOM' },\n },\n backgroundImage: {\n backgroundPosition: 'backgroundPosition',\n backgroundSize: 'backgroundSize',\n imageUrl: 'imageUrl',\n },\n flexboxPositioning: 'BOTTOM_CENTER',\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: 'BOTTOM',\n },\n type: 'type',\n w: 0,\n x: 0,\n },\n },\n linkRelCanonicalUrl: 'linkRelCanonicalUrl',\n mabExperimentId: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectId: 0,\n pageExpiryRedirectUrl: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: { foo: {} },\n translatedFromId: 'translatedFromId',\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: 'authorName',\n campaign: 'campaign',\n campaignName: 'campaignName',\n created: '2019-12-27T18:11:19.117Z',\n name: 'name',\n password: 'password',\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: '2019-12-27T18:11:19.117Z',\n slug: 'slug',\n state: 'state',\n updated: '2019-12-27T18:11:19.117Z',\n },\n },\n updated: '2019-12-27T18:11:19.117Z',\n updatedById: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: { foo: {} },\n widgets: { foo: {} },\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.draft.update_draft', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.draft.update_draft(\n object_id="objectId",\n id="id",\n ab_status="automated_loser_variant",\n ab_test_id="abTestId",\n archived_at=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n archived_in_dashboard=True,\n attached_stylesheets=[{\n "foo": {}\n }],\n author_name="authorName",\n campaign="campaign",\n category_id=0,\n content_group_id="contentGroupId",\n content_type_category="0",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n created_by_id="createdById",\n currently_published=True,\n current_state="AGENT_GENERATED",\n domain="domain",\n dynamic_page_data_source_id="dynamicPageDataSourceId",\n dynamic_page_data_source_type=0,\n dynamic_page_hub_db_table_id="dynamicPageHubDbTableId",\n enable_domain_stylesheets=True,\n enable_layout_stylesheets=True,\n featured_image="featuredImage",\n featured_image_alt_text="featuredImageAltText",\n folder_id="folderId",\n footer_html="footerHtml",\n head_html="headHtml",\n html_title="htmlTitle",\n include_default_custom_css=True,\n language="aa",\n layout_sections={\n "foo": {\n "cells": [],\n "css_class": "cssClass",\n "css_id": "cssId",\n "css_style": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "row_meta_data": [{\n "css_class": "cssClass",\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n }],\n "rows": [{}],\n "styles": {\n "background_color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n },\n "background_gradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0,\n },\n "colors": [{\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0,\n }\n }],\n "side_or_corner": {\n "horizontal_side": "CENTER",\n "vertical_side": "BOTTOM",\n },\n },\n "background_image": {\n "background_position": "backgroundPosition",\n "background_size": "backgroundSize",\n "image_url": "imageUrl",\n },\n "flexbox_positioning": "BOTTOM_CENTER",\n "force_full_width_section": True,\n "max_width_section_centering": 0,\n "vertical_alignment": "BOTTOM",\n },\n "type": "type",\n "w": 0,\n "x": 0,\n }\n },\n link_rel_canonical_url="linkRelCanonicalUrl",\n mab_experiment_id="mabExperimentId",\n meta_description="metaDescription",\n name="name",\n page_expiry_date=0,\n page_expiry_enabled=True,\n page_expiry_redirect_id=0,\n page_expiry_redirect_url="pageExpiryRedirectUrl",\n page_redirected=True,\n password="password",\n public_access_rules=[{}],\n public_access_rules_enabled=True,\n publish_date=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n publish_immediately=True,\n slug="slug",\n state="state",\n subcategory="subcategory",\n template_path="templatePath",\n theme_settings_values={\n "foo": {}\n },\n translated_from_id="translatedFromId",\n translations={\n "foo": {\n "id": 0,\n "archived_in_dashboard": True,\n "author_name": "authorName",\n "campaign": "campaign",\n "campaign_name": "campaignName",\n "created": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "name": "name",\n "password": "password",\n "public_access_rules": [{}],\n "public_access_rules_enabled": True,\n "publish_date": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "slug": "slug",\n "state": "state",\n "updated": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n }\n },\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n updated_by_id="updatedById",\n url="url",\n use_featured_image=True,\n widget_containers={\n "foo": {}\n },\n widgets={\n "foo": {}\n },\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().draft().updateDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.cms.PublicAccessRule;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.draft.DraftUpdateDraftParams;\nimport java.time.OffsetDateTime;\nimport java.util.List;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DraftUpdateDraftParams params = DraftUpdateDraftParams.builder()\n .objectId("objectId")\n .pagesPage(PagesPage.builder()\n .id("id")\n .abStatus(PagesPage.AbStatus.AUTOMATED_LOSER_VARIANT)\n .abTestId("abTestId")\n .archivedAt(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .archivedInDashboard(true)\n .addAttachedStylesheet(PagesPage.AttachedStylesheet.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .authorName("authorName")\n .campaign("campaign")\n .categoryId(0)\n .contentGroupId("contentGroupId")\n .contentTypeCategory(PagesPage.ContentTypeCategory._0)\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .createdById("createdById")\n .currentlyPublished(true)\n .currentState(PagesPage.CurrentState.AGENT_GENERATED)\n .domain("domain")\n .dynamicPageDataSourceId("dynamicPageDataSourceId")\n .dynamicPageDataSourceType(0)\n .dynamicPageHubDbTableId("dynamicPageHubDbTableId")\n .enableDomainStylesheets(true)\n .enableLayoutStylesheets(true)\n .featuredImage("featuredImage")\n .featuredImageAltText("featuredImageAltText")\n .folderId("folderId")\n .footerHtml("footerHtml")\n .headHtml("headHtml")\n .htmlTitle("htmlTitle")\n .includeDefaultCustomCss(true)\n .language(PagesPage.Language.AA)\n .layoutSections(PagesPage.LayoutSections.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "cells",\n List.of(),\n "cssClass",\n "cssClass",\n "cssId",\n "cssId",\n "cssStyle",\n "cssStyle",\n "label",\n "label",\n "name",\n "name",\n "params",\n Map.of(\n "foo", Map.of()\n ),\n "rowMetaData",\n List.of(Map.of(\n "cssClass",\n "cssClass",\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n )\n )),\n "rows",\n List.of(Map.of()),\n "styles",\n Map.of(\n "backgroundColor",\n Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n ),\n "backgroundGradient",\n Map.of(\n "angle",\n Map.of(\n "units",\n "DEGREES",\n "value",\n 0\n ),\n "colors",\n List.of(Map.of(\n "color", Map.of(\n "a",\n 0,\n "b",\n 0,\n "g",\n 0,\n "r",\n 0\n )\n )),\n "sideOrCorner",\n Map.of(\n "horizontalSide",\n "CENTER",\n "verticalSide",\n "BOTTOM"\n )\n ),\n "backgroundImage",\n Map.of(\n "backgroundPosition",\n "backgroundPosition",\n "backgroundSize",\n "backgroundSize",\n "imageUrl",\n "imageUrl"\n ),\n "flexboxPositioning",\n "BOTTOM_CENTER",\n "forceFullWidthSection",\n true,\n "maxWidthSectionCentering",\n 0,\n "verticalAlignment",\n "BOTTOM"\n ),\n "type",\n "type",\n "w",\n 0,\n "x",\n 0\n )))\n .build())\n .linkRelCanonicalUrl("linkRelCanonicalUrl")\n .mabExperimentId("mabExperimentId")\n .metaDescription("metaDescription")\n .name("name")\n .pageExpiryDate(0L)\n .pageExpiryEnabled(true)\n .pageExpiryRedirectId(0L)\n .pageExpiryRedirectUrl("pageExpiryRedirectUrl")\n .pageRedirected(true)\n .password("password")\n .addPublicAccessRule(PublicAccessRule.builder().build())\n .publicAccessRulesEnabled(true)\n .publishDate(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .publishImmediately(true)\n .slug("slug")\n .state("state")\n .subcategory("subcategory")\n .templatePath("templatePath")\n .themeSettingsValues(PagesPage.ThemeSettingsValues.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .translatedFromId("translatedFromId")\n .translations(PagesPage.Translations.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of(\n "id",\n 0,\n "archivedInDashboard",\n true,\n "authorName",\n "authorName",\n "campaign",\n "campaign",\n "campaignName",\n "campaignName",\n "created",\n "2019-12-27T18:11:19.117Z",\n "name",\n "name",\n "password",\n "password",\n "publicAccessRules",\n List.of(Map.of()),\n "publicAccessRulesEnabled",\n true,\n "publishDate",\n "2019-12-27T18:11:19.117Z",\n "slug",\n "slug",\n "state",\n "state",\n "updated",\n "2019-12-27T18:11:19.117Z"\n )))\n .build())\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .updatedById("updatedById")\n .url("url")\n .useFeaturedImage(true)\n .widgetContainers(PagesPage.WidgetContainers.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .widgets(PagesPage.Widgets.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .build())\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().draft().updateDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Draft.UpdateDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Draft.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageDraftUpdateDraftParams{\n\t\t\tPagesPage: cms.PagesPageParam{\n\t\t\t\tID: "id",\n\t\t\t\tAbStatus: cms.PagesPageAbStatusAutomatedLoserVariant,\n\t\t\t\tAbTestID: "abTestId",\n\t\t\t\tArchivedAt: time.Now(),\n\t\t\t\tArchivedInDashboard: true,\n\t\t\t\tAttachedStylesheets: []map[string]any{{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t}},\n\t\t\t\tAuthorName: "authorName",\n\t\t\t\tCampaign: "campaign",\n\t\t\t\tCategoryID: 0,\n\t\t\t\tContentGroupID: "contentGroupId",\n\t\t\t\tContentTypeCategory: cms.PagesPageContentTypeCategory0,\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tCreatedByID: "createdById",\n\t\t\t\tCurrentlyPublished: true,\n\t\t\t\tCurrentState: cms.PagesPageCurrentStateAgentGenerated,\n\t\t\t\tDomain: "domain",\n\t\t\t\tDynamicPageDataSourceID: "dynamicPageDataSourceId",\n\t\t\t\tDynamicPageDataSourceType: 0,\n\t\t\t\tDynamicPageHubDBTableID: "dynamicPageHubDbTableId",\n\t\t\t\tEnableDomainStylesheets: true,\n\t\t\t\tEnableLayoutStylesheets: true,\n\t\t\t\tFeaturedImage: "featuredImage",\n\t\t\t\tFeaturedImageAltText: "featuredImageAltText",\n\t\t\t\tFolderID: "folderId",\n\t\t\t\tFooterHTML: "footerHtml",\n\t\t\t\tHeadHTML: "headHtml",\n\t\t\t\tHTMLTitle: "htmlTitle",\n\t\t\t\tIncludeDefaultCustomCss: true,\n\t\t\t\tLanguage: cms.PagesPageLanguageAa,\n\t\t\t\tLayoutSections: map[string]cms.LayoutSectionParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tCells: []cms.LayoutSectionParam{},\n\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\tCssID: "cssId",\n\t\t\t\t\t\tCssStyle: "cssStyle",\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tParams: map[string]any{\n\t\t\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t\t\t},\n\t\t\t\t\t\tRowMetaData: []cms.RowMetaDataParam{{\n\t\t\t\t\t\t\tCssClass: "cssClass",\n\t\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tRows: []map[string]cms.LayoutSectionParam{{}},\n\t\t\t\t\t\tStyles: cms.StylesParam{\n\t\t\t\t\t\t\tBackgroundColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundGradient: cms.GradientParam{\n\t\t\t\t\t\t\t\tAngle: cms.AngleParam{\n\t\t\t\t\t\t\t\t\tUnits: cms.AngleUnitsDegrees,\n\t\t\t\t\t\t\t\t\tValue: 0,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tColors: []cms.ColorStopParam{{\n\t\t\t\t\t\t\t\t\tColor: cms.RgbaColorParam{\n\t\t\t\t\t\t\t\t\t\tA: 0,\n\t\t\t\t\t\t\t\t\t\tB: 0,\n\t\t\t\t\t\t\t\t\t\tG: 0,\n\t\t\t\t\t\t\t\t\t\tR: 0,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tSideOrCorner: cms.SideOrCornerParam{\n\t\t\t\t\t\t\t\t\tHorizontalSide: cms.SideOrCornerHorizontalSideCenter,\n\t\t\t\t\t\t\t\t\tVerticalSide: cms.SideOrCornerVerticalSideBottom,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tBackgroundImage: cms.BackgroundImageParam{\n\t\t\t\t\t\t\t\tBackgroundPosition: "backgroundPosition",\n\t\t\t\t\t\t\t\tBackgroundSize: "backgroundSize",\n\t\t\t\t\t\t\t\tImageURL: "imageUrl",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tFlexboxPositioning: cms.StylesFlexboxPositioningBottomCenter,\n\t\t\t\t\t\t\tForceFullWidthSection: true,\n\t\t\t\t\t\t\tMaxWidthSectionCentering: 0,\n\t\t\t\t\t\t\tVerticalAlignment: cms.StylesVerticalAlignmentBottom,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tType: "type",\n\t\t\t\t\t\tW: 0,\n\t\t\t\t\t\tX: 0,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tLinkRelCanonicalURL: "linkRelCanonicalUrl",\n\t\t\t\tMabExperimentID: "mabExperimentId",\n\t\t\t\tMetaDescription: "metaDescription",\n\t\t\t\tName: "name",\n\t\t\t\tPageExpiryDate: 0,\n\t\t\t\tPageExpiryEnabled: true,\n\t\t\t\tPageExpiryRedirectID: 0,\n\t\t\t\tPageExpiryRedirectURL: "pageExpiryRedirectUrl",\n\t\t\t\tPageRedirected: true,\n\t\t\t\tPassword: "password",\n\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\tPublishDate: time.Now(),\n\t\t\t\tPublishImmediately: true,\n\t\t\t\tSlug: "slug",\n\t\t\t\tState: "state",\n\t\t\t\tSubcategory: "subcategory",\n\t\t\t\tTemplatePath: "templatePath",\n\t\t\t\tThemeSettingsValues: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tTranslatedFromID: "translatedFromId",\n\t\t\t\tTranslations: map[string]cms.ContentLanguageVariationParam{\n\t\t\t\t\t"foo": {\n\t\t\t\t\t\tID: 0,\n\t\t\t\t\t\tArchivedInDashboard: true,\n\t\t\t\t\t\tAuthorName: "authorName",\n\t\t\t\t\t\tCampaign: "campaign",\n\t\t\t\t\t\tCampaignName: "campaignName",\n\t\t\t\t\t\tCreated: time.Now(),\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tPassword: "password",\n\t\t\t\t\t\tPublicAccessRules: []cms.PublicAccessRule{map[string]any{}},\n\t\t\t\t\t\tPublicAccessRulesEnabled: true,\n\t\t\t\t\t\tPublishDate: time.Now(),\n\t\t\t\t\t\tSlug: "slug",\n\t\t\t\t\t\tState: "state",\n\t\t\t\t\t\tUpdated: time.Now(),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tUpdated: time.Now(),\n\t\t\t\tUpdatedByID: "updatedById",\n\t\t\t\tURL: "url",\n\t\t\t\tUseFeaturedImage: true,\n\t\t\t\tWidgetContainers: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tWidgets: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.draft.update_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.draft.update_draft(\n "objectId",\n id: "id",\n ab_status: :automated_loser_variant,\n ab_test_id: "abTestId",\n archived_at: "2019-12-27T18:11:19.117Z",\n archived_in_dashboard: true,\n attached_stylesheets: [{foo: {}}],\n author_name: "authorName",\n campaign: "campaign",\n category_id: 0,\n content_group_id: "contentGroupId",\n content_type_category: :"0",\n created: "2019-12-27T18:11:19.117Z",\n created_by_id: "createdById",\n currently_published: true,\n current_state: :AGENT_GENERATED,\n domain: "domain",\n dynamic_page_data_source_id: "dynamicPageDataSourceId",\n dynamic_page_data_source_type: 0,\n dynamic_page_hub_db_table_id: "dynamicPageHubDbTableId",\n enable_domain_stylesheets: true,\n enable_layout_stylesheets: true,\n featured_image: "featuredImage",\n featured_image_alt_text: "featuredImageAltText",\n folder_id: "folderId",\n footer_html: "footerHtml",\n head_html: "headHtml",\n html_title: "htmlTitle",\n include_default_custom_css: true,\n language: :aa,\n layout_sections: {\n foo: {\n cells: [],\n cssClass: "cssClass",\n cssId: "cssId",\n cssStyle: "cssStyle",\n label: "label",\n name: "name",\n params: {foo: {}},\n rowMetaData: [\n {\n cssClass: "cssClass",\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n }\n }\n ],\n rows: [{}],\n styles: {\n backgroundColor: {a: 0, b: 0, g: 0, r: 0},\n backgroundGradient: {\n angle: {units: :DEGREES, value: 0},\n colors: [{color: {a: 0, b: 0, g: 0, r: 0}}],\n sideOrCorner: {horizontalSide: :CENTER, verticalSide: :BOTTOM}\n },\n backgroundImage: {backgroundPosition: "backgroundPosition", backgroundSize: "backgroundSize", imageUrl: "imageUrl"},\n flexboxPositioning: :BOTTOM_CENTER,\n forceFullWidthSection: true,\n maxWidthSectionCentering: 0,\n verticalAlignment: :BOTTOM\n },\n type: "type",\n w: 0,\n x: 0\n }\n },\n link_rel_canonical_url: "linkRelCanonicalUrl",\n mab_experiment_id: "mabExperimentId",\n meta_description: "metaDescription",\n name: "name",\n page_expiry_date: 0,\n page_expiry_enabled: true,\n page_expiry_redirect_id: 0,\n page_expiry_redirect_url: "pageExpiryRedirectUrl",\n page_redirected: true,\n password: "password",\n public_access_rules: [{}],\n public_access_rules_enabled: true,\n publish_date: "2019-12-27T18:11:19.117Z",\n publish_immediately: true,\n slug: "slug",\n state: "state",\n subcategory: "subcategory",\n template_path: "templatePath",\n theme_settings_values: {foo: {}},\n translated_from_id: "translatedFromId",\n translations: {\n foo: {\n id: 0,\n archivedInDashboard: true,\n authorName: "authorName",\n campaign: "campaign",\n campaignName: "campaignName",\n created: "2019-12-27T18:11:19.117Z",\n name: "name",\n password: "password",\n publicAccessRules: [{}],\n publicAccessRulesEnabled: true,\n publishDate: "2019-12-27T18:11:19.117Z",\n slug: "slug",\n state: "state",\n updated: "2019-12-27T18:11:19.117Z"\n }\n },\n updated: "2019-12-27T18:11:19.117Z",\n updated_by_id: "updatedById",\n url: "url",\n use_featured_image: true,\n widget_containers: {foo: {}},\n widgets: {foo: {}}\n)\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->draft->updateDraft', - example: - "cms->pages->sitePages->draft->updateDraft(\n 'objectId',\n id: 'id',\n abStatus: 'automated_loser_variant',\n abTestID: 'abTestId',\n archivedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n archivedInDashboard: true,\n attachedStylesheets: [['foo' => (object) []]],\n authorName: 'authorName',\n campaign: 'campaign',\n categoryID: 0,\n contentGroupID: 'contentGroupId',\n contentTypeCategory: '0',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdByID: 'createdById',\n currentlyPublished: true,\n currentState: 'AGENT_GENERATED',\n domain: 'domain',\n dynamicPageDataSourceID: 'dynamicPageDataSourceId',\n dynamicPageDataSourceType: 0,\n dynamicPageHubDBTableID: 'dynamicPageHubDbTableId',\n enableDomainStylesheets: true,\n enableLayoutStylesheets: true,\n featuredImage: 'featuredImage',\n featuredImageAltText: 'featuredImageAltText',\n folderID: 'folderId',\n footerHTML: 'footerHtml',\n headHTML: 'headHtml',\n htmlTitle: 'htmlTitle',\n includeDefaultCustomCss: true,\n language: 'aa',\n layoutSections: [\n 'foo' => [\n 'cells' => [],\n 'cssClass' => 'cssClass',\n 'cssID' => 'cssId',\n 'cssStyle' => 'cssStyle',\n 'label' => 'label',\n 'name' => 'name',\n 'params' => ['foo' => (object) []],\n 'rowMetaData' => [\n [\n 'cssClass' => 'cssClass',\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [\n ['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]\n ],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n ],\n ],\n 'rows' => [[]],\n 'styles' => [\n 'backgroundColor' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0],\n 'backgroundGradient' => [\n 'angle' => ['units' => 'DEGREES', 'value' => 0],\n 'colors' => [['color' => ['a' => 0, 'b' => 0, 'g' => 0, 'r' => 0]]],\n 'sideOrCorner' => [\n 'horizontalSide' => 'CENTER', 'verticalSide' => 'BOTTOM'\n ],\n ],\n 'backgroundImage' => [\n 'backgroundPosition' => 'backgroundPosition',\n 'backgroundSize' => 'backgroundSize',\n 'imageURL' => 'imageUrl',\n ],\n 'flexboxPositioning' => 'BOTTOM_CENTER',\n 'forceFullWidthSection' => true,\n 'maxWidthSectionCentering' => 0,\n 'verticalAlignment' => 'BOTTOM',\n 'breakpointStyles' => [\n 'foo' => [\n 'hidden' => true,\n 'margin' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n 'padding' => [\n 'bottom' => ['units' => 'CH', 'value' => 0],\n 'left' => ['units' => 'CH', 'value' => 0],\n 'right' => ['units' => 'CH', 'value' => 0],\n 'top' => ['units' => 'CH', 'value' => 0],\n ],\n ],\n ],\n ],\n 'type' => 'type',\n 'w' => 0,\n 'x' => 0,\n ],\n ],\n linkRelCanonicalURL: 'linkRelCanonicalUrl',\n mabExperimentID: 'mabExperimentId',\n metaDescription: 'metaDescription',\n name: 'name',\n pageExpiryDate: 0,\n pageExpiryEnabled: true,\n pageExpiryRedirectID: 0,\n pageExpiryRedirectURL: 'pageExpiryRedirectUrl',\n pageRedirected: true,\n password: 'password',\n publicAccessRules: [(object) []],\n publicAccessRulesEnabled: true,\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishImmediately: true,\n slug: 'slug',\n state: 'state',\n subcategory: 'subcategory',\n templatePath: 'templatePath',\n themeSettingsValues: ['foo' => (object) []],\n translatedFromID: 'translatedFromId',\n translations: [\n 'foo' => [\n 'id' => 0,\n 'archivedInDashboard' => true,\n 'authorName' => 'authorName',\n 'campaign' => 'campaign',\n 'campaignName' => 'campaignName',\n 'created' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'name' => 'name',\n 'password' => 'password',\n 'publicAccessRules' => [(object) []],\n 'publicAccessRulesEnabled' => true,\n 'publishDate' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'slug' => 'slug',\n 'state' => 'state',\n 'updated' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'tagIDs' => [0],\n ],\n ],\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedByID: 'updatedById',\n url: 'url',\n useFeaturedImage: true,\n widgetContainers: ['foo' => (object) []],\n widgets: ['foo' => (object) []],\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/draft \\\n -X PATCH \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "abStatus": "automated_loser_variant",\n "abTestId": "abTestId",\n "archivedAt": "2019-12-27T18:11:19.117Z",\n "archivedInDashboard": true,\n "attachedStylesheets": [\n {\n "foo": {}\n }\n ],\n "authorName": "authorName",\n "campaign": "campaign",\n "categoryId": 0,\n "contentGroupId": "contentGroupId",\n "contentTypeCategory": "0",\n "created": "2019-12-27T18:11:19.117Z",\n "createdById": "createdById",\n "currentlyPublished": true,\n "currentState": "AGENT_GENERATED",\n "domain": "domain",\n "dynamicPageDataSourceId": "dynamicPageDataSourceId",\n "dynamicPageDataSourceType": 0,\n "dynamicPageHubDbTableId": "dynamicPageHubDbTableId",\n "enableDomainStylesheets": true,\n "enableLayoutStylesheets": true,\n "featuredImage": "featuredImage",\n "featuredImageAltText": "featuredImageAltText",\n "folderId": "folderId",\n "footerHtml": "footerHtml",\n "headHtml": "headHtml",\n "htmlTitle": "htmlTitle",\n "includeDefaultCustomCss": true,\n "language": "aa",\n "layoutSections": {\n "foo": {\n "cells": [],\n "cssClass": "cssClass",\n "cssId": "cssId",\n "cssStyle": "cssStyle",\n "label": "label",\n "name": "name",\n "params": {\n "foo": {}\n },\n "rowMetaData": [\n {\n "cssClass": "cssClass",\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n }\n }\n ],\n "rows": [\n {}\n ],\n "styles": {\n "backgroundColor": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n },\n "backgroundGradient": {\n "angle": {\n "units": "DEGREES",\n "value": 0\n },\n "colors": [\n {\n "color": {\n "a": 0,\n "b": 0,\n "g": 0,\n "r": 0\n }\n }\n ],\n "sideOrCorner": {\n "horizontalSide": "CENTER",\n "verticalSide": "BOTTOM"\n }\n },\n "backgroundImage": {\n "backgroundPosition": "backgroundPosition",\n "backgroundSize": "backgroundSize",\n "imageUrl": "imageUrl"\n },\n "flexboxPositioning": "BOTTOM_CENTER",\n "forceFullWidthSection": true,\n "maxWidthSectionCentering": 0,\n "verticalAlignment": "BOTTOM"\n },\n "type": "type",\n "w": 0,\n "x": 0\n }\n },\n "linkRelCanonicalUrl": "linkRelCanonicalUrl",\n "mabExperimentId": "mabExperimentId",\n "metaDescription": "metaDescription",\n "name": "name",\n "pageExpiryDate": 0,\n "pageExpiryEnabled": true,\n "pageExpiryRedirectId": 0,\n "pageExpiryRedirectUrl": "pageExpiryRedirectUrl",\n "pageRedirected": true,\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "publishImmediately": true,\n "slug": "slug",\n "state": "state",\n "subcategory": "subcategory",\n "templatePath": "templatePath",\n "themeSettingsValues": {\n "foo": {}\n },\n "translatedFromId": "translatedFromId",\n "translations": {\n "foo": {\n "id": 0,\n "archivedInDashboard": true,\n "authorName": "authorName",\n "campaign": "campaign",\n "campaignName": "campaignName",\n "created": "2019-12-27T18:11:19.117Z",\n "name": "name",\n "password": "password",\n "publicAccessRules": [\n {}\n ],\n "publicAccessRulesEnabled": true,\n "publishDate": "2019-12-27T18:11:19.117Z",\n "slug": "slug",\n "state": "state",\n "updated": "2019-12-27T18:11:19.117Z"\n }\n },\n "updated": "2019-12-27T18:11:19.117Z",\n "updatedById": "updatedById",\n "url": "url",\n "useFeaturedImage": true,\n "widgetContainers": {\n "foo": {}\n },\n "widgets": {\n "foo": {}\n }\n }\'', - }, - }, - }, - { - name: 'attach_to_lang_group', - endpoint: '/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group', - httpMethod: 'post', - summary: 'Add a website page to a multi-language group', - description: 'Attach a site page to a multi-language group.', - stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) attach_to_lang_group', - qualified: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', - params: ['id: string;', 'language: string;', 'primaryId: string;', 'primaryLanguage?: string;'], - response: 'string', - markdown: - "## attach_to_lang_group\n\n`client.cms.pages.sitePages.multiLanguage.attachToLangGroup(id: string, language: string, primaryId: string, primaryLanguage?: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group`\n\nAttach a site page to a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to add to a multi-language group.\n\n- `language: string`\n Designated language of the object to add to a multi-language group.\n\n- `primaryId: string`\n ID of primary language object in multi-language group.\n\n- `primaryLanguage?: string`\n Primary language of the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.attachToLangGroup({\n id: 'id',\n language: 'aa',\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.site_pages.multi_language.attach_to_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.attach_to_lang_group(\n id="id",\n language="aa",\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().sitePages().multiLanguage().attachToLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.AttachToLangPrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttachToLangPrimaryRequestVNext params = AttachToLangPrimaryRequestVNext.builder()\n .id("id")\n .language(AttachToLangPrimaryRequestVNext.Language.AA)\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().attachToLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.MultiLanguage.AttachToLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.AttachToLangGroup(context.TODO(), cms.PageSitePageMultiLanguageAttachToLangGroupParams{\n\t\tAttachToLangPrimaryRequestVNext: cms.AttachToLangPrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t\tLanguage: cms.AttachToLangPrimaryRequestVNextLanguageAa,\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.multi_language.attach_to_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.attach_to_lang_group(\n id: "id",\n language: :aa,\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->pages->sitePages->multiLanguage->attachToLangGroup', - example: - "cms->pages->sitePages->multiLanguage->attachToLangGroup(\n id: 'id', language: 'aa', primaryID: 'primaryId', primaryLanguage: 'aa'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "language": "aa",\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'create_language_variation', - endpoint: '/cms/pages/2026-03/site-pages/multi-language/create-language-variation', - httpMethod: 'post', - summary: 'Create a new language variation', - description: - 'Create a new language variation from an existing website page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source website page](/api-reference/latest/cms/pages/website-pages/drafts/get-website-page-draft).', - stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) create_language_variation', - qualified: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', - params: ['id: string;', 'language?: string;', 'primaryLanguage?: string;', 'usePublished?: boolean;'], - response: 'object', - markdown: - "## create_language_variation\n\n`client.cms.pages.sitePages.multiLanguage.createLanguageVariation(id: string, language?: string, primaryLanguage?: string, usePublished?: boolean): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/create-language-variation`\n\nCreate a new language variation from an existing website page. The variation will be a copy of the draft state of the source page. To preview the content, you can [retrieve the draft of the source website page](/api-reference/latest/cms/pages/website-pages/drafts/get-website-page-draft).\n\n### Parameters\n\n- `id: string`\n ID of content to clone.\n\n- `language?: string`\n Target language of new variant.\n\n- `primaryLanguage?: string`\n Language of primary content to clone.\n\n- `usePublished?: boolean`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.multiLanguage.createLanguageVariation({ id: 'id' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.multiLanguage.createLanguageVariation({\n id: 'id',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.multi_language.create_language_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.multi_language.create_language_variation(\n id="id",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().multiLanguage().createLanguageVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.ContentLanguageCloneRequestVNext;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContentLanguageCloneRequestVNext params = ContentLanguageCloneRequestVNext.builder()\n .id("id")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().multiLanguage().createLanguageVariation(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.MultiLanguage.NewLanguageVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.MultiLanguage.NewLanguageVariation(context.TODO(), cms.PageSitePageMultiLanguageNewLanguageVariationParams{\n\t\tContentLanguageCloneRequestVNext: cms.ContentLanguageCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.multi_language.create_language_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.multi_language.create_language_variation(id: "id")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->multiLanguage->createLanguageVariation', - example: - "cms\n ->pages\n ->sitePages\n ->multiLanguage\n ->createLanguageVariation(\n id: 'id',\n language: 'language',\n primaryLanguage: 'primaryLanguage',\n usePublished: true,\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/create-language-variation \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'detach_from_lang_group', - endpoint: '/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group', - httpMethod: 'post', - summary: 'Remove a website page from a multi-language group', - description: 'Detach a website page from a multi-language group.', - stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) detach_from_lang_group', - qualified: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', - params: ['id: string;'], - response: 'string', - markdown: - "## detach_from_lang_group\n\n`client.cms.pages.sitePages.multiLanguage.detachFromLangGroup(id: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group`\n\nDetach a website page from a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of the object to remove from a multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.detachFromLangGroup({ id: 'id' });\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.site_pages.multi_language.detach_from_lang_group', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.detach_from_lang_group(\n id="id",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().sitePages().multiLanguage().detachFromLangGroup', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.DetachFromLangGroupRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DetachFromLangGroupRequestVNext params = DetachFromLangGroupRequestVNext.builder()\n .id("id")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().detachFromLangGroup(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.MultiLanguage.DetachFromLangGroup', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.DetachFromLangGroup(context.TODO(), cms.PageSitePageMultiLanguageDetachFromLangGroupParams{\n\t\tDetachFromLangGroupRequestVNext: cms.DetachFromLangGroupRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.multi_language.detach_from_lang_group', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.detach_from_lang_group(id: "id")\n\nputs(response)', - }, - php: { - method: 'cms->pages->sitePages->multiLanguage->detachFromLangGroup', - example: - "cms->pages->sitePages->multiLanguage->detachFromLangGroup(\n id: 'id'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'set_new_lang_primary', - endpoint: '/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary', - httpMethod: 'put', - summary: 'Set a new primary language', - description: 'Set a site page as the primary language of a multi-language group.', - stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) set_new_lang_primary', - qualified: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', - params: ['id: string;'], - markdown: - "## set_new_lang_primary\n\n`client.cms.pages.sitePages.multiLanguage.setNewLangPrimary(id: string): void`\n\n**put** `/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary`\n\nSet a site page as the primary language of a multi-language group.\n\n### Parameters\n\n- `id: string`\n ID of object to set as primary in multi-language group.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.pages.sitePages.multiLanguage.setNewLangPrimary({ id: 'id' })\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.pages.sitePages.multiLanguage.setNewLangPrimary({ id: 'id' });", - }, - python: { - method: 'cms.pages.site_pages.multi_language.set_new_lang_primary', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.pages.site_pages.multi_language.set_new_lang_primary(\n id="id",\n)', - }, - java: { - method: 'cms().pages().sitePages().multiLanguage().setNewLangPrimary', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.SetNewLanguagePrimaryRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SetNewLanguagePrimaryRequestVNext params = SetNewLanguagePrimaryRequestVNext.builder()\n .id("id")\n .build();\n client.cms().pages().sitePages().multiLanguage().setNewLangPrimary(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.MultiLanguage.SetNewLangPrimary', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.Pages.SitePages.MultiLanguage.SetNewLangPrimary(context.TODO(), cms.PageSitePageMultiLanguageSetNewLangPrimaryParams{\n\t\tSetNewLanguagePrimaryRequestVNext: cms.SetNewLanguagePrimaryRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.multi_language.set_new_lang_primary', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.pages.site_pages.multi_language.set_new_lang_primary(id: "id")\n\nputs(result)', - }, - php: { - method: 'cms->pages->sitePages->multiLanguage->setNewLangPrimary', - example: - "cms->pages->sitePages->multiLanguage->setNewLangPrimary(\n id: 'id'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary \\\n -X PUT \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update_languages', - endpoint: '/cms/pages/2026-03/site-pages/multi-language/update-languages', - httpMethod: 'post', - summary: 'Update languages of multi-language group', - description: 'Explicitly set new languages for each site page in a multi-language group.', - stainlessPath: '(resource) cms.pages.site-pages.multi-language > (method) update_languages', - qualified: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', - params: ['languages: object;', 'primaryId: string;'], - response: 'string', - markdown: - "## update_languages\n\n`client.cms.pages.sitePages.multiLanguage.updateLanguages(languages: object, primaryId: string): string`\n\n**post** `/cms/pages/2026-03/site-pages/multi-language/update-languages`\n\nExplicitly set new languages for each site page in a multi-language group.\n\n### Parameters\n\n- `languages: object`\n Map of object IDs to associated languages of object in the multi-language group.\n\n- `primaryId: string`\n ID of the primary object in the multi-language group.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.cms.pages.sitePages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.cms.pages.sitePages.multiLanguage.updateLanguages({\n languages: { foo: 'aa' },\n primaryId: 'primaryId',\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.pages.site_pages.multi_language.update_languages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.cms.pages.site_pages.multi_language.update_languages(\n languages={\n "foo": "aa"\n },\n primary_id="primaryId",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'cms().pages().sitePages().multiLanguage().updateLanguages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.UpdateLanguagesRequestVNext;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateLanguagesRequestVNext params = UpdateLanguagesRequestVNext.builder()\n .languages(UpdateLanguagesRequestVNext.Languages.builder()\n .putAdditionalProperty("foo", JsonValue.from("aa"))\n .build())\n .primaryId("primaryId")\n .build();\n HttpResponse response = client.cms().pages().sitePages().multiLanguage().updateLanguages(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.MultiLanguage.UpdateLanguages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Cms.Pages.SitePages.MultiLanguage.UpdateLanguages(context.TODO(), cms.PageSitePageMultiLanguageUpdateLanguagesParams{\n\t\tUpdateLanguagesRequestVNext: cms.UpdateLanguagesRequestVNextParam{\n\t\t\tLanguages: map[string]string{\n\t\t\t\t"foo": "aa",\n\t\t\t},\n\t\t\tPrimaryID: "primaryId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.multi_language.update_languages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.cms.pages.site_pages.multi_language.update_languages(\n languages: {foo: :aa},\n primary_id: "primaryId"\n)\n\nputs(response)', - }, - php: { - method: 'cms->pages->sitePages->multiLanguage->updateLanguages', - example: - "cms->pages->sitePages->multiLanguage->updateLanguages(\n languages: ['foo' => 'aa'], primaryID: 'primaryId'\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/multi-language/update-languages \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "languages": {\n "foo": "aa"\n },\n "primaryId": "primaryId"\n }\'', - }, - }, - }, - { - name: 'get_site_page_revision', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Retrieve a previous version of a website page', - description: 'Retrieve a previous version of a website page by the revision ID.', - stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) get_site_page_revision', - qualified: 'client.cms.pages.sitePages.revisions.getSitePageRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## get_site_page_revision\n\n`client.cms.pages.sitePages.revisions.getSitePageRevision(objectId: string, revisionId: string): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}`\n\nRetrieve a previous version of a website page by the revision ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pageVersion = await client.cms.pages.sitePages.revisions.getSitePageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pageVersion);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.revisions.getSitePageRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pageVersion = await client.cms.pages.sitePages.revisions.getSitePageRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(pageVersion.id);", - }, - python: { - method: 'cms.pages.site_pages.revisions.get_site_page_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage_version = client.cms.pages.site_pages.revisions.get_site_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(page_version.id)', - }, - java: { - method: 'cms().pages().sitePages().revisions().getSitePageRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PageVersion;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionGetSitePageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionGetSitePageRevisionParams params = RevisionGetSitePageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PageVersion pageVersion = client.cms().pages().sitePages().revisions().getSitePageRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Revisions.GetSitePageRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpageVersion, err := client.Cms.Pages.SitePages.Revisions.GetSitePageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageSitePageRevisionGetSitePageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pageVersion.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.revisions.get_site_page_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage_version = hubspot.cms.pages.site_pages.revisions.get_site_page_revision("revisionId", object_id_: "objectId")\n\nputs(page_version)', - }, - php: { - method: 'cms->pages->sitePages->revisions->getSitePageRevision', - example: - "cms->pages->sitePages->revisions->getSitePageRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($pageVersion);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_site_page_revisions', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions', - httpMethod: 'get', - summary: 'Retrieve all previous versions of a website page', - description: 'Retrieves all the previous versions of a website page, specified by page ID.', - stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) list_site_page_revisions', - qualified: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', - params: ['objectId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## list_site_page_revisions\n\n`client.cms.pages.sitePages.revisions.listSitePageRevisions(objectId: string, after?: string, before?: string, limit?: number): { id: string; object: pages_page; updatedAt: string; user: version_user; }`\n\n**get** `/cms/pages/2026-03/site-pages/{objectId}/revisions`\n\nRetrieves all the previous versions of a website page, specified by page ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.sitePages.revisions.listSitePageRevisions('objectId')) {\n console.log(pageVersion);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const pageVersion of client.cms.pages.sitePages.revisions.listSitePageRevisions(\n 'objectId',\n)) {\n console.log(pageVersion.id);\n}", - }, - python: { - method: 'cms.pages.site_pages.revisions.list_site_page_revisions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.pages.site_pages.revisions.list_site_page_revisions(\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().pages().sitePages().revisions().listSitePageRevisions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionListSitePageRevisionsPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionListSitePageRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionListSitePageRevisionsPage page = client.cms().pages().sitePages().revisions().listSitePageRevisions("objectId");\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Revisions.ListSitePageRevisions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.Pages.SitePages.Revisions.ListSitePageRevisions(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcms.PageSitePageRevisionListSitePageRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.revisions.list_site_page_revisions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.pages.site_pages.revisions.list_site_page_revisions("objectId")\n\nputs(page)', - }, - php: { - method: 'cms->pages->sitePages->revisions->listSitePageRevisions', - example: - "cms->pages->sitePages->revisions->listSitePageRevisions(\n 'objectId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_site_page_revision', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore', - httpMethod: 'post', - summary: 'Restore a previous version of a website page', - description: 'Restores a website page to a previous version, specified by page ID and version ID.', - stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) restore_site_page_revision', - qualified: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', - params: ['objectId: string;', 'revisionId: string;'], - response: 'object', - markdown: - "## restore_site_page_revision\n\n`client.cms.pages.sitePages.revisions.restoreSitePageRevision(objectId: string, revisionId: string): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore`\n\nRestores a website page to a previous version, specified by page ID and version ID.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevision('revisionId', { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevision('revisionId', {\n objectId: 'objectId',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.revisions.restore_site_page_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.revisions.restore_site_page_revision(\n revision_id="revisionId",\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().revisions().restoreSitePageRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionRestoreSitePageRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreSitePageRevisionParams params = RevisionRestoreSitePageRevisionParams.builder()\n .objectId("objectId")\n .revisionId("revisionId")\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().revisions().restoreSitePageRevision(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tcms.PageSitePageRevisionRestoreSitePageRevisionParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.revisions.restore_site_page_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.revisions.restore_site_page_revision("revisionId", object_id_: "objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->revisions->restoreSitePageRevision', - example: - "cms->pages->sitePages->revisions->restoreSitePageRevision(\n 'revisionId', objectID: 'objectId'\n);\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_site_page_revision_to_draft', - endpoint: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft', - httpMethod: 'post', - summary: 'Restore a previous draft of a website page', - description: - 'Takes a specified version of a website page and sets it as the new draft version of the page.', - stainlessPath: '(resource) cms.pages.site-pages.revisions > (method) restore_site_page_revision_to_draft', - qualified: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', - params: ['objectId: string;', 'revisionId: number;'], - response: 'object', - markdown: - "## restore_site_page_revision_to_draft\n\n`client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(objectId: string, revisionId: number): { id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: public_access_rule[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n**post** `/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft`\n\nTakes a specified version of a website page and sets it as the new draft version of the page.\n\n### Parameters\n\n- `objectId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ id: string; abStatus: string; abTestId: string; archivedAt: string; archivedInDashboard: boolean; attachedStylesheets: object[]; authorName: string; campaign: string; categoryId: number; contentGroupId: string; contentTypeCategory: string; created: string; createdById: string; currentlyPublished: boolean; currentState: string; domain: string; dynamicPageDataSourceId: string; dynamicPageDataSourceType: number; dynamicPageHubDbTableId: string; enableDomainStylesheets: boolean; enableLayoutStylesheets: boolean; featuredImage: string; featuredImageAltText: string; folderId: string; footerHtml: string; headHtml: string; htmlTitle: string; includeDefaultCustomCss: boolean; language: string; layoutSections: object; linkRelCanonicalUrl: string; mabExperimentId: string; metaDescription: string; name: string; pageExpiryDate: number; pageExpiryEnabled: boolean; pageExpiryRedirectId: number; pageExpiryRedirectUrl: string; pageRedirected: boolean; password: string; publicAccessRules: object[]; publicAccessRulesEnabled: boolean; publishDate: string; publishImmediately: boolean; slug: string; state: string; subcategory: string; templatePath: string; themeSettingsValues: object; translatedFromId: string; translations: object; updated: string; updatedById: string; url: string; useFeaturedImage: boolean; widgetContainers: object; widgets: object; }`\n\n - `id: string`\n - `abStatus: string`\n - `abTestId: string`\n - `archivedAt: string`\n - `archivedInDashboard: boolean`\n - `attachedStylesheets: object[]`\n - `authorName: string`\n - `campaign: string`\n - `categoryId: number`\n - `contentGroupId: string`\n - `contentTypeCategory: string`\n - `created: string`\n - `createdById: string`\n - `currentlyPublished: boolean`\n - `currentState: string`\n - `domain: string`\n - `dynamicPageDataSourceId: string`\n - `dynamicPageDataSourceType: number`\n - `dynamicPageHubDbTableId: string`\n - `enableDomainStylesheets: boolean`\n - `enableLayoutStylesheets: boolean`\n - `featuredImage: string`\n - `featuredImageAltText: string`\n - `folderId: string`\n - `footerHtml: string`\n - `headHtml: string`\n - `htmlTitle: string`\n - `includeDefaultCustomCss: boolean`\n - `language: string`\n - `layoutSections: object`\n - `linkRelCanonicalUrl: string`\n - `mabExperimentId: string`\n - `metaDescription: string`\n - `name: string`\n - `pageExpiryDate: number`\n - `pageExpiryEnabled: boolean`\n - `pageExpiryRedirectId: number`\n - `pageExpiryRedirectUrl: string`\n - `pageRedirected: boolean`\n - `password: string`\n - `publicAccessRules: object[]`\n - `publicAccessRulesEnabled: boolean`\n - `publishDate: string`\n - `publishImmediately: boolean`\n - `slug: string`\n - `state: string`\n - `subcategory: string`\n - `templatePath: string`\n - `themeSettingsValues: object`\n - `translatedFromId: string`\n - `translations: object`\n - `updated: string`\n - `updatedById: string`\n - `url: string`\n - `useFeaturedImage: boolean`\n - `widgetContainers: object`\n - `widgets: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(0, { objectId: 'objectId' });\n\nconsole.log(pagesPage);\n```", - perLanguage: { - typescript: { - method: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pagesPage = await client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft(0, {\n objectId: 'objectId',\n});\n\nconsole.log(pagesPage.id);", - }, - python: { - method: 'cms.pages.site_pages.revisions.restore_site_page_revision_to_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npages_page = client.cms.pages.site_pages.revisions.restore_site_page_revision_to_draft(\n revision_id=0,\n object_id="objectId",\n)\nprint(pages_page.id)', - }, - java: { - method: 'cms().pages().sitePages().revisions().restoreSitePageRevisionToDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.pages.PagesPage;\nimport com.hubspot.sdk.models.cms.pages.sitepages.revisions.RevisionRestoreSitePageRevisionToDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevisionRestoreSitePageRevisionToDraftParams params = RevisionRestoreSitePageRevisionToDraftParams.builder()\n .objectId("objectId")\n .revisionId(0L)\n .build();\n PagesPage pagesPage = client.cms().pages().sitePages().revisions().restoreSitePageRevisionToDraft(params);\n }\n}', - }, - go: { - method: 'client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevisionToDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpagesPage, err := client.Cms.Pages.SitePages.Revisions.RestoreSitePageRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcms.PageSitePageRevisionRestoreSitePageRevisionToDraftParams{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pagesPage.ID)\n}\n', - }, - ruby: { - method: 'cms.pages.site_pages.revisions.restore_site_page_revision_to_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npages_page = hubspot.cms.pages.site_pages.revisions.restore_site_page_revision_to_draft(0, object_id_: "objectId")\n\nputs(pages_page)', - }, - php: { - method: 'cms->pages->sitePages->revisions->restoreSitePageRevisionToDraft', - example: - "cms\n ->pages\n ->sitePages\n ->revisions\n ->restoreSitePageRevisionToDraft(0, objectID: 'objectId');\n\nvar_dump($pagesPage);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/pages/2026-03/site-pages/$OBJECT_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_indexed_data', - endpoint: '/cms/site-search/2026-03/indexed-data/{contentId}', - httpMethod: 'get', - summary: 'Get indexed properties', - description: - 'Return all indexed data for an asset (e.g., page, blog post, HubDB table), specified by ID. This is useful when debugging why a particular asset is not returned from a custom search.', - stainlessPath: '(resource) cms.site_search > (method) get_indexed_data', - qualified: 'client.cms.siteSearch.getIndexedData', - params: ['contentId: string;', 'type?: string;'], - response: '{ id: string; fields: object; type: string; }', - markdown: - "## get_indexed_data\n\n`client.cms.siteSearch.getIndexedData(contentId: string, type?: string): { id: string; fields: object; type: string; }`\n\n**get** `/cms/site-search/2026-03/indexed-data/{contentId}`\n\nReturn all indexed data for an asset (e.g., page, blog post, HubDB table), specified by ID. This is useful when debugging why a particular asset is not returned from a custom search.\n\n### Parameters\n\n- `contentId: string`\n\n- `type?: string`\n\n### Returns\n\n- `{ id: string; fields: object; type: string; }`\n\n - `id: string`\n - `fields: object`\n - `type: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst indexedData = await client.cms.siteSearch.getIndexedData('contentId');\n\nconsole.log(indexedData);\n```", - perLanguage: { - typescript: { - method: 'client.cms.siteSearch.getIndexedData', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst indexedData = await client.cms.siteSearch.getIndexedData('contentId');\n\nconsole.log(indexedData.id);", - }, - python: { - method: 'cms.site_search.get_indexed_data', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nindexed_data = client.cms.site_search.get_indexed_data(\n content_id="contentId",\n)\nprint(indexed_data.id)', - }, - java: { - method: 'cms().siteSearch().getIndexedData', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.sitesearch.IndexedData;\nimport com.hubspot.sdk.models.cms.sitesearch.SiteSearchGetIndexedDataParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndexedData indexedData = client.cms().siteSearch().getIndexedData("contentId");\n }\n}', - }, - go: { - method: 'client.Cms.SiteSearch.GetIndexedData', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindexedData, err := client.Cms.SiteSearch.GetIndexedData(\n\t\tcontext.TODO(),\n\t\t"contentId",\n\t\tcms.SiteSearchGetIndexedDataParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", indexedData.ID)\n}\n', - }, - ruby: { - method: 'cms.site_search.get_indexed_data', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nindexed_data = hubspot.cms.site_search.get_indexed_data("contentId")\n\nputs(indexed_data)', - }, - php: { - method: 'cms->siteSearch->getIndexedData', - example: - "cms->siteSearch->getIndexedData(\n 'contentId', type: 'type'\n);\n\nvar_dump($indexedData);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/site-search/2026-03/indexed-data/$CONTENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'extract_async', - endpoint: '/cms/source-code/2026-03/extract/async', - httpMethod: 'post', - summary: 'Extract a zip file', - description: - 'Extract a zip file in the developer file system. Extraction status can be checked with the `/extract/async/tasks/taskId/status` endpoint below.', - stainlessPath: '(resource) cms.source_code > (method) extract_async', - qualified: 'client.cms.sourceCode.extractAsync', - params: ['path: string;'], - response: '{ id: string; links?: object; }', - markdown: - "## extract_async\n\n`client.cms.sourceCode.extractAsync(path: string): { id: string; links?: object; }`\n\n**post** `/cms/source-code/2026-03/extract/async`\n\nExtract a zip file in the developer file system. Extraction status can be checked with the `/extract/async/tasks/taskId/status` endpoint below.\n\n### Parameters\n\n- `path: string`\n The file system location where the zip file is to be extracted.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst taskLocator = await client.cms.sourceCode.extractAsync({ path: 'path' });\n\nconsole.log(taskLocator);\n```", - perLanguage: { - typescript: { - method: 'client.cms.sourceCode.extractAsync', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst taskLocator = await client.cms.sourceCode.extractAsync({ path: 'path' });\n\nconsole.log(taskLocator.id);", - }, - python: { - method: 'cms.source_code.extract_async', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntask_locator = client.cms.source_code.extract_async(\n path="path",\n)\nprint(task_locator.id)', - }, - java: { - method: 'cms().sourceCode().extractAsync', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.TaskLocator;\nimport com.hubspot.sdk.models.cms.sourcecode.FileExtractRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileExtractRequest params = FileExtractRequest.builder()\n .path("path")\n .build();\n TaskLocator taskLocator = client.cms().sourceCode().extractAsync(params);\n }\n}', - }, - go: { - method: 'client.Cms.SourceCode.ExtractAsync', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttaskLocator, err := client.Cms.SourceCode.ExtractAsync(context.TODO(), cms.SourceCodeExtractAsyncParams{\n\t\tFileExtractRequest: cms.FileExtractRequestParam{\n\t\t\tPath: "path",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", taskLocator.ID)\n}\n', - }, - ruby: { - method: 'cms.source_code.extract_async', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntask_locator = hubspot.cms.source_code.extract_async(path: "path")\n\nputs(task_locator)', - }, - php: { - method: 'cms->sourceCode->extractAsync', - example: - "cms->sourceCode->extractAsync(path: 'path');\n\nvar_dump($taskLocator);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/source-code/2026-03/extract/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "path": "path"\n }\'', - }, - }, - }, - { - name: 'get_extraction_status', - endpoint: '/cms/source-code/2026-03/extract/async/tasks/{taskId}/status', - httpMethod: 'get', - summary: 'Get extraction status', - description: - 'Get the status of an extraction by the `taskId` returned from the initial `extract/async` request.', - stainlessPath: '(resource) cms.source_code > (method) get_extraction_status', - qualified: 'client.cms.sourceCode.getExtractionStatus', - params: ['taskId: number;'], - response: - "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_extraction_status\n\n`client.cms.sourceCode.getExtractionStatus(taskId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/cms/source-code/2026-03/extract/async/tasks/{taskId}/status`\n\nGet the status of an extraction by the `taskId` returned from the initial `extract/async` request.\n\n### Parameters\n\n- `taskId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponse = await client.cms.sourceCode.getExtractionStatus(0);\n\nconsole.log(actionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.cms.sourceCode.getExtractionStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponse = await client.cms.sourceCode.getExtractionStatus(0);\n\nconsole.log(actionResponse.completedAt);", - }, - python: { - method: 'cms.source_code.get_extraction_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response = client.cms.source_code.get_extraction_status(\n 0,\n)\nprint(action_response.completed_at)', - }, - java: { - method: 'cms().sourceCode().getExtractionStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ActionResponse;\nimport com.hubspot.sdk.models.cms.sourcecode.SourceCodeGetExtractionStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponse actionResponse = client.cms().sourceCode().getExtractionStatus(0);\n }\n}', - }, - go: { - method: 'client.Cms.SourceCode.GetExtractionStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponse, err := client.Cms.SourceCode.GetExtractionStatus(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'cms.source_code.get_extraction_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response = hubspot.cms.source_code.get_extraction_status(0)\n\nputs(action_response)', - }, - php: { - method: 'cms->sourceCode->getExtractionStatus', - example: - "cms->sourceCode->getExtractionStatus(0);\n\nvar_dump($actionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/source-code/2026-03/extract/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/url-mappings/2026-03/url-mappings', - httpMethod: 'post', - summary: 'Create URL mapping', - description: - 'Create a new URL mapping in your HubSpot account. This endpoint allows you to define URL redirections and mappings, which can be useful for managing site navigation and SEO. The request body must include all required properties of the UrlMapping schema.', - stainlessPath: '(resource) cms.url_mappings > (method) create', - qualified: 'client.cms.urlMappings.create', - params: [ - 'id: number;', - 'cdnPurgeEmbargoTime: number;', - 'contentGroupId: number;', - 'cosObjectType: string;', - 'created: number;', - 'createdById: number;', - 'deletedAt: number;', - 'destination: string;', - 'internallyCreated: boolean;', - 'isActive: boolean;', - 'isMatchFullUrl: boolean;', - 'isMatchQueryString: boolean;', - 'isOnlyAfterNotFound: boolean;', - 'isPattern: boolean;', - 'isProtocolAgnostic: boolean;', - 'isRegex: boolean;', - 'isTrailingSlashOptional: boolean;', - 'label: string;', - 'lastUsedAt: number;', - 'name: string;', - 'note: string;', - 'portalId: number;', - 'precedence: number;', - 'redirectStyle: number;', - 'routePrefix: string;', - 'updated: number;', - 'updatedById: number;', - ], - response: 'string', - markdown: - "## create\n\n`client.cms.urlMappings.create(id: number, cdnPurgeEmbargoTime: number, contentGroupId: number, cosObjectType: string, created: number, createdById: number, deletedAt: number, destination: string, internallyCreated: boolean, isActive: boolean, isMatchFullUrl: boolean, isMatchQueryString: boolean, isOnlyAfterNotFound: boolean, isPattern: boolean, isProtocolAgnostic: boolean, isRegex: boolean, isTrailingSlashOptional: boolean, label: string, lastUsedAt: number, name: string, note: string, portalId: number, precedence: number, redirectStyle: number, routePrefix: string, updated: number, updatedById: number): string`\n\n**post** `/url-mappings/2026-03/url-mappings`\n\nCreate a new URL mapping in your HubSpot account. This endpoint allows you to define URL redirections and mappings, which can be useful for managing site navigation and SEO. The request body must include all required properties of the UrlMapping schema.\n\n### Parameters\n\n- `id: number`\n The unique identifier for the URL mapping, represented as a 64-bit integer.\n\n- `cdnPurgeEmbargoTime: number`\n A Unix timestamp in milliseconds indicating the embargo time for CDN purge related to the URL mapping.\n\n- `contentGroupId: number`\n A 64-bit integer representing the content group associated with the URL mapping.\n\n- `cosObjectType: string`\n A string representing the type of content object associated with the URL mapping. Valid values include various content types such as 'CONTENT', 'LAYOUT', 'FILE', etc.\n\n- `created: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was created.\n\n- `createdById: number`\n The identifier of the user who created the URL mapping.\n\n- `deletedAt: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was deleted.\n\n- `destination: string`\n The destination URL to which the routePrefix is redirected.\n\n- `internallyCreated: boolean`\n A boolean indicating if the URL mapping was created internally by the system.\n\n- `isActive: boolean`\n A boolean indicating if the URL mapping is currently active.\n\n- `isMatchFullUrl: boolean`\n A boolean indicating if the full URL should be matched.\n\n- `isMatchQueryString: boolean`\n A boolean indicating if the query string should be matched.\n\n- `isOnlyAfterNotFound: boolean`\n A boolean indicating if the mapping should only be applied after a 404 Not Found response.\n\n- `isPattern: boolean`\n A boolean indicating if the routePrefix is a pattern.\n\n- `isProtocolAgnostic: boolean`\n A boolean indicating if the mapping should ignore the URL protocol (http/https).\n\n- `isRegex: boolean`\n A boolean indicating if the routePrefix should be treated as a regular expression.\n\n- `isTrailingSlashOptional: boolean`\n A boolean indicating if the trailing slash in the URL is optional.\n\n- `label: string`\n A label for the URL mapping.\n\n- `lastUsedAt: number`\n\n- `name: string`\n The name of the URL mapping.\n\n- `note: string`\n A string containing notes about the URL mapping.\n\n- `portalId: number`\n The identifier for the HubSpot portal associated with this URL mapping.\n\n- `precedence: number`\n An integer representing the precedence of the URL mapping, used to determine order of evaluation.\n\n- `redirectStyle: number`\n An integer representing the style of redirection used.\n\n- `routePrefix: string`\n The prefix of the URL path that is being mapped.\n\n- `updated: number`\n A Unix timestamp in milliseconds indicating when the URL mapping was last updated.\n\n- `updatedById: number`\n The identifier of the user who last updated the URL mapping.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlMappings.create({\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupId: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdById: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalId: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedById: 0,\n});\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlMappings.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlMappings.create({\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupId: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdById: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalId: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedById: 0,\n});\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.url_mappings.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_mappings.create(\n id=0,\n cdn_purge_embargo_time=0,\n content_group_id=0,\n cos_object_type="ACCESS_GROUP_MEMBERSHIP",\n created=0,\n created_by_id=0,\n deleted_at=0,\n destination="destination",\n internally_created=True,\n is_active=True,\n is_match_full_url=True,\n is_match_query_string=True,\n is_only_after_not_found=True,\n is_pattern=True,\n is_protocol_agnostic=True,\n is_regex=True,\n is_trailing_slash_optional=True,\n label="label",\n last_used_at=0,\n name="name",\n note="note",\n portal_id=0,\n precedence=0,\n redirect_style=0,\n route_prefix="routePrefix",\n updated=0,\n updated_by_id=0,\n)\nprint(url_mapping)\ncontent = url_mapping.read()\nprint(content)', - }, - java: { - method: 'cms().urlMappings().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingsUrlMapping;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMappingsUrlMapping params = UrlMappingsUrlMapping.builder()\n .id(0L)\n .cdnPurgeEmbargoTime(0L)\n .contentGroupId(0L)\n .cosObjectType(UrlMappingsUrlMapping.CosObjectType.ACCESS_GROUP_MEMBERSHIP)\n .created(0L)\n .createdById(0)\n .deletedAt(0L)\n .destination("destination")\n .internallyCreated(true)\n .isActive(true)\n .isMatchFullUrl(true)\n .isMatchQueryString(true)\n .isOnlyAfterNotFound(true)\n .isPattern(true)\n .isProtocolAgnostic(true)\n .isRegex(true)\n .isTrailingSlashOptional(true)\n .label("label")\n .lastUsedAt(0L)\n .name("name")\n .note("note")\n .portalId(0)\n .precedence(0)\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .updated(0L)\n .updatedById(0)\n .build();\n HttpResponse urlMapping = client.cms().urlMappings().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.URLMappings.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLMappings.New(context.TODO(), cms.URLMappingNewParams{\n\t\tURLMappingsURLMapping: cms.URLMappingsURLMappingParam{\n\t\t\tID: 0,\n\t\t\tCdnPurgeEmbargoTime: 0,\n\t\t\tContentGroupID: 0,\n\t\t\tCosObjectType: cms.URLMappingsURLMappingCosObjectTypeAccessGroupMembership,\n\t\t\tCreated: 0,\n\t\t\tCreatedByID: 0,\n\t\t\tDeletedAt: 0,\n\t\t\tDestination: "destination",\n\t\t\tInternallyCreated: true,\n\t\t\tIsActive: true,\n\t\t\tIsMatchFullURL: true,\n\t\t\tIsMatchQueryString: true,\n\t\t\tIsOnlyAfterNotFound: true,\n\t\t\tIsPattern: true,\n\t\t\tIsProtocolAgnostic: true,\n\t\t\tIsRegex: true,\n\t\t\tIsTrailingSlashOptional: true,\n\t\t\tLabel: "label",\n\t\t\tLastUsedAt: 0,\n\t\t\tName: "name",\n\t\t\tNote: "note",\n\t\t\tPortalID: 0,\n\t\t\tPrecedence: 0,\n\t\t\tRedirectStyle: 0,\n\t\t\tRoutePrefix: "routePrefix",\n\t\t\tUpdated: 0,\n\t\t\tUpdatedByID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping)\n}\n', - }, - ruby: { - method: 'cms.url_mappings.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_mappings.create(\n id: 0,\n cdn_purge_embargo_time: 0,\n content_group_id: 0,\n cos_object_type: :ACCESS_GROUP_MEMBERSHIP,\n created: 0,\n created_by_id: 0,\n deleted_at: 0,\n destination: "destination",\n internally_created: true,\n is_active: true,\n is_match_full_url: true,\n is_match_query_string: true,\n is_only_after_not_found: true,\n is_pattern: true,\n is_protocol_agnostic: true,\n is_regex: true,\n is_trailing_slash_optional: true,\n label: "label",\n last_used_at: 0,\n name: "name",\n note: "note",\n portal_id: 0,\n precedence: 0,\n redirect_style: 0,\n route_prefix: "routePrefix",\n updated: 0,\n updated_by_id: 0\n)\n\nputs(url_mapping)', - }, - php: { - method: 'cms->urlMappings->create', - example: - "cms->urlMappings->create(\n id: 0,\n cdnPurgeEmbargoTime: 0,\n contentGroupID: 0,\n cosObjectType: 'ACCESS_GROUP_MEMBERSHIP',\n created: 0,\n createdByID: 0,\n deletedAt: 0,\n destination: 'destination',\n internallyCreated: true,\n isActive: true,\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isRegex: true,\n isTrailingSlashOptional: true,\n label: 'label',\n lastUsedAt: 0,\n name: 'name',\n note: 'note',\n portalID: 0,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: 0,\n updatedByID: 0,\n);\n\nvar_dump($urlMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings \\\n -H \'Content-Type: */*\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": 0,\n "cdnPurgeEmbargoTime": 0,\n "contentGroupId": 0,\n "cosObjectType": "ACCESS_GROUP_MEMBERSHIP",\n "created": 0,\n "createdById": 0,\n "deletedAt": 0,\n "destination": "destination",\n "internallyCreated": true,\n "isActive": true,\n "isMatchFullUrl": true,\n "isMatchQueryString": true,\n "isOnlyAfterNotFound": true,\n "isPattern": true,\n "isProtocolAgnostic": true,\n "isRegex": true,\n "isTrailingSlashOptional": true,\n "label": "label",\n "lastUsedAt": 0,\n "name": "name",\n "note": "note",\n "portalId": 0,\n "precedence": 0,\n "redirectStyle": 0,\n "routePrefix": "routePrefix",\n "updated": 0,\n "updatedById": 0\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/url-mappings/2026-03/url-mappings/{id}', - httpMethod: 'delete', - summary: 'Delete URL mapping', - description: - 'Delete a specific URL mapping in your HubSpot account using its unique identifier. This operation will remove the URL mapping permanently, and it requires appropriate write and delete permissions.', - stainlessPath: '(resource) cms.url_mappings > (method) delete', - qualified: 'client.cms.urlMappings.delete', - params: ['id: number;'], - markdown: - "## delete\n\n`client.cms.urlMappings.delete(id: number): void`\n\n**delete** `/url-mappings/2026-03/url-mappings/{id}`\n\nDelete a specific URL mapping in your HubSpot account using its unique identifier. This operation will remove the URL mapping permanently, and it requires appropriate write and delete permissions.\n\n### Parameters\n\n- `id: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.urlMappings.delete(0)\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlMappings.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.urlMappings.delete(0);", - }, - python: { - method: 'cms.url_mappings.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.url_mappings.delete(\n 0,\n)', - }, - java: { - method: 'cms().urlMappings().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().urlMappings().delete(0L);\n }\n}', - }, - go: { - method: 'client.Cms.URLMappings.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.URLMappings.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.url_mappings.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.url_mappings.delete(0)\n\nputs(result)', - }, - php: { - method: 'cms->urlMappings->delete', - example: - "cms->urlMappings->delete(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings/$ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/url-mappings/2026-03/url-mappings/{id}', - httpMethod: 'get', - summary: 'Retrieve URL mapping', - description: - 'Retrieve a specific URL mapping by its unique identifier. This endpoint is useful for obtaining details about a particular URL mapping configuration within your HubSpot account. It requires the ID of the URL mapping as a path parameter.', - stainlessPath: '(resource) cms.url_mappings > (method) get', - qualified: 'client.cms.urlMappings.get', - params: ['id: number;'], - response: 'string', - markdown: - "## get\n\n`client.cms.urlMappings.get(id: number): string`\n\n**get** `/url-mappings/2026-03/url-mappings/{id}`\n\nRetrieve a specific URL mapping by its unique identifier. This endpoint is useful for obtaining details about a particular URL mapping configuration within your HubSpot account. It requires the ID of the URL mapping as a path parameter.\n\n### Parameters\n\n- `id: number`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlMappings.get(0);\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlMappings.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlMappings.get(0);\n\nconsole.log(urlMapping);\n\nconst content = await urlMapping.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.url_mappings.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_mappings.get(\n 0,\n)\nprint(url_mapping)\ncontent = url_mapping.read()\nprint(content)', - }, - java: { - method: 'cms().urlMappings().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse urlMapping = client.cms().urlMappings().get(0L);\n }\n}', - }, - go: { - method: 'client.Cms.URLMappings.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLMappings.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping)\n}\n', - }, - ruby: { - method: 'cms.url_mappings.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_mappings.get(0)\n\nputs(url_mapping)', - }, - php: { - method: 'cms->urlMappings->get', - example: - "cms->urlMappings->get(0);\n\nvar_dump($urlMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings/$ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/url-mappings/2026-03/url-mappings', - httpMethod: 'get', - summary: 'List URL mappings', - description: - 'Retrieve a list of URL mappings from the HubSpot account. This endpoint provides access to URL mapping configurations, which can be used to manage and redirect URLs within the HubSpot CMS. It is useful for understanding how URLs are structured and redirected in your content management setup.', - stainlessPath: '(resource) cms.url_mappings > (method) list', - qualified: 'client.cms.urlMappings.list', - response: 'string', - markdown: - "## list\n\n`client.cms.urlMappings.list(): string`\n\n**get** `/url-mappings/2026-03/url-mappings`\n\nRetrieve a list of URL mappings from the HubSpot account. This endpoint provides access to URL mapping configurations, which can be used to manage and redirect URLs within the HubSpot CMS. It is useful for understanding how URLs are structured and redirected in your content management setup.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMappings = await client.cms.urlMappings.list();\n\nconsole.log(urlMappings);\n\nconst content = await urlMappings.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlMappings.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMappings = await client.cms.urlMappings.list();\n\nconsole.log(urlMappings);\n\nconst content = await urlMappings.blob();\nconsole.log(content);", - }, - python: { - method: 'cms.url_mappings.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mappings = client.cms.url_mappings.list()\nprint(url_mappings)\ncontent = url_mappings.read()\nprint(content)', - }, - java: { - method: 'cms().urlMappings().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.cms.urlmappings.UrlMappingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse urlMappings = client.cms().urlMappings().list();\n }\n}', - }, - go: { - method: 'client.Cms.URLMappings.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMappings, err := client.Cms.URLMappings.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMappings)\n}\n', - }, - ruby: { - method: 'cms.url_mappings.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mappings = hubspot.cms.url_mappings.list\n\nputs(url_mappings)', - }, - php: { - method: 'cms->urlMappings->list', - example: - "cms->urlMappings->list();\n\nvar_dump($urlMappings);", - }, - http: { - example: - 'curl https://api.hubapi.com/url-mappings/2026-03/url-mappings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/cms/url-redirects/2026-03', - httpMethod: 'post', - summary: 'Create redirect', - description: - 'Create a new URL redirect in your HubSpot account. This endpoint allows you to define a new URL mapping that redirects traffic from a specified route to a destination URL. This is useful for managing URL changes, handling outdated links, or creating short links.', - stainlessPath: '(resource) cms.url_redirects > (method) create', - qualified: 'client.cms.urlRedirects.create', - params: [ - 'destination: string;', - 'redirectStyle: number;', - 'routePrefix: string;', - 'isMatchFullUrl?: boolean;', - 'isMatchQueryString?: boolean;', - 'isOnlyAfterNotFound?: boolean;', - 'isPattern?: boolean;', - 'isProtocolAgnostic?: boolean;', - 'isTrailingSlashOptional?: boolean;', - 'precedence?: number;', - ], - response: - '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', - markdown: - "## create\n\n`client.cms.urlRedirects.create(destination: string, redirectStyle: number, routePrefix: string, isMatchFullUrl?: boolean, isMatchQueryString?: boolean, isOnlyAfterNotFound?: boolean, isPattern?: boolean, isProtocolAgnostic?: boolean, isTrailingSlashOptional?: boolean, precedence?: number): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**post** `/cms/url-redirects/2026-03`\n\nCreate a new URL redirect in your HubSpot account. This endpoint allows you to define a new URL mapping that redirects traffic from a specified route to a destination URL. This is useful for managing URL changes, handling outdated links, or creating short links.\n\n### Parameters\n\n- `destination: string`\n The destination URL, where the target URL should be redirected if it matches the `routePrefix`.\n\n- `redirectStyle: number`\n The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).\n\n- `routePrefix: string`\n The target incoming URL, path, or pattern to match for redirection.\n\n- `isMatchFullUrl?: boolean`\n Whether the `routePrefix` should match on the entire URL, including the domain.\n\n- `isMatchQueryString?: boolean`\n Whether the `routePrefix` should match on the entire URL path, including the query string.\n\n- `isOnlyAfterNotFound?: boolean`\n Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.\n\n- `isPattern?: boolean`\n Whether the `routePrefix` should match based on pattern.\n\n- `isProtocolAgnostic?: boolean`\n Whether the `routePrefix` should match both HTTP and HTTPS protocols.\n\n- `isTrailingSlashOptional?: boolean`\n Whether a trailing slash will be ignored.\n\n- `precedence?: number`\n Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.create({\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n});\n\nconsole.log(urlMapping);\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlRedirects.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.create({\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n});\n\nconsole.log(urlMapping.id);", - }, - python: { - method: 'cms.url_redirects.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.create(\n destination="destination",\n redirect_style=0,\n route_prefix="routePrefix",\n)\nprint(url_mapping.id)', - }, - java: { - method: 'cms().urlRedirects().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMappingCreateRequestBody;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMappingCreateRequestBody params = UrlMappingCreateRequestBody.builder()\n .destination("destination")\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .build();\n UrlMapping urlMapping = client.cms().urlRedirects().create(params);\n }\n}', - }, - go: { - method: 'client.Cms.URLRedirects.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.New(context.TODO(), cms.URLRedirectNewParams{\n\t\tURLMappingCreateRequestBody: cms.URLMappingCreateRequestBodyParam{\n\t\t\tDestination: "destination",\n\t\t\tRedirectStyle: 0,\n\t\t\tRoutePrefix: "routePrefix",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', - }, - ruby: { - method: 'cms.url_redirects.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.create(\n destination: "destination",\n redirect_style: 0,\n route_prefix: "routePrefix"\n)\n\nputs(url_mapping)', - }, - php: { - method: 'cms->urlRedirects->create', - example: - "cms->urlRedirects->create(\n destination: 'destination',\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n);\n\nvar_dump($urlMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/url-redirects/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "destination": "destination",\n "redirectStyle": 0,\n "routePrefix": "routePrefix"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', - httpMethod: 'delete', - summary: 'Delete a redirect', - description: 'Delete one existing redirect, so it is no longer mapped.', - stainlessPath: '(resource) cms.url_redirects > (method) delete', - qualified: 'client.cms.urlRedirects.delete', - params: ['urlRedirectId: string;'], - markdown: - "## delete\n\n`client.cms.urlRedirects.delete(urlRedirectId: string): void`\n\n**delete** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nDelete one existing redirect, so it is no longer mapped.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.cms.urlRedirects.delete('urlRedirectId')\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlRedirects.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.cms.urlRedirects.delete('urlRedirectId');", - }, - python: { - method: 'cms.url_redirects.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.cms.url_redirects.delete(\n "urlRedirectId",\n)', - }, - java: { - method: 'cms().urlRedirects().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.cms().urlRedirects().delete("urlRedirectId");\n }\n}', - }, - go: { - method: 'client.Cms.URLRedirects.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Cms.URLRedirects.Delete(context.TODO(), "urlRedirectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'cms.url_redirects.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.cms.url_redirects.delete("urlRedirectId")\n\nputs(result)', - }, - php: { - method: 'cms->urlRedirects->delete', - example: - "cms->urlRedirects->delete('urlRedirectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', - httpMethod: 'get', - summary: 'Get details for a redirect', - description: 'Returns the details for a single existing URL redirect by ID.', - stainlessPath: '(resource) cms.url_redirects > (method) get', - qualified: 'client.cms.urlRedirects.get', - params: ['urlRedirectId: string;'], - response: - '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', - markdown: - "## get\n\n`client.cms.urlRedirects.get(urlRedirectId: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**get** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nReturns the details for a single existing URL redirect by ID.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.get('urlRedirectId');\n\nconsole.log(urlMapping);\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlRedirects.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.get('urlRedirectId');\n\nconsole.log(urlMapping.id);", - }, - python: { - method: 'cms.url_redirects.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.get(\n "urlRedirectId",\n)\nprint(url_mapping.id)', - }, - java: { - method: 'cms().urlRedirects().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlMapping urlMapping = client.cms().urlRedirects().get("urlRedirectId");\n }\n}', - }, - go: { - method: 'client.Cms.URLRedirects.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.Get(context.TODO(), "urlRedirectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', - }, - ruby: { - method: 'cms.url_redirects.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.get("urlRedirectId")\n\nputs(url_mapping)', - }, - php: { - method: 'cms->urlRedirects->get', - example: - "cms->urlRedirects->get('urlRedirectId');\n\nvar_dump($urlMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/cms/url-redirects/2026-03', - httpMethod: 'get', - summary: 'Retrieve redirects', - description: - 'Retrieve a list of URL redirects configured in your HubSpot account. This endpoint allows you to filter redirects based on their creation or update timestamps, and sort the results. It supports pagination and can include archived redirects if specified.', - stainlessPath: '(resource) cms.url_redirects > (method) list', - qualified: 'client.cms.urlRedirects.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'limit?: number;', - 'sort?: string[];', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - ], - response: - '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', - markdown: - "## list\n\n`client.cms.urlRedirects.list(after?: string, archived?: boolean, createdAfter?: string, createdAt?: string, createdBefore?: string, limit?: number, sort?: string[], updatedAfter?: string, updatedAt?: string, updatedBefore?: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**get** `/cms/url-redirects/2026-03`\n\nRetrieve a list of URL redirects configured in your HubSpot account. This endpoint allows you to filter redirects based on their creation or update timestamps, and sort the results. It supports pagination and can include archived redirects if specified.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const urlMapping of client.cms.urlRedirects.list()) {\n console.log(urlMapping);\n}\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlRedirects.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const urlMapping of client.cms.urlRedirects.list()) {\n console.log(urlMapping.id);\n}", - }, - python: { - method: 'cms.url_redirects.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.cms.url_redirects.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'cms().urlRedirects().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectListPage;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlRedirectListPage page = client.cms().urlRedirects().list();\n }\n}', - }, - go: { - method: 'client.Cms.URLRedirects.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Cms.URLRedirects.List(context.TODO(), cms.URLRedirectListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'cms.url_redirects.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.cms.url_redirects.list\n\nputs(page)', - }, - php: { - method: 'cms->urlRedirects->list', - example: - "cms->urlRedirects->list(\n after: 'after',\n archived: true,\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n limit: 0,\n sort: ['string'],\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/url-redirects/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/cms/url-redirects/2026-03/{urlRedirectId}', - httpMethod: 'patch', - summary: 'Update a redirect', - description: 'Updates the settings for an existing URL redirect.', - stainlessPath: '(resource) cms.url_redirects > (method) update', - qualified: 'client.cms.urlRedirects.update', - params: [ - 'urlRedirectId: string;', - 'id: string;', - 'created: string;', - 'destination: string;', - 'isMatchFullUrl: boolean;', - 'isMatchQueryString: boolean;', - 'isOnlyAfterNotFound: boolean;', - 'isPattern: boolean;', - 'isProtocolAgnostic: boolean;', - 'isTrailingSlashOptional: boolean;', - 'precedence: number;', - 'redirectStyle: number;', - 'routePrefix: string;', - 'updated: string;', - ], - response: - '{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }', - markdown: - "## update\n\n`client.cms.urlRedirects.update(urlRedirectId: string, id: string, created: string, destination: string, isMatchFullUrl: boolean, isMatchQueryString: boolean, isOnlyAfterNotFound: boolean, isPattern: boolean, isProtocolAgnostic: boolean, isTrailingSlashOptional: boolean, precedence: number, redirectStyle: number, routePrefix: string, updated: string): { id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n**patch** `/cms/url-redirects/2026-03/{urlRedirectId}`\n\nUpdates the settings for an existing URL redirect.\n\n### Parameters\n\n- `urlRedirectId: string`\n\n- `id: string`\n The unique ID of this URL redirect.\n\n- `created: string`\n The date and time when the URL mapping was initially created.\n\n- `destination: string`\n The destination URL, where the target URL should be redirected if it matches the `routePrefix`.\n\n- `isMatchFullUrl: boolean`\n Whether the `routePrefix` should match on the entire URL, including the domain.\n\n- `isMatchQueryString: boolean`\n Whether the `routePrefix` should match on the entire URL path, including the query string.\n\n- `isOnlyAfterNotFound: boolean`\n Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.\n\n- `isPattern: boolean`\n Whether the `routePrefix` should match based on pattern.\n\n- `isProtocolAgnostic: boolean`\n Whether the `routePrefix` should match both HTTP and HTTPS protocols.\n\n- `isTrailingSlashOptional: boolean`\n Whether a trailing slash will be ignored.\n\n- `precedence: number`\n Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the **lower** precedence will be used.\n\n- `redirectStyle: number`\n The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page).\n\n- `routePrefix: string`\n The target incoming URL, path, or pattern to match for redirection.\n\n- `updated: string`\n The date and time when the URL mapping was last modified.\n\n### Returns\n\n- `{ id: string; created: string; destination: string; isMatchFullUrl: boolean; isMatchQueryString: boolean; isOnlyAfterNotFound: boolean; isPattern: boolean; isProtocolAgnostic: boolean; isTrailingSlashOptional: boolean; precedence: number; redirectStyle: number; routePrefix: string; updated: string; }`\n\n - `id: string`\n - `created: string`\n - `destination: string`\n - `isMatchFullUrl: boolean`\n - `isMatchQueryString: boolean`\n - `isOnlyAfterNotFound: boolean`\n - `isPattern: boolean`\n - `isProtocolAgnostic: boolean`\n - `isTrailingSlashOptional: boolean`\n - `precedence: number`\n - `redirectStyle: number`\n - `routePrefix: string`\n - `updated: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst urlMapping = await client.cms.urlRedirects.update('urlRedirectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n destination: 'destination',\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(urlMapping);\n```", - perLanguage: { - typescript: { - method: 'client.cms.urlRedirects.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst urlMapping = await client.cms.urlRedirects.update('urlRedirectId', {\n id: 'id',\n created: '2019-12-27T18:11:19.117Z',\n destination: 'destination',\n isMatchFullUrl: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(urlMapping.id);", - }, - python: { - method: 'cms.url_redirects.update', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nurl_mapping = client.cms.url_redirects.update(\n url_redirect_id="urlRedirectId",\n id="id",\n created=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n destination="destination",\n is_match_full_url=True,\n is_match_query_string=True,\n is_only_after_not_found=True,\n is_pattern=True,\n is_protocol_agnostic=True,\n is_trailing_slash_optional=True,\n precedence=0,\n redirect_style=0,\n route_prefix="routePrefix",\n updated=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(url_mapping.id)', - }, - java: { - method: 'cms().urlRedirects().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlMapping;\nimport com.hubspot.sdk.models.cms.urlredirects.UrlRedirectUpdateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UrlRedirectUpdateParams params = UrlRedirectUpdateParams.builder()\n .urlRedirectId("urlRedirectId")\n .urlMapping(UrlMapping.builder()\n .id("id")\n .created(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .destination("destination")\n .isMatchFullUrl(true)\n .isMatchQueryString(true)\n .isOnlyAfterNotFound(true)\n .isPattern(true)\n .isProtocolAgnostic(true)\n .isTrailingSlashOptional(true)\n .precedence(0)\n .redirectStyle(0)\n .routePrefix("routePrefix")\n .updated(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n UrlMapping urlMapping = client.cms().urlRedirects().update(params);\n }\n}', - }, - go: { - method: 'client.Cms.URLRedirects.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/cms"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\turlMapping, err := client.Cms.URLRedirects.Update(\n\t\tcontext.TODO(),\n\t\t"urlRedirectId",\n\t\tcms.URLRedirectUpdateParams{\n\t\t\tURLMapping: cms.URLMappingParam{\n\t\t\t\tID: "id",\n\t\t\t\tCreated: time.Now(),\n\t\t\t\tDestination: "destination",\n\t\t\t\tIsMatchFullURL: true,\n\t\t\t\tIsMatchQueryString: true,\n\t\t\t\tIsOnlyAfterNotFound: true,\n\t\t\t\tIsPattern: true,\n\t\t\t\tIsProtocolAgnostic: true,\n\t\t\t\tIsTrailingSlashOptional: true,\n\t\t\t\tPrecedence: 0,\n\t\t\t\tRedirectStyle: 0,\n\t\t\t\tRoutePrefix: "routePrefix",\n\t\t\t\tUpdated: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", urlMapping.ID)\n}\n', - }, - ruby: { - method: 'cms.url_redirects.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nurl_mapping = hubspot.cms.url_redirects.update(\n "urlRedirectId",\n id: "id",\n created: "2019-12-27T18:11:19.117Z",\n destination: "destination",\n is_match_full_url: true,\n is_match_query_string: true,\n is_only_after_not_found: true,\n is_pattern: true,\n is_protocol_agnostic: true,\n is_trailing_slash_optional: true,\n precedence: 0,\n redirect_style: 0,\n route_prefix: "routePrefix",\n updated: "2019-12-27T18:11:19.117Z"\n)\n\nputs(url_mapping)', - }, - php: { - method: 'cms->urlRedirects->update', - example: - "cms->urlRedirects->update(\n 'urlRedirectId',\n id: 'id',\n created: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n destination: 'destination',\n isMatchFullURL: true,\n isMatchQueryString: true,\n isOnlyAfterNotFound: true,\n isPattern: true,\n isProtocolAgnostic: true,\n isTrailingSlashOptional: true,\n precedence: 0,\n redirectStyle: 0,\n routePrefix: 'routePrefix',\n updated: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($urlMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/cms/url-redirects/2026-03/$URL_REDIRECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "created": "2019-12-27T18:11:19.117Z",\n "destination": "destination",\n "isMatchFullUrl": true,\n "isMatchQueryString": true,\n "isOnlyAfterNotFound": true,\n "isPattern": true,\n "isProtocolAgnostic": true,\n "isTrailingSlashOptional": true,\n "precedence": 0,\n "redirectStyle": 0,\n "routePrefix": "routePrefix",\n "updated": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'generate_links', - endpoint: '/communication-preferences/2026-03/links/generate', - httpMethod: 'post', - summary: 'Generate subscription links', - description: - 'Generate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.', - stainlessPath: '(resource) communication_preferences > (method) generate_links', - qualified: 'client.communicationPreferences.generateLinks', - params: [ - "channel: 'EMAIL';", - 'subscriberIdString: string;', - 'businessUnitId?: number;', - 'language?: string;', - 'subscriptionId?: number;', - ], - response: - '{ managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }', - markdown: - "## generate_links\n\n`client.communicationPreferences.generateLinks(channel: 'EMAIL', subscriberIdString: string, businessUnitId?: number, language?: string, subscriptionId?: number): { managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }`\n\n**post** `/communication-preferences/2026-03/links/generate`\n\nGenerate communication preference links for a subscriber. This endpoint allows you to create URLs for managing preferences and unsubscribing, tailored to a specific subscriber. It is useful for integrating communication preference management into your applications.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel for which the links are generated. Must be 'EMAIL'.\n\n- `subscriberIdString: string`\n A string representing the unique identifier of the subscriber. This property is required.\n\n- `businessUnitId?: number`\n The identifier of the business unit. Defaults to 0 if not specified.\n\n- `language?: string`\n The language in which the generated link should be presented, represented as a string.\n\n- `subscriptionId?: number`\n The unique identifier for the subscription, represented as an integer in int64 format.\n\n### Returns\n\n- `{ managePreferencesUrl: string; subscriberIdString: string; unsubscribeAllUrl: string; unsubscribeSingleUrl?: string; }`\n\n - `managePreferencesUrl: string`\n - `subscriberIdString: string`\n - `unsubscribeAllUrl: string`\n - `unsubscribeSingleUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst linkGenerationResponse = await client.communicationPreferences.generateLinks({ channel: 'EMAIL', subscriberIdString: 'subscriberIdString' });\n\nconsole.log(linkGenerationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.generateLinks', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst linkGenerationResponse = await client.communicationPreferences.generateLinks({\n channel: 'EMAIL',\n subscriberIdString: 'subscriberIdString',\n});\n\nconsole.log(linkGenerationResponse.managePreferencesUrl);", - }, - python: { - method: 'communication_preferences.generate_links', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlink_generation_response = client.communication_preferences.generate_links(\n channel="EMAIL",\n subscriber_id_string="subscriberIdString",\n)\nprint(link_generation_response.manage_preferences_url)', - }, - java: { - method: 'communicationPreferences().generateLinks', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGenerateLinksParams;\nimport com.hubspot.sdk.models.communicationpreferences.LinkGenerationRequest;\nimport com.hubspot.sdk.models.communicationpreferences.LinkGenerationResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGenerateLinksParams params = CommunicationPreferenceGenerateLinksParams.builder()\n .channel(CommunicationPreferenceGenerateLinksParams.Channel.EMAIL)\n .linkGenerationRequest(LinkGenerationRequest.builder()\n .subscriberIdString("subscriberIdString")\n .build())\n .build();\n LinkGenerationResponse linkGenerationResponse = client.communicationPreferences().generateLinks(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.GenerateLinks', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlinkGenerationResponse, err := client.CommunicationPreferences.GenerateLinks(context.TODO(), communication_preferences.CommunicationPreferenceGenerateLinksParams{\n\t\tChannel: communication_preferences.CommunicationPreferenceGenerateLinksParamsChannelEmail,\n\t\tLinkGenerationRequest: communication_preferences.LinkGenerationRequestParam{\n\t\t\tSubscriberIDString: "subscriberIdString",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", linkGenerationResponse.ManagePreferencesURL)\n}\n', - }, - ruby: { - method: 'communication_preferences.generate_links', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlink_generation_response = hubspot.communication_preferences.generate_links(\n channel: :EMAIL,\n subscriber_id_string: "subscriberIdString"\n)\n\nputs(link_generation_response)', - }, - php: { - method: 'communicationPreferences->generateLinks', - example: - "communicationPreferences->generateLinks(\n channel: 'EMAIL',\n subscriberIDString: 'subscriberIdString',\n businessUnitID: 0,\n language: 'language',\n subscriptionID: 0,\n);\n\nvar_dump($linkGenerationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/links/generate \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "subscriberIdString": "subscriberIdString"\n }\'', - }, - }, - }, - { - name: 'get_statuses', - endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}', - httpMethod: 'get', - summary: 'Get subscription preferences for a specific contact', - description: "Retrieve a contact's current email subscription preferences.", - stainlessPath: '(resource) communication_preferences > (method) get_statuses', - qualified: 'client.communicationPreferences.getStatuses', - params: ['subscriberIdString: string;', "channel: 'EMAIL';", 'businessUnitId?: number;'], - response: - "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## get_statuses\n\n`client.communicationPreferences.getStatuses(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/statuses/{subscriberIdString}`\n\nRetrieve a contact's current email subscription preferences.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit to filter the subscription status by. This is an optional parameter.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.getStatuses('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.getStatuses', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.getStatuses(\n 'subscriberIdString',\n { channel: 'EMAIL' },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", - }, - python: { - method: 'communication_preferences.get_statuses', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.get_statuses(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_status.completed_at)', - }, - java: { - method: 'communicationPreferences().getStatuses', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGetStatusesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGetStatusesParams params = CommunicationPreferenceGetStatusesParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceGetStatusesParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().getStatuses(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.GetStatuses', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.GetStatuses(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceGetStatusesParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceGetStatusesParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.get_statuses', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.get_statuses("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_status)', - }, - php: { - method: 'communicationPreferences->getStatuses', - example: - "communicationPreferences\n ->getStatuses('subscriberIdString', channel: 'EMAIL', businessUnitID: 0);\n\nvar_dump($actionResponseWithResultsPublicStatus);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_unsubscribe_all_status', - endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', - httpMethod: 'get', - summary: "Retrieve a contact's unsubscribed status", - description: - 'Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty.', - stainlessPath: '(resource) communication_preferences > (method) get_unsubscribe_all_status', - qualified: 'client.communicationPreferences.getUnsubscribeAllStatus', - params: [ - 'subscriberIdString: string;', - "channel: 'EMAIL';", - 'businessUnitId?: number;', - 'verbose?: boolean;', - ], - response: - "{ completedAt: string; results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## get_unsubscribe_all_status\n\n`client.communicationPreferences.getUnsubscribeAllStatus(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_wide_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all`\n\nCheck whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit to which the subscriber belongs. This is an optional parameter.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicWideStatus = await client.communicationPreferences.getUnsubscribeAllStatus('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicWideStatus);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.getUnsubscribeAllStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicWideStatus =\n await client.communicationPreferences.getUnsubscribeAllStatus('subscriberIdString', {\n channel: 'EMAIL',\n });\n\nconsole.log(actionResponseWithResultsPublicWideStatus.completedAt);", - }, - python: { - method: 'communication_preferences.get_unsubscribe_all_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_wide_status = client.communication_preferences.get_unsubscribe_all_status(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_wide_status.completed_at)', - }, - java: { - method: 'communicationPreferences().getUnsubscribeAllStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicWideStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceGetUnsubscribeAllStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceGetUnsubscribeAllStatusParams params = CommunicationPreferenceGetUnsubscribeAllStatusParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceGetUnsubscribeAllStatusParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicWideStatus actionResponseWithResultsPublicWideStatus = client.communicationPreferences().getUnsubscribeAllStatus(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.GetUnsubscribeAllStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicWideStatus, err := client.CommunicationPreferences.GetUnsubscribeAllStatus(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceGetUnsubscribeAllStatusParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceGetUnsubscribeAllStatusParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicWideStatus.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.get_unsubscribe_all_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_wide_status = hubspot.communication_preferences.get_unsubscribe_all_status("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_wide_status)', - }, - php: { - method: 'communicationPreferences->getUnsubscribeAllStatus', - example: - "communicationPreferences\n ->getUnsubscribeAllStatus(\n 'subscriberIdString', channel: 'EMAIL', businessUnitID: 0, verbose: true\n);\n\nvar_dump($actionResponseWithResultsPublicWideStatus);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING/unsubscribe-all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'unsubscribe_all', - endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', - httpMethod: 'post', - summary: 'Unsubscribe a contact from all subscriptions', - description: 'Unsubscribe a contact from all email subscriptions.', - stainlessPath: '(resource) communication_preferences > (method) unsubscribe_all', - qualified: 'client.communicationPreferences.unsubscribeAll', - params: [ - 'subscriberIdString: string;', - "channel: 'EMAIL';", - 'businessUnitId?: number;', - 'verbose?: boolean;', - ], - response: - "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## unsubscribe_all\n\n`client.communicationPreferences.unsubscribeAll(subscriberIdString: string, channel: 'EMAIL', businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all`\n\nUnsubscribe a contact from all email subscriptions.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The communication channel to unsubscribe from. Must be 'EMAIL'.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the request. This is an optional integer parameter.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.unsubscribeAll('subscriberIdString', { channel: 'EMAIL' });\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.unsubscribeAll', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.unsubscribeAll(\n 'subscriberIdString',\n { channel: 'EMAIL' },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", - }, - python: { - method: 'communication_preferences.unsubscribe_all', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.unsubscribe_all(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n)\nprint(action_response_with_results_public_status.completed_at)', - }, - java: { - method: 'communicationPreferences().unsubscribeAll', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceUnsubscribeAllParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceUnsubscribeAllParams params = CommunicationPreferenceUnsubscribeAllParams.builder()\n .subscriberIdString("subscriberIdString")\n .channel(CommunicationPreferenceUnsubscribeAllParams.Channel.EMAIL)\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().unsubscribeAll(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.UnsubscribeAll', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.UnsubscribeAll(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceUnsubscribeAllParams{\n\t\t\tChannel: communication_preferences.CommunicationPreferenceUnsubscribeAllParamsChannelEmail,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.unsubscribe_all', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.unsubscribe_all("subscriberIdString", channel: :EMAIL)\n\nputs(action_response_with_results_public_status)', - }, - php: { - method: 'communicationPreferences->unsubscribeAll', - example: - "communicationPreferences\n ->unsubscribeAll(\n 'subscriberIdString', channel: 'EMAIL', businessUnitID: 0, verbose: true\n);\n\nvar_dump($actionResponseWithResultsPublicStatus);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING/unsubscribe-all \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_status', - endpoint: '/communication-preferences/2026-03/statuses/{subscriberIdString}', - httpMethod: 'post', - summary: "Update a contact's subscription status", - description: 'Set the subscription status of a specific contact.', - stainlessPath: '(resource) communication_preferences > (method) update_status', - qualified: 'client.communicationPreferences.updateStatus', - params: [ - 'subscriberIdString: string;', - "channel: 'EMAIL';", - "statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED';", - 'subscriptionId: number;', - 'legalBasis?: string;', - 'legalBasisExplanation?: string;', - ], - response: - "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## update_status\n\n`client.communicationPreferences.updateStatus(subscriberIdString: string, channel: 'EMAIL', statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED', subscriptionId: number, legalBasis?: string, legalBasisExplanation?: string): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/{subscriberIdString}`\n\nSet the subscription status of a specific contact.\n\n### Parameters\n\n- `subscriberIdString: string`\n\n- `channel: 'EMAIL'`\n The type of communication channel, with 'EMAIL' as the only supported option.\n\n- `statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'`\n The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.\n\n- `subscriptionId: number`\n The unique identifier of the subscription to be updated.\n\n- `legalBasis?: string`\n The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.\n\n- `legalBasisExplanation?: string`\n An explanation for the legal basis used for communication.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.updateStatus('subscriberIdString', {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionId: 0,\n});\n\nconsole.log(actionResponseWithResultsPublicStatus);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.updateStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsPublicStatus = await client.communicationPreferences.updateStatus(\n 'subscriberIdString',\n {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionId: 0,\n },\n);\n\nconsole.log(actionResponseWithResultsPublicStatus.completedAt);", - }, - python: { - method: 'communication_preferences.update_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_public_status = client.communication_preferences.update_status(\n subscriber_id_string="subscriberIdString",\n channel="EMAIL",\n status_state="NOT_SPECIFIED",\n subscription_id=0,\n)\nprint(action_response_with_results_public_status.completed_at)', - }, - java: { - method: 'communicationPreferences().updateStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsPublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.CommunicationPreferenceUpdateStatusParams;\nimport com.hubspot.sdk.models.communicationpreferences.PartialPublicStatusRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationPreferenceUpdateStatusParams params = CommunicationPreferenceUpdateStatusParams.builder()\n .subscriberIdString("subscriberIdString")\n .partialPublicStatusRequest(PartialPublicStatusRequest.builder()\n .channel(PartialPublicStatusRequest.Channel.EMAIL)\n .statusState(PartialPublicStatusRequest.StatusState.NOT_SPECIFIED)\n .subscriptionId(0L)\n .build())\n .build();\n ActionResponseWithResultsPublicStatus actionResponseWithResultsPublicStatus = client.communicationPreferences().updateStatus(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.UpdateStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsPublicStatus, err := client.CommunicationPreferences.UpdateStatus(\n\t\tcontext.TODO(),\n\t\t"subscriberIdString",\n\t\tcommunication_preferences.CommunicationPreferenceUpdateStatusParams{\n\t\t\tPartialPublicStatusRequest: communication_preferences.PartialPublicStatusRequestParam{\n\t\t\t\tChannel: communication_preferences.PartialPublicStatusRequestChannelEmail,\n\t\t\t\tStatusState: communication_preferences.PartialPublicStatusRequestStatusStateNotSpecified,\n\t\t\t\tSubscriptionID: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsPublicStatus.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.update_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_public_status = hubspot.communication_preferences.update_status(\n "subscriberIdString",\n channel: :EMAIL,\n status_state: :NOT_SPECIFIED,\n subscription_id: 0\n)\n\nputs(action_response_with_results_public_status)', - }, - php: { - method: 'communicationPreferences->updateStatus', - example: - "communicationPreferences\n ->updateStatus(\n 'subscriberIdString',\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriptionID: 0,\n legalBasis: 'CONSENT_WITH_NOTICE',\n legalBasisExplanation: 'legalBasisExplanation',\n);\n\nvar_dump($actionResponseWithResultsPublicStatus);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/$SUBSCRIBER_ID_STRING \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "channel": "EMAIL",\n "statusState": "NOT_SPECIFIED",\n "subscriptionId": 0\n }\'', - }, - }, - }, - { - name: 'list', - endpoint: '/communication-preferences/2026-03/definitions', - httpMethod: 'get', - summary: 'Retrieve all subscription status definitions', - description: 'Get a list of subscription status definitions from the account.', - stainlessPath: '(resource) communication_preferences.definitions > (method) list', - qualified: 'client.communicationPreferences.definitions.list', - params: ['businessUnitId?: number;', 'includeTranslations?: boolean;'], - response: - "{ completedAt: string; results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: public_subscription_translation[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## list\n\n`client.communicationPreferences.definitions.list(businessUnitId?: number, includeTranslations?: boolean): { completedAt: string; results: subscription_definition[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**get** `/communication-preferences/2026-03/definitions`\n\nGet a list of subscription status definitions from the account.\n\n### Parameters\n\n- `businessUnitId?: number`\n An integer representing the ID of the business unit for which to retrieve subscription definitions.\n\n- `includeTranslations?: boolean`\n A boolean indicating whether to include translations of the communication preferences definitions in the response.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: public_subscription_translation[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; createdAt: string; description: string; isActive: boolean; isDefault: boolean; isInternal: boolean; name: string; updatedAt: string; businessUnitId?: number; communicationMethod?: string; purpose?: string; subscriptionTranslations?: { createdAt: number; description: string; languageCode: string; name: string; subscriptionId: number; updatedAt: number; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithResultsSubscriptionDefinition = await client.communicationPreferences.definitions.list();\n\nconsole.log(actionResponseWithResultsSubscriptionDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.definitions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithResultsSubscriptionDefinition =\n await client.communicationPreferences.definitions.list();\n\nconsole.log(actionResponseWithResultsSubscriptionDefinition.completedAt);", - }, - python: { - method: 'communication_preferences.definitions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_results_subscription_definition = client.communication_preferences.definitions.list()\nprint(action_response_with_results_subscription_definition.completed_at)', - }, - java: { - method: 'communicationPreferences().definitions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.ActionResponseWithResultsSubscriptionDefinition;\nimport com.hubspot.sdk.models.communicationpreferences.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponseWithResultsSubscriptionDefinition actionResponseWithResultsSubscriptionDefinition = client.communicationPreferences().definitions().list();\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.Definitions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithResultsSubscriptionDefinition, err := client.CommunicationPreferences.Definitions.List(context.TODO(), communication_preferences.DefinitionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithResultsSubscriptionDefinition.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.definitions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_results_subscription_definition = hubspot.communication_preferences.definitions.list\n\nputs(action_response_with_results_subscription_definition)', - }, - php: { - method: 'communicationPreferences->definitions->list', - example: - "communicationPreferences\n ->definitions\n ->list(businessUnitID: 0, includeTranslations: true);\n\nvar_dump($actionResponseWithResultsSubscriptionDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/definitions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_unsubscribe_all_statuses', - endpoint: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read', - httpMethod: 'post', - summary: 'Batch retrieve contacts who have opted out of all communications', - description: 'Checks whether a set of contacts have opted out of all communications.', - stainlessPath: - '(resource) communication_preferences.statuses.batch > (method) get_unsubscribe_all_statuses', - qualified: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', - params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;'], - response: - "{ completedAt: string; results: { subscriberIdString: string; wideStatuses: public_wide_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_unsubscribe_all_statuses\n\n`client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses(channel: 'EMAIL', inputs: string[], businessUnitId?: number): { completedAt: string; results: public_wide_status_bulk_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read`\n\nChecks whether a set of contacts have opted out of all communications.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n The ID of the business unit to filter the results. This is an optional parameter.\n\n### Returns\n\n- `{ completedAt: string; results: { subscriberIdString: string; wideStatuses: public_wide_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { subscriberIdString: string; wideStatuses: { channel: 'EMAIL'; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; timestamp: string; wideStatusType: 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE'; businessUnitId?: number; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicWideStatusBulkResponse = await client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicWideStatusBulkResponse);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicWideStatusBulkResponse =\n await client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicWideStatusBulkResponse.completedAt);", - }, - python: { - method: 'communication_preferences.statuses.batch.get_unsubscribe_all_statuses', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_wide_status_bulk_response = client.communication_preferences.statuses.batch.get_unsubscribe_all_statuses(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_wide_status_bulk_response.completed_at)', - }, - java: { - method: 'communicationPreferences().statuses().batch().getUnsubscribeAllStatuses', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicWideStatusBulkResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchGetUnsubscribeAllStatusesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetUnsubscribeAllStatusesParams params = BatchGetUnsubscribeAllStatusesParams.builder()\n .channel(BatchGetUnsubscribeAllStatusesParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicWideStatusBulkResponse batchResponsePublicWideStatusBulkResponse = client.communicationPreferences().statuses().batch().getUnsubscribeAllStatuses(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.Statuses.Batch.GetUnsubscribeAllStatuses', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicWideStatusBulkResponse, err := client.CommunicationPreferences.Statuses.Batch.GetUnsubscribeAllStatuses(context.TODO(), communication_preferences.StatusBatchGetUnsubscribeAllStatusesParams{\n\t\tChannel: communication_preferences.StatusBatchGetUnsubscribeAllStatusesParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicWideStatusBulkResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.statuses.batch.get_unsubscribe_all_statuses', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_wide_status_bulk_response = hubspot.communication_preferences.statuses.batch.get_unsubscribe_all_statuses(\n channel: :EMAIL,\n inputs: ["string"]\n)\n\nputs(batch_response_public_wide_status_bulk_response)', - }, - php: { - method: 'communicationPreferences->statuses->batch->getUnsubscribeAllStatuses', - example: - "communicationPreferences\n ->statuses\n ->batch\n ->getUnsubscribeAllStatuses(\n channel: 'EMAIL', inputs: ['string'], businessUnitID: 0\n);\n\nvar_dump($batchResponsePublicWideStatusBulkResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'read', - endpoint: '/communication-preferences/2026-03/statuses/batch/read', - httpMethod: 'post', - summary: 'Batch retrieve subscription statuses', - description: 'Batch retrieve subscription statuses for a set of contacts.', - stainlessPath: '(resource) communication_preferences.statuses.batch > (method) read', - qualified: 'client.communicationPreferences.statuses.batch.read', - params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;'], - response: - "{ completedAt: string; results: { statuses: public_status[]; subscriberIdString: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## read\n\n`client.communicationPreferences.statuses.batch.read(channel: 'EMAIL', inputs: string[], businessUnitId?: number): { completedAt: string; results: public_status_bulk_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/read`\n\nBatch retrieve subscription statuses for a set of contacts.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel to filter the subscription statuses. Must be 'EMAIL'.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.\n\n### Returns\n\n- `{ completedAt: string; results: { statuses: public_status[]; subscriberIdString: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { statuses: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; subscriberIdString: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicStatusBulkResponse = await client.communicationPreferences.statuses.batch.read({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicStatusBulkResponse);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.statuses.batch.read', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicStatusBulkResponse =\n await client.communicationPreferences.statuses.batch.read({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicStatusBulkResponse.completedAt);", - }, - python: { - method: 'communication_preferences.statuses.batch.read', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_status_bulk_response = client.communication_preferences.statuses.batch.read(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_status_bulk_response.completed_at)', - }, - java: { - method: 'communicationPreferences().statuses().batch().read', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicStatusBulkResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchReadParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadParams params = BatchReadParams.builder()\n .channel(BatchReadParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicStatusBulkResponse batchResponsePublicStatusBulkResponse = client.communicationPreferences().statuses().batch().read(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.Statuses.Batch.Read', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicStatusBulkResponse, err := client.CommunicationPreferences.Statuses.Batch.Read(context.TODO(), communication_preferences.StatusBatchReadParams{\n\t\tChannel: communication_preferences.StatusBatchReadParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicStatusBulkResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.statuses.batch.read', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_status_bulk_response = hubspot.communication_preferences.statuses.batch.read(channel: :EMAIL, inputs: ["string"])\n\nputs(batch_response_public_status_bulk_response)', - }, - php: { - method: 'communicationPreferences->statuses->batch->read', - example: - "communicationPreferences\n ->statuses\n ->batch\n ->read(channel: 'EMAIL', inputs: ['string'], businessUnitID: 0);\n\nvar_dump($batchResponsePublicStatusBulkResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'unsubscribe_all', - endpoint: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all', - httpMethod: 'post', - summary: 'Batch unsubscribe contacts from all subscriptions', - description: 'Unsubscribe a set of contacts from all email subscriptions.', - stainlessPath: '(resource) communication_preferences.statuses.batch > (method) unsubscribe_all', - qualified: 'client.communicationPreferences.statuses.batch.unsubscribeAll', - params: ["channel: 'EMAIL';", 'inputs: string[];', 'businessUnitId?: number;', 'verbose?: boolean;'], - response: - "{ completedAt: string; results: { subscriberIdString: string; statuses?: public_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## unsubscribe_all\n\n`client.communicationPreferences.statuses.batch.unsubscribeAll(channel: 'EMAIL', inputs: string[], businessUnitId?: number, verbose?: boolean): { completedAt: string; results: public_bulk_opt_out_from_all_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/unsubscribe-all`\n\nUnsubscribe a set of contacts from all email subscriptions.\n\n### Parameters\n\n- `channel: 'EMAIL'`\n The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.\n\n- `inputs: string[]`\n Strings to input.\n\n- `businessUnitId?: number`\n An optional integer representing the business unit ID for which the operation is being performed.\n\n- `verbose?: boolean`\n A boolean indicating whether to include detailed information in the response. Defaults to false.\n\n### Returns\n\n- `{ completedAt: string; results: { subscriberIdString: string; statuses?: public_status[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { subscriberIdString: string; statuses?: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicBulkOptOutFromAllResponse = await client.communicationPreferences.statuses.batch.unsubscribeAll({ channel: 'EMAIL', inputs: ['string'] });\n\nconsole.log(batchResponsePublicBulkOptOutFromAllResponse);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.statuses.batch.unsubscribeAll', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicBulkOptOutFromAllResponse =\n await client.communicationPreferences.statuses.batch.unsubscribeAll({\n channel: 'EMAIL',\n inputs: ['string'],\n });\n\nconsole.log(batchResponsePublicBulkOptOutFromAllResponse.completedAt);", - }, - python: { - method: 'communication_preferences.statuses.batch.unsubscribe_all', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_bulk_opt_out_from_all_response = client.communication_preferences.statuses.batch.unsubscribe_all(\n channel="EMAIL",\n inputs=["string"],\n)\nprint(batch_response_public_bulk_opt_out_from_all_response.completed_at)', - }, - java: { - method: 'communicationPreferences().statuses().batch().unsubscribeAll', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicBulkOptOutFromAllResponse;\nimport com.hubspot.sdk.models.communicationpreferences.statuses.batch.BatchUnsubscribeAllParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUnsubscribeAllParams params = BatchUnsubscribeAllParams.builder()\n .channel(BatchUnsubscribeAllParams.Channel.EMAIL)\n .batchInputString(BatchInputString.builder()\n .addInput("string")\n .build())\n .build();\n BatchResponsePublicBulkOptOutFromAllResponse batchResponsePublicBulkOptOutFromAllResponse = client.communicationPreferences().statuses().batch().unsubscribeAll(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.Statuses.Batch.UnsubscribeAll', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicBulkOptOutFromAllResponse, err := client.CommunicationPreferences.Statuses.Batch.UnsubscribeAll(context.TODO(), communication_preferences.StatusBatchUnsubscribeAllParams{\n\t\tChannel: communication_preferences.StatusBatchUnsubscribeAllParamsChannelEmail,\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicBulkOptOutFromAllResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.statuses.batch.unsubscribe_all', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_bulk_opt_out_from_all_response = hubspot.communication_preferences.statuses.batch.unsubscribe_all(channel: :EMAIL, inputs: ["string"])\n\nputs(batch_response_public_bulk_opt_out_from_all_response)', - }, - php: { - method: 'communicationPreferences->statuses->batch->unsubscribeAll', - example: - "communicationPreferences\n ->statuses\n ->batch\n ->unsubscribeAll(\n channel: 'EMAIL', inputs: ['string'], businessUnitID: 0, verbose: true\n);\n\nvar_dump($batchResponsePublicBulkOptOutFromAllResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update_statuses', - endpoint: '/communication-preferences/2026-03/statuses/batch/write', - httpMethod: 'post', - summary: 'Batch update subscription status', - description: 'Update the subscription status for a set of contacts.', - stainlessPath: '(resource) communication_preferences.statuses.batch > (method) update_statuses', - qualified: 'client.communicationPreferences.statuses.batch.updateStatuses', - params: [ - "inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[];", - ], - response: - "{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## update_statuses\n\n`client.communicationPreferences.statuses.batch.updateStatuses(inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[]): { completedAt: string; results: public_status[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/communication-preferences/2026-03/statuses/batch/write`\n\nUpdate the subscription status for a set of contacts.\n\n### Parameters\n\n- `inputs: { channel: 'EMAIL'; statusState: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; legalBasis?: string; legalBasisExplanation?: string; }[]`\n An array of PublicStatusRequest objects, each representing a subscription status update request. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { channel: 'EMAIL'; source: string; status: 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED'; subscriberIdString: string; subscriptionId: number; timestamp: string; businessUnitId?: number; legalBasis?: string; legalBasisExplanation?: string; setStatusSuccessReason?: string; subscriptionName?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicStatus = await client.communicationPreferences.statuses.batch.updateStatuses({ inputs: [{\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriberIdString: 'subscriberIdString',\n subscriptionId: 0,\n}] });\n\nconsole.log(batchResponsePublicStatus);\n```", - perLanguage: { - typescript: { - method: 'client.communicationPreferences.statuses.batch.updateStatuses', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicStatus =\n await client.communicationPreferences.statuses.batch.updateStatuses({\n inputs: [\n {\n channel: 'EMAIL',\n statusState: 'NOT_SPECIFIED',\n subscriberIdString: 'subscriberIdString',\n subscriptionId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicStatus.completedAt);", - }, - python: { - method: 'communication_preferences.statuses.batch.update_statuses', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_status = client.communication_preferences.statuses.batch.update_statuses(\n inputs=[{\n "channel": "EMAIL",\n "status_state": "NOT_SPECIFIED",\n "subscriber_id_string": "subscriberIdString",\n "subscription_id": 0,\n }],\n)\nprint(batch_response_public_status.completed_at)', - }, - java: { - method: 'communicationPreferences().statuses().batch().updateStatuses', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.communicationpreferences.BatchInputPublicStatusRequest;\nimport com.hubspot.sdk.models.communicationpreferences.BatchResponsePublicStatus;\nimport com.hubspot.sdk.models.communicationpreferences.PublicStatusRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicStatusRequest params = BatchInputPublicStatusRequest.builder()\n .addInput(PublicStatusRequest.builder()\n .channel(PublicStatusRequest.Channel.EMAIL)\n .statusState(PublicStatusRequest.StatusState.NOT_SPECIFIED)\n .subscriberIdString("subscriberIdString")\n .subscriptionId(0L)\n .build())\n .build();\n BatchResponsePublicStatus batchResponsePublicStatus = client.communicationPreferences().statuses().batch().updateStatuses(params);\n }\n}', - }, - go: { - method: 'client.CommunicationPreferences.Statuses.Batch.UpdateStatuses', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/communication_preferences"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicStatus, err := client.CommunicationPreferences.Statuses.Batch.UpdateStatuses(context.TODO(), communication_preferences.StatusBatchUpdateStatusesParams{\n\t\tBatchInputPublicStatusRequest: communication_preferences.BatchInputPublicStatusRequestParam{\n\t\t\tInputs: []communication_preferences.PublicStatusRequestParam{{\n\t\t\t\tChannel: communication_preferences.PublicStatusRequestChannelEmail,\n\t\t\t\tStatusState: communication_preferences.PublicStatusRequestStatusStateNotSpecified,\n\t\t\t\tSubscriberIDString: "subscriberIdString",\n\t\t\t\tSubscriptionID: 0,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicStatus.CompletedAt)\n}\n', - }, - ruby: { - method: 'communication_preferences.statuses.batch.update_statuses', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_status = hubspot.communication_preferences.statuses.batch.update_statuses(\n inputs: [\n {channel: :EMAIL, statusState: :NOT_SPECIFIED, subscriberIdString: "subscriberIdString", subscriptionId: 0}\n ]\n)\n\nputs(batch_response_public_status)', - }, - php: { - method: 'communicationPreferences->statuses->batch->updateStatuses', - example: - "communicationPreferences\n ->statuses\n ->batch\n ->updateStatuses(\n inputs: [\n [\n 'channel' => 'EMAIL',\n 'statusState' => 'NOT_SPECIFIED',\n 'subscriberIDString' => 'subscriberIdString',\n 'subscriptionID' => 0,\n 'legalBasis' => 'CONSENT_WITH_NOTICE',\n 'legalBasisExplanation' => 'legalBasisExplanation',\n ],\n ],\n);\n\nvar_dump($batchResponsePublicStatus);", - }, - http: { - example: - 'curl https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/write \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "channel": "EMAIL",\n "statusState": "NOT_SPECIFIED",\n "subscriberIdString": "subscriberIdString",\n "subscriptionId": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/conversations/custom-channels/2026-03', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) conversations.custom_channels > (method) create', - qualified: 'client.conversations.customChannels.create', - params: [ - 'capabilities: object;', - 'name: string;', - 'channelAccountConnectionRedirectUrl?: string;', - 'channelDescription?: string;', - 'channelLogoUrl?: string;', - 'webhookUrl?: string;', - ], - response: - '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', - markdown: - "## create\n\n`client.conversations.customChannels.create(capabilities: object, name: string, channelAccountConnectionRedirectUrl?: string, channelDescription?: string, channelLogoUrl?: string, webhookUrl?: string): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**post** `/conversations/custom-channels/2026-03`\n\n### Parameters\n\n- `capabilities: object`\n\n- `name: string`\n\n- `channelAccountConnectionRedirectUrl?: string`\n\n- `channelDescription?: string`\n\n- `channelLogoUrl?: string`\n\n- `webhookUrl?: string`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.create({\n capabilities: { foo: {} },\n name: 'name',\n});\n\nconsole.log(publicChannelIntegrationChannel);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.create({\n capabilities: { foo: {} },\n name: 'name',\n});\n\nconsole.log(publicChannelIntegrationChannel.id);", - }, - python: { - method: 'conversations.custom_channels.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npublic_channel_integration_channel = client.conversations.custom_channels.create(\n capabilities={\n "foo": {}\n },\n name="name",\n)\nprint(public_channel_integration_channel.id)', - }, - java: { - method: 'conversations().customChannels().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannel;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannelCreate;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicChannelIntegrationChannelCreate params = PublicChannelIntegrationChannelCreate.builder()\n .capabilities(PublicChannelIntegrationChannelCreate.Capabilities.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .name("name")\n .build();\n PublicChannelIntegrationChannel publicChannelIntegrationChannel = client.conversations().customChannels().create(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelIntegrationChannel, err := client.Conversations.CustomChannels.New(context.TODO(), conversations.CustomChannelNewParams{\n\t\tPublicChannelIntegrationChannelCreate: conversations.PublicChannelIntegrationChannelCreateParam{\n\t\t\tCapabilities: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelIntegrationChannel.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_integration_channel = hubspot.conversations.custom_channels.create(capabilities: {foo: {}}, name: "name")\n\nputs(public_channel_integration_channel)', - }, - php: { - method: 'conversations->customChannels->create', - example: - "conversations\n ->customChannels\n ->create(\n capabilities: ['foo' => (object) []],\n name: 'name',\n channelAccountConnectionRedirectURL: 'channelAccountConnectionRedirectUrl',\n channelDescription: 'channelDescription',\n channelLogoURL: 'channelLogoUrl',\n webhookURL: 'webhookUrl',\n);\n\nvar_dump($publicChannelIntegrationChannel);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "capabilities": {\n "foo": {}\n },\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/conversations/custom-channels/2026-03/{channelId}', - httpMethod: 'delete', - summary: 'Archive a custom channel', - description: 'Archive an existing registered custom channel', - stainlessPath: '(resource) conversations.custom_channels > (method) delete', - qualified: 'client.conversations.customChannels.delete', - params: ['channelId: number;'], - markdown: - "## delete\n\n`client.conversations.customChannels.delete(channelId: number): void`\n\n**delete** `/conversations/custom-channels/2026-03/{channelId}`\n\nArchive an existing registered custom channel\n\n### Parameters\n\n- `channelId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.conversations.customChannels.delete(0)\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.conversations.customChannels.delete(0);", - }, - python: { - method: 'conversations.custom_channels.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\nclient.conversations.custom_channels.delete(\n 0,\n)', - }, - java: { - method: 'conversations().customChannels().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.conversations().customChannels().delete(0);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Conversations.CustomChannels.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.conversations.custom_channels.delete(0)\n\nputs(result)', - }, - php: { - method: 'conversations->customChannels->delete', - example: - "conversations->customChannels->delete(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', - httpMethod: 'get', - summary: 'Get a channel account by id', - description: - 'Retrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.', - stainlessPath: '(resource) conversations.custom_channels > (method) get', - qualified: 'client.conversations.customChannels.get', - params: ['channelId: number;', 'channelAccountId: number;', 'archived?: boolean;'], - response: - "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", - markdown: - "## get\n\n`client.conversations.customChannels.get(channelId: number, channelAccountId: number, archived?: boolean): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}`\n\nRetrieve the details for a specific channel account. This contains all the metadata about your channel account, including its channel, associated inbox id, and delivery identifier information.\n\n### Parameters\n\n- `channelId: number`\n\n- `channelAccountId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.get(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.get(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount.id);", - }, - python: { - method: 'conversations.custom_channels.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.get(\n channel_account_id=0,\n channel_id=0,\n)\nprint(public_channel_account.id)', - }, - java: { - method: 'conversations().customChannels().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelGetParams;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelGetParams params = CustomChannelGetParams.builder()\n .channelId(0)\n .channelAccountId(0L)\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().get(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelGetParams{\n\t\t\tChannelID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.get(0, channel_id: 0)\n\nputs(public_channel_account)', - }, - php: { - method: 'conversations->customChannels->get', - example: - "conversations->customChannels->get(\n 0, channelID: 0, archived: true\n);\n\nvar_dump($publicChannelAccount);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts/$CHANNEL_ACCOUNT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/conversations/custom-channels/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) conversations.custom_channels > (method) list', - qualified: 'client.conversations.customChannels.list', - params: ['after?: string;', 'defaultPageLength?: number;', 'limit?: number;', 'sort?: string[];'], - response: - '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', - markdown: - "## list\n\n`client.conversations.customChannels.list(after?: string, defaultPageLength?: number, limit?: number, sort?: string[]): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**get** `/conversations/custom-channels/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `defaultPageLength?: number`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelIntegrationChannel of client.conversations.customChannels.list()) {\n console.log(publicChannelIntegrationChannel);\n}\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelIntegrationChannel of client.conversations.customChannels.list()) {\n console.log(publicChannelIntegrationChannel.id);\n}", - }, - python: { - method: 'conversations.custom_channels.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npage = client.conversations.custom_channels.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'conversations().customChannels().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelListPage;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelListPage page = client.conversations().customChannels().list();\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Conversations.CustomChannels.List(context.TODO(), conversations.CustomChannelListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.conversations.custom_channels.list\n\nputs(page)', - }, - php: { - method: 'conversations->customChannels->list', - example: - "conversations->customChannels->list(\n after: 'after', defaultPageLength: 0, limit: 0, sort: ['string']\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/conversations/custom-channels/2026-03/{channelId}', - httpMethod: 'patch', - summary: 'Update a custom channel', - description: - "Update the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.", - stainlessPath: '(resource) conversations.custom_channels > (method) update', - qualified: 'client.conversations.customChannels.update', - params: [ - 'channelId: number;', - 'capabilities: object;', - 'channelAccountConnectionRedirectUrl: object;', - 'channelDescription: object;', - 'channelLogoUrl: object;', - 'name: object;', - 'webhookUrl: object;', - ], - response: - '{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }', - markdown: - "## update\n\n`client.conversations.customChannels.update(channelId: number, capabilities: object, channelAccountConnectionRedirectUrl: object, channelDescription: object, channelLogoUrl: object, name: object, webhookUrl: object): { id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}`\n\nUpdate the capabilities for an existing. You can also use it to update the channel's webhookUri and its channelAccountConnectionRedirectUrl.\n\n### Parameters\n\n- `channelId: number`\n\n- `capabilities: object`\n\n- `channelAccountConnectionRedirectUrl: object`\n\n- `channelDescription: object`\n\n- `channelLogoUrl: object`\n\n- `name: object`\n\n- `webhookUrl: object`\n\n### Returns\n\n- `{ id: string; capabilities: object; createdAt: string; name: string; channelAccountConnectionRedirectUrl?: string; channelDescription?: string; channelLogoUrl?: string; webhookUrl?: string; }`\n\n - `id: string`\n - `capabilities: object`\n - `createdAt: string`\n - `name: string`\n - `channelAccountConnectionRedirectUrl?: string`\n - `channelDescription?: string`\n - `channelLogoUrl?: string`\n - `webhookUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.update(0, {\n capabilities: { foo: {} },\n channelAccountConnectionRedirectUrl: {},\n channelDescription: {},\n channelLogoUrl: {},\n name: {},\n webhookUrl: {},\n});\n\nconsole.log(publicChannelIntegrationChannel);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelIntegrationChannel = await client.conversations.customChannels.update(0, {\n capabilities: { foo: {} },\n channelAccountConnectionRedirectUrl: {},\n channelDescription: {},\n channelLogoUrl: {},\n name: {},\n webhookUrl: {},\n});\n\nconsole.log(publicChannelIntegrationChannel.id);", - }, - python: { - method: 'conversations.custom_channels.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot()\npublic_channel_integration_channel = client.conversations.custom_channels.update(\n channel_id=0,\n capabilities={\n "foo": {}\n },\n channel_account_connection_redirect_url={},\n channel_description={},\n channel_logo_url={},\n name={},\n webhook_url={},\n)\nprint(public_channel_integration_channel.id)', - }, - java: { - method: 'conversations().customChannels().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.conversations.customchannels.CustomChannelUpdateParams;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannel;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationChannelPatch;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomChannelUpdateParams params = CustomChannelUpdateParams.builder()\n .channelId(0)\n .publicChannelIntegrationChannelPatch(PublicChannelIntegrationChannelPatch.builder()\n .capabilities(PublicChannelIntegrationChannelPatch.Capabilities.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .channelAccountConnectionRedirectUrl(JsonValue.from(Map.of()))\n .channelDescription(JsonValue.from(Map.of()))\n .channelLogoUrl(JsonValue.from(Map.of()))\n .name(JsonValue.from(Map.of()))\n .webhookUrl(JsonValue.from(Map.of()))\n .build())\n .build();\n PublicChannelIntegrationChannel publicChannelIntegrationChannel = client.conversations().customChannels().update(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelIntegrationChannel, err := client.Conversations.CustomChannels.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelUpdateParams{\n\t\t\tPublicChannelIntegrationChannelPatch: conversations.PublicChannelIntegrationChannelPatchParam{\n\t\t\t\tCapabilities: map[string]any{\n\t\t\t\t\t"foo": map[string]any{},\n\t\t\t\t},\n\t\t\t\tChannelAccountConnectionRedirectURL: map[string]any{},\n\t\t\t\tChannelDescription: map[string]any{},\n\t\t\t\tChannelLogoURL: map[string]any{},\n\t\t\t\tName: map[string]any{},\n\t\t\t\tWebhookURL: map[string]any{},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelIntegrationChannel.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_integration_channel = hubspot.conversations.custom_channels.update(\n 0,\n capabilities: {foo: {}},\n channel_account_connection_redirect_url: {},\n channel_description: {},\n channel_logo_url: {},\n name: {},\n webhook_url: {}\n)\n\nputs(public_channel_integration_channel)', - }, - php: { - method: 'conversations->customChannels->update', - example: - "conversations\n ->customChannels\n ->update(\n 0,\n capabilities: ['foo' => (object) []],\n channelAccountConnectionRedirectURL: (object) [],\n channelDescription: (object) [],\n channelLogoURL: (object) [],\n name: (object) [],\n webhookURL: (object) [],\n);\n\nvar_dump($publicChannelIntegrationChannel);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "capabilities": {\n "foo": {}\n },\n "channelAccountConnectionRedirectUrl": {},\n "channelDescription": {},\n "channelLogoUrl": {},\n "name": {},\n "webhookUrl": {}\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', - httpMethod: 'post', - summary: 'Create a channel account', - description: - 'Create a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.', - stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) create', - qualified: 'client.conversations.customChannels.channelAccounts.create', - params: [ - 'channelId: number;', - 'authorized: boolean;', - 'inboxId: string;', - 'name: string;', - "deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; };", - ], - response: - "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", - markdown: - "## create\n\n`client.conversations.customChannels.channelAccounts.create(channelId: number, authorized: boolean, inboxId: string, name: string, deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**post** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts`\n\nCreate a new account for a channel. Multiple accounts can communicate over a single channel using different delivery identifiers.\n\n### Parameters\n\n- `channelId: number`\n\n- `authorized: boolean`\n\n- `inboxId: string`\n\n- `name: string`\n\n- `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n - `type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'`\n - `value: string`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.create(0, {\n authorized: true,\n inboxId: 'inboxId',\n name: 'name',\n});\n\nconsole.log(publicChannelAccount);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.channelAccounts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.create(0, {\n authorized: true,\n inboxId: 'inboxId',\n name: 'name',\n});\n\nconsole.log(publicChannelAccount.id);", - }, - python: { - method: 'conversations.custom_channels.channel_accounts.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.channel_accounts.create(\n channel_id=0,\n authorized=True,\n inbox_id="inboxId",\n name="name",\n)\nprint(public_channel_account.id)', - }, - java: { - method: 'conversations().customChannels().channelAccounts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountEgg;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountCreateParams params = ChannelAccountCreateParams.builder()\n .channelId(0)\n .publicChannelAccountEgg(PublicChannelAccountEgg.builder()\n .authorized(true)\n .inboxId("inboxId")\n .name("name")\n .build())\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().channelAccounts().create(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.ChannelAccounts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.ChannelAccounts.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountNewParams{\n\t\t\tPublicChannelAccountEgg: conversations.PublicChannelAccountEggParam{\n\t\t\t\tAuthorized: true,\n\t\t\t\tInboxID: "inboxId",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.channel_accounts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.channel_accounts.create(\n 0,\n authorized: true,\n inbox_id: "inboxId",\n name: "name"\n)\n\nputs(public_channel_account)', - }, - php: { - method: 'conversations->customChannels->channelAccounts->create', - example: - "conversations\n ->customChannels\n ->channelAccounts\n ->create(\n 0,\n authorized: true,\n inboxID: 'inboxId',\n name: 'name',\n deliveryIdentifier: [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n);\n\nvar_dump($publicChannelAccount);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "authorized": true,\n "inboxId": "inboxId",\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'list', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', - httpMethod: 'get', - summary: 'Get accounts for a channel', - description: 'Retrieve a list of accounts for a custom channel.', - stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) list', - qualified: 'client.conversations.customChannels.channelAccounts.list', - params: [ - 'channelId: number;', - 'after?: string;', - 'archived?: boolean;', - 'defaultPageLength?: number;', - "deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[];", - 'deliveryIdentifierValue?: string[];', - 'limit?: number;', - 'sort?: string[];', - ], - response: - "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", - markdown: - "## list\n\n`client.conversations.customChannels.channelAccounts.list(channelId: number, after?: string, archived?: boolean, defaultPageLength?: number, deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[], deliveryIdentifierValue?: string[], limit?: number, sort?: string[]): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts`\n\nRetrieve a list of accounts for a custom channel.\n\n### Parameters\n\n- `channelId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `defaultPageLength?: number`\n\n- `deliveryIdentifierType?: 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE' | 'CHANNEL_SPECIFIC_OPAQUE_ID'[]`\n\n- `deliveryIdentifierValue?: string[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelAccount of client.conversations.customChannels.channelAccounts.list(0)) {\n console.log(publicChannelAccount);\n}\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.channelAccounts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicChannelAccount of client.conversations.customChannels.channelAccounts.list(\n 0,\n)) {\n console.log(publicChannelAccount.id);\n}", - }, - python: { - method: 'conversations.custom_channels.channel_accounts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.conversations.custom_channels.channel_accounts.list(\n channel_id=0,\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'conversations().customChannels().channelAccounts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountListPage;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountListPage page = client.conversations().customChannels().channelAccounts().list(0);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.ChannelAccounts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Conversations.CustomChannels.ChannelAccounts.List(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.channel_accounts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.conversations.custom_channels.channel_accounts.list(0)\n\nputs(page)', - }, - php: { - method: 'conversations->customChannels->channelAccounts->list', - example: - "conversations->customChannels->channelAccounts->list(\n 0,\n after: 'after',\n archived: true,\n defaultPageLength: 0,\n deliveryIdentifierType: ['HS_EMAIL_ADDRESS'],\n deliveryIdentifierValue: ['string'],\n limit: 0,\n sort: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', - httpMethod: 'patch', - summary: 'Update a channel account', - description: - "This API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.", - stainlessPath: '(resource) conversations.custom_channels.channel_accounts > (method) update', - qualified: 'client.conversations.customChannels.channelAccounts.update', - params: ['channelId: number;', 'channelAccountId: number;', 'authorized?: boolean;', 'name?: string;'], - response: - "{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", - markdown: - "## update\n\n`client.conversations.customChannels.channelAccounts.update(channelId: number, channelAccountId: number, authorized?: boolean, name?: string): { id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}`\n\nThis API is used to update the name of the channel account and it's isAuthorized status. Setting to isAuthorized flag to False disables the channel account.\n\n### Parameters\n\n- `channelId: number`\n\n- `channelAccountId: number`\n\n- `authorized?: boolean`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; active: boolean; archived: boolean; authorized: boolean; channelId: string; createdAt: string; inboxId: string; name: string; archivedAt?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `id: string`\n - `active: boolean`\n - `archived: boolean`\n - `authorized: boolean`\n - `channelId: string`\n - `createdAt: string`\n - `inboxId: string`\n - `name: string`\n - `archivedAt?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.update(0, { channelId: 0 });\n\nconsole.log(publicChannelAccount);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.channelAccounts.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccount = await client.conversations.customChannels.channelAccounts.update(0, {\n channelId: 0,\n});\n\nconsole.log(publicChannelAccount.id);", - }, - python: { - method: 'conversations.custom_channels.channel_accounts.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account = client.conversations.custom_channels.channel_accounts.update(\n channel_account_id=0,\n channel_id=0,\n)\nprint(public_channel_account.id)', - }, - java: { - method: 'conversations().customChannels().channelAccounts().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccount;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountUpdateParams params = ChannelAccountUpdateParams.builder()\n .channelId(0)\n .channelAccountId(0L)\n .publicChannelAccountUpdateRequest(PublicChannelAccountUpdateRequest.builder().build())\n .build();\n PublicChannelAccount publicChannelAccount = client.conversations().customChannels().channelAccounts().update(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.ChannelAccounts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccount, err := client.Conversations.CustomChannels.ChannelAccounts.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelChannelAccountUpdateParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelAccountUpdateRequest: conversations.PublicChannelAccountUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccount.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.channel_accounts.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account = hubspot.conversations.custom_channels.channel_accounts.update(0, channel_id: 0)\n\nputs(public_channel_account)', - }, - php: { - method: 'conversations->customChannels->channelAccounts->update', - example: - "conversations\n ->customChannels\n ->channelAccounts\n ->update(0, channelID: 0, authorized: true, name: 'name');\n\nvar_dump($publicChannelAccount);", - }, - http: { - example: - "curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-accounts/$CHANNEL_ACCOUNT_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_staging_token', - endpoint: - '/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}', - httpMethod: 'patch', - summary: 'Update a channel account staging token', - description: - "Update a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token. This is used for public apps.", - stainlessPath: - '(resource) conversations.custom_channels.channel_accounts > (method) update_staging_token', - qualified: 'client.conversations.customChannels.channelAccounts.updateStagingToken', - params: [ - 'channelId: number;', - 'accountToken: string;', - 'accountName?: string;', - "deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; };", - ], - response: - "{ accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }", - markdown: - "## update_staging_token\n\n`client.conversations.customChannels.channelAccounts.updateStagingToken(channelId: number, accountToken: string, accountName?: string, deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }): { accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: public_delivery_identifier; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}`\n\nUpdate a channel account staging token's account name and delivery identifier. This information will be applied to the channel account created from this staging token. This is used for public apps.\n\n### Parameters\n\n- `channelId: number`\n\n- `accountToken: string`\n\n- `accountName?: string`\n\n- `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n - `type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'`\n - `value: string`\n\n### Returns\n\n- `{ accountToken: string; createdAt: string; genericChannelId: number; inboxId: number; userId: number; accountName?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; }`\n\n - `accountToken: string`\n - `createdAt: string`\n - `genericChannelId: number`\n - `inboxId: number`\n - `userId: number`\n - `accountName?: string`\n - `deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicChannelAccountStagingToken = await client.conversations.customChannels.channelAccounts.updateStagingToken('accountToken', { channelId: 0 });\n\nconsole.log(publicChannelAccountStagingToken);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.channelAccounts.updateStagingToken', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicChannelAccountStagingToken =\n await client.conversations.customChannels.channelAccounts.updateStagingToken('accountToken', {\n channelId: 0,\n });\n\nconsole.log(publicChannelAccountStagingToken.accountToken);", - }, - python: { - method: 'conversations.custom_channels.channel_accounts.update_staging_token', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_channel_account_staging_token = client.conversations.custom_channels.channel_accounts.update_staging_token(\n account_token="accountToken",\n channel_id=0,\n)\nprint(public_channel_account_staging_token.account_token)', - }, - java: { - method: 'conversations().customChannels().channelAccounts().updateStagingToken', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountStagingToken;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelAccountStagingTokenUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.channelaccounts.ChannelAccountUpdateStagingTokenParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelAccountUpdateStagingTokenParams params = ChannelAccountUpdateStagingTokenParams.builder()\n .channelId(0)\n .accountToken("accountToken")\n .publicChannelAccountStagingTokenUpdateRequest(PublicChannelAccountStagingTokenUpdateRequest.builder().build())\n .build();\n PublicChannelAccountStagingToken publicChannelAccountStagingToken = client.conversations().customChannels().channelAccounts().updateStagingToken(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.ChannelAccounts.UpdateStagingToken', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicChannelAccountStagingToken, err := client.Conversations.CustomChannels.ChannelAccounts.UpdateStagingToken(\n\t\tcontext.TODO(),\n\t\t"accountToken",\n\t\tconversations.CustomChannelChannelAccountUpdateStagingTokenParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelAccountStagingTokenUpdateRequest: conversations.PublicChannelAccountStagingTokenUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicChannelAccountStagingToken.AccountToken)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.channel_accounts.update_staging_token', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_channel_account_staging_token = hubspot.conversations.custom_channels.channel_accounts.update_staging_token("accountToken", channel_id: 0)\n\nputs(public_channel_account_staging_token)', - }, - php: { - method: 'conversations->customChannels->channelAccounts->updateStagingToken', - example: - "conversations\n ->customChannels\n ->channelAccounts\n ->updateStagingToken(\n 'accountToken',\n channelID: 0,\n accountName: 'accountName',\n deliveryIdentifier: [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n);\n\nvar_dump($publicChannelAccountStagingToken);", - }, - http: { - example: - "curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/channel-account-staging-tokens/$ACCOUNT_TOKEN \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages', - httpMethod: 'post', - summary: 'Publish a message', - description: 'Publish a message over your custom channel', - stainlessPath: '(resource) conversations.custom_channels.messages > (method) create', - qualified: 'client.conversations.customChannels.messages.create', - params: [ - 'channelId: number;', - "attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[];", - 'channelAccountId: string;', - "messageDirection: 'INCOMING' | 'OUTGOING';", - "recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[];", - "senders: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[];", - 'text: string;', - 'timestamp: string;', - 'associateWithContactId?: number;', - 'inReplyToId?: string;', - 'integrationIdempotencyId?: string;', - 'integrationThreadId?: string;', - 'preResolvedContacts?: { contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]; };', - 'richText?: string;', - ], - response: - "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", - markdown: - "## create\n\n`client.conversations.customChannels.messages.create(channelId: number, attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[], channelAccountId: string, messageDirection: 'INCOMING' | 'OUTGOING', recipients: { deliveryIdentifier: public_delivery_identifier; name?: string; senderActorId?: string; }[], senders: { deliveryIdentifier: public_delivery_identifier; name?: string; senderActorId?: string; }[], text: string, timestamp: string, associateWithContactId?: number, inReplyToId?: string, integrationIdempotencyId?: string, integrationThreadId?: string, preResolvedContacts?: { contacts: pre_resolved_contact[]; }, richText?: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**post** `/conversations/custom-channels/2026-03/{channelId}/messages`\n\nPublish a message over your custom channel\n\n### Parameters\n\n- `channelId: number`\n\n- `attachments: { fileId: string; type: 'FILE'; fileUsageType?: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n\n- `channelAccountId: string`\n\n- `messageDirection: 'INCOMING' | 'OUTGOING'`\n\n- `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[]`\n\n- `senders: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderActorId?: string; }[]`\n\n- `text: string`\n\n- `timestamp: string`\n\n- `associateWithContactId?: number`\n\n- `inReplyToId?: string`\n\n- `integrationIdempotencyId?: string`\n\n- `integrationThreadId?: string`\n\n- `preResolvedContacts?: { contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]; }`\n - `contacts: { contactPropertiesLeadingToMatch: string[]; contactVid: number; }[]`\n\n- `richText?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.create(0, {\n attachments: [{ fileId: 'fileId', type: 'FILE' }],\n channelAccountId: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n senders: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n text: 'text',\n timestamp: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(publicConversationsMessage);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.messages.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.create(0, {\n attachments: [{ fileId: 'fileId', type: 'FILE' }],\n channelAccountId: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n senders: [{ deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID', value: 'value' } }],\n text: 'text',\n timestamp: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(publicConversationsMessage.id);", - }, - python: { - method: 'conversations.custom_channels.messages.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.create(\n channel_id=0,\n attachments=[{\n "file_id": "fileId",\n "type": "FILE",\n }],\n channel_account_id="channelAccountId",\n message_direction="INCOMING",\n recipients=[{\n "delivery_identifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value",\n }\n }],\n senders=[{\n "delivery_identifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value",\n }\n }],\n text="text",\n timestamp=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(public_conversations_message.id)', - }, - java: { - method: 'conversations().customChannels().messages().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.ChannelIntegrationMessageEgg;\nimport com.hubspot.sdk.models.conversations.customchannels.ChannelIntegrationParticipant;\nimport com.hubspot.sdk.models.conversations.customchannels.FileAttachment;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicDeliveryIdentifier;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageCreateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageCreateParams params = MessageCreateParams.builder()\n .channelId(0)\n .channelIntegrationMessageEgg(ChannelIntegrationMessageEgg.builder()\n .addAttachment(FileAttachment.builder()\n .fileId("fileId")\n .type(FileAttachment.Type.FILE)\n .build())\n .channelAccountId("channelAccountId")\n .messageDirection(ChannelIntegrationMessageEgg.MessageDirection.INCOMING)\n .addRecipient(ChannelIntegrationParticipant.builder()\n .deliveryIdentifier(PublicDeliveryIdentifier.builder()\n .type(PublicDeliveryIdentifier.Type.CHANNEL_SPECIFIC_OPAQUE_ID)\n .value("value")\n .build())\n .build())\n .addSender(ChannelIntegrationParticipant.builder()\n .deliveryIdentifier(PublicDeliveryIdentifier.builder()\n .type(PublicDeliveryIdentifier.Type.CHANNEL_SPECIFIC_OPAQUE_ID)\n .value("value")\n .build())\n .build())\n .text("text")\n .timestamp(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().create(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Messages.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tconversations.CustomChannelMessageNewParams{\n\t\t\tChannelIntegrationMessageEgg: conversations.ChannelIntegrationMessageEggParam{\n\t\t\t\tAttachments: []conversations.ChannelIntegrationMessageEggAttachmentUnionParam{{\n\t\t\t\t\tOfFile: &conversations.FileAttachmentParam{\n\t\t\t\t\t\tFileID: "fileId",\n\t\t\t\t\t\tType: conversations.FileAttachmentTypeFile,\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tChannelAccountID: "channelAccountId",\n\t\t\t\tMessageDirection: conversations.ChannelIntegrationMessageEggMessageDirectionIncoming,\n\t\t\t\tRecipients: []conversations.ChannelIntegrationParticipantParam{{\n\t\t\t\t\tDeliveryIdentifier: conversations.PublicDeliveryIdentifierParam{\n\t\t\t\t\t\tType: conversations.PublicDeliveryIdentifierTypeChannelSpecificOpaqueID,\n\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tSenders: []conversations.ChannelIntegrationParticipantParam{{\n\t\t\t\t\tDeliveryIdentifier: conversations.PublicDeliveryIdentifierParam{\n\t\t\t\t\t\tType: conversations.PublicDeliveryIdentifierTypeChannelSpecificOpaqueID,\n\t\t\t\t\t\tValue: "value",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t\tText: "text",\n\t\t\t\tTimestamp: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.messages.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.create(\n 0,\n attachments: [{fileId: "fileId", type: :FILE}],\n channel_account_id: "channelAccountId",\n message_direction: :INCOMING,\n recipients: [{deliveryIdentifier: {type: :CHANNEL_SPECIFIC_OPAQUE_ID, value: "value"}}],\n senders: [{deliveryIdentifier: {type: :CHANNEL_SPECIFIC_OPAQUE_ID, value: "value"}}],\n text: "text",\n timestamp: "2019-12-27T18:11:19.117Z"\n)\n\nputs(public_conversations_message)', - }, - php: { - method: 'conversations->customChannels->messages->create', - example: - "conversations\n ->customChannels\n ->messages\n ->create(\n 0,\n attachments: [\n ['fileID' => 'fileId', 'type' => 'FILE', 'fileUsageType' => 'AUDIO']\n ],\n channelAccountID: 'channelAccountId',\n messageDirection: 'INCOMING',\n recipients: [\n [\n 'deliveryIdentifier' => [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n 'name' => 'name',\n 'senderActorID' => 'senderActorId',\n ],\n ],\n senders: [\n [\n 'deliveryIdentifier' => [\n 'type' => 'CHANNEL_SPECIFIC_OPAQUE_ID', 'value' => 'value'\n ],\n 'name' => 'name',\n 'senderActorID' => 'senderActorId',\n ],\n ],\n text: 'text',\n timestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n associateWithContactID: 0,\n inReplyToID: 'inReplyToId',\n integrationIdempotencyID: 'integrationIdempotencyId',\n integrationThreadID: 'integrationThreadId',\n preResolvedContacts: [\n 'contacts' => [\n ['contactPropertiesLeadingToMatch' => ['address'], 'contactVid' => 0]\n ],\n ],\n richText: 'richText',\n);\n\nvar_dump($publicConversationsMessage);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "attachments": [\n {\n "fileId": "fileId",\n "type": "FILE"\n }\n ],\n "channelAccountId": "channelAccountId",\n "messageDirection": "INCOMING",\n "recipients": [\n {\n "deliveryIdentifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value"\n }\n }\n ],\n "senders": [\n {\n "deliveryIdentifier": {\n "type": "CHANNEL_SPECIFIC_OPAQUE_ID",\n "value": "value"\n }\n }\n ],\n "text": "text",\n "timestamp": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', - httpMethod: 'get', - summary: 'Get a message', - description: 'Get the details for a specific message sent over a custom channel', - stainlessPath: '(resource) conversations.custom_channels.messages > (method) get', - qualified: 'client.conversations.customChannels.messages.get', - params: ['channelId: number;', 'messageId: string;'], - response: - "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", - markdown: - "## get\n\n`client.conversations.customChannels.messages.get(channelId: number, messageId: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**get** `/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}`\n\nGet the details for a specific message sent over a custom channel\n\n### Parameters\n\n- `channelId: number`\n\n- `messageId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.get('messageId', { channelId: 0 });\n\nconsole.log(publicConversationsMessage);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.messages.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.get(\n 'messageId',\n { channelId: 0 },\n);\n\nconsole.log(publicConversationsMessage.id);", - }, - python: { - method: 'conversations.custom_channels.messages.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.get(\n message_id="messageId",\n channel_id=0,\n)\nprint(public_conversations_message.id)', - }, - java: { - method: 'conversations().customChannels().messages().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageGetParams params = MessageGetParams.builder()\n .channelId(0)\n .messageId("messageId")\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().get(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Messages.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.Get(\n\t\tcontext.TODO(),\n\t\t"messageId",\n\t\tconversations.CustomChannelMessageGetParams{\n\t\t\tChannelID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.messages.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.get("messageId", channel_id: 0)\n\nputs(public_conversations_message)', - }, - php: { - method: 'conversations->customChannels->messages->get', - example: - "conversations\n ->customChannels\n ->messages\n ->get('messageId', channelID: 0);\n\nvar_dump($publicConversationsMessage);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages/$MESSAGE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', - httpMethod: 'patch', - summary: 'Update a message ', - description: - "Update a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure.", - stainlessPath: '(resource) conversations.custom_channels.messages > (method) update', - qualified: 'client.conversations.customChannels.messages.update', - params: [ - 'channelId: number;', - 'messageId: string;', - "statusType: 'FAILED' | 'READ' | 'SENT';", - 'errorMessage?: string;', - ], - response: - "{ id: string; archived: boolean; attachments: object | object | object | object | object | object | object | object[]; channelAccountId: string; channelId: string; client: object; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: object[]; senders: object[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: object; subject?: string; updatedAt?: string; }", - markdown: - "## update\n\n`client.conversations.customChannels.messages.update(channelId: number, messageId: string, statusType: 'FAILED' | 'READ' | 'SENT', errorMessage?: string): { id: string; archived: boolean; attachments: public_file | public_location | public_contact | public_unsupported_content | public_message_header | public_quick_replies | public_whats_app_template_metadata | public_social_metadata_attachment[]; channelAccountId: string; channelId: string; client: public_client; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: public_recipient[]; senders: public_sender[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: public_message_status; subject?: string; updatedAt?: string; }`\n\n**patch** `/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}`\n\nUpdate a message's status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure.\n\n### Parameters\n\n- `channelId: number`\n\n- `messageId: string`\n\n- `statusType: 'FAILED' | 'READ' | 'SENT'`\n Valid status are SENT, FAILED, and READ\n\n- `errorMessage?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: contact_profile; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: quick_reply[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: social_metadata; type: 'SOCIAL_MEDIA_METADATA'; }[]; channelAccountId: string; channelId: string; client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }; conversationsThreadId: string; createdAt: string; createdBy: string; direction: 'INCOMING' | 'OUTGOING'; recipients: { deliveryIdentifier: public_delivery_identifier; actorId?: string; name?: string; recipientField?: string; }[]; senders: { actorId?: string; deliveryIdentifier?: public_delivery_identifier; name?: string; senderField?: string; }[]; text: string; truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'; type: 'MESSAGE'; inReplyToId?: string; richText?: string; status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: public_message_failure_details; }; subject?: string; updatedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `attachments: { fileId: string; fileUsageType: 'AUDIO' | 'IMAGE' | 'OTHER' | 'STICKER' | 'VOICE_RECORDING'; type: 'FILE'; name?: string; url?: string; } | { latitude: number; longitude: number; type: 'LOCATION'; address?: string; name?: string; url?: string; } | { contactProfile: { addresses: contact_address[]; emails: contact_email[]; phones: contact_phone[]; urls: contact_url[]; name?: contact_name; org?: contact_org; }; type: 'CONTACT'; } | { type: 'UNSUPPORTED_CONTENT'; } | { type: 'MESSAGE_HEADER'; fileId?: number; text?: string; } | { allowMultiSelect: boolean; allowUserInput: boolean; quickReplies: { value: string; valueType: 'TEXT' | 'URL'; label?: string; }[]; type: 'QUICK_REPLIES'; } | { crmObjectIds: object; parameters: object; type: 'WHATSAPP_TEMPLATE_METADATA'; contentId?: number; mappedTemplateId?: number; rootMicId?: number; } | { socialMetadata: { mediaType: string; id?: string; description?: string; mediaTitle?: string; mediaUrl?: string; mediaUrlString?: string; thumbnailUrl?: string; }; type: 'SOCIAL_MEDIA_METADATA'; }[]`\n - `channelAccountId: string`\n - `channelId: string`\n - `client: { clientType: 'HUBSPOT' | 'INTEGRATION' | 'SYSTEM' | 'UNKNOWN'; integrationAppId?: number; }`\n - `conversationsThreadId: string`\n - `createdAt: string`\n - `createdBy: string`\n - `direction: 'INCOMING' | 'OUTGOING'`\n - `recipients: { deliveryIdentifier: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; actorId?: string; name?: string; recipientField?: string; }[]`\n - `senders: { actorId?: string; deliveryIdentifier?: { type: 'CHANNEL_SPECIFIC_OPAQUE_ID' | 'HS_EMAIL_ADDRESS' | 'HS_PHONE_NUMBER' | 'HS_SHORT_CODE'; value: string; }; name?: string; senderField?: string; }[]`\n - `text: string`\n - `truncationStatus: 'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY'`\n - `type: 'MESSAGE'`\n - `inReplyToId?: string`\n - `richText?: string`\n - `status?: { statusType: 'FAILED' | 'READ' | 'RECEIVED' | 'SENT'; failureDetails?: { errorMessageTokens: object; errorMessage?: string; }; }`\n - `subject?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.update('messageId', { channelId: 0, statusType: 'FAILED' });\n\nconsole.log(publicConversationsMessage);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.customChannels.messages.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicConversationsMessage = await client.conversations.customChannels.messages.update(\n 'messageId',\n { channelId: 0, statusType: 'FAILED' },\n);\n\nconsole.log(publicConversationsMessage.id);", - }, - python: { - method: 'conversations.custom_channels.messages.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_conversations_message = client.conversations.custom_channels.messages.update(\n message_id="messageId",\n channel_id=0,\n status_type="FAILED",\n)\nprint(public_conversations_message.id)', - }, - java: { - method: 'conversations().customChannels().messages().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicChannelIntegrationMessageUpdateRequest;\nimport com.hubspot.sdk.models.conversations.customchannels.PublicConversationsMessage;\nimport com.hubspot.sdk.models.conversations.customchannels.messages.MessageUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MessageUpdateParams params = MessageUpdateParams.builder()\n .channelId(0)\n .messageId("messageId")\n .publicChannelIntegrationMessageUpdateRequest(PublicChannelIntegrationMessageUpdateRequest.builder()\n .statusType(PublicChannelIntegrationMessageUpdateRequest.StatusType.FAILED)\n .build())\n .build();\n PublicConversationsMessage publicConversationsMessage = client.conversations().customChannels().messages().update(params);\n }\n}', - }, - go: { - method: 'client.Conversations.CustomChannels.Messages.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicConversationsMessage, err := client.Conversations.CustomChannels.Messages.Update(\n\t\tcontext.TODO(),\n\t\t"messageId",\n\t\tconversations.CustomChannelMessageUpdateParams{\n\t\t\tChannelID: 0,\n\t\t\tPublicChannelIntegrationMessageUpdateRequest: conversations.PublicChannelIntegrationMessageUpdateRequestParam{\n\t\t\t\tStatusType: conversations.PublicChannelIntegrationMessageUpdateRequestStatusTypeFailed,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicConversationsMessage.ID)\n}\n', - }, - ruby: { - method: 'conversations.custom_channels.messages.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_conversations_message = hubspot.conversations.custom_channels.messages.update("messageId", channel_id: 0, status_type: :FAILED)\n\nputs(public_conversations_message)', - }, - php: { - method: 'conversations->customChannels->messages->update', - example: - "conversations\n ->customChannels\n ->messages\n ->update(\n 'messageId', channelID: 0, statusType: 'FAILED', errorMessage: 'errorMessage'\n);\n\nvar_dump($publicConversationsMessage);", - }, - http: { - example: - 'curl https://api.hubapi.com/conversations/custom-channels/2026-03/$CHANNEL_ID/messages/$MESSAGE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "statusType": "FAILED"\n }\'', - }, - }, - }, - { - name: 'generate_token', - endpoint: '/visitor-identification/2026-03/tokens/create', - httpMethod: 'post', - summary: 'Generate visitor token', - description: - 'Generate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This allows support agents to recognize and assist the visitor more effectively.', - stainlessPath: '(resource) conversations.visitor_identification > (method) generate_token', - qualified: 'client.conversations.visitorIdentification.generateToken', - params: ['email: string;', 'firstName?: string;', 'lastName?: string;'], - response: '{ token: string; }', - markdown: - "## generate_token\n\n`client.conversations.visitorIdentification.generateToken(email: string, firstName?: string, lastName?: string): { token: string; }`\n\n**post** `/visitor-identification/2026-03/tokens/create`\n\nGenerate an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This allows support agents to recognize and assist the visitor more effectively.\n\n### Parameters\n\n- `email: string`\n The email of the visitor that you wish to identify\n\n- `firstName?: string`\n The first name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where first name is unknown. Optional.\n\n- `lastName?: string`\n The last name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where last name is unknown. Optional.\n\n### Returns\n\n- `{ token: string; }`\n\n - `token: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst identificationTokenResponse = await client.conversations.visitorIdentification.generateToken({ email: 'email' });\n\nconsole.log(identificationTokenResponse);\n```", - perLanguage: { - typescript: { - method: 'client.conversations.visitorIdentification.generateToken', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst identificationTokenResponse = await client.conversations.visitorIdentification.generateToken({\n email: 'email',\n});\n\nconsole.log(identificationTokenResponse.token);", - }, - python: { - method: 'conversations.visitor_identification.generate_token', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nidentification_token_response = client.conversations.visitor_identification.generate_token(\n email="email",\n)\nprint(identification_token_response.token)', - }, - java: { - method: 'conversations().visitorIdentification().generateToken', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.conversations.visitoridentification.IdentificationTokenGenerationRequest;\nimport com.hubspot.sdk.models.conversations.visitoridentification.IdentificationTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IdentificationTokenGenerationRequest params = IdentificationTokenGenerationRequest.builder()\n .email("email")\n .build();\n IdentificationTokenResponse identificationTokenResponse = client.conversations().visitorIdentification().generateToken(params);\n }\n}', - }, - go: { - method: 'client.Conversations.VisitorIdentification.GenerateToken', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/conversations"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tidentificationTokenResponse, err := client.Conversations.VisitorIdentification.GenerateToken(context.TODO(), conversations.VisitorIdentificationGenerateTokenParams{\n\t\tIdentificationTokenGenerationRequest: conversations.IdentificationTokenGenerationRequestParam{\n\t\t\tEmail: "email",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", identificationTokenResponse.Token)\n}\n', - }, - ruby: { - method: 'conversations.visitor_identification.generate_token', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nidentification_token_response = hubspot.conversations.visitor_identification.generate_token(email: "email")\n\nputs(identification_token_response)', - }, - php: { - method: 'conversations->visitorIdentification->generateToken', - example: - "conversations\n ->visitorIdentification\n ->generateToken(email: 'email', firstName: 'firstName', lastName: 'lastName');\n\nvar_dump($identificationTokenResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/visitor-identification/2026-03/tokens/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email"\n }\'', - }, - }, - }, - { - name: 'uninstall', - endpoint: '/appinstalls/2026-03/external-install', - httpMethod: 'delete', - summary: 'Uninstall app', - description: - "Use this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account.", - stainlessPath: '(resource) crm.app_uninstalls > (method) uninstall', - qualified: 'client.crm.appUninstalls.uninstall', - markdown: - "## uninstall\n\n`client.crm.appUninstalls.uninstall(): void`\n\n**delete** `/appinstalls/2026-03/external-install`\n\nUse this endpoint to uninstall your app from a customer's HubSpot account. If successful, this endpoint will return a 204 and the customer will receive an email notification that the developer has uninstall the app from their account.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.appUninstalls.uninstall()\n```", - perLanguage: { - typescript: { - method: 'client.crm.appUninstalls.uninstall', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.appUninstalls.uninstall();", - }, - python: { - method: 'crm.app_uninstalls.uninstall', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.app_uninstalls.uninstall()', - }, - java: { - method: 'crm().appUninstalls().uninstall', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.appuninstalls.AppUninstallUninstallParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().appUninstalls().uninstall();\n }\n}', - }, - go: { - method: 'client.Crm.AppUninstalls.Uninstall', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AppUninstalls.Uninstall(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.app_uninstalls.uninstall', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.app_uninstalls.uninstall\n\nputs(result)', - }, - php: { - method: 'crm->appUninstalls->uninstall', - example: - "crm->appUninstalls->uninstall();\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/appinstalls/2026-03/external-install \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: - '/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}', - httpMethod: 'put', - summary: 'Associate records (default)', - description: 'Create the default (most generic) association type between two object types', - stainlessPath: '(resource) crm.associations > (method) create', - qualified: 'client.crm.associations.create', - params: [ - 'fromObjectType: string;', - 'fromObjectId: string;', - 'toObjectType: string;', - 'toObjectId: string;', - ], - response: - "{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.associations.create(fromObjectType: string, fromObjectId: string, toObjectType: string, toObjectId: string): { completedAt: string; results: public_default_association[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**put** `/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}`\n\nCreate the default (most generic) association type between two object types\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `fromObjectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n### Returns\n\n- `{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n The response returned after performing a batch operation on associations.\n\n - `completedAt: string`\n - `results: { associationSpec: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }; from: { id: string; }; to: { id: string; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.create('toObjectId', {\n fromObjectType: 'fromObjectType',\n fromObjectId: 'fromObjectId',\n toObjectType: 'toObjectType',\n});\n\nconsole.log(batchResponsePublicDefaultAssociation);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.create('toObjectId', {\n fromObjectType: 'fromObjectType',\n fromObjectId: 'fromObjectId',\n toObjectType: 'toObjectType',\n});\n\nconsole.log(batchResponsePublicDefaultAssociation.completedAt);", - }, - python: { - method: 'crm.associations.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_default_association = client.crm.associations.create(\n to_object_id="toObjectId",\n from_object_type="fromObjectType",\n from_object_id="fromObjectId",\n to_object_type="toObjectType",\n)\nprint(batch_response_public_default_association.completed_at)', - }, - java: { - method: 'crm().associations().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicDefaultAssociation;\nimport com.hubspot.sdk.models.crm.associations.AssociationCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationCreateParams params = AssociationCreateParams.builder()\n .fromObjectType("fromObjectType")\n .fromObjectId("fromObjectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .build();\n BatchResponsePublicDefaultAssociation batchResponsePublicDefaultAssociation = client.crm().associations().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicDefaultAssociation, err := client.Crm.Associations.New(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tFromObjectID: "fromObjectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicDefaultAssociation.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_default_association = hubspot.crm.associations.create(\n "toObjectId",\n from_object_type: "fromObjectType",\n from_object_id: "fromObjectId",\n to_object_type: "toObjectType"\n)\n\nputs(batch_response_public_default_association)', - }, - php: { - method: 'crm->associations->create', - example: - "crm->associations->create(\n 'toObjectId',\n fromObjectType: 'fromObjectType',\n fromObjectID: 'fromObjectId',\n toObjectType: 'toObjectType',\n);\n\nvar_dump($batchResponsePublicDefaultAssociation);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$FROM_OBJECT_TYPE/$FROM_OBJECT_ID/associations/default/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', - httpMethod: 'delete', - summary: 'Delete associations between two records', - description: 'deletes all associations between two records.', - stainlessPath: '(resource) crm.associations > (method) delete', - qualified: 'client.crm.associations.delete', - params: ['objectType: string;', 'objectId: string;', 'toObjectType: string;', 'toObjectId: string;'], - markdown: - "## delete\n\n`client.crm.associations.delete(objectType: string, objectId: string, toObjectType: string, toObjectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`\n\ndeletes all associations between two records.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.delete('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n})\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.delete('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n});", - }, - python: { - method: 'crm.associations.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.delete(\n to_object_id="toObjectId",\n object_type="objectType",\n object_id="objectId",\n to_object_type="toObjectType",\n)', - }, - java: { - method: 'crm().associations().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associations.AssociationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationDeleteParams params = AssociationDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .build();\n client.crm().associations().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Delete(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.delete(\n "toObjectId",\n object_type: "objectType",\n object_id_: "objectId",\n to_object_type: "toObjectType"\n)\n\nputs(result)', - }, - php: { - method: 'crm->associations->delete', - example: - "crm->associations->delete(\n 'toObjectId',\n objectType: 'objectType',\n objectID: 'objectId',\n toObjectType: 'toObjectType',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}', - httpMethod: 'get', - summary: 'Retrieve all associations by object type', - description: - 'Retrieve all associations between a specific record and an object type. Limit 500 per call.', - stainlessPath: '(resource) crm.associations > (method) list', - qualified: 'client.crm.associations.list', - params: [ - 'objectType: string;', - 'objectId: string;', - 'toObjectType: string;', - 'after?: string;', - 'limit?: number;', - ], - response: - "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", - markdown: - "## list\n\n`client.crm.associations.list(objectType: string, objectId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}`\n\nRetrieve all associations between a specific record and an object type. Limit 500 per call.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.associations.list('toObjectType', { objectType: 'objectType', objectId: 'objectId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.associations.list('toObjectType', {\n objectType: 'objectType',\n objectId: 'objectId',\n})) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", - }, - python: { - method: 'crm.associations.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.associations.list(\n to_object_type="toObjectType",\n object_type="objectType",\n object_id="objectId",\n)\npage = page.results[0]\nprint(page.association_types)', - }, - java: { - method: 'crm().associations().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associations.AssociationListPage;\nimport com.hubspot.sdk.models.crm.associations.AssociationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationListParams params = AssociationListParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .build();\n AssociationListPage page = client.crm().associations().list(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Associations.List(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationListParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.associations.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.associations.list("toObjectType", object_type: "objectType", object_id_: "objectId")\n\nputs(page)', - }, - php: { - method: 'crm->associations->list', - example: - "crm->associations->list(\n 'toObjectType',\n objectType: 'objectType',\n objectID: 'objectId',\n after: 'after',\n limit: 0,\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'request_high_usage_report', - endpoint: '/crm/associations/2026-03/usage/high-usage-report/{userId}', - httpMethod: 'post', - summary: 'Report high usage', - description: 'Requests a report of all objects in the portal which have a high usage of associations', - stainlessPath: '(resource) crm.associations > (method) request_high_usage_report', - qualified: 'client.crm.associations.requestHighUsageReport', - params: ['userId: number;'], - response: - '{ enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }; userEmail: string; userId: number; }', - markdown: - "## request_high_usage_report\n\n`client.crm.associations.requestHighUsageReport(userId: number): { enqueueTime: date_time; userEmail: string; userId: number; }`\n\n**post** `/crm/associations/2026-03/usage/high-usage-report/{userId}`\n\nRequests a report of all objects in the portal which have a high usage of associations\n\n### Parameters\n\n- `userId: number`\n\n### Returns\n\n- `{ enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }; userEmail: string; userId: number; }`\n\n - `enqueueTime: { dateOnly: boolean; timeZoneShift: number; value: number; }`\n - `userEmail: string`\n - `userId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst reportCreationResponse = await client.crm.associations.requestHighUsageReport(0);\n\nconsole.log(reportCreationResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.requestHighUsageReport', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst reportCreationResponse = await client.crm.associations.requestHighUsageReport(0);\n\nconsole.log(reportCreationResponse.enqueueTime);", - }, - python: { - method: 'crm.associations.request_high_usage_report', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nreport_creation_response = client.crm.associations.request_high_usage_report(\n 0,\n)\nprint(report_creation_response.enqueue_time)', - }, - java: { - method: 'crm().associations().requestHighUsageReport', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.ReportCreationResponse;\nimport com.hubspot.sdk.models.crm.associations.AssociationRequestHighUsageReportParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ReportCreationResponse reportCreationResponse = client.crm().associations().requestHighUsageReport(0);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.RequestHighUsageReport', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\treportCreationResponse, err := client.Crm.Associations.RequestHighUsageReport(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", reportCreationResponse.EnqueueTime)\n}\n', - }, - ruby: { - method: 'crm.associations.request_high_usage_report', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nreport_creation_response = hubspot.crm.associations.request_high_usage_report(0)\n\nputs(report_creation_response)', - }, - php: { - method: 'crm->associations->requestHighUsageReport', - example: - "crm->associations->requestHighUsageReport(0);\n\nvar_dump($reportCreationResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/usage/high-usage-report/$USER_ID \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/{objectType}/search', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.associations > (method) search', - qualified: 'client.crm.associations.search', - params: [ - 'objectType: string;', - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.associations.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.associations.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.associations.search(\n 'objectType',\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.associations.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.associations.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().associations().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.associations.AssociationSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationSearchParams params = AssociationSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().associations().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Associations.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.AssociationSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.associations.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.associations.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->associations->search', - example: - "crm\n ->associations\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update_labels', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', - httpMethod: 'put', - summary: 'Associate records (labelled)', - description: 'Set association labels between two records.', - stainlessPath: '(resource) crm.associations > (method) update_labels', - qualified: 'client.crm.associations.updateLabels', - params: [ - 'objectType: string;', - 'objectId: string;', - 'toObjectType: string;', - 'toObjectId: string;', - "body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[];", - ], - response: - '{ fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }', - markdown: - "## update_labels\n\n`client.crm.associations.updateLabels(objectType: string, objectId: string, toObjectType: string, toObjectId: string, body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]): { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }`\n\n**put** `/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}`\n\nSet association labels between two records.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `toObjectType: string`\n\n- `toObjectId: string`\n\n- `body: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]`\n\n### Returns\n\n- `{ fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }`\n The relationship descriptors applicable between two object types.\n\n - `fromObjectId: string`\n - `fromObjectTypeId: string`\n - `labels: string[]`\n - `toObjectId: string`\n - `toObjectTypeId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst labelsBetweenObjectPair = await client.crm.associations.updateLabels('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n body: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n});\n\nconsole.log(labelsBetweenObjectPair);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.updateLabels', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst labelsBetweenObjectPair = await client.crm.associations.updateLabels('toObjectId', {\n objectType: 'objectType',\n objectId: 'objectId',\n toObjectType: 'toObjectType',\n body: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n});\n\nconsole.log(labelsBetweenObjectPair.fromObjectId);", - }, - python: { - method: 'crm.associations.update_labels', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlabels_between_object_pair = client.crm.associations.update_labels(\n to_object_id="toObjectId",\n object_type="objectType",\n object_id="objectId",\n to_object_type="toObjectType",\n body=[{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n)\nprint(labels_between_object_pair.from_object_id)', - }, - java: { - method: 'crm().associations().updateLabels', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.crm.LabelsBetweenObjectPair;\nimport com.hubspot.sdk.models.crm.associations.AssociationUpdateLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssociationUpdateLabelsParams params = AssociationUpdateLabelsParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .toObjectType("toObjectType")\n .toObjectId("toObjectId")\n .addBody(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build();\n LabelsBetweenObjectPair labelsBetweenObjectPair = client.crm().associations().updateLabels(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.UpdateLabels', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlabelsBetweenObjectPair, err := client.Crm.Associations.UpdateLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectId",\n\t\tcrm.AssociationUpdateLabelsParams{\n\t\t\tObjectType: "objectType",\n\t\t\tObjectID: "objectId",\n\t\t\tToObjectType: "toObjectType",\n\t\t\tBody: []shared.AssociationSpecParam{{\n\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t}},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", labelsBetweenObjectPair.FromObjectID)\n}\n', - }, - ruby: { - method: 'crm.associations.update_labels', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlabels_between_object_pair = hubspot.crm.associations.update_labels(\n "toObjectId",\n object_type: "objectType",\n object_id_: "objectId",\n to_object_type: "toObjectType",\n body: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]\n)\n\nputs(labels_between_object_pair)', - }, - php: { - method: 'crm->associations->updateLabels', - example: - "crm->associations->updateLabels(\n 'toObjectId',\n objectType: 'objectType',\n objectID: 'objectId',\n toObjectType: 'toObjectType',\n body: [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n);\n\nvar_dump($labelsBetweenObjectPair);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID/associations/$TO_OBJECT_TYPE/$TO_OBJECT_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create', - httpMethod: 'post', - summary: 'Associate records (labelled)', - description: 'Batch create associations for objects', - stainlessPath: '(resource) crm.associations.batch > (method) create', - qualified: 'client.crm.associations.batch.create', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - "inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - ], - response: - "{ completedAt: string; results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.associations.batch.create(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; types: association_spec[]; }[]): { completedAt: string; results: labels_between_object_pair[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create`\n\nBatch create associations for objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { fromObjectId: string; fromObjectTypeId: string; labels: string[]; toObjectId: string; toObjectTypeId: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseLabelsBetweenObjectPair = await client.crm.associations.batch.create('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}] });\n\nconsole.log(batchResponseLabelsBetweenObjectPair);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseLabelsBetweenObjectPair = await client.crm.associations.batch.create(\n 'toObjectType',\n {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n },\n);\n\nconsole.log(batchResponseLabelsBetweenObjectPair.completedAt);", - }, - python: { - method: 'crm.associations.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_labels_between_object_pair = client.crm.associations.batch.create(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n)\nprint(batch_response_labels_between_object_pair.completed_at)', - }, - java: { - method: 'crm().associations().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.BatchResponseLabelsBetweenObjectPair;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiPost(BatchInputPublicAssociationMultiPost.builder()\n .addInput(PublicAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .build())\n .build();\n BatchResponseLabelsBetweenObjectPair batchResponseLabelsBetweenObjectPair = client.crm().associations().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseLabelsBetweenObjectPair, err := client.Crm.Associations.Batch.New(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiPost: crm.BatchInputPublicAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseLabelsBetweenObjectPair.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_labels_between_object_pair = hubspot.crm.associations.batch.create(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}]\n)\n\nputs(batch_response_labels_between_object_pair)', - }, - php: { - method: 'crm->associations->batch->create', - example: - "crm\n ->associations\n ->batch\n ->create(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n [\n 'from' => ['id' => 'id'],\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n);\n\nvar_dump($batchResponseLabelsBetweenObjectPair);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_default', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default', - httpMethod: 'post', - summary: 'Associate records (default)', - description: 'Create the default (most generic) association type between two object types', - stainlessPath: '(resource) crm.associations.batch > (method) create_default', - qualified: 'client.crm.associations.batch.createDefault', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'inputs: { from: { id: string; }; to: { id: string; }; }[];', - ], - response: - "{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create_default\n\n`client.crm.associations.batch.createDefault(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; }[]): { completedAt: string; results: public_default_association[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default`\n\nCreate the default (most generic) association type between two object types\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { associationSpec: association_spec; from: public_object_id; to: public_object_id; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n The response returned after performing a batch operation on associations.\n\n - `completedAt: string`\n - `results: { associationSpec: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }; from: { id: string; }; to: { id: string; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.batch.createDefault('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n}] });\n\nconsole.log(batchResponsePublicDefaultAssociation);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.batch.createDefault', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicDefaultAssociation = await client.crm.associations.batch.createDefault(\n 'toObjectType',\n {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n },\n ],\n },\n);\n\nconsole.log(batchResponsePublicDefaultAssociation.completedAt);", - }, - python: { - method: 'crm.associations.batch.create_default', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_default_association = client.crm.associations.batch.create_default(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n }],\n)\nprint(batch_response_public_default_association.completed_at)', - }, - java: { - method: 'crm().associations().batch().createDefault', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicDefaultAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicDefaultAssociation;\nimport com.hubspot.sdk.models.crm.PublicDefaultAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchCreateDefaultParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateDefaultParams params = BatchCreateDefaultParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicDefaultAssociationMultiPost(BatchInputPublicDefaultAssociationMultiPost.builder()\n .addInput(PublicDefaultAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .build())\n .build())\n .build();\n BatchResponsePublicDefaultAssociation batchResponsePublicDefaultAssociation = client.crm().associations().batch().createDefault(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Batch.NewDefault', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicDefaultAssociation, err := client.Crm.Associations.Batch.NewDefault(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchNewDefaultParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicDefaultAssociationMultiPost: crm.BatchInputPublicDefaultAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicDefaultAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicDefaultAssociation.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations.batch.create_default', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_default_association = hubspot.crm.associations.batch.create_default(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}}]\n)\n\nputs(batch_response_public_default_association)', - }, - php: { - method: 'crm->associations->batch->createDefault', - example: - "crm\n ->associations\n ->batch\n ->createDefault(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['from' => ['id' => 'id'], 'to' => ['id' => 'id']]],\n);\n\nvar_dump($batchResponsePublicDefaultAssociation);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/associate/default \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive', - httpMethod: 'post', - summary: 'Remove associations', - description: 'Batch delete associations for objects', - stainlessPath: '(resource) crm.associations.batch > (method) delete', - qualified: 'client.crm.associations.batch.delete', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'inputs: { from: { id: string; }; to: { id: string; }[]; }[];', - ], - markdown: - "## delete\n\n`client.crm.associations.batch.delete(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id[]; }[]): void`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive`\n\nBatch delete associations for objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.batch.delete('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: [{ id: 'id' }],\n}] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.batch.delete('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: [{ id: 'id' }],\n },\n ],\n});", - }, - python: { - method: 'crm.associations.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.batch.delete(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": [{\n "id": "id"\n }],\n }],\n)', - }, - java: { - method: 'crm().associations().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiArchive;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiArchive;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiArchive(BatchInputPublicAssociationMultiArchive.builder()\n .addInput(PublicAssociationMultiArchive.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .addTo(PublicObjectId.builder()\n .id("id")\n .build())\n .build())\n .build())\n .build();\n client.crm().associations().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchDeleteParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiArchive: crm.BatchInputPublicAssociationMultiArchiveParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiArchiveParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: []shared.PublicObjectIDParam{{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.batch.delete(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: [{id: "id"}]}]\n)\n\nputs(result)', - }, - php: { - method: 'crm->associations->batch->delete', - example: - "crm->associations->batch->delete(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['from' => ['id' => 'id'], 'to' => [['id' => 'id']]]],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": [\n {\n "id": "id"\n }\n ]\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_labels', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive', - httpMethod: 'post', - summary: 'Delete specific labels', - description: - 'Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects', - stainlessPath: '(resource) crm.associations.batch > (method) delete_labels', - qualified: 'client.crm.associations.batch.deleteLabels', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - "inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - ], - markdown: - "## delete_labels\n\n`client.crm.associations.batch.deleteLabels(fromObjectType: string, toObjectType: string, inputs: { from: public_object_id; to: public_object_id; types: association_spec[]; }[]): void`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive`\n\nBatch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { from: { id: string; }; to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associations.batch.deleteLabels('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.batch.deleteLabels', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associations.batch.deleteLabels('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n from: { id: 'id' },\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n});", - }, - python: { - method: 'crm.associations.batch.delete_labels', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations.batch.delete_labels(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n)', - }, - java: { - method: 'crm().associations().batch().deleteLabels', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.BatchInputPublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.PublicAssociationMultiPost;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchDeleteLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteLabelsParams params = BatchDeleteLabelsParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationMultiPost(BatchInputPublicAssociationMultiPost.builder()\n .addInput(PublicAssociationMultiPost.builder()\n .from(PublicObjectId.builder()\n .id("id")\n .build())\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .build())\n .build();\n client.crm().associations().batch().deleteLabels(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Batch.DeleteLabels', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Associations.Batch.DeleteLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchDeleteLabelsParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationMultiPost: crm.BatchInputPublicAssociationMultiPostParam{\n\t\t\t\tInputs: []crm.PublicAssociationMultiPostParam{{\n\t\t\t\t\tFrom: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations.batch.delete_labels', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations.batch.delete_labels(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{from: {id: "id"}, to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}]\n)\n\nputs(result)', - }, - php: { - method: 'crm->associations->batch->deleteLabels', - example: - "crm->associations->batch->deleteLabels(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n [\n 'from' => ['id' => 'id'],\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/labels/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "from": {\n "id": "id"\n },\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read', - httpMethod: 'post', - summary: 'Retrieve associations', - description: - "Batch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.", - stainlessPath: '(resource) crm.associations.batch > (method) get', - qualified: 'client.crm.associations.batch.get', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'inputs: { id: string; after?: string; }[];', - ], - response: - "{ completedAt: string; results: { from: public_object_id; to: multi_associated_object_with_label[]; paging?: paging; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.associations.batch.get(fromObjectType: string, toObjectType: string, inputs: { id: string; after?: string; }[]): { completedAt: string; results: public_association_multi_with_label[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read`\n\nBatch read associations for objects to specific object type. The 'after' field in a returned paging object can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. Note: The 'paging' field will only be present if there are more pages and absent otherwise.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { id: string; after?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { from: public_object_id; to: multi_associated_object_with_label[]; paging?: paging; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { from: { id: string; }; to: { associationTypes: association_spec_with_label[]; toObjectId: string; }[]; paging?: { next?: next_page; prev?: previous_page; }; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationMultiWithLabel = await client.crm.associations.batch.get('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponsePublicAssociationMultiWithLabel);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associations.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationMultiWithLabel = await client.crm.associations.batch.get(\n 'toObjectType',\n { fromObjectType: 'fromObjectType', inputs: [{ id: 'id' }] },\n);\n\nconsole.log(batchResponsePublicAssociationMultiWithLabel.completedAt);", - }, - python: { - method: 'crm.associations.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_multi_with_label = client.crm.associations.batch.get(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_public_association_multi_with_label.completed_at)', - }, - java: { - method: 'crm().associations().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.BatchInputPublicFetchAssociationsBatchRequest;\nimport com.hubspot.sdk.models.crm.BatchResponsePublicAssociationMultiWithLabel;\nimport com.hubspot.sdk.models.crm.PublicFetchAssociationsBatchRequest;\nimport com.hubspot.sdk.models.crm.associations.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicFetchAssociationsBatchRequest(BatchInputPublicFetchAssociationsBatchRequest.builder()\n .addInput(PublicFetchAssociationsBatchRequest.builder()\n .id("id")\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationMultiWithLabel batchResponsePublicAssociationMultiWithLabel = client.crm().associations().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Associations.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationMultiWithLabel, err := client.Crm.Associations.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationBatchGetParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicFetchAssociationsBatchRequest: crm.BatchInputPublicFetchAssociationsBatchRequestParam{\n\t\t\t\tInputs: []crm.PublicFetchAssociationsBatchRequestParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationMultiWithLabel.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_multi_with_label = hubspot.crm.associations.batch.get(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{id: "id"}]\n)\n\nputs(batch_response_public_association_multi_with_label)', - }, - php: { - method: 'crm->associations->batch->get', - example: - "crm\n ->associations\n ->batch\n ->get(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['id' => 'id', 'after' => 'after']],\n);\n\nvar_dump($batchResponsePublicAssociationMultiWithLabel);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'batch_create', - endpoint: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create', - httpMethod: 'post', - summary: 'Configure association limits', - description: 'Batch configure association limits between two object types.', - stainlessPath: '(resource) crm.associations_schema.labels > (method) batch_create', - qualified: 'client.crm.associationsSchema.labels.batchCreate', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - "inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[];", - ], - response: - "{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## batch_create\n\n`client.crm.associationsSchema.labels.batchCreate(fromObjectType: string, toObjectType: string, inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]): { completedAt: string; results: public_association_definition_user_configuration[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create`\n\nBatch configure association limits between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationDefinitionUserConfiguration = await client.crm.associationsSchema.labels.batchCreate('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n}] });\n\nconsole.log(batchResponsePublicAssociationDefinitionUserConfiguration);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.labels.batchCreate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationDefinitionUserConfiguration =\n await client.crm.associationsSchema.labels.batchCreate('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicAssociationDefinitionUserConfiguration.completedAt);", - }, - python: { - method: 'crm.associations_schema.labels.batch_create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_definition_user_configuration = client.crm.associations_schema.labels.batch_create(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "HUBSPOT_DEFINED",\n "max_to_object_ids": 0,\n "type_id": 0,\n }],\n)\nprint(batch_response_public_association_definition_user_configuration.completed_at)', - }, - java: { - method: 'crm().associationsSchema().labels().batchCreate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationDefinitionConfigurationCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchResponsePublicAssociationDefinitionUserConfiguration;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionConfigurationCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelBatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelBatchCreateParams params = LabelBatchCreateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationDefinitionConfigurationCreateRequest(BatchInputPublicAssociationDefinitionConfigurationCreateRequest.builder()\n .addInput(PublicAssociationDefinitionConfigurationCreateRequest.builder()\n .category(PublicAssociationDefinitionConfigurationCreateRequest.Category.HUBSPOT_DEFINED)\n .maxToObjectIds(0)\n .typeId(0)\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationDefinitionUserConfiguration batchResponsePublicAssociationDefinitionUserConfiguration = client.crm().associationsSchema().labels().batchCreate(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Labels.BatchNew', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationDefinitionUserConfiguration, err := client.Crm.AssociationsSchema.Labels.BatchNew(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelBatchNewParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationDefinitionConfigurationCreateRequest: crm.BatchInputPublicAssociationDefinitionConfigurationCreateRequestParam{\n\t\t\t\tInputs: []crm.PublicAssociationDefinitionConfigurationCreateRequestParam{{\n\t\t\t\t\tCategory: crm.PublicAssociationDefinitionConfigurationCreateRequestCategoryHubSpotDefined,\n\t\t\t\t\tMaxToObjectIDs: 0,\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationDefinitionUserConfiguration.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.labels.batch_create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_definition_user_configuration = hubspot.crm.associations_schema.labels.batch_create(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: :HUBSPOT_DEFINED, maxToObjectIds: 0, typeId: 0}]\n)\n\nputs(batch_response_public_association_definition_user_configuration)', - }, - php: { - method: 'crm->associationsSchema->labels->batchCreate', - example: - "crm\n ->associationsSchema\n ->labels\n ->batchCreate(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n ['category' => 'HUBSPOT_DEFINED', 'maxToObjectIDs' => 0, 'typeID' => 0]\n ],\n);\n\nvar_dump($batchResponsePublicAssociationDefinitionUserConfiguration);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "HUBSPOT_DEFINED",\n "maxToObjectIds": 0,\n "typeId": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_label', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - httpMethod: 'post', - summary: 'Create association label', - description: - 'Create a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively.', - stainlessPath: '(resource) crm.associations_schema.labels > (method) create_label', - qualified: 'client.crm.associationsSchema.labels.createLabel', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'label: string;', - 'name: string;', - 'inverseLabel?: string;', - ], - response: - "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }", - markdown: - "## create_label\n\n`client.crm.associationsSchema.labels.createLabel(fromObjectType: string, toObjectType: string, label: string, name: string, inverseLabel?: string): { results: association_spec_with_label[]; }`\n\n**post** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nCreate a new label that describes the relationship between two specified CRM object types. This can help in categorizing and managing associations more effectively.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `label: string`\n A descriptor that provides context about the relationship between two associated CRM objects.\n\n- `name: string`\n The unique identifier for the association definition.\n\n- `inverseLabel?: string`\n An optional descriptor that clarifies the reverse relationship in the association.\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationSpecWithLabelNoPaging = await client.crm.associationsSchema.labels.createLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n});\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.labels.createLabel', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationSpecWithLabelNoPaging =\n await client.crm.associationsSchema.labels.createLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging.results);", - }, - python: { - method: 'crm.associations_schema.labels.create_label', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_spec_with_label_no_paging = client.crm.associations_schema.labels.create_label(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n label="label",\n name="name",\n)\nprint(collection_response_association_spec_with_label_no_paging.results)', - }, - java: { - method: 'crm().associationsSchema().labels().createLabel', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponseAssociationSpecWithLabelNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionCreateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelCreateLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelCreateLabelParams params = LabelCreateLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .publicAssociationDefinitionCreateRequest(PublicAssociationDefinitionCreateRequest.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n CollectionResponseAssociationSpecWithLabelNoPaging collectionResponseAssociationSpecWithLabelNoPaging = client.crm().associationsSchema().labels().createLabel(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Labels.NewLabel', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationSpecWithLabelNoPaging, err := client.Crm.AssociationsSchema.Labels.NewLabel(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelNewLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tPublicAssociationDefinitionCreateRequest: crm.PublicAssociationDefinitionCreateRequestParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationSpecWithLabelNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.labels.create_label', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_spec_with_label_no_paging = hubspot.crm.associations_schema.labels.create_label(\n "toObjectType",\n from_object_type: "fromObjectType",\n label: "label",\n name: "name"\n)\n\nputs(collection_response_association_spec_with_label_no_paging)', - }, - php: { - method: 'crm->associationsSchema->labels->createLabel', - example: - "crm\n ->associationsSchema\n ->labels\n ->createLabel(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n label: 'label',\n name: 'name',\n inverseLabel: 'inverseLabel',\n);\n\nvar_dump($collectionResponseAssociationSpecWithLabelNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'delete_label', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}', - httpMethod: 'delete', - summary: 'Delete association label', - description: 'Remove a specific label from the association between two CRM object types.', - stainlessPath: '(resource) crm.associations_schema.labels > (method) delete_label', - qualified: 'client.crm.associationsSchema.labels.deleteLabel', - params: ['fromObjectType: string;', 'toObjectType: string;', 'associationTypeId: number;'], - markdown: - "## delete_label\n\n`client.crm.associationsSchema.labels.deleteLabel(fromObjectType: string, toObjectType: string, associationTypeId: number): void`\n\n**delete** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}`\n\nRemove a specific label from the association between two CRM object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `associationTypeId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.labels.deleteLabel(0, { fromObjectType: 'fromObjectType', toObjectType: 'toObjectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.labels.deleteLabel', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.labels.deleteLabel(0, {\n fromObjectType: 'fromObjectType',\n toObjectType: 'toObjectType',\n});", - }, - python: { - method: 'crm.associations_schema.labels.delete_label', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.labels.delete_label(\n association_type_id=0,\n from_object_type="fromObjectType",\n to_object_type="toObjectType",\n)', - }, - java: { - method: 'crm().associationsSchema().labels().deleteLabel', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelDeleteLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelDeleteLabelParams params = LabelDeleteLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .associationTypeId(0)\n .build();\n client.crm().associationsSchema().labels().deleteLabel(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Labels.DeleteLabel', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Labels.DeleteLabel(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.AssociationsSchemaLabelDeleteLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tToObjectType: "toObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations_schema.labels.delete_label', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.labels.delete_label(\n 0,\n from_object_type: "fromObjectType",\n to_object_type: "toObjectType"\n)\n\nputs(result)', - }, - php: { - method: 'crm->associationsSchema->labels->deleteLabel', - example: - "crm->associationsSchema->labels->deleteLabel(\n 0, fromObjectType: 'fromObjectType', toObjectType: 'toObjectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels/$ASSOCIATION_TYPE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_labels', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - httpMethod: 'get', - summary: 'Retrieve association labels', - description: - 'Retrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations.', - stainlessPath: '(resource) crm.associations_schema.labels > (method) list_labels', - qualified: 'client.crm.associationsSchema.labels.listLabels', - params: ['fromObjectType: string;', 'toObjectType: string;'], - response: - "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }", - markdown: - "## list_labels\n\n`client.crm.associationsSchema.labels.listLabels(fromObjectType: string, toObjectType: string): { results: association_spec_with_label[]; }`\n\n**get** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nRetrieve all labels that describe the relationships between two specified CRM object types. These labels provide context about the nature of the associations.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationSpecWithLabelNoPaging = await client.crm.associationsSchema.labels.listLabels('toObjectType', { fromObjectType: 'fromObjectType' });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.labels.listLabels', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationSpecWithLabelNoPaging =\n await client.crm.associationsSchema.labels.listLabels('toObjectType', {\n fromObjectType: 'fromObjectType',\n });\n\nconsole.log(collectionResponseAssociationSpecWithLabelNoPaging.results);", - }, - python: { - method: 'crm.associations_schema.labels.list_labels', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_spec_with_label_no_paging = client.crm.associations_schema.labels.list_labels(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n)\nprint(collection_response_association_spec_with_label_no_paging.results)', - }, - java: { - method: 'crm().associationsSchema().labels().listLabels', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponseAssociationSpecWithLabelNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelListLabelsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelListLabelsParams params = LabelListLabelsParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .build();\n CollectionResponseAssociationSpecWithLabelNoPaging collectionResponseAssociationSpecWithLabelNoPaging = client.crm().associationsSchema().labels().listLabels(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Labels.ListLabels', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationSpecWithLabelNoPaging, err := client.Crm.AssociationsSchema.Labels.ListLabels(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelListLabelsParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationSpecWithLabelNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.labels.list_labels', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_spec_with_label_no_paging = hubspot.crm.associations_schema.labels.list_labels("toObjectType", from_object_type: "fromObjectType")\n\nputs(collection_response_association_spec_with_label_no_paging)', - }, - php: { - method: 'crm->associationsSchema->labels->listLabels', - example: - "crm\n ->associationsSchema\n ->labels\n ->listLabels('toObjectType', fromObjectType: 'fromObjectType');\n\nvar_dump($collectionResponseAssociationSpecWithLabelNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_label', - endpoint: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - httpMethod: 'put', - summary: 'Update association label', - description: - 'Update an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship.', - stainlessPath: '(resource) crm.associations_schema.labels > (method) update_label', - qualified: 'client.crm.associationsSchema.labels.updateLabel', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'associationTypeId: number;', - 'label: string;', - 'inverseLabel?: string;', - ], - markdown: - "## update_label\n\n`client.crm.associationsSchema.labels.updateLabel(fromObjectType: string, toObjectType: string, associationTypeId: number, label: string, inverseLabel?: string): void`\n\n**put** `/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels`\n\nUpdate an existing label that describes the relationship between two specified CRM object types. This allows for modifications to existing association labels to better reflect the nature of the relationship.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `associationTypeId: number`\n The unique identifier for the association type.\n\n- `label: string`\n A descriptor that provides context about the relationship between associated records.\n\n- `inverseLabel?: string`\n An optional descriptor for the inverse relationship between associated records.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.labels.updateLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n associationTypeId: 0,\n label: 'label',\n})\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.labels.updateLabel', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.labels.updateLabel('toObjectType', {\n fromObjectType: 'fromObjectType',\n associationTypeId: 0,\n label: 'label',\n});", - }, - python: { - method: 'crm.associations_schema.labels.update_label', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.labels.update_label(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n association_type_id=0,\n label="label",\n)', - }, - java: { - method: 'crm().associationsSchema().labels().updateLabel', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.labels.LabelUpdateLabelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LabelUpdateLabelParams params = LabelUpdateLabelParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .publicAssociationDefinitionUpdateRequest(PublicAssociationDefinitionUpdateRequest.builder()\n .associationTypeId(0)\n .label("label")\n .build())\n .build();\n client.crm().associationsSchema().labels().updateLabel(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Labels.UpdateLabel', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Labels.UpdateLabel(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLabelUpdateLabelParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tPublicAssociationDefinitionUpdateRequest: crm.PublicAssociationDefinitionUpdateRequestParam{\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t\tLabel: "label",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations_schema.labels.update_label', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.labels.update_label(\n "toObjectType",\n from_object_type: "fromObjectType",\n association_type_id: 0,\n label: "label"\n)\n\nputs(result)', - }, - php: { - method: 'crm->associationsSchema->labels->updateLabel', - example: - "crm->associationsSchema->labels->updateLabel(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n associationTypeID: 0,\n label: 'label',\n inverseLabel: 'inverseLabel',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/labels \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associationTypeId": 0,\n "label": "label"\n }\'', - }, - }, - }, - { - name: 'batch_delete', - endpoint: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge', - httpMethod: 'post', - summary: 'Remove association limits', - description: 'Batch delete limits that have been defined for association types between two object types.', - stainlessPath: '(resource) crm.associations_schema.limits > (method) batch_delete', - qualified: 'client.crm.associationsSchema.limits.batchDelete', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - 'inputs: { category: string; typeId: number; }[];', - ], - markdown: - "## batch_delete\n\n`client.crm.associationsSchema.limits.batchDelete(fromObjectType: string, toObjectType: string, inputs: { category: string; typeId: number; }[]): void`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge`\n\nBatch delete limits that have been defined for association types between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: string; typeId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.associationsSchema.limits.batchDelete('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{ category: 'category', typeId: 0 }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.limits.batchDelete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.associationsSchema.limits.batchDelete('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [{ category: 'category', typeId: 0 }],\n});", - }, - python: { - method: 'crm.associations_schema.limits.batch_delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.associations_schema.limits.batch_delete(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "category",\n "type_id": 0,\n }],\n)', - }, - java: { - method: 'crm().associationsSchema().limits().batchDelete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationSpec;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationSpec;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitBatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitBatchDeleteParams params = LimitBatchDeleteParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationSpec(BatchInputPublicAssociationSpec.builder()\n .addInput(PublicAssociationSpec.builder()\n .category("category")\n .typeId(0)\n .build())\n .build())\n .build();\n client.crm().associationsSchema().limits().batchDelete(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Limits.BatchDelete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.AssociationsSchema.Limits.BatchDelete(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitBatchDeleteParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationSpec: crm.BatchInputPublicAssociationSpecParam{\n\t\t\t\tInputs: []crm.PublicAssociationSpecParam{{\n\t\t\t\t\tCategory: "category",\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.associations_schema.limits.batch_delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.associations_schema.limits.batch_delete(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: "category", typeId: 0}]\n)\n\nputs(result)', - }, - php: { - method: 'crm->associationsSchema->limits->batchDelete', - example: - "crm->associationsSchema->limits->batchDelete(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [['category' => 'category', 'typeID' => 0]],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/purge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "category",\n "typeId": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'batch_update', - endpoint: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update', - httpMethod: 'post', - summary: 'Update association limits', - description: 'Batch update association limits that have been configured between two object types.', - stainlessPath: '(resource) crm.associations_schema.limits > (method) batch_update', - qualified: 'client.crm.associationsSchema.limits.batchUpdate', - params: [ - 'fromObjectType: string;', - 'toObjectType: string;', - "inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[];", - ], - response: - "{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## batch_update\n\n`client.crm.associationsSchema.limits.batchUpdate(fromObjectType: string, toObjectType: string, inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]): { completedAt: string; results: public_association_definition_configuration_update_result[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update`\n\nBatch update association limits that have been configured between two object types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n- `inputs: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; maxToObjectIds: number; typeId: number; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; userEnforcedMaxToObjectIds?: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicAssociationDefinitionConfigurationUpdateResult = await client.crm.associationsSchema.limits.batchUpdate('toObjectType', { fromObjectType: 'fromObjectType', inputs: [{\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n}] });\n\nconsole.log(batchResponsePublicAssociationDefinitionConfigurationUpdateResult);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.limits.batchUpdate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicAssociationDefinitionConfigurationUpdateResult =\n await client.crm.associationsSchema.limits.batchUpdate('toObjectType', {\n fromObjectType: 'fromObjectType',\n inputs: [\n {\n category: 'HUBSPOT_DEFINED',\n maxToObjectIds: 0,\n typeId: 0,\n },\n ],\n });\n\nconsole.log(batchResponsePublicAssociationDefinitionConfigurationUpdateResult.completedAt);", - }, - python: { - method: 'crm.associations_schema.limits.batch_update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_association_definition_configuration_update_result = client.crm.associations_schema.limits.batch_update(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n inputs=[{\n "category": "HUBSPOT_DEFINED",\n "max_to_object_ids": 0,\n "type_id": 0,\n }],\n)\nprint(batch_response_public_association_definition_configuration_update_result.completed_at)', - }, - java: { - method: 'crm().associationsSchema().limits().batchUpdate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchInputPublicAssociationDefinitionConfigurationUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.BatchResponsePublicAssociationDefinitionConfigurationUpdateResult;\nimport com.hubspot.sdk.models.crm.associationsschema.PublicAssociationDefinitionConfigurationUpdateRequest;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitBatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitBatchUpdateParams params = LimitBatchUpdateParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .batchInputPublicAssociationDefinitionConfigurationUpdateRequest(BatchInputPublicAssociationDefinitionConfigurationUpdateRequest.builder()\n .addInput(PublicAssociationDefinitionConfigurationUpdateRequest.builder()\n .category(PublicAssociationDefinitionConfigurationUpdateRequest.Category.HUBSPOT_DEFINED)\n .maxToObjectIds(0)\n .typeId(0)\n .build())\n .build())\n .build();\n BatchResponsePublicAssociationDefinitionConfigurationUpdateResult batchResponsePublicAssociationDefinitionConfigurationUpdateResult = client.crm().associationsSchema().limits().batchUpdate(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Limits.BatchUpdate', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicAssociationDefinitionConfigurationUpdateResult, err := client.Crm.AssociationsSchema.Limits.BatchUpdate(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitBatchUpdateParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t\tBatchInputPublicAssociationDefinitionConfigurationUpdateRequest: crm.BatchInputPublicAssociationDefinitionConfigurationUpdateRequestParam{\n\t\t\t\tInputs: []crm.PublicAssociationDefinitionConfigurationUpdateRequestParam{{\n\t\t\t\t\tCategory: crm.PublicAssociationDefinitionConfigurationUpdateRequestCategoryHubSpotDefined,\n\t\t\t\t\tMaxToObjectIDs: 0,\n\t\t\t\t\tTypeID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicAssociationDefinitionConfigurationUpdateResult.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.limits.batch_update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_association_definition_configuration_update_result = hubspot.crm.associations_schema.limits.batch_update(\n "toObjectType",\n from_object_type: "fromObjectType",\n inputs: [{category: :HUBSPOT_DEFINED, maxToObjectIds: 0, typeId: 0}]\n)\n\nputs(batch_response_public_association_definition_configuration_update_result)', - }, - php: { - method: 'crm->associationsSchema->limits->batchUpdate', - example: - "crm\n ->associationsSchema\n ->limits\n ->batchUpdate(\n 'toObjectType',\n fromObjectType: 'fromObjectType',\n inputs: [\n ['category' => 'HUBSPOT_DEFINED', 'maxToObjectIDs' => 0, 'typeID' => 0]\n ],\n);\n\nvar_dump($batchResponsePublicAssociationDefinitionConfigurationUpdateResult);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "category": "HUBSPOT_DEFINED",\n "maxToObjectIds": 0,\n "typeId": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get_by_object_types', - endpoint: '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}', - httpMethod: 'get', - summary: 'Retrieve association limits', - description: - 'Retrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types.', - stainlessPath: '(resource) crm.associations_schema.limits > (method) get_by_object_types', - qualified: 'client.crm.associationsSchema.limits.getByObjectTypes', - params: ['fromObjectType: string;', 'toObjectType: string;'], - response: - "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }", - markdown: - "## get_by_object_types\n\n`client.crm.associationsSchema.limits.getByObjectTypes(fromObjectType: string, toObjectType: string): { results: public_association_definition_user_configuration[]; }`\n\n**get** `/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}`\n\nRetrieve the configuration details for associations between two specified CRM object types. Use this endpoint to understand limits that have been set for specific association types.\n\n### Parameters\n\n- `fromObjectType: string`\n\n- `toObjectType: string`\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = await client.crm.associationsSchema.limits.getByObjectTypes('toObjectType', { fromObjectType: 'fromObjectType' });\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.limits.getByObjectTypes', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging =\n await client.crm.associationsSchema.limits.getByObjectTypes('toObjectType', {\n fromObjectType: 'fromObjectType',\n });\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.results);", - }, - python: { - method: 'crm.associations_schema.limits.get_by_object_types', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_association_definition_user_configuration_no_paging = client.crm.associations_schema.limits.get_by_object_types(\n to_object_type="toObjectType",\n from_object_type="fromObjectType",\n)\nprint(collection_response_public_association_definition_user_configuration_no_paging.results)', - }, - java: { - method: 'crm().associationsSchema().limits().getByObjectTypes', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitGetByObjectTypesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitGetByObjectTypesParams params = LimitGetByObjectTypesParams.builder()\n .fromObjectType("fromObjectType")\n .toObjectType("toObjectType")\n .build();\n CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = client.crm().associationsSchema().limits().getByObjectTypes(params);\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Limits.GetByObjectTypes', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging, err := client.Crm.AssociationsSchema.Limits.GetByObjectTypes(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.AssociationsSchemaLimitGetByObjectTypesParams{\n\t\t\tFromObjectType: "fromObjectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.limits.get_by_object_types', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_association_definition_user_configuration_no_paging = hubspot.crm.associations_schema.limits.get_by_object_types(\n "toObjectType",\n from_object_type: "fromObjectType"\n)\n\nputs(collection_response_public_association_definition_user_configuration_no_paging)', - }, - php: { - method: 'crm->associationsSchema->limits->getByObjectTypes', - example: - "crm\n ->associationsSchema\n ->limits\n ->getByObjectTypes('toObjectType', fromObjectType: 'fromObjectType');\n\nvar_dump(\n $collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging\n);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/$FROM_OBJECT_TYPE/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/associations/2026-03/definitions/configurations/all', - httpMethod: 'get', - summary: 'Retrieve all association limits', - description: - 'Retrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other.', - stainlessPath: '(resource) crm.associations_schema.limits > (method) list', - qualified: 'client.crm.associationsSchema.limits.list', - response: - "{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }", - markdown: - "## list\n\n`client.crm.associationsSchema.limits.list(): { results: public_association_definition_user_configuration[]; }`\n\n**get** `/crm/associations/2026-03/definitions/configurations/all`\n\nRetrieve all configured association limits between objects, which include details about how different CRM object types are associated with each other.\n\n### Returns\n\n- `{ results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]; }`\n\n - `results: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; userEnforcedMaxToObjectIds?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = await client.crm.associationsSchema.limits.list();\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.associationsSchema.limits.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging =\n await client.crm.associationsSchema.limits.list();\n\nconsole.log(collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.results);", - }, - python: { - method: 'crm.associations_schema.limits.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_association_definition_user_configuration_no_paging = client.crm.associations_schema.limits.list()\nprint(collection_response_public_association_definition_user_configuration_no_paging.results)', - }, - java: { - method: 'crm().associationsSchema().limits().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.associationsschema.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;\nimport com.hubspot.sdk.models.crm.associationsschema.limits.LimitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging = client.crm().associationsSchema().limits().list();\n }\n}', - }, - go: { - method: 'client.Crm.AssociationsSchema.Limits.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging, err := client.Crm.AssociationsSchema.Limits.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.associations_schema.limits.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_association_definition_user_configuration_no_paging = hubspot.crm.associations_schema.limits.list\n\nputs(collection_response_public_association_definition_user_configuration_no_paging)', - }, - php: { - method: 'crm->associationsSchema->limits->list', - example: - "crm\n ->associationsSchema\n ->limits\n ->list();\n\nvar_dump(\n $collectionResponsePublicAssociationDefinitionUserConfigurationNoPaging\n);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/associations/2026-03/definitions/configurations/all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'read', - endpoint: '/deal-splits/2026-03/batch/read', - httpMethod: 'post', - summary: 'Read a batch of deal split objects by their associated deal object internal ID', - description: 'Read a batch of deal split objects by their associated deal object internal ID', - stainlessPath: '(resource) crm.deal_splits.batch > (method) read', - qualified: 'client.crm.dealSplits.batch.read', - params: ['inputs: { id: string; }[];'], - response: - "{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## read\n\n`client.crm.dealSplits.batch.read(inputs: { id: string; }[]): { completedAt: string; results: deal_to_deal_splits[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/deal-splits/2026-03/batch/read`\n\nRead a batch of deal split objects by their associated deal object internal ID\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; splits: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.read({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseDealToDealSplits);\n```", - perLanguage: { - typescript: { - method: 'client.crm.dealSplits.batch.read', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.read({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseDealToDealSplits.completedAt);", - }, - python: { - method: 'crm.deal_splits.batch.read', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_deal_to_deal_splits = client.crm.deal_splits.batch.read(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_deal_to_deal_splits.completed_at)', - }, - java: { - method: 'crm().dealSplits().batch().read', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPublicObjectId;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.dealsplits.BatchResponseDealToDealSplits;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicObjectId params = BatchInputPublicObjectId.builder()\n .addInput(PublicObjectId.builder()\n .id("id")\n .build())\n .build();\n BatchResponseDealToDealSplits batchResponseDealToDealSplits = client.crm().dealSplits().batch().read(params);\n }\n}', - }, - go: { - method: 'client.Crm.DealSplits.Batch.Read', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseDealToDealSplits, err := client.Crm.DealSplits.Batch.Read(context.TODO(), crm.DealSplitBatchReadParams{\n\t\tBatchInputPublicObjectID: shared.BatchInputPublicObjectIDParam{\n\t\t\tInputs: []shared.PublicObjectIDParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseDealToDealSplits.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.deal_splits.batch.read', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_deal_to_deal_splits = hubspot.crm.deal_splits.batch.read(inputs: [{id: "id"}])\n\nputs(batch_response_deal_to_deal_splits)', - }, - php: { - method: 'crm->dealSplits->batch->read', - example: - "crm->dealSplits->batch->read(\n inputs: [['id' => 'id']]\n);\n\nvar_dump($batchResponseDealToDealSplits);", - }, - http: { - example: - 'curl https://api.hubapi.com/deal-splits/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/deal-splits/2026-03/batch/upsert', - httpMethod: 'post', - summary: - 'Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places', - description: - 'Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places', - stainlessPath: '(resource) crm.deal_splits.batch > (method) upsert', - qualified: 'client.crm.dealSplits.batch.upsert', - params: ['inputs: { id: number; splits: { ownerId: number; percentage: number; }[]; }[];'], - response: - "{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.dealSplits.batch.upsert(inputs: { id: number; splits: public_deal_split_input[]; }[]): { completedAt: string; results: deal_to_deal_splits[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/deal-splits/2026-03/batch/upsert`\n\nCreate or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places\n\n### Parameters\n\n- `inputs: { id: number; splits: { ownerId: number; percentage: number; }[]; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; splits: simple_public_object[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; splits: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.upsert({ inputs: [{ id: 0, splits: [{ ownerId: 0, percentage: 0 }] }] });\n\nconsole.log(batchResponseDealToDealSplits);\n```", - perLanguage: { - typescript: { - method: 'client.crm.dealSplits.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseDealToDealSplits = await client.crm.dealSplits.batch.upsert({\n inputs: [{ id: 0, splits: [{ ownerId: 0, percentage: 0 }] }],\n});\n\nconsole.log(batchResponseDealToDealSplits.completedAt);", - }, - python: { - method: 'crm.deal_splits.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_deal_to_deal_splits = client.crm.deal_splits.batch.upsert(\n inputs=[{\n "id": 0,\n "splits": [{\n "owner_id": 0,\n "percentage": 0,\n }],\n }],\n)\nprint(batch_response_deal_to_deal_splits.completed_at)', - }, - java: { - method: 'crm().dealSplits().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.dealsplits.BatchResponseDealToDealSplits;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitInput;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitsBatchCreateRequest;\nimport com.hubspot.sdk.models.crm.dealsplits.PublicDealSplitsCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicDealSplitsBatchCreateRequest params = PublicDealSplitsBatchCreateRequest.builder()\n .addInput(PublicDealSplitsCreateRequest.builder()\n .id(0L)\n .addSplit(PublicDealSplitInput.builder()\n .ownerId(0)\n .percentage(0.0)\n .build())\n .build())\n .build();\n BatchResponseDealToDealSplits batchResponseDealToDealSplits = client.crm().dealSplits().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.DealSplits.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseDealToDealSplits, err := client.Crm.DealSplits.Batch.Upsert(context.TODO(), crm.DealSplitBatchUpsertParams{\n\t\tPublicDealSplitsBatchCreateRequest: crm.PublicDealSplitsBatchCreateRequestParam{\n\t\t\tInputs: []crm.PublicDealSplitsCreateRequestParam{{\n\t\t\t\tID: 0,\n\t\t\t\tSplits: []crm.PublicDealSplitInputParam{{\n\t\t\t\t\tOwnerID: 0,\n\t\t\t\t\tPercentage: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseDealToDealSplits.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.deal_splits.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_deal_to_deal_splits = hubspot.crm.deal_splits.batch.upsert(inputs: [{id: 0, splits: [{ownerId: 0, percentage: 0}]}])\n\nputs(batch_response_deal_to_deal_splits)', - }, - php: { - method: 'crm->dealSplits->batch->upsert', - example: - "crm->dealSplits->batch->upsert(\n inputs: [['id' => 0, 'splits' => [['ownerID' => 0, 'percentage' => 0]]]]\n);\n\nvar_dump($batchResponseDealToDealSplits);", - }, - http: { - example: - 'curl https://api.hubapi.com/deal-splits/2026-03/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": 0,\n "splits": [\n {\n "ownerId": 0,\n "percentage": 0\n }\n ]\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_async', - endpoint: '/crm/exports/2026-03/export/async', - httpMethod: 'post', - summary: 'Start an export', - description: 'Begins exporting CRM data for the portal as specified in the request body', - stainlessPath: '(resource) crm.exports > (method) create_async', - qualified: 'client.crm.exports.createAsync', - params: [ - "public_export_request: { associatedObjectType: string[]; exportInternalValuesOptions: 'NAMES' | 'VALUES'[]; exportName: string; exportType: 'VIEW'; format: 'XLS' | 'XLSX' | 'CSV'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: string; objectProperties: string[]; objectType: string; overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; publicCrmSearchRequest?: object; } | { associatedObjectType: string[]; exportInternalValuesOptions: 'NAMES' | 'VALUES'[]; exportName: string; exportType: 'LIST'; format: 'XLS' | 'XLSX' | 'CSV'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: string; listId: string; objectProperties: string[]; objectType: string; overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; };", - ], - response: '{ id: string; links?: object; }', - perLanguage: { - typescript: { - method: 'client.crm.exports.createAsync', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst taskLocator = await client.crm.exports.createAsync();\n\nconsole.log(taskLocator.id);", - }, - python: { - method: 'crm.exports.create_async', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntask_locator = client.crm.exports.create_async()\nprint(task_locator.id)', - }, - java: { - method: 'crm().exports().createAsync', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.TaskLocator;\nimport com.hubspot.sdk.models.crm.exports.PublicExportListRequest;\nimport com.hubspot.sdk.models.crm.exports.PublicExportViewRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicExportViewRequest params = PublicExportViewRequest.builder()\n .addAssociatedObjectType("string")\n .addExportInternalValuesOption(PublicExportViewRequest.ExportInternalValuesOption.NAMES)\n .exportName("exportName")\n .exportType(PublicExportViewRequest.ExportType.VIEW)\n .format(PublicExportViewRequest.Format.XLS)\n .includeLabeledAssociations(true)\n .includePrimaryDisplayPropertyForAssociatedObjects(true)\n .language(PublicExportViewRequest.Language.EN)\n .addObjectProperty("string")\n .objectType("objectType")\n .overrideAssociatedObjectsPerDefinitionPerRowLimit(true)\n .build();\n TaskLocator taskLocator = client.crm().exports().createAsync(params);\n }\n}', - }, - go: { - method: 'client.Crm.Exports.NewAsync', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttaskLocator, err := client.Crm.Exports.NewAsync(context.TODO(), crm.ExportNewAsyncParams{\n\t\tPublicExportRequest: crm.PublicExportRequestUnionParam{\n\t\t\tOfPublicExportViewRequest: &crm.PublicExportViewRequestParam{\n\t\t\t\tAssociatedObjectType: []string{"string"},\n\t\t\t\tExportInternalValuesOptions: []string{"NAMES"},\n\t\t\t\tExportName: "exportName",\n\t\t\t\tExportType: crm.PublicExportViewRequestExportTypeView,\n\t\t\t\tFormat: crm.PublicExportViewRequestFormatXls,\n\t\t\t\tIncludeLabeledAssociations: true,\n\t\t\t\tIncludePrimaryDisplayPropertyForAssociatedObjects: true,\n\t\t\t\tLanguage: crm.PublicExportViewRequestLanguageEn,\n\t\t\t\tObjectProperties: []string{"string"},\n\t\t\t\tObjectType: "objectType",\n\t\t\t\tOverrideAssociatedObjectsPerDefinitionPerRowLimit: true,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", taskLocator.ID)\n}\n', - }, - ruby: { - method: 'crm.exports.create_async', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntask_locator = hubspot.crm.exports.create_async(\n public_export_request: {\n associatedObjectType: ["string"],\n exportInternalValuesOptions: [:NAMES],\n exportName: "exportName",\n exportType: :VIEW,\n format: :XLS,\n includeLabeledAssociations: true,\n includePrimaryDisplayPropertyForAssociatedObjects: true,\n language: :EN,\n objectProperties: ["string"],\n objectType: "objectType",\n overrideAssociatedObjectsPerDefinitionPerRowLimit: true\n }\n)\n\nputs(task_locator)', - }, - php: { - method: 'crm->exports->createAsync', - example: - "crm->exports->createAsync();\n\nvar_dump($taskLocator);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/exports/2026-03/export/async \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'get', - endpoint: '/crm/exports/2026-03/export/{exportId}', - httpMethod: 'get', - summary: 'Retrieve details of a specific export by its unique ID.', - description: - 'Retrieve detailed information about a specific CRM export, including its current state and properties.', - stainlessPath: '(resource) crm.exports > (method) get', - qualified: 'client.crm.exports.get', - params: ['exportId: number;'], - response: - "{ id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }", - markdown: - "## get\n\n`client.crm.exports.get(exportId: number): { id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }`\n\n**get** `/crm/exports/2026-03/export/{exportId}`\n\nRetrieve detailed information about a specific CRM export, including its current state and properties.\n\n### Parameters\n\n- `exportId: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; exportState: string; exportType: 'LIST' | 'VIEW'; objectProperties: string[]; objectType: string; updatedAt: string; exportName?: string; recordCount?: number; }`\n\n - `id: string`\n - `createdAt: string`\n - `exportState: string`\n - `exportType: 'LIST' | 'VIEW'`\n - `objectProperties: string[]`\n - `objectType: string`\n - `updatedAt: string`\n - `exportName?: string`\n - `recordCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicExportResponse = await client.crm.exports.get(0);\n\nconsole.log(publicExportResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.exports.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicExportResponse = await client.crm.exports.get(0);\n\nconsole.log(publicExportResponse.id);", - }, - python: { - method: 'crm.exports.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_export_response = client.crm.exports.get(\n 0,\n)\nprint(public_export_response.id)', - }, - java: { - method: 'crm().exports().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.exports.ExportGetParams;\nimport com.hubspot.sdk.models.crm.exports.PublicExportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicExportResponse publicExportResponse = client.crm().exports().get(0L);\n }\n}', - }, - go: { - method: 'client.Crm.Exports.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicExportResponse, err := client.Crm.Exports.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicExportResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.exports.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_export_response = hubspot.crm.exports.get(0)\n\nputs(public_export_response)', - }, - php: { - method: 'crm->exports->get', - example: - "crm->exports->get(0);\n\nvar_dump($publicExportResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/exports/2026-03/export/$EXPORT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_status', - endpoint: '/crm/exports/2026-03/export/async/tasks/{taskId}/status', - httpMethod: 'get', - summary: 'Get the status of the export including the URL to download the file', - description: - 'Returns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE', - stainlessPath: '(resource) crm.exports > (method) get_status', - qualified: 'client.crm.exports.getStatus', - params: ['taskId: number;'], - response: - "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }", - markdown: - "## get_status\n\n`client.crm.exports.getStatus(taskId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }`\n\n**get** `/crm/exports/2026-03/export/async/tasks/{taskId}/status`\n\nReturns the status of the export with taskId, including the URL of the resulting file if the export status is COMPLETE\n\n### Parameters\n\n- `taskId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponseWithSingleResultUri = await client.crm.exports.getStatus(0);\n\nconsole.log(actionResponseWithSingleResultUri);\n```", - perLanguage: { - typescript: { - method: 'client.crm.exports.getStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponseWithSingleResultUri = await client.crm.exports.getStatus(0);\n\nconsole.log(actionResponseWithSingleResultUri.completedAt);", - }, - python: { - method: 'crm.exports.get_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response_with_single_result_uri = client.crm.exports.get_status(\n 0,\n)\nprint(action_response_with_single_result_uri.completed_at)', - }, - java: { - method: 'crm().exports().getStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.exports.ActionResponseWithSingleResultUri;\nimport com.hubspot.sdk.models.crm.exports.ExportGetStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponseWithSingleResultUri actionResponseWithSingleResultUri = client.crm().exports().getStatus(0L);\n }\n}', - }, - go: { - method: 'client.Crm.Exports.GetStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponseWithSingleResultUri, err := client.Crm.Exports.GetStatus(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponseWithSingleResultUri.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.exports.get_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response_with_single_result_uri = hubspot.crm.exports.get_status(0)\n\nputs(action_response_with_single_result_uri)', - }, - php: { - method: 'crm->exports->getStatus', - example: - "crm->exports->getStatus(0);\n\nvar_dump($actionResponseWithSingleResultUri);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/exports/2026-03/export/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create_channel_connection_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - httpMethod: 'post', - summary: 'Create new channel connection settings for a specific app.', - description: 'Establish new channel connection settings for the specified app.', - stainlessPath: '(resource) crm.extensions.calling > (method) create_channel_connection_settings', - qualified: 'client.crm.extensions.calling.createChannelConnectionSettings', - params: ['appId: number;', 'isReady: boolean;', 'url: string;'], - response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', - markdown: - "## create_channel_connection_settings\n\n`client.crm.extensions.calling.createChannelConnectionSettings(appId: number, isReady: boolean, url: string): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nEstablish new channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `isReady: boolean`\n Indicates whether the channel connection settings are ready.\n\n- `url: string`\n The URL associated with the channel connection settings.\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.createChannelConnectionSettings(0, { isReady: true, url: 'url' });\n\nconsole.log(channelConnectionSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.createChannelConnectionSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.createChannelConnectionSettings(0, {\n isReady: true,\n url: 'url',\n });\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", - }, - python: { - method: 'crm.extensions.calling.create_channel_connection_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.create_channel_connection_settings(\n app_id=0,\n is_ready=True,\n url="url",\n)\nprint(channel_connection_settings_response.created_at)', - }, - java: { - method: 'crm().extensions().calling().createChannelConnectionSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateChannelConnectionSettingsParams params = CallingCreateChannelConnectionSettingsParams.builder()\n .appId(0)\n .channelConnectionSettingsRequest(ChannelConnectionSettingsRequest.builder()\n .isReady(true)\n .url("url")\n .build())\n .build();\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().createChannelConnectionSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.NewChannelConnectionSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.NewChannelConnectionSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewChannelConnectionSettingsParams{\n\t\t\tChannelConnectionSettingsRequest: crm.ChannelConnectionSettingsRequestParam{\n\t\t\t\tIsReady: true,\n\t\t\t\tURL: "url",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.create_channel_connection_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.create_channel_connection_settings(0, is_ready: true, url: "url")\n\nputs(channel_connection_settings_response)', - }, - php: { - method: 'crm->extensions->calling->createChannelConnectionSettings', - example: - "crm\n ->extensions\n ->calling\n ->createChannelConnectionSettings(0, isReady: true, url: 'url');\n\nvar_dump($channelConnectionSettingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "isReady": true,\n "url": "url"\n }\'', - }, - }, - }, - { - name: 'create_inbound_call', - endpoint: '/crm/extensions/calling/2026-03/inbound-call', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.extensions.calling > (method) create_inbound_call', - qualified: 'client.crm.extensions.calling.createInboundCall', - params: [ - 'createEngagement: boolean;', - 'engagementProperties: object;', - 'externalCallId: string;', - 'finalCallStatus: string;', - 'fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', - 'potentialRecipientUserIds: number[];', - 'toNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', - 'callStartedTimestamp?: string;', - 'durationSeconds?: number;', - 'userId?: number;', - ], - response: - "{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }", - markdown: - "## create_inbound_call\n\n`client.crm.extensions.calling.createInboundCall(createEngagement: boolean, engagementProperties: object, externalCallId: string, finalCallStatus: string, fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, potentialRecipientUserIds: number[], toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, callStartedTimestamp?: string, durationSeconds?: number, userId?: number): { callerIdMatches: contact_caller_id | company_caller_id[]; }`\n\n**post** `/crm/extensions/calling/2026-03/inbound-call`\n\n### Parameters\n\n- `createEngagement: boolean`\n Indicates whether an engagement should be created for the call.\n\n- `engagementProperties: object`\n Contains additional properties related to the engagement.\n\n- `externalCallId: string`\n The unique identifier for the call from an external system.\n\n- `finalCallStatus: string`\n The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.\n\n- `fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `potentialRecipientUserIds: number[]`\n\n- `toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `callStartedTimestamp?: string`\n The timestamp indicating when the call started, formatted as a date-time string.\n\n- `durationSeconds?: number`\n The duration of the call in seconds.\n\n- `userId?: number`\n The ID of the user associated with the call.\n\n### Returns\n\n- `{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }`\n\n - `callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; name?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.createInboundCall', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse.callerIdMatches);", - }, - python: { - method: 'crm.extensions.calling.create_inbound_call', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompleted_third_party_call_response = client.crm.extensions.calling.create_inbound_call(\n create_engagement=True,\n engagement_properties={\n "foo": "string"\n },\n external_call_id="externalCallId",\n final_call_status="BUSY",\n from_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n potential_recipient_user_ids=[0],\n to_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n)\nprint(completed_third_party_call_response.caller_id_matches)', - }, - java: { - method: 'crm().extensions().calling().createInboundCall', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.FormattedPhoneNumber;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompletedThirdPartyCallRequest params = CompletedThirdPartyCallRequest.builder()\n .createEngagement(true)\n .engagementProperties(CompletedThirdPartyCallRequest.EngagementProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .externalCallId("externalCallId")\n .finalCallStatus(CompletedThirdPartyCallRequest.FinalCallStatus.BUSY)\n .fromNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .addPotentialRecipientUserId(0)\n .toNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .build();\n CompletedThirdPartyCallResponse completedThirdPartyCallResponse = client.crm().extensions().calling().createInboundCall(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.NewInboundCall', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompletedThirdPartyCallResponse, err := client.Crm.Extensions.Calling.NewInboundCall(context.TODO(), crm.ExtensionCallingNewInboundCallParams{\n\t\tCompletedThirdPartyCallRequest: crm.CompletedThirdPartyCallRequestParam{\n\t\t\tCreateEngagement: true,\n\t\t\tEngagementProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tExternalCallID: "externalCallId",\n\t\t\tFinalCallStatus: crm.CompletedThirdPartyCallRequestFinalCallStatusBusy,\n\t\t\tFromNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t\tPotentialRecipientUserIDs: []int64{0},\n\t\t\tToNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", completedThirdPartyCallResponse.CallerIDMatches)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.create_inbound_call', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompleted_third_party_call_response = hubspot.crm.extensions.calling.create_inbound_call(\n create_engagement: true,\n engagement_properties: {foo: "string"},\n external_call_id: "externalCallId",\n final_call_status: :BUSY,\n from_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE},\n potential_recipient_user_ids: [0],\n to_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE}\n)\n\nputs(completed_third_party_call_response)', - }, - php: { - method: 'crm->extensions->calling->createInboundCall', - example: - "crm\n ->extensions\n ->calling\n ->createInboundCall(\n createEngagement: true,\n engagementProperties: ['foo' => 'string'],\n externalCallID: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n potentialRecipientUserIDs: [0],\n toNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n callStartedTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n durationSeconds: 0,\n userID: 0,\n);\n\nvar_dump($completedThirdPartyCallResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/inbound-call \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createEngagement": true,\n "engagementProperties": {\n "foo": "string"\n },\n "externalCallId": "externalCallId",\n "finalCallStatus": "BUSY",\n "fromNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n },\n "potentialRecipientUserIds": [\n 0\n ],\n "toNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n }\n }\'', - }, - }, - }, - { - name: 'create_recording_ready', - endpoint: '/crm/extensions/calling/2026-03/recordings/ready', - httpMethod: 'post', - summary: 'Mark a call recording as ready for retrieval.', - description: - 'This endpoint is used to mark a call recording as ready. It requires the engagementId to identify the specific recording.', - stainlessPath: '(resource) crm.extensions.calling > (method) create_recording_ready', - qualified: 'client.crm.extensions.calling.createRecordingReady', - params: ['engagementId: number;'], - markdown: - "## create_recording_ready\n\n`client.crm.extensions.calling.createRecordingReady(engagementId: number): void`\n\n**post** `/crm/extensions/calling/2026-03/recordings/ready`\n\nThis endpoint is used to mark a call recording as ready. It requires the engagementId to identify the specific recording.\n\n### Parameters\n\n- `engagementId: number`\n The unique identifier for the engagement associated with the call recording.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.createRecordingReady({ engagementId: 0 })\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.createRecordingReady', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.createRecordingReady({ engagementId: 0 });", - }, - python: { - method: 'crm.extensions.calling.create_recording_ready', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.create_recording_ready(\n engagement_id=0,\n)', - }, - java: { - method: 'crm().extensions().calling().createRecordingReady', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.MarkRecordingAsReadyRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarkRecordingAsReadyRequest params = MarkRecordingAsReadyRequest.builder()\n .engagementId(0L)\n .build();\n client.crm().extensions().calling().createRecordingReady(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.NewRecordingReady', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.NewRecordingReady(context.TODO(), crm.ExtensionCallingNewRecordingReadyParams{\n\t\tMarkRecordingAsReadyRequest: crm.MarkRecordingAsReadyRequestParam{\n\t\t\tEngagementID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.create_recording_ready', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.create_recording_ready(engagement_id: 0)\n\nputs(result)', - }, - php: { - method: 'crm->extensions->calling->createRecordingReady', - example: - "crm->extensions->calling->createRecordingReady(\n engagementID: 0\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/recordings/ready \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "engagementId": 0\n }\'', - }, - }, - }, - { - name: 'create_recording_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - httpMethod: 'post', - summary: 'Create recording settings for an app.', - description: 'Create new recording settings for a specific app using the provided app ID.', - stainlessPath: '(resource) crm.extensions.calling > (method) create_recording_settings', - qualified: 'client.crm.extensions.calling.createRecordingSettings', - params: ['appId: number;', 'urlToRetrieveAuthedRecording: string;'], - response: '{ urlToRetrieveAuthedRecording: string; }', - markdown: - "## create_recording_settings\n\n`client.crm.extensions.calling.createRecordingSettings(appId: number, urlToRetrieveAuthedRecording: string): { urlToRetrieveAuthedRecording: string; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nCreate new recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `urlToRetrieveAuthedRecording: string`\n The URL used to access authenticated call recordings.\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.createRecordingSettings(0, { urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording' });\n\nconsole.log(recordingSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.createRecordingSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.createRecordingSettings(0, {\n urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording',\n});\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", - }, - python: { - method: 'crm.extensions.calling.create_recording_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.create_recording_settings(\n app_id=0,\n url_to_retrieve_authed_recording="urlToRetrieveAuthedRecording",\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', - }, - java: { - method: 'crm().extensions().calling().createRecordingSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateRecordingSettingsParams params = CallingCreateRecordingSettingsParams.builder()\n .appId(0)\n .recordingSettingsRequest(RecordingSettingsRequest.builder()\n .urlToRetrieveAuthedRecording("urlToRetrieveAuthedRecording")\n .build())\n .build();\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().createRecordingSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.NewRecordingSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.NewRecordingSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewRecordingSettingsParams{\n\t\t\tRecordingSettingsRequest: crm.RecordingSettingsRequestParam{\n\t\t\t\tURLToRetrieveAuthedRecording: "urlToRetrieveAuthedRecording",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.create_recording_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.create_recording_settings(\n 0,\n url_to_retrieve_authed_recording: "urlToRetrieveAuthedRecording"\n)\n\nputs(recording_settings_response)', - }, - php: { - method: 'crm->extensions->calling->createRecordingSettings', - example: - "crm\n ->extensions\n ->calling\n ->createRecordingSettings(\n 0, urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording'\n);\n\nvar_dump($recordingSettingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "urlToRetrieveAuthedRecording": "urlToRetrieveAuthedRecording"\n }\'', - }, - }, - }, - { - name: 'create_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', - httpMethod: 'post', - summary: 'Create new calling extension settings for a specific app.', - description: 'Create new settings for the calling extension associated with the specified appId.', - stainlessPath: '(resource) crm.extensions.calling > (method) create_settings', - qualified: 'client.crm.extensions.calling.createSettings', - params: [ - 'appId: number;', - 'height: number;', - 'isReady: boolean;', - 'name: string;', - 'supportsCustomObjects: boolean;', - 'supportsInboundCalling: boolean;', - 'url: string;', - 'usesCallingWindow: boolean;', - 'usesRemote: boolean;', - 'width: number;', - ], - response: - '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', - markdown: - "## create_settings\n\n`client.crm.extensions.calling.createSettings(appId: number, height: number, isReady: boolean, name: string, supportsCustomObjects: boolean, supportsInboundCalling: boolean, url: string, usesCallingWindow: boolean, usesRemote: boolean, width: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**post** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nCreate new settings for the calling extension associated with the specified appId.\n\n### Parameters\n\n- `appId: number`\n\n- `height: number`\n Specifies the height of the calling extension interface.\n\n- `isReady: boolean`\n Indicates if the calling extension is ready for use.\n\n- `name: string`\n The name of the calling extension.\n\n- `supportsCustomObjects: boolean`\n Indicates if the calling extension supports custom objects.\n\n- `supportsInboundCalling: boolean`\n Indicates if the calling extension supports inbound calling.\n\n- `url: string`\n The URL associated with the calling extension.\n\n- `usesCallingWindow: boolean`\n Indicates if the calling extension uses a separate calling window.\n\n- `usesRemote: boolean`\n Indicates if the calling extension uses remote services.\n\n- `width: number`\n Specifies the width of the calling extension interface.\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.createSettings(0, {\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n});\n\nconsole.log(settingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.createSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.createSettings(0, {\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n});\n\nconsole.log(settingsResponse.width);", - }, - python: { - method: 'crm.extensions.calling.create_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.create_settings(\n app_id=0,\n height=0,\n is_ready=True,\n name="name",\n supports_custom_objects=True,\n supports_inbound_calling=True,\n url="url",\n uses_calling_window=True,\n uses_remote=True,\n width=0,\n)\nprint(settings_response.width)', - }, - java: { - method: 'crm().extensions().calling().createSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingCreateSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingCreateSettingsParams params = CallingCreateSettingsParams.builder()\n .appId(0)\n .settingsRequest(SettingsRequest.builder()\n .height(0)\n .isReady(true)\n .name("name")\n .supportsCustomObjects(true)\n .supportsInboundCalling(true)\n .url("url")\n .usesCallingWindow(true)\n .usesRemote(true)\n .width(0)\n .build())\n .build();\n SettingsResponse settingsResponse = client.crm().extensions().calling().createSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.NewSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.NewSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingNewSettingsParams{\n\t\t\tSettingsRequest: crm.SettingsRequestParam{\n\t\t\t\tHeight: 0,\n\t\t\t\tIsReady: true,\n\t\t\t\tName: "name",\n\t\t\t\tSupportsCustomObjects: true,\n\t\t\t\tSupportsInboundCalling: true,\n\t\t\t\tURL: "url",\n\t\t\t\tUsesCallingWindow: true,\n\t\t\t\tUsesRemote: true,\n\t\t\t\tWidth: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.create_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.create_settings(\n 0,\n height: 0,\n is_ready: true,\n name: "name",\n supports_custom_objects: true,\n supports_inbound_calling: true,\n url: "url",\n uses_calling_window: true,\n uses_remote: true,\n width: 0\n)\n\nputs(settings_response)', - }, - php: { - method: 'crm->extensions->calling->createSettings', - example: - "crm->extensions->calling->createSettings(\n 0,\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n);\n\nvar_dump($settingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "height": 0,\n "isReady": true,\n "name": "name",\n "supportsCustomObjects": true,\n "supportsInboundCalling": true,\n "url": "url",\n "usesCallingWindow": true,\n "usesRemote": true,\n "width": 0\n }\'', - }, - }, - }, - { - name: 'delete_channel_connection_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - httpMethod: 'delete', - summary: 'Remove the channel connection settings for a specific app.', - description: 'Delete the channel connection settings associated with the specified app.', - stainlessPath: '(resource) crm.extensions.calling > (method) delete_channel_connection_settings', - qualified: 'client.crm.extensions.calling.deleteChannelConnectionSettings', - params: ['appId: number;'], - markdown: - "## delete_channel_connection_settings\n\n`client.crm.extensions.calling.deleteChannelConnectionSettings(appId: number): void`\n\n**delete** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nDelete the channel connection settings associated with the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.deleteChannelConnectionSettings(0)\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.deleteChannelConnectionSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.deleteChannelConnectionSettings(0);", - }, - python: { - method: 'crm.extensions.calling.delete_channel_connection_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.delete_channel_connection_settings(\n 0,\n)', - }, - java: { - method: 'crm().extensions().calling().deleteChannelConnectionSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingDeleteChannelConnectionSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().deleteChannelConnectionSettings(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.DeleteChannelConnectionSettings', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.DeleteChannelConnectionSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.delete_channel_connection_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.delete_channel_connection_settings(0)\n\nputs(result)', - }, - php: { - method: 'crm->extensions->calling->deleteChannelConnectionSettings', - example: - "crm->extensions->calling->deleteChannelConnectionSettings(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', - httpMethod: 'delete', - summary: 'Delete the calling extension settings for a specific app.', - description: - 'Remove the calling extension settings associated with the specified appId. This action cannot be undone.', - stainlessPath: '(resource) crm.extensions.calling > (method) delete_settings', - qualified: 'client.crm.extensions.calling.deleteSettings', - params: ['appId: number;'], - markdown: - "## delete_settings\n\n`client.crm.extensions.calling.deleteSettings(appId: number): void`\n\n**delete** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nRemove the calling extension settings associated with the specified appId. This action cannot be undone.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.deleteSettings(0)\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.deleteSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.deleteSettings(0);", - }, - python: { - method: 'crm.extensions.calling.delete_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.delete_settings(\n 0,\n)', - }, - java: { - method: 'crm().extensions().calling().deleteSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingDeleteSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().deleteSettings(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.DeleteSettings', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.DeleteSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.delete_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.delete_settings(0)\n\nputs(result)', - }, - php: { - method: 'crm->extensions->calling->deleteSettings', - example: - "crm->extensions->calling->deleteSettings(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_channel_connection_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - httpMethod: 'get', - summary: 'Retrieve the channel connection settings for a specific app.', - description: 'Access the current channel connection settings for the specified app.', - stainlessPath: '(resource) crm.extensions.calling > (method) get_channel_connection_settings', - qualified: 'client.crm.extensions.calling.getChannelConnectionSettings', - params: ['appId: number;'], - response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', - markdown: - "## get_channel_connection_settings\n\n`client.crm.extensions.calling.getChannelConnectionSettings(appId: number): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nAccess the current channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.getChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.getChannelConnectionSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.getChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", - }, - python: { - method: 'crm.extensions.calling.get_channel_connection_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.get_channel_connection_settings(\n 0,\n)\nprint(channel_connection_settings_response.created_at)', - }, - java: { - method: 'crm().extensions().calling().getChannelConnectionSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().getChannelConnectionSettings(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.GetChannelConnectionSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.GetChannelConnectionSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.get_channel_connection_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.get_channel_connection_settings(0)\n\nputs(channel_connection_settings_response)', - }, - php: { - method: 'crm->extensions->calling->getChannelConnectionSettings', - example: - "crm\n ->extensions\n ->calling\n ->getChannelConnectionSettings(0);\n\nvar_dump($channelConnectionSettingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_recording_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - httpMethod: 'get', - summary: 'Retrieve recording settings for an app.', - description: 'Retrieve the current recording settings for a specific app using the provided app ID.', - stainlessPath: '(resource) crm.extensions.calling > (method) get_recording_settings', - qualified: 'client.crm.extensions.calling.getRecordingSettings', - params: ['appId: number;'], - response: '{ urlToRetrieveAuthedRecording: string; }', - markdown: - "## get_recording_settings\n\n`client.crm.extensions.calling.getRecordingSettings(appId: number): { urlToRetrieveAuthedRecording: string; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nRetrieve the current recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.getRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.getRecordingSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.getRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", - }, - python: { - method: 'crm.extensions.calling.get_recording_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.get_recording_settings(\n 0,\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', - }, - java: { - method: 'crm().extensions().calling().getRecordingSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().getRecordingSettings(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.GetRecordingSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.GetRecordingSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.get_recording_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.get_recording_settings(0)\n\nputs(recording_settings_response)', - }, - php: { - method: 'crm->extensions->calling->getRecordingSettings', - example: - "crm\n ->extensions\n ->calling\n ->getRecordingSettings(0);\n\nvar_dump($recordingSettingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', - httpMethod: 'get', - summary: 'Retrieve the calling extension settings for a specific app.', - description: 'Retrieve the current settings of the calling extension for the specified appId. ', - stainlessPath: '(resource) crm.extensions.calling > (method) get_settings', - qualified: 'client.crm.extensions.calling.getSettings', - params: ['appId: number;'], - response: - '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', - markdown: - "## get_settings\n\n`client.crm.extensions.calling.getSettings(appId: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**get** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nRetrieve the current settings of the calling extension for the specified appId. \n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.getSettings(0);\n\nconsole.log(settingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.getSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.getSettings(0);\n\nconsole.log(settingsResponse.width);", - }, - python: { - method: 'crm.extensions.calling.get_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.get_settings(\n 0,\n)\nprint(settings_response.width)', - }, - java: { - method: 'crm().extensions().calling().getSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingGetSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingsResponse settingsResponse = client.crm().extensions().calling().getSettings(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.GetSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.GetSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.get_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.get_settings(0)\n\nputs(settings_response)', - }, - php: { - method: 'crm->extensions->calling->getSettings', - example: - "crm->extensions->calling->getSettings(0);\n\nvar_dump($settingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_channel_connection_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - httpMethod: 'patch', - summary: 'Update the channel connection settings for a specific app.', - description: 'Modify the existing channel connection settings for the specified app.', - stainlessPath: '(resource) crm.extensions.calling > (method) update_channel_connection_settings', - qualified: 'client.crm.extensions.calling.updateChannelConnectionSettings', - params: ['appId: number;', 'isReady?: boolean;', 'url?: string;'], - response: '{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }', - markdown: - "## update_channel_connection_settings\n\n`client.crm.extensions.calling.updateChannelConnectionSettings(appId: number, isReady?: boolean, url?: string): { createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings/channel-connection`\n\nModify the existing channel connection settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `isReady?: boolean`\n Indicates whether the channel connection settings are ready.\n\n- `url?: string`\n The URL for the channel connection settings.\n\n### Returns\n\n- `{ createdAt: string; isReady: boolean; updatedAt: string; url: string; }`\n\n - `createdAt: string`\n - `isReady: boolean`\n - `updatedAt: string`\n - `url: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst channelConnectionSettingsResponse = await client.crm.extensions.calling.updateChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.updateChannelConnectionSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst channelConnectionSettingsResponse =\n await client.crm.extensions.calling.updateChannelConnectionSettings(0);\n\nconsole.log(channelConnectionSettingsResponse.createdAt);", - }, - python: { - method: 'crm.extensions.calling.update_channel_connection_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nchannel_connection_settings_response = client.crm.extensions.calling.update_channel_connection_settings(\n app_id=0,\n)\nprint(channel_connection_settings_response.created_at)', - }, - java: { - method: 'crm().extensions().calling().updateChannelConnectionSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateChannelConnectionSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.ChannelConnectionSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateChannelConnectionSettingsParams params = CallingUpdateChannelConnectionSettingsParams.builder()\n .appId(0)\n .channelConnectionSettingsPatchRequest(ChannelConnectionSettingsPatchRequest.builder().build())\n .build();\n ChannelConnectionSettingsResponse channelConnectionSettingsResponse = client.crm().extensions().calling().updateChannelConnectionSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.UpdateChannelConnectionSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tchannelConnectionSettingsResponse, err := client.Crm.Extensions.Calling.UpdateChannelConnectionSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateChannelConnectionSettingsParams{\n\t\t\tChannelConnectionSettingsPatchRequest: crm.ChannelConnectionSettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", channelConnectionSettingsResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.update_channel_connection_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nchannel_connection_settings_response = hubspot.crm.extensions.calling.update_channel_connection_settings(0)\n\nputs(channel_connection_settings_response)', - }, - php: { - method: 'crm->extensions->calling->updateChannelConnectionSettings', - example: - "crm\n ->extensions\n ->calling\n ->updateChannelConnectionSettings(0, isReady: true, url: 'url');\n\nvar_dump($channelConnectionSettingsResponse);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/channel-connection \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_recording_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - httpMethod: 'patch', - summary: 'Update recording settings for an app.', - description: 'Update the recording settings for a specific app using the provided app ID.', - stainlessPath: '(resource) crm.extensions.calling > (method) update_recording_settings', - qualified: 'client.crm.extensions.calling.updateRecordingSettings', - params: ['appId: number;', 'urlToRetrieveAuthedRecording?: string;'], - response: '{ urlToRetrieveAuthedRecording: string; }', - markdown: - "## update_recording_settings\n\n`client.crm.extensions.calling.updateRecordingSettings(appId: number, urlToRetrieveAuthedRecording?: string): { urlToRetrieveAuthedRecording: string; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings/recording`\n\nUpdate the recording settings for a specific app using the provided app ID.\n\n### Parameters\n\n- `appId: number`\n\n- `urlToRetrieveAuthedRecording?: string`\n The URL used to access authenticated call recordings.\n\n### Returns\n\n- `{ urlToRetrieveAuthedRecording: string; }`\n\n - `urlToRetrieveAuthedRecording: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.updateRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.updateRecordingSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordingSettingsResponse = await client.crm.extensions.calling.updateRecordingSettings(0);\n\nconsole.log(recordingSettingsResponse.urlToRetrieveAuthedRecording);", - }, - python: { - method: 'crm.extensions.calling.update_recording_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecording_settings_response = client.crm.extensions.calling.update_recording_settings(\n app_id=0,\n)\nprint(recording_settings_response.url_to_retrieve_authed_recording)', - }, - java: { - method: 'crm().extensions().calling().updateRecordingSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateRecordingSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.RecordingSettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateRecordingSettingsParams params = CallingUpdateRecordingSettingsParams.builder()\n .appId(0)\n .recordingSettingsPatchRequest(RecordingSettingsPatchRequest.builder().build())\n .build();\n RecordingSettingsResponse recordingSettingsResponse = client.crm().extensions().calling().updateRecordingSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.UpdateRecordingSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordingSettingsResponse, err := client.Crm.Extensions.Calling.UpdateRecordingSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateRecordingSettingsParams{\n\t\t\tRecordingSettingsPatchRequest: crm.RecordingSettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordingSettingsResponse.URLToRetrieveAuthedRecording)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.update_recording_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecording_settings_response = hubspot.crm.extensions.calling.update_recording_settings(0)\n\nputs(recording_settings_response)', - }, - php: { - method: 'crm->extensions->calling->updateRecordingSettings', - example: - "crm\n ->extensions\n ->calling\n ->updateRecordingSettings(\n 0, urlToRetrieveAuthedRecording: 'urlToRetrieveAuthedRecording'\n);\n\nvar_dump($recordingSettingsResponse);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings/recording \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_settings', - endpoint: '/crm/extensions/calling/2026-03/{appId}/settings', - httpMethod: 'patch', - summary: 'Update the calling extension settings for a specific app.', - description: - 'Modify existing calling extension settings for the specified appId. Only the fields provided in the request will be updated.', - stainlessPath: '(resource) crm.extensions.calling > (method) update_settings', - qualified: 'client.crm.extensions.calling.updateSettings', - params: [ - 'appId: number;', - 'height?: number;', - 'isReady?: boolean;', - 'name?: string;', - 'supportsCustomObjects?: boolean;', - 'supportsInboundCalling?: boolean;', - 'url?: string;', - 'usesCallingWindow?: boolean;', - 'usesRemote?: boolean;', - 'width?: number;', - ], - response: - '{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }', - markdown: - "## update_settings\n\n`client.crm.extensions.calling.updateSettings(appId: number, height?: number, isReady?: boolean, name?: string, supportsCustomObjects?: boolean, supportsInboundCalling?: boolean, url?: string, usesCallingWindow?: boolean, usesRemote?: boolean, width?: number): { createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n**patch** `/crm/extensions/calling/2026-03/{appId}/settings`\n\nModify existing calling extension settings for the specified appId. Only the fields provided in the request will be updated.\n\n### Parameters\n\n- `appId: number`\n\n- `height?: number`\n The height setting for the calling extension interface.\n\n- `isReady?: boolean`\n Specifies whether the calling extension is ready for use.\n\n- `name?: string`\n The name of the calling extension.\n\n- `supportsCustomObjects?: boolean`\n Indicates if the calling extension supports custom objects.\n\n- `supportsInboundCalling?: boolean`\n Indicates if the calling extension supports inbound calling.\n\n- `url?: string`\n The URL associated with the calling extension settings.\n\n- `usesCallingWindow?: boolean`\n Indicates if the calling extension uses a calling window.\n\n- `usesRemote?: boolean`\n Indicates if the calling extension uses a remote connection.\n\n- `width?: number`\n The width setting for the calling extension interface.\n\n### Returns\n\n- `{ createdAt: string; height: number; isReady: boolean; name: string; supportsCustomObjects: boolean; supportsInboundCalling: boolean; updatedAt: string; url: string; usesCallingWindow: boolean; usesRemote: boolean; width: number; }`\n\n - `createdAt: string`\n - `height: number`\n - `isReady: boolean`\n - `name: string`\n - `supportsCustomObjects: boolean`\n - `supportsInboundCalling: boolean`\n - `updatedAt: string`\n - `url: string`\n - `usesCallingWindow: boolean`\n - `usesRemote: boolean`\n - `width: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.crm.extensions.calling.updateSettings(0);\n\nconsole.log(settingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.updateSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.crm.extensions.calling.updateSettings(0);\n\nconsole.log(settingsResponse.width);", - }, - python: { - method: 'crm.extensions.calling.update_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.crm.extensions.calling.update_settings(\n app_id=0,\n)\nprint(settings_response.width)', - }, - java: { - method: 'crm().extensions().calling().updateSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.CallingUpdateSettingsParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.SettingsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallingUpdateSettingsParams params = CallingUpdateSettingsParams.builder()\n .appId(0)\n .settingsPatchRequest(SettingsPatchRequest.builder().build())\n .build();\n SettingsResponse settingsResponse = client.crm().extensions().calling().updateSettings(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.UpdateSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Crm.Extensions.Calling.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCallingUpdateSettingsParams{\n\t\t\tSettingsPatchRequest: crm.SettingsPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.Width)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.update_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.crm.extensions.calling.update_settings(0)\n\nputs(settings_response)', - }, - php: { - method: 'crm->extensions->calling->updateSettings', - example: - "crm->extensions->calling->updateSettings(\n 0,\n height: 0,\n isReady: true,\n name: 'name',\n supportsCustomObjects: true,\n supportsInboundCalling: true,\n url: 'url',\n usesCallingWindow: true,\n usesRemote: true,\n width: 0,\n);\n\nvar_dump($settingsResponse);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/extensions/calling/2026-03/$APP_ID/settings \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create', - endpoint: '/crm/extensions/calling/2026-03/transcripts', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) create', - qualified: 'client.crm.extensions.calling.transcripts.create', - params: [ - 'engagementId: number;', - 'transcriptCreateUtterances: { endTimeMillis: number; speaker: { id: string; name: string; email?: string; }; startTimeMillis: number; text: string; languageCode?: string; }[];', - ], - response: '{ id: string; }', - markdown: - "## create\n\n`client.crm.extensions.calling.transcripts.create(engagementId: number, transcriptCreateUtterances: { endTimeMillis: number; speaker: speaker; startTimeMillis: number; text: string; languageCode?: string; }[]): { id: string; }`\n\n**post** `/crm/extensions/calling/2026-03/transcripts`\n\n### Parameters\n\n- `engagementId: number`\n\n- `transcriptCreateUtterances: { endTimeMillis: number; speaker: { id: string; name: string; email?: string; }; startTimeMillis: number; text: string; languageCode?: string; }[]`\n\n### Returns\n\n- `{ id: string; }`\n\n - `id: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst transcriptCreateResponse = await client.crm.extensions.calling.transcripts.create({ engagementId: 0, transcriptCreateUtterances: [{\n endTimeMillis: 0,\n speaker: { id: 'id', name: 'name' },\n startTimeMillis: 0,\n text: 'text',\n}] });\n\nconsole.log(transcriptCreateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.transcripts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst transcriptCreateResponse = await client.crm.extensions.calling.transcripts.create({\n engagementId: 0,\n transcriptCreateUtterances: [\n {\n endTimeMillis: 0,\n speaker: { id: 'id', name: 'name' },\n startTimeMillis: 0,\n text: 'text',\n },\n ],\n});\n\nconsole.log(transcriptCreateResponse.id);", - }, - python: { - method: 'crm.extensions.calling.transcripts.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntranscript_create_response = client.crm.extensions.calling.transcripts.create(\n engagement_id=0,\n transcript_create_utterances=[{\n "end_time_millis": 0,\n "speaker": {\n "id": "id",\n "name": "name",\n },\n "start_time_millis": 0,\n "text": "text",\n }],\n)\nprint(transcript_create_response.id)', - }, - java: { - method: 'crm().extensions().calling().transcripts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.Speaker;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptCreateUtterance;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TranscriptCreateRequest params = TranscriptCreateRequest.builder()\n .engagementId(0L)\n .addTranscriptCreateUtterance(TranscriptCreateUtterance.builder()\n .endTimeMillis(0L)\n .speaker(Speaker.builder()\n .id("id")\n .name("name")\n .build())\n .startTimeMillis(0L)\n .text("text")\n .build())\n .build();\n TranscriptCreateResponse transcriptCreateResponse = client.crm().extensions().calling().transcripts().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.Transcripts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttranscriptCreateResponse, err := client.Crm.Extensions.Calling.Transcripts.New(context.TODO(), crm.ExtensionCallingTranscriptNewParams{\n\t\tTranscriptCreateRequest: crm.TranscriptCreateRequestParam{\n\t\t\tEngagementID: 0,\n\t\t\tTranscriptCreateUtterances: []crm.TranscriptCreateUtteranceParam{{\n\t\t\t\tEndTimeMillis: 0,\n\t\t\t\tSpeaker: crm.SpeakerParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tName: "name",\n\t\t\t\t},\n\t\t\t\tStartTimeMillis: 0,\n\t\t\t\tText: "text",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", transcriptCreateResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.transcripts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntranscript_create_response = hubspot.crm.extensions.calling.transcripts.create(\n engagement_id: 0,\n transcript_create_utterances: [{endTimeMillis: 0, speaker: {id: "id", name: "name"}, startTimeMillis: 0, text: "text"}]\n)\n\nputs(transcript_create_response)', - }, - php: { - method: 'crm->extensions->calling->transcripts->create', - example: - "crm\n ->extensions\n ->calling\n ->transcripts\n ->create(\n engagementID: 0,\n transcriptCreateUtterances: [\n [\n 'endTimeMillis' => 0,\n 'speaker' => ['id' => 'id', 'name' => 'name', 'email' => 'email'],\n 'startTimeMillis' => 0,\n 'text' => 'text',\n 'languageCode' => 'languageCode',\n ],\n ],\n);\n\nvar_dump($transcriptCreateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "engagementId": 0,\n "transcriptCreateUtterances": [\n {\n "endTimeMillis": 0,\n "speaker": {\n "id": "id",\n "name": "name"\n },\n "startTimeMillis": 0,\n "text": "text"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_inbound_call', - endpoint: '/crm/extensions/calling/2026-03/inbound-call', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) create_inbound_call', - qualified: 'client.crm.extensions.calling.transcripts.createInboundCall', - params: [ - 'createEngagement: boolean;', - 'engagementProperties: object;', - 'externalCallId: string;', - 'finalCallStatus: string;', - 'fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', - 'potentialRecipientUserIds: number[];', - 'toNumber: { e164Number: string; phoneNumberType: string; extension?: string; };', - 'callStartedTimestamp?: string;', - 'durationSeconds?: number;', - 'userId?: number;', - ], - response: - "{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }", - markdown: - "## create_inbound_call\n\n`client.crm.extensions.calling.transcripts.createInboundCall(createEngagement: boolean, engagementProperties: object, externalCallId: string, finalCallStatus: string, fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, potentialRecipientUserIds: number[], toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }, callStartedTimestamp?: string, durationSeconds?: number, userId?: number): { callerIdMatches: contact_caller_id | company_caller_id[]; }`\n\n**post** `/crm/extensions/calling/2026-03/inbound-call`\n\n### Parameters\n\n- `createEngagement: boolean`\n Indicates whether an engagement should be created for the call.\n\n- `engagementProperties: object`\n Contains additional properties related to the engagement.\n\n- `externalCallId: string`\n The unique identifier for the call from an external system.\n\n- `finalCallStatus: string`\n The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.\n\n- `fromNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `potentialRecipientUserIds: number[]`\n\n- `toNumber: { e164Number: string; phoneNumberType: string; extension?: string; }`\n - `e164Number: string`\n The phone number formatted in E.164 standard.\n - `phoneNumberType: string`\n The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.\n - `extension?: string`\n The extension number associated with the phone number.\n\n- `callStartedTimestamp?: string`\n The timestamp indicating when the call started, formatted as a date-time string.\n\n- `durationSeconds?: number`\n The duration of the call in seconds.\n\n- `userId?: number`\n The ID of the user associated with the call.\n\n### Returns\n\n- `{ callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: object_coordinates; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: object_coordinates; name?: string; }[]; }`\n\n - `callerIdMatches: { callerIdType: 'CONTACT'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; email?: string; firstName?: string; lastName?: string; } | { callerIdType: 'COMPANY'; objectCoordinates: { objectId: number; objectTypeId: string; portalId: number; }; name?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst completedThirdPartyCallResponse = await client.crm.extensions.calling.transcripts.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n});\n\nconsole.log(completedThirdPartyCallResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.transcripts.createInboundCall', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst completedThirdPartyCallResponse =\n await client.crm.extensions.calling.transcripts.createInboundCall({\n createEngagement: true,\n engagementProperties: { foo: 'string' },\n externalCallId: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n potentialRecipientUserIds: [0],\n toNumber: { e164Number: 'e164Number', phoneNumberType: 'FIXED_LINE' },\n });\n\nconsole.log(completedThirdPartyCallResponse.callerIdMatches);", - }, - python: { - method: 'crm.extensions.calling.transcripts.create_inbound_call', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompleted_third_party_call_response = client.crm.extensions.calling.transcripts.create_inbound_call(\n create_engagement=True,\n engagement_properties={\n "foo": "string"\n },\n external_call_id="externalCallId",\n final_call_status="BUSY",\n from_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n potential_recipient_user_ids=[0],\n to_number={\n "e164_number": "e164Number",\n "phone_number_type": "FIXED_LINE",\n },\n)\nprint(completed_third_party_call_response.caller_id_matches)', - }, - java: { - method: 'crm().extensions().calling().transcripts().createInboundCall', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallRequest;\nimport com.hubspot.sdk.models.crm.extensions.calling.CompletedThirdPartyCallResponse;\nimport com.hubspot.sdk.models.crm.extensions.calling.FormattedPhoneNumber;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompletedThirdPartyCallRequest params = CompletedThirdPartyCallRequest.builder()\n .createEngagement(true)\n .engagementProperties(CompletedThirdPartyCallRequest.EngagementProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .externalCallId("externalCallId")\n .finalCallStatus(CompletedThirdPartyCallRequest.FinalCallStatus.BUSY)\n .fromNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .addPotentialRecipientUserId(0)\n .toNumber(FormattedPhoneNumber.builder()\n .e164Number("e164Number")\n .phoneNumberType(FormattedPhoneNumber.PhoneNumberType.FIXED_LINE)\n .build())\n .build();\n CompletedThirdPartyCallResponse completedThirdPartyCallResponse = client.crm().extensions().calling().transcripts().createInboundCall(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.Transcripts.NewInboundCall', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompletedThirdPartyCallResponse, err := client.Crm.Extensions.Calling.Transcripts.NewInboundCall(context.TODO(), crm.ExtensionCallingTranscriptNewInboundCallParams{\n\t\tCompletedThirdPartyCallRequest: crm.CompletedThirdPartyCallRequestParam{\n\t\t\tCreateEngagement: true,\n\t\t\tEngagementProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tExternalCallID: "externalCallId",\n\t\t\tFinalCallStatus: crm.CompletedThirdPartyCallRequestFinalCallStatusBusy,\n\t\t\tFromNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t\tPotentialRecipientUserIDs: []int64{0},\n\t\t\tToNumber: crm.FormattedPhoneNumberParam{\n\t\t\t\tE164Number: "e164Number",\n\t\t\t\tPhoneNumberType: crm.FormattedPhoneNumberPhoneNumberTypeFixedLine,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", completedThirdPartyCallResponse.CallerIDMatches)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.transcripts.create_inbound_call', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompleted_third_party_call_response = hubspot.crm.extensions.calling.transcripts.create_inbound_call(\n create_engagement: true,\n engagement_properties: {foo: "string"},\n external_call_id: "externalCallId",\n final_call_status: :BUSY,\n from_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE},\n potential_recipient_user_ids: [0],\n to_number: {e164Number: "e164Number", phoneNumberType: :FIXED_LINE}\n)\n\nputs(completed_third_party_call_response)', - }, - php: { - method: 'crm->extensions->calling->transcripts->createInboundCall', - example: - "crm\n ->extensions\n ->calling\n ->transcripts\n ->createInboundCall(\n createEngagement: true,\n engagementProperties: ['foo' => 'string'],\n externalCallID: 'externalCallId',\n finalCallStatus: 'BUSY',\n fromNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n potentialRecipientUserIDs: [0],\n toNumber: [\n 'e164Number' => 'e164Number',\n 'phoneNumberType' => 'FIXED_LINE',\n 'extension' => 'extension',\n ],\n callStartedTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n durationSeconds: 0,\n userID: 0,\n);\n\nvar_dump($completedThirdPartyCallResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/inbound-call \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createEngagement": true,\n "engagementProperties": {\n "foo": "string"\n },\n "externalCallId": "externalCallId",\n "finalCallStatus": "BUSY",\n "fromNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n },\n "potentialRecipientUserIds": [\n 0\n ],\n "toNumber": {\n "e164Number": "e164Number",\n "phoneNumberType": "FIXED_LINE"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', - httpMethod: 'delete', - summary: '', - description: '', - stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) delete', - qualified: 'client.crm.extensions.calling.transcripts.delete', - params: ['transcriptId: string;'], - markdown: - "## delete\n\n`client.crm.extensions.calling.transcripts.delete(transcriptId: string): void`\n\n**delete** `/crm/extensions/calling/2026-03/transcripts/{transcriptId}`\n\n### Parameters\n\n- `transcriptId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.calling.transcripts.delete('transcriptId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.transcripts.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.calling.transcripts.delete('transcriptId');", - }, - python: { - method: 'crm.extensions.calling.transcripts.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.calling.transcripts.delete(\n "transcriptId",\n)', - }, - java: { - method: 'crm().extensions().calling().transcripts().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().calling().transcripts().delete("transcriptId");\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.Transcripts.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.Calling.Transcripts.Delete(context.TODO(), "transcriptId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.transcripts.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.calling.transcripts.delete("transcriptId")\n\nputs(result)', - }, - php: { - method: 'crm->extensions->calling->transcripts->delete', - example: - "crm->extensions->calling->transcripts->delete(\n 'transcriptId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts/$TRANSCRIPT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.extensions.calling.transcripts > (method) get', - qualified: 'client.crm.extensions.calling.transcripts.get', - params: ['transcriptId: string;'], - response: - "{ id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: speaker; }[]; updatedAt: string; }", - markdown: - "## get\n\n`client.crm.extensions.calling.transcripts.get(transcriptId: string): { id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: transcript_utterance[]; updatedAt: string; }`\n\n**get** `/crm/extensions/calling/2026-03/transcripts/{transcriptId}`\n\n### Parameters\n\n- `transcriptId: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; engagementId: number; transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'; transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: speaker; }[]; updatedAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `engagementId: number`\n - `transcriptSource: 'HUBSPOT_GENERATED' | 'INTEGRATOR_GENERATED'`\n - `transcriptUtterances: { id: string; endTimeMillis: number; startTimeMillis: number; text: string; languageCode?: string; speaker?: { id: string; name: string; email?: string; }; }[]`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst transcriptResponse = await client.crm.extensions.calling.transcripts.get('transcriptId');\n\nconsole.log(transcriptResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.calling.transcripts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst transcriptResponse = await client.crm.extensions.calling.transcripts.get('transcriptId');\n\nconsole.log(transcriptResponse.id);", - }, - python: { - method: 'crm.extensions.calling.transcripts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ntranscript_response = client.crm.extensions.calling.transcripts.get(\n "transcriptId",\n)\nprint(transcript_response.id)', - }, - java: { - method: 'crm().extensions().calling().transcripts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptGetParams;\nimport com.hubspot.sdk.models.crm.extensions.calling.transcripts.TranscriptResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TranscriptResponse transcriptResponse = client.crm().extensions().calling().transcripts().get("transcriptId");\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.Calling.Transcripts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\ttranscriptResponse, err := client.Crm.Extensions.Calling.Transcripts.Get(context.TODO(), "transcriptId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", transcriptResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.extensions.calling.transcripts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ntranscript_response = hubspot.crm.extensions.calling.transcripts.get("transcriptId")\n\nputs(transcript_response)', - }, - php: { - method: 'crm->extensions->calling->transcripts->get', - example: - "crm->extensions->calling->transcripts->get(\n 'transcriptId'\n);\n\nvar_dump($transcriptResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/calling/2026-03/transcripts/$TRANSCRIPT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}', - httpMethod: 'post', - summary: 'Create a new card', - description: 'Defines a new card that will become active on an account when this app is installed.', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) create', - qualified: 'client.crm.extensions.cardsDev.create', - params: [ - 'appId: number;', - 'actions: { baseUrls: string[]; };', - "display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; };", - "fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; serverlessFunction?: string; };", - 'title: string;', - ], - response: - "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", - markdown: - "## create\n\n`client.crm.extensions.cardsDev.create(appId: number, actions: { baseUrls: string[]; }, display: { properties: card_display_property[]; }, fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: card_object_type_body[]; targetUrl: string; serverlessFunction?: string; }, title: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**post** `/crm/extensions/cards-dev/2026-03/{appId}`\n\nDefines a new card that will become active on an account when this app is installed.\n\n### Parameters\n\n- `appId: number`\n\n- `actions: { baseUrls: string[]; }`\n - `baseUrls: string[]`\n A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.\n\n- `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: { label: string; name: string; type: 'DANGER' | 'DEFAULT' | 'INFO' | 'SUCCESS' | 'WARNING'; }[]; }[]`\n Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.\n\n- `fetch: { cardType: 'EXTERNAL' | 'SERVERLESS'; objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; serverlessFunction?: string; }`\n - `cardType: 'EXTERNAL' | 'SERVERLESS'`\n A deprecated field to determine the type of card returned.\n - `objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]`\n An array of CRM object types where this card should be displayed. HubSpot will call your data fetch URL whenever a user visits a record page of the types defined here.\n - `targetUrl: string`\n URL to a service endpoints that will respond with card details. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.\n - `serverlessFunction?: string`\n A deprecated field to specify serverless functionality with the card\n\n- `title: string`\n The top-level title for this card. Displayed to users in the CRM UI.\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.create(0, {\n actions: { baseUrls: ['string'] },\n display: { properties: [{\n dataType: 'BOOLEAN',\n label: 'label',\n name: 'name',\n options: [{\n label: 'label',\n name: 'name',\n type: 'DANGER',\n}],\n}] },\n fetch: {\n cardType: 'EXTERNAL',\n objectTypes: [{ name: 'companies', propertiesToSend: ['string'] }],\n targetUrl: 'targetUrl',\n},\n title: 'title',\n});\n\nconsole.log(publicCardResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.create(0, {\n actions: { baseUrls: ['string'] },\n display: {\n properties: [\n {\n dataType: 'BOOLEAN',\n label: 'label',\n name: 'name',\n options: [\n {\n label: 'label',\n name: 'name',\n type: 'DANGER',\n },\n ],\n },\n ],\n },\n fetch: {\n cardType: 'EXTERNAL',\n objectTypes: [{ name: 'companies', propertiesToSend: ['string'] }],\n targetUrl: 'targetUrl',\n },\n title: 'title',\n});\n\nconsole.log(publicCardResponse.id);", - }, - python: { - method: 'crm.extensions.cards_dev.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.create(\n app_id=0,\n actions={\n "base_urls": ["string"]\n },\n display={\n "properties": [{\n "data_type": "BOOLEAN",\n "label": "label",\n "name": "name",\n "options": [{\n "label": "label",\n "name": "name",\n "type": "DANGER",\n }],\n }]\n },\n fetch={\n "card_type": "EXTERNAL",\n "object_types": [{\n "name": "companies",\n "properties_to_send": ["string"],\n }],\n "target_url": "targetUrl",\n },\n title="title",\n)\nprint(public_card_response.id)', - }, - java: { - method: 'crm().extensions().cardsDev().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardActions;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardCreateRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardDisplayBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardDisplayProperty;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardFetchBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardObjectTypeBody;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevCreateParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.DisplayOption;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevCreateParams params = CardsDevCreateParams.builder()\n .appId(0)\n .cardCreateRequest(CardCreateRequest.builder()\n .actions(CardActions.builder()\n .addBaseUrl("string")\n .build())\n .display(CardDisplayBody.builder()\n .addProperty(CardDisplayProperty.builder()\n .dataType(CardDisplayProperty.DataType.BOOLEAN)\n .label("label")\n .name("name")\n .addOption(DisplayOption.builder()\n .label("label")\n .name("name")\n .type(DisplayOption.Type.DANGER)\n .build())\n .build())\n .build())\n .fetch(CardFetchBody.builder()\n .cardType(CardFetchBody.CardType.EXTERNAL)\n .addObjectType(CardObjectTypeBody.builder()\n .name(CardObjectTypeBody.Name.COMPANIES)\n .addPropertiesToSend("string")\n .build())\n .targetUrl("targetUrl")\n .build())\n .title("title")\n .build())\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.New(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCardsDevNewParams{\n\t\t\tCardCreateRequest: crm.CardCreateRequestParam{\n\t\t\t\tActions: crm.CardActionsParam{\n\t\t\t\t\tBaseURLs: []string{"string"},\n\t\t\t\t},\n\t\t\t\tDisplay: crm.CardDisplayBodyParam{\n\t\t\t\t\tProperties: []crm.CardDisplayPropertyParam{{\n\t\t\t\t\t\tDataType: crm.CardDisplayPropertyDataTypeBoolean,\n\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\tOptions: []crm.DisplayOptionParam{{\n\t\t\t\t\t\t\tLabel: "label",\n\t\t\t\t\t\t\tName: "name",\n\t\t\t\t\t\t\tType: crm.DisplayOptionTypeDanger,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t},\n\t\t\t\tFetch: crm.CardFetchBodyParam{\n\t\t\t\t\tCardType: crm.CardFetchBodyCardTypeExternal,\n\t\t\t\t\tObjectTypes: []crm.CardObjectTypeBodyParam{{\n\t\t\t\t\t\tName: crm.CardObjectTypeBodyNameCompanies,\n\t\t\t\t\t\tPropertiesToSend: []string{"string"},\n\t\t\t\t\t}},\n\t\t\t\t\tTargetURL: "targetUrl",\n\t\t\t\t},\n\t\t\t\tTitle: "title",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.create(\n 0,\n actions: {baseUrls: ["string"]},\n display_: {\n properties: [\n {dataType: :BOOLEAN, label: "label", name: "name", options: [{label: "label", name: "name", type: :DANGER}]}\n ]\n },\n fetch: {cardType: :EXTERNAL, objectTypes: [{name: :companies, propertiesToSend: ["string"]}], targetUrl: "targetUrl"},\n title: "title"\n)\n\nputs(public_card_response)', - }, - php: { - method: 'crm->extensions->cardsDev->create', - example: - "crm->extensions->cardsDev->create(\n 0,\n actions: ['baseURLs' => ['string']],\n display: [\n 'properties' => [\n [\n 'dataType' => 'BOOLEAN',\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n ['label' => 'label', 'name' => 'name', 'type' => 'DANGER']\n ],\n ],\n ],\n ],\n fetch: [\n 'cardType' => 'EXTERNAL',\n 'objectTypes' => [\n ['name' => 'companies', 'propertiesToSend' => ['string']]\n ],\n 'targetURL' => 'targetUrl',\n 'serverlessFunction' => 'serverlessFunction',\n ],\n title: 'title',\n);\n\nvar_dump($publicCardResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "actions": {\n "baseUrls": [\n "string"\n ]\n },\n "display": {\n "properties": [\n {\n "dataType": "BOOLEAN",\n "label": "label",\n "name": "name",\n "options": [\n {\n "label": "label",\n "name": "name",\n "type": "DANGER"\n }\n ]\n }\n ]\n },\n "fetch": {\n "cardType": "EXTERNAL",\n "objectTypes": [\n {\n "name": "companies",\n "propertiesToSend": [\n "string"\n ]\n }\n ],\n "targetUrl": "targetUrl"\n },\n "title": "title"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - httpMethod: 'delete', - summary: 'Delete a card', - description: - "Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.", - stainlessPath: '(resource) crm.extensions.cards_dev > (method) delete', - qualified: 'client.crm.extensions.cardsDev.delete', - params: ['appId: number;', 'cardId: string;'], - markdown: - "## delete\n\n`client.crm.extensions.cardsDev.delete(appId: number, cardId: string): void`\n\n**delete** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nPermanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can't be undone.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.cardsDev.delete('cardId', { appId: 0 })\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.cardsDev.delete('cardId', { appId: 0 });", - }, - python: { - method: 'crm.extensions.cards_dev.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.cards_dev.delete(\n card_id="cardId",\n app_id=0,\n)', - }, - java: { - method: 'crm().extensions().cardsDev().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevDeleteParams params = CardsDevDeleteParams.builder()\n .appId(0)\n .cardId("cardId")\n .build();\n client.crm().extensions().cardsDev().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.CardsDev.Delete(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.cards_dev.delete("cardId", app_id: 0)\n\nputs(result)', - }, - php: { - method: 'crm->extensions->cardsDev->delete', - example: - "crm->extensions->cardsDev->delete('cardId', appID: 0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}', - httpMethod: 'get', - summary: 'Get all cards', - description: 'Returns a list of cards for a given app.', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) get', - qualified: 'client.crm.extensions.cardsDev.get', - params: ['appId: number;'], - response: - '{ results: { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }[]; }', - markdown: - "## get\n\n`client.crm.extensions.cardsDev.get(appId: number): { results: public_card_response[]; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/{appId}`\n\nReturns a list of cards for a given app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ results: { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }[]; }`\n\n - `results: { id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardListResponse = await client.crm.extensions.cardsDev.get(0);\n\nconsole.log(publicCardListResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardListResponse = await client.crm.extensions.cardsDev.get(0);\n\nconsole.log(publicCardListResponse.results);", - }, - python: { - method: 'crm.extensions.cards_dev.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_list_response = client.crm.extensions.cards_dev.get(\n 0,\n)\nprint(public_card_list_response.results)', - }, - java: { - method: 'crm().extensions().cardsDev().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardListResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCardListResponse publicCardListResponse = client.crm().extensions().cardsDev().get(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardListResponse, err := client.Crm.Extensions.CardsDev.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardListResponse.Results)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_list_response = hubspot.crm.extensions.cards_dev.get(0)\n\nputs(public_card_list_response)', - }, - php: { - method: 'crm->extensions->cardsDev->get', - example: - "crm->extensions->cardsDev->get(0);\n\nvar_dump($publicCardListResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_id', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - httpMethod: 'get', - summary: 'Get a card.', - description: 'Returns the definition for a card with the given ID.', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) get_by_id', - qualified: 'client.crm.extensions.cardsDev.getByID', - params: ['appId: number;', 'cardId: string;'], - response: - "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", - markdown: - "## get_by_id\n\n`client.crm.extensions.cardsDev.getByID(appId: number, cardId: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nReturns the definition for a card with the given ID.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.getByID('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.getByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.getByID('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse.id);", - }, - python: { - method: 'crm.extensions.cards_dev.get_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.get_by_id(\n card_id="cardId",\n app_id=0,\n)\nprint(public_card_response.id)', - }, - java: { - method: 'crm().extensions().cardsDev().getById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetByIdParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevGetByIdParams params = CardsDevGetByIdParams.builder()\n .appId(0)\n .cardId("cardId")\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().getById(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.GetByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.GetByID(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevGetByIDParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.get_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.get_by_id("cardId", app_id: 0)\n\nputs(public_card_response)', - }, - php: { - method: 'crm->extensions->cardsDev->getByID', - example: - "crm->extensions->cardsDev->getByID(\n 'cardId', appID: 0\n);\n\nvar_dump($publicCardResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_sample_response', - endpoint: '/crm/extensions/cards-dev/2026-03/sample-response', - httpMethod: 'get', - summary: 'Get sample card detail response', - description: - 'Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) get_sample_response', - qualified: 'client.crm.extensions.cardsDev.getSampleResponse', - response: - "{ responseVersion: 'v1' | 'v3'; sections: { id: string; actions: action_hook_action_body | i_frame_action_body[]; title: string; tokens: object_token[]; linkUrl?: string; }[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: { secondary: action_hook_action_body | i_frame_action_body[]; primary?: action_hook_action_body | i_frame_action_body; settings?: i_frame_action_body; }; }", - markdown: - "## get_sample_response\n\n`client.crm.extensions.cardsDev.getSampleResponse(): { responseVersion: 'v1' | 'v3'; sections: integrator_object_result[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: top_level_actions; }`\n\n**get** `/crm/extensions/cards-dev/2026-03/sample-response`\n\nReturns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.\n\n### Returns\n\n- `{ responseVersion: 'v1' | 'v3'; sections: { id: string; actions: action_hook_action_body | i_frame_action_body[]; title: string; tokens: object_token[]; linkUrl?: string; }[]; totalCount: number; allItemsLinkUrl?: string; cardLabel?: string; topLevelActions?: { secondary: action_hook_action_body | i_frame_action_body[]; primary?: action_hook_action_body | i_frame_action_body; settings?: i_frame_action_body; }; }`\n\n - `responseVersion: 'v1' | 'v3'`\n - `sections: { id: string; actions: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }[]; title: string; tokens: { value: string; dataType?: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label?: string; name?: string; }[]; linkUrl?: string; }[]`\n - `totalCount: number`\n - `allItemsLinkUrl?: string`\n - `cardLabel?: string`\n - `topLevelActions?: { secondary: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }[]; primary?: { httpMethod: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'; propertyNamesIncluded: string[]; type: 'ACTION_HOOK'; url: string; confirmation?: action_confirmation_body; label?: string; } | { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }; settings?: { height: number; propertyNamesIncluded: string[]; type: 'IFRAME'; url: string; width: number; label?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst integratorCardPayloadResponse = await client.crm.extensions.cardsDev.getSampleResponse();\n\nconsole.log(integratorCardPayloadResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.getSampleResponse', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst integratorCardPayloadResponse = await client.crm.extensions.cardsDev.getSampleResponse();\n\nconsole.log(integratorCardPayloadResponse.responseVersion);", - }, - python: { - method: 'crm.extensions.cards_dev.get_sample_response', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nintegrator_card_payload_response = client.crm.extensions.cards_dev.get_sample_response()\nprint(integrator_card_payload_response.response_version)', - }, - java: { - method: 'crm().extensions().cardsDev().getSampleResponse', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevGetSampleResponseParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.IntegratorCardPayloadResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IntegratorCardPayloadResponse integratorCardPayloadResponse = client.crm().extensions().cardsDev().getSampleResponse();\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.GetSampleResponse', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintegratorCardPayloadResponse, err := client.Crm.Extensions.CardsDev.GetSampleResponse(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", integratorCardPayloadResponse.ResponseVersion)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.get_sample_response', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nintegrator_card_payload_response = hubspot.crm.extensions.cards_dev.get_sample_response\n\nputs(integrator_card_payload_response)', - }, - php: { - method: 'crm->extensions->cardsDev->getSampleResponse', - example: - "crm\n ->extensions\n ->cardsDev\n ->getSampleResponse();\n\nvar_dump($integratorCardPayloadResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/sample-response \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'migrate_views', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/views/migrate', - httpMethod: 'post', - summary: 'Migrate Card Views', - description: - 'Swaps a Legacy CRM Card with an App Card in views. Reference the "Migrate a legacy CRM card to an app card" docs for more information', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) migrate_views', - qualified: 'client.crm.extensions.cardsDev.migrateViews', - params: [ - 'appId: number;', - 'allowDuplicateAppCardIds: boolean;', - 'appCardId: number;', - 'legacyCrmCardId: number;', - 'helpdeskAppCardId?: number;', - ], - response: - '{ message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }', - markdown: - '## migrate_views\n\n`client.crm.extensions.cardsDev.migrateViews(appId: number, allowDuplicateAppCardIds: boolean, appCardId: number, legacyCrmCardId: number, helpdeskAppCardId?: number): { message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }`\n\n**post** `/crm/extensions/cards-dev/2026-03/{appId}/views/migrate`\n\nSwaps a Legacy CRM Card with an App Card in views. Reference the "Migrate a legacy CRM card to an app card" docs for more information\n\n### Parameters\n\n- `appId: number`\n\n- `allowDuplicateAppCardIds: boolean`\n\n- `appCardId: number`\n\n- `legacyCrmCardId: number`\n\n- `helpdeskAppCardId?: number`\n\n### Returns\n\n- `{ message: string; endedAt?: number; remainingPortalCount?: number; startedAt?: number; totalPortalCount?: number; }`\n\n - `message: string`\n - `endedAt?: number`\n - `remainingPortalCount?: number`\n - `startedAt?: number`\n - `totalPortalCount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from \'@hubspot/sdk\';\n\nconst client = new HubSpot();\n\nconst cardMigrateViewsResponse = await client.crm.extensions.cardsDev.migrateViews(0, {\n allowDuplicateAppCardIds: true,\n appCardId: 0,\n legacyCrmCardId: 0,\n});\n\nconsole.log(cardMigrateViewsResponse);\n```', - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.migrateViews', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst cardMigrateViewsResponse = await client.crm.extensions.cardsDev.migrateViews(0, {\n allowDuplicateAppCardIds: true,\n appCardId: 0,\n legacyCrmCardId: 0,\n});\n\nconsole.log(cardMigrateViewsResponse.message);", - }, - python: { - method: 'crm.extensions.cards_dev.migrate_views', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncard_migrate_views_response = client.crm.extensions.cards_dev.migrate_views(\n app_id=0,\n allow_duplicate_app_card_ids=True,\n app_card_id=0,\n legacy_crm_card_id=0,\n)\nprint(card_migrate_views_response.message)', - }, - java: { - method: 'crm().extensions().cardsDev().migrateViews', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardMigrateViewsRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardMigrateViewsResponse;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevMigrateViewsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevMigrateViewsParams params = CardsDevMigrateViewsParams.builder()\n .appId(0)\n .cardMigrateViewsRequest(CardMigrateViewsRequest.builder()\n .allowDuplicateAppCardIds(true)\n .appCardId(0L)\n .legacyCrmCardId(0L)\n .build())\n .build();\n CardMigrateViewsResponse cardMigrateViewsResponse = client.crm().extensions().cardsDev().migrateViews(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.MigrateViews', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcardMigrateViewsResponse, err := client.Crm.Extensions.CardsDev.MigrateViews(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionCardsDevMigrateViewsParams{\n\t\t\tCardMigrateViewsRequest: crm.CardMigrateViewsRequestParam{\n\t\t\t\tAllowDuplicateAppCardIDs: true,\n\t\t\t\tAppCardID: 0,\n\t\t\t\tLegacyCrmCardID: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", cardMigrateViewsResponse.Message)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.migrate_views', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncard_migrate_views_response = hubspot.crm.extensions.cards_dev.migrate_views(\n 0,\n allow_duplicate_app_card_ids: true,\n app_card_id: 0,\n legacy_crm_card_id: 0\n)\n\nputs(card_migrate_views_response)', - }, - php: { - method: 'crm->extensions->cardsDev->migrateViews', - example: - "crm->extensions->cardsDev->migrateViews(\n 0,\n allowDuplicateAppCardIDs: true,\n appCardID: 0,\n legacyCrmCardID: 0,\n helpdeskAppCardID: 0,\n);\n\nvar_dump($cardMigrateViewsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/views/migrate \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowDuplicateAppCardIds": true,\n "appCardId": 0,\n "legacyCrmCardId": 0\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - httpMethod: 'patch', - summary: 'Update a card', - description: 'Update a card definition with new details.', - stainlessPath: '(resource) crm.extensions.cards_dev > (method) update', - qualified: 'client.crm.extensions.cardsDev.update', - params: [ - 'appId: number;', - 'cardId: string;', - 'actions?: { baseUrls: string[]; };', - "display?: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; };", - "fetch?: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; };", - 'title?: string;', - ], - response: - "{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }", - markdown: - "## update\n\n`client.crm.extensions.cardsDev.update(appId: number, cardId: string, actions?: { baseUrls: string[]; }, display?: { properties: card_display_property[]; }, fetch?: { objectTypes: card_object_type_body[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; }, title?: string): { id: string; actions: card_actions; auditHistory: card_audit_response[]; display: card_display_body; fetch: public_card_fetch_body; title: string; createdAt?: string; updatedAt?: string; }`\n\n**patch** `/crm/extensions/cards-dev/2026-03/{appId}/{cardId}`\n\nUpdate a card definition with new details.\n\n### Parameters\n\n- `appId: number`\n\n- `cardId: string`\n\n- `actions?: { baseUrls: string[]; }`\n - `baseUrls: string[]`\n A list of URL prefixes that will be accepted for card action URLs. If your data fetch response includes an action URL that doesn't begin with one of these values, it will result in an error and the card will not be displayed.\n\n- `display?: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: { label: string; name: string; type: 'DANGER' | 'DEFAULT' | 'INFO' | 'SUCCESS' | 'WARNING'; }[]; }[]`\n Card display properties. These will will be rendered as \"label : value\" pairs in the card UI. See the [example card](#) in the overview docs for more details.\n\n- `fetch?: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; cardType?: 'EXTERNAL' | 'SERVERLESS'; serverlessFunction?: string; targetUrl?: string; }`\n - `objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]`\n An array of CRM object types where this card should be displayed. HubSpot will call your target URL whenever a user visits a record page of the types defined here.\n - `cardType?: 'EXTERNAL' | 'SERVERLESS'`\n A deprecated field to determine the type of card returned.\n - `serverlessFunction?: string`\n A deprecated field to specify serverless functionality with the card\n - `targetUrl?: string`\n URL to a service endpoint that will respond with details for this card. HubSpot will call this endpoint each time a user visits a CRM record page where this card should be displayed.\n\n- `title?: string`\n The top-level title for this card. Displayed to users in the CRM UI.\n\n### Returns\n\n- `{ id: string; actions: { baseUrls: string[]; }; auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]; display: { properties: card_display_property[]; }; fetch: { objectTypes: card_object_type_body[]; targetUrl: string; }; title: string; createdAt?: string; updatedAt?: string; }`\n\n - `id: string`\n - `actions: { baseUrls: string[]; }`\n - `auditHistory: { actionType: 'CREATE' | 'DELETE' | 'UPDATE'; applicationId: number; authSource: 'APP' | 'EXTERNAL' | 'INTERNAL'; changedAt: number; initiatingUserId: number; objectTypeId: number; }[]`\n - `display: { properties: { dataType: 'BOOLEAN' | 'CURRENCY' | 'DATE' | 'DATETIME' | 'EMAIL' | 'LINK' | 'NUMERIC' | 'STATUS' | 'STRING'; label: string; name: string; options: display_option[]; }[]; }`\n - `fetch: { objectTypes: { name: 'companies' | 'contacts' | 'deals' | 'marketing_events' | 'tickets'; propertiesToSend: string[]; }[]; targetUrl: string; }`\n - `title: string`\n - `createdAt?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.update('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.cardsDev.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCardResponse = await client.crm.extensions.cardsDev.update('cardId', { appId: 0 });\n\nconsole.log(publicCardResponse.id);", - }, - python: { - method: 'crm.extensions.cards_dev.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_card_response = client.crm.extensions.cards_dev.update(\n card_id="cardId",\n app_id=0,\n)\nprint(public_card_response.id)', - }, - java: { - method: 'crm().extensions().cardsDev().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardPatchRequest;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.CardsDevUpdateParams;\nimport com.hubspot.sdk.models.crm.extensions.cardsdev.PublicCardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CardsDevUpdateParams params = CardsDevUpdateParams.builder()\n .appId(0)\n .cardId("cardId")\n .cardPatchRequest(CardPatchRequest.builder().build())\n .build();\n PublicCardResponse publicCardResponse = client.crm().extensions().cardsDev().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.CardsDev.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCardResponse, err := client.Crm.Extensions.CardsDev.Update(\n\t\tcontext.TODO(),\n\t\t"cardId",\n\t\tcrm.ExtensionCardsDevUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tCardPatchRequest: crm.CardPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCardResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.extensions.cards_dev.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_card_response = hubspot.crm.extensions.cards_dev.update("cardId", app_id: 0)\n\nputs(public_card_response)', - }, - php: { - method: 'crm->extensions->cardsDev->update', - example: - "crm->extensions->cardsDev->update(\n 'cardId',\n appID: 0,\n actions: ['baseURLs' => ['string']],\n display: [\n 'properties' => [\n [\n 'dataType' => 'BOOLEAN',\n 'label' => 'label',\n 'name' => 'name',\n 'options' => [\n ['label' => 'label', 'name' => 'name', 'type' => 'DANGER']\n ],\n ],\n ],\n ],\n fetch: [\n 'objectTypes' => [\n ['name' => 'companies', 'propertiesToSend' => ['string']]\n ],\n 'cardType' => 'EXTERNAL',\n 'serverlessFunction' => 'serverlessFunction',\n 'targetURL' => 'targetUrl',\n ],\n title: 'title',\n);\n\nvar_dump($publicCardResponse);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/extensions/cards-dev/2026-03/$APP_ID/$CARD_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - httpMethod: 'delete', - summary: 'Delete settings', - description: 'Delete video conference extension settings for your app', - stainlessPath: '(resource) crm.extensions.video_conferencing > (method) delete', - qualified: 'client.crm.extensions.videoConferencing.delete', - params: ['appId: number;'], - markdown: - "## delete\n\n`client.crm.extensions.videoConferencing.delete(appId: number): void`\n\n**delete** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nDelete video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.extensions.videoConferencing.delete(0)\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.videoConferencing.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.extensions.videoConferencing.delete(0);", - }, - python: { - method: 'crm.extensions.video_conferencing.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.extensions.video_conferencing.delete(\n 0,\n)', - }, - java: { - method: 'crm().extensions().videoConferencing().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().extensions().videoConferencing().delete(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.VideoConferencing.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Extensions.VideoConferencing.Delete(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.extensions.video_conferencing.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.extensions.video_conferencing.delete(0)\n\nputs(result)', - }, - php: { - method: 'crm->extensions->videoConferencing->delete', - example: - "crm->extensions->videoConferencing->delete(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - httpMethod: 'get', - summary: 'Get settings', - description: 'Fetch video conference extension settings for your app', - stainlessPath: '(resource) crm.extensions.video_conferencing > (method) get', - qualified: 'client.crm.extensions.videoConferencing.get', - params: ['appId: number;'], - response: - '{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }', - markdown: - "## get\n\n`client.crm.extensions.videoConferencing.get(appId: number): { createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n**get** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nFetch video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n - `createMeetingUrl: string`\n - `deleteMeetingUrl?: string`\n - `fetchAccountsUri?: string`\n - `updateMeetingUrl?: string`\n - `userVerifyUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalSettings = await client.crm.extensions.videoConferencing.get(0);\n\nconsole.log(externalSettings);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.videoConferencing.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalSettings = await client.crm.extensions.videoConferencing.get(0);\n\nconsole.log(externalSettings.createMeetingUrl);", - }, - python: { - method: 'crm.extensions.video_conferencing.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_settings = client.crm.extensions.video_conferencing.get(\n 0,\n)\nprint(external_settings.create_meeting_url)', - }, - java: { - method: 'crm().extensions().videoConferencing().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.ExternalSettings;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalSettings externalSettings = client.crm().extensions().videoConferencing().get(0);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.VideoConferencing.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalSettings, err := client.Crm.Extensions.VideoConferencing.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalSettings.CreateMeetingURL)\n}\n', - }, - ruby: { - method: 'crm.extensions.video_conferencing.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_settings = hubspot.crm.extensions.video_conferencing.get(0)\n\nputs(external_settings)', - }, - php: { - method: 'crm->extensions->videoConferencing->get', - example: - "crm->extensions->videoConferencing->get(0);\n\nvar_dump($externalSettings);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - httpMethod: 'put', - summary: 'Create or update settings', - description: 'Create or update video conference extension settings for your app', - stainlessPath: '(resource) crm.extensions.video_conferencing > (method) update', - qualified: 'client.crm.extensions.videoConferencing.update', - params: [ - 'appId: number;', - 'createMeetingUrl: string;', - 'deleteMeetingUrl?: string;', - 'fetchAccountsUri?: string;', - 'updateMeetingUrl?: string;', - 'userVerifyUrl?: string;', - ], - response: - '{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }', - markdown: - "## update\n\n`client.crm.extensions.videoConferencing.update(appId: number, createMeetingUrl: string, deleteMeetingUrl?: string, fetchAccountsUri?: string, updateMeetingUrl?: string, userVerifyUrl?: string): { createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n**put** `/crm/extensions/videoconferencing/2026-03/settings/{appId}`\n\nCreate or update video conference extension settings for your app\n\n### Parameters\n\n- `appId: number`\n\n- `createMeetingUrl: string`\n\n- `deleteMeetingUrl?: string`\n\n- `fetchAccountsUri?: string`\n\n- `updateMeetingUrl?: string`\n\n- `userVerifyUrl?: string`\n\n### Returns\n\n- `{ createMeetingUrl: string; deleteMeetingUrl?: string; fetchAccountsUri?: string; updateMeetingUrl?: string; userVerifyUrl?: string; }`\n\n - `createMeetingUrl: string`\n - `deleteMeetingUrl?: string`\n - `fetchAccountsUri?: string`\n - `updateMeetingUrl?: string`\n - `userVerifyUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalSettings = await client.crm.extensions.videoConferencing.update(0, { createMeetingUrl: 'createMeetingUrl' });\n\nconsole.log(externalSettings);\n```", - perLanguage: { - typescript: { - method: 'client.crm.extensions.videoConferencing.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalSettings = await client.crm.extensions.videoConferencing.update(0, {\n createMeetingUrl: 'createMeetingUrl',\n});\n\nconsole.log(externalSettings.createMeetingUrl);", - }, - python: { - method: 'crm.extensions.video_conferencing.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_settings = client.crm.extensions.video_conferencing.update(\n app_id=0,\n create_meeting_url="createMeetingUrl",\n)\nprint(external_settings.create_meeting_url)', - }, - java: { - method: 'crm().extensions().videoConferencing().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.ExternalSettings;\nimport com.hubspot.sdk.models.crm.extensions.videoconferencing.VideoConferencingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n VideoConferencingUpdateParams params = VideoConferencingUpdateParams.builder()\n .appId(0)\n .externalSettings(ExternalSettings.builder()\n .createMeetingUrl("createMeetingUrl")\n .build())\n .build();\n ExternalSettings externalSettings = client.crm().extensions().videoConferencing().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Extensions.VideoConferencing.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalSettings, err := client.Crm.Extensions.VideoConferencing.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ExtensionVideoConferencingUpdateParams{\n\t\t\tExternalSettings: crm.ExternalSettingsParam{\n\t\t\t\tCreateMeetingURL: "createMeetingUrl",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalSettings.CreateMeetingURL)\n}\n', - }, - ruby: { - method: 'crm.extensions.video_conferencing.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_settings = hubspot.crm.extensions.video_conferencing.update(0, create_meeting_url: "createMeetingUrl")\n\nputs(external_settings)', - }, - php: { - method: 'crm->extensions->videoConferencing->update', - example: - "crm->extensions->videoConferencing->update(\n 0,\n createMeetingURL: 'createMeetingUrl',\n deleteMeetingURL: 'deleteMeetingUrl',\n fetchAccountsUri: 'fetchAccountsUri',\n updateMeetingURL: 'updateMeetingUrl',\n userVerifyURL: 'userVerifyUrl',\n);\n\nvar_dump($externalSettings);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/extensions/videoconferencing/2026-03/settings/$APP_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "createMeetingUrl": "createMeetingUrl"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', - httpMethod: 'delete', - summary: "Delete an app's feature flag", - description: - 'Delete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated.', - stainlessPath: '(resource) crm.feature_flags > (method) delete', - qualified: 'client.crm.featureFlags.delete', - params: ['appId: number;', 'flagName: string;'], - response: - "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", - markdown: - "## delete\n\n`client.crm.featureFlags.delete(appId: number, flagName: string): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**delete** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nDelete a feature flag in an app. For example, delete the `hs-release-app-cards` flag after all accounts have been migrated.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.delete('flagName', { appId: 0 });\n\nconsole.log(flagResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.delete('flagName', { appId: 0 });\n\nconsole.log(flagResponse.overrideState);", - }, - python: { - method: 'crm.feature_flags.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.delete(\n flag_name="flagName",\n app_id=0,\n)\nprint(flag_response.override_state)', - }, - java: { - method: 'crm().featureFlags().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagDeleteParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagDeleteParams params = FeatureFlagDeleteParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Delete(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagDeleteParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.delete("flagName", app_id: 0)\n\nputs(flag_response)', - }, - php: { - method: 'crm->featureFlags->delete', - example: - "crm->featureFlags->delete('flagName', appID: 0);\n\nvar_dump($flagResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_portal_state', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - httpMethod: 'delete', - summary: 'Delete an account flag state', - description: - 'Delete an account-level flag state for a specific HubSpot account. No request body is included.', - stainlessPath: '(resource) crm.feature_flags > (method) delete_portal_state', - qualified: 'client.crm.featureFlags.deletePortalState', - params: ['appId: number;', 'flagName: string;', 'portalId: number;'], - response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", - markdown: - "## delete_portal_state\n\n`client.crm.featureFlags.deletePortalState(appId: number, flagName: string, portalId: number): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**delete** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nDelete an account-level flag state for a specific HubSpot account. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.deletePortalState(0, { appId: 0, flagName: 'flagName' });\n\nconsole.log(portalFlagStateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.deletePortalState', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.deletePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n});\n\nconsole.log(portalFlagStateResponse.appId);", - }, - python: { - method: 'crm.feature_flags.delete_portal_state', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.delete_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n)\nprint(portal_flag_state_response.app_id)', - }, - java: { - method: 'crm().featureFlags().deletePortalState', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagDeletePortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagDeletePortalStateParams params = FeatureFlagDeletePortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().deletePortalState(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.DeletePortalState', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.DeletePortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagDeletePortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.delete_portal_state', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.delete_portal_state(0, app_id: 0, flag_name: "flagName")\n\nputs(portal_flag_state_response)', - }, - php: { - method: 'crm->featureFlags->deletePortalState', - example: - "crm->featureFlags->deletePortalState(\n 0, appID: 0, flagName: 'flagName'\n);\n\nvar_dump($portalFlagStateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', - httpMethod: 'get', - summary: "Retrieve an app's feature flags", - description: "Retrieve the current status of the app's feature flags. No request body is included.", - stainlessPath: '(resource) crm.feature_flags > (method) get', - qualified: 'client.crm.featureFlags.get', - params: ['appId: number;', 'flagName: string;'], - response: - "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", - markdown: - "## get\n\n`client.crm.featureFlags.get(appId: number, flagName: string): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nRetrieve the current status of the app's feature flags. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.get('flagName', { appId: 0 });\n\nconsole.log(flagResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.get('flagName', { appId: 0 });\n\nconsole.log(flagResponse.overrideState);", - }, - python: { - method: 'crm.feature_flags.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.get(\n flag_name="flagName",\n app_id=0,\n)\nprint(flag_response.override_state)', - }, - java: { - method: 'crm().featureFlags().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagGetParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagGetParams params = FeatureFlagGetParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Get(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagGetParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.get("flagName", app_id: 0)\n\nputs(flag_response)', - }, - php: { - method: 'crm->featureFlags->get', - example: - "crm->featureFlags->get('flagName', appID: 0);\n\nvar_dump($flagResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_portal_state', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - httpMethod: 'get', - summary: 'Retrieve account flag state', - description: 'Retrieve the account-level flag state of a specific HubSpot account.', - stainlessPath: '(resource) crm.feature_flags > (method) get_portal_state', - qualified: 'client.crm.featureFlags.getPortalState', - params: ['appId: number;', 'flagName: string;', 'portalId: number;'], - response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", - markdown: - "## get_portal_state\n\n`client.crm.featureFlags.getPortalState(appId: number, flagName: string, portalId: number): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nRetrieve the account-level flag state of a specific HubSpot account.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.getPortalState(0, { appId: 0, flagName: 'flagName' });\n\nconsole.log(portalFlagStateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.getPortalState', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.getPortalState(0, {\n appId: 0,\n flagName: 'flagName',\n});\n\nconsole.log(portalFlagStateResponse.appId);", - }, - python: { - method: 'crm.feature_flags.get_portal_state', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.get_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n)\nprint(portal_flag_state_response.app_id)', - }, - java: { - method: 'crm().featureFlags().getPortalState', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagGetPortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagGetPortalStateParams params = FeatureFlagGetPortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().getPortalState(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.GetPortalState', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.GetPortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagGetPortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.get_portal_state', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.get_portal_state(0, app_id: 0, flag_name: "flagName")\n\nputs(portal_flag_state_response)', - }, - php: { - method: 'crm->featureFlags->getPortalState', - example: - "crm->featureFlags->getPortalState(\n 0, appID: 0, flagName: 'flagName'\n);\n\nvar_dump($portalFlagStateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_all', - endpoint: '/feature-flags/2026-03/{appId}/flags/all', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.feature_flags > (method) list_all', - qualified: 'client.crm.featureFlags.listAll', - params: ['appId: number;'], - response: '{ flagsForApp: string[]; }', - markdown: - "## list_all\n\n`client.crm.featureFlags.listAll(appId: number): { flagsForApp: string[]; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/all`\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ flagsForApp: string[]; }`\n\n - `flagsForApp: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagsForAppResponse = await client.crm.featureFlags.listAll(0);\n\nconsole.log(flagsForAppResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.listAll', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagsForAppResponse = await client.crm.featureFlags.listAll(0);\n\nconsole.log(flagsForAppResponse.flagsForApp);", - }, - python: { - method: 'crm.feature_flags.list_all', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflags_for_app_response = client.crm.feature_flags.list_all(\n 0,\n)\nprint(flags_for_app_response.flags_for_app)', - }, - java: { - method: 'crm().featureFlags().listAll', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagListAllParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagsForAppResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FlagsForAppResponse flagsForAppResponse = client.crm().featureFlags().listAll(0);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.ListAll', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagsForAppResponse, err := client.Crm.FeatureFlags.ListAll(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagsForAppResponse.FlagsForApp)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.list_all', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflags_for_app_response = hubspot.crm.feature_flags.list_all(0)\n\nputs(flags_for_app_response)', - }, - php: { - method: 'crm->featureFlags->listAll', - example: - "crm->featureFlags->listAll(0);\n\nvar_dump($flagsForAppResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/all \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_portals', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals', - httpMethod: 'get', - summary: 'Retrieve accounts with a set flag state', - description: - 'Retrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included.', - stainlessPath: '(resource) crm.feature_flags > (method) list_portals', - qualified: 'client.crm.featureFlags.listPortals', - params: ['appId: number;', 'flagName: string;', 'limit?: number;', 'startPortalId?: number;'], - response: - "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", - markdown: - "## list_portals\n\n`client.crm.featureFlags.listPortals(appId: number, flagName: string, limit?: number, startPortalId?: number): { portalFlagStates: portal_flag_state_response[]; }`\n\n**get** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals`\n\nRetrieve a list of HubSpot accounts with an account-level flag setting for the specified app. No request body is included.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `startPortalId?: number`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.listPortals('flagName', { appId: 0 });\n\nconsole.log(portalFlagStateBatchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.listPortals', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.listPortals('flagName', {\n appId: 0,\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", - }, - python: { - method: 'crm.feature_flags.list_portals', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.list_portals(\n flag_name="flagName",\n app_id=0,\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', - }, - java: { - method: 'crm().featureFlags().listPortals', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagListPortalsParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagListPortalsParams params = FeatureFlagListPortalsParams.builder()\n .appId(0)\n .flagName("flagName")\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().listPortals(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.ListPortals', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.ListPortals(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagListPortalsParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.list_portals', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.list_portals("flagName", app_id: 0)\n\nputs(portal_flag_state_batch_response)', - }, - php: { - method: 'crm->featureFlags->listPortals', - example: - "crm->featureFlags->listPortals(\n 'flagName', appID: 0, limit: 0, startPortalID: 0\n);\n\nvar_dump($portalFlagStateBatchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}', - httpMethod: 'put', - summary: "Set an app's feature flag", - description: - "Set a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs.", - stainlessPath: '(resource) crm.feature_flags > (method) update', - qualified: 'client.crm.featureFlags.update', - params: [ - 'appId: number;', - 'flagName: string;', - "defaultState: 'ABSENT' | 'OFF' | 'ON';", - "overrideState?: 'ABSENT' | 'OFF' | 'ON';", - ], - response: - "{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }", - markdown: - "## update\n\n`client.crm.featureFlags.update(appId: number, flagName: string, defaultState: 'ABSENT' | 'OFF' | 'ON', overrideState?: 'ABSENT' | 'OFF' | 'ON'): { appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n**put** `/feature-flags/2026-03/{appId}/flags/{flagName}`\n\nSet a feature flag for an app. For example, update the `hs-hide-crm-cards` flag's `defaultState` to `ON` to hide classic CRM cards from new installs.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n The state that the flag should have if there are no overrides for a particular portal\n\n- `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n A flag value that supercedes all other overrides, including portal-level values. Mostly used for things like emergency overrides\n\n### Returns\n\n- `{ appId: number; defaultState: 'ABSENT' | 'OFF' | 'ON'; flagName: string; overrideState?: 'ABSENT' | 'OFF' | 'ON'; }`\n\n - `appId: number`\n - `defaultState: 'ABSENT' | 'OFF' | 'ON'`\n - `flagName: string`\n - `overrideState?: 'ABSENT' | 'OFF' | 'ON'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst flagResponse = await client.crm.featureFlags.update('flagName', { appId: 0, defaultState: 'ABSENT' });\n\nconsole.log(flagResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst flagResponse = await client.crm.featureFlags.update('flagName', {\n appId: 0,\n defaultState: 'ABSENT',\n});\n\nconsole.log(flagResponse.overrideState);", - }, - python: { - method: 'crm.feature_flags.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nflag_response = client.crm.feature_flags.update(\n flag_name="flagName",\n app_id=0,\n default_state="ABSENT",\n)\nprint(flag_response.override_state)', - }, - java: { - method: 'crm().featureFlags().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagUpdateParams;\nimport com.hubspot.sdk.models.crm.featureflags.FlagPutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.FlagResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagUpdateParams params = FeatureFlagUpdateParams.builder()\n .appId(0)\n .flagName("flagName")\n .flagPutRequest(FlagPutRequest.builder()\n .defaultState(FlagPutRequest.DefaultState.ABSENT)\n .build())\n .build();\n FlagResponse flagResponse = client.crm().featureFlags().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tflagResponse, err := client.Crm.FeatureFlags.Update(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagUpdateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagPutRequest: crm.FlagPutRequestParam{\n\t\t\t\tDefaultState: crm.FlagPutRequestDefaultStateAbsent,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", flagResponse.OverrideState)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nflag_response = hubspot.crm.feature_flags.update("flagName", app_id: 0, default_state: :ABSENT)\n\nputs(flag_response)', - }, - php: { - method: 'crm->featureFlags->update', - example: - "crm->featureFlags->update(\n 'flagName', appID: 0, defaultState: 'ABSENT', overrideState: 'ABSENT'\n);\n\nvar_dump($flagResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "defaultState": "ABSENT"\n }\'', - }, - }, - }, - { - name: 'update_portal_state', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - httpMethod: 'put', - summary: 'Set an account flag state', - description: 'Specify an account-level flag state for a specific HubSpot account.', - stainlessPath: '(resource) crm.feature_flags > (method) update_portal_state', - qualified: 'client.crm.featureFlags.updatePortalState', - params: [ - 'appId: number;', - 'flagName: string;', - 'portalId: number;', - "flagState: 'ABSENT' | 'OFF' | 'ON';", - ], - response: "{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }", - markdown: - "## update_portal_state\n\n`client.crm.featureFlags.updatePortalState(appId: number, flagName: string, portalId: number, flagState: 'ABSENT' | 'OFF' | 'ON'): { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n**put** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}`\n\nSpecify an account-level flag state for a specific HubSpot account.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalId: number`\n\n- `flagState: 'ABSENT' | 'OFF' | 'ON'`\n The state that the given flag should be in for this portal\n\n### Returns\n\n- `{ appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }`\n\n - `appId: number`\n - `flagName: string`\n - `flagState: 'ABSENT' | 'OFF' | 'ON'`\n - `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateResponse = await client.crm.featureFlags.updatePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n flagState: 'ABSENT',\n});\n\nconsole.log(portalFlagStateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.updatePortalState', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateResponse = await client.crm.featureFlags.updatePortalState(0, {\n appId: 0,\n flagName: 'flagName',\n flagState: 'ABSENT',\n});\n\nconsole.log(portalFlagStateResponse.appId);", - }, - python: { - method: 'crm.feature_flags.update_portal_state', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_response = client.crm.feature_flags.update_portal_state(\n portal_id=0,\n app_id=0,\n flag_name="flagName",\n flag_state="ABSENT",\n)\nprint(portal_flag_state_response.app_id)', - }, - java: { - method: 'crm().featureFlags().updatePortalState', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.FeatureFlagUpdatePortalStateParams;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStatePutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeatureFlagUpdatePortalStateParams params = FeatureFlagUpdatePortalStateParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalId(0)\n .portalFlagStatePutRequest(PortalFlagStatePutRequest.builder()\n .flagState(PortalFlagStatePutRequest.FlagState.ABSENT)\n .build())\n .build();\n PortalFlagStateResponse portalFlagStateResponse = client.crm().featureFlags().updatePortalState(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.UpdatePortalState', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateResponse, err := client.Crm.FeatureFlags.UpdatePortalState(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.FeatureFlagUpdatePortalStateParams{\n\t\t\tAppID: 0,\n\t\t\tFlagName: "flagName",\n\t\t\tPortalFlagStatePutRequest: crm.PortalFlagStatePutRequestParam{\n\t\t\t\tFlagState: crm.PortalFlagStatePutRequestFlagStateAbsent,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateResponse.AppID)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.update_portal_state', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_response = hubspot.crm.feature_flags.update_portal_state(0, app_id: 0, flag_name: "flagName", flag_state: :ABSENT)\n\nputs(portal_flag_state_response)', - }, - php: { - method: 'crm->featureFlags->updatePortalState', - example: - "crm->featureFlags->updatePortalState(\n 0, appID: 0, flagName: 'flagName', flagState: 'ABSENT'\n);\n\nvar_dump($portalFlagStateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/$PORTAL_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "flagState": "ABSENT"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete', - httpMethod: 'post', - summary: 'Batch delete account flag state', - description: - 'Delete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.', - stainlessPath: '(resource) crm.feature_flags.batch > (method) delete', - qualified: 'client.crm.featureFlags.batch.delete', - params: ['appId: number;', 'flagName: string;', 'portalIds: number[];'], - response: - "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", - markdown: - "## delete\n\n`client.crm.featureFlags.batch.delete(appId: number, flagName: string, portalIds: number[]): { portalFlagStates: portal_flag_state_response[]; }`\n\n**post** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete`\n\nDelete an account-level flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalIds: number[]`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.delete('flagName', { appId: 0, portalIds: [0] });\n\nconsole.log(portalFlagStateBatchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.delete('flagName', {\n appId: 0,\n portalIds: [0],\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", - }, - python: { - method: 'crm.feature_flags.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.batch.delete(\n flag_name="flagName",\n app_id=0,\n portal_ids=[0],\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', - }, - java: { - method: 'crm().featureFlags().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchDeleteRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\nimport com.hubspot.sdk.models.crm.featureflags.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalFlagStateBatchDeleteRequest(PortalFlagStateBatchDeleteRequest.builder()\n .addPortalId(0)\n .build())\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagBatchDeleteParams{\n\t\t\tAppID: 0,\n\t\t\tPortalFlagStateBatchDeleteRequest: crm.PortalFlagStateBatchDeleteRequestParam{\n\t\t\t\tPortalIDs: []int64{0},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.batch.delete("flagName", app_id: 0, portal_ids: [0])\n\nputs(portal_flag_state_batch_response)', - }, - php: { - method: 'crm->featureFlags->batch->delete', - example: - "crm->featureFlags->batch->delete(\n 'flagName', appID: 0, portalIDs: [0]\n);\n\nvar_dump($portalFlagStateBatchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/batch/delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "portalIds": [\n 0\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert', - httpMethod: 'post', - summary: 'Batch set account flag state', - description: - 'Set the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.', - stainlessPath: '(resource) crm.feature_flags.batch > (method) upsert', - qualified: 'client.crm.featureFlags.batch.upsert', - params: [ - 'appId: number;', - 'flagName: string;', - "portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[];", - ], - response: - "{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }", - markdown: - "## upsert\n\n`client.crm.featureFlags.batch.upsert(appId: number, flagName: string, portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]): { portalFlagStates: portal_flag_state_response[]; }`\n\n**post** `/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert`\n\nSet the portal flag state for multiple HubSpot accounts at once. Use this endpoint to manage flag exposure for groups of HubSpot accounts.\n\n### Parameters\n\n- `appId: number`\n\n- `flagName: string`\n\n- `portalStates: { flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Returns\n\n- `{ portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]; }`\n\n - `portalFlagStates: { appId: number; flagName: string; flagState: 'ABSENT' | 'OFF' | 'ON'; portalId: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.upsert('flagName', { appId: 0, portalStates: [{ flagState: 'ABSENT', portalId: 0 }] });\n\nconsole.log(portalFlagStateBatchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.featureFlags.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalFlagStateBatchResponse = await client.crm.featureFlags.batch.upsert('flagName', {\n appId: 0,\n portalStates: [{ flagState: 'ABSENT', portalId: 0 }],\n});\n\nconsole.log(portalFlagStateBatchResponse.portalFlagStates);", - }, - python: { - method: 'crm.feature_flags.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_flag_state_batch_response = client.crm.feature_flags.batch.upsert(\n flag_name="flagName",\n app_id=0,\n portal_states=[{\n "flag_state": "ABSENT",\n "portal_id": 0,\n }],\n)\nprint(portal_flag_state_batch_response.portal_flag_states)', - }, - java: { - method: 'crm().featureFlags().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.featureflags.BatchPortalEntry;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchPutRequest;\nimport com.hubspot.sdk.models.crm.featureflags.PortalFlagStateBatchResponse;\nimport com.hubspot.sdk.models.crm.featureflags.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .appId(0)\n .flagName("flagName")\n .portalFlagStateBatchPutRequest(PortalFlagStateBatchPutRequest.builder()\n .addPortalState(BatchPortalEntry.builder()\n .flagState(BatchPortalEntry.FlagState.ABSENT)\n .portalId(0)\n .build())\n .build())\n .build();\n PortalFlagStateBatchResponse portalFlagStateBatchResponse = client.crm().featureFlags().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.FeatureFlags.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalFlagStateBatchResponse, err := client.Crm.FeatureFlags.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"flagName",\n\t\tcrm.FeatureFlagBatchUpsertParams{\n\t\t\tAppID: 0,\n\t\t\tPortalFlagStateBatchPutRequest: crm.PortalFlagStateBatchPutRequestParam{\n\t\t\t\tPortalStates: []crm.BatchPortalEntryParam{{\n\t\t\t\t\tFlagState: crm.BatchPortalEntryFlagStateAbsent,\n\t\t\t\t\tPortalID: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalFlagStateBatchResponse.PortalFlagStates)\n}\n', - }, - ruby: { - method: 'crm.feature_flags.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_flag_state_batch_response = hubspot.crm.feature_flags.batch.upsert(\n "flagName",\n app_id: 0,\n portal_states: [{flagState: :ABSENT, portalId: 0}]\n)\n\nputs(portal_flag_state_batch_response)', - }, - php: { - method: 'crm->featureFlags->batch->upsert', - example: - "crm->featureFlags->batch->upsert(\n 'flagName',\n appID: 0,\n portalStates: [['flagState' => 'ABSENT', 'portalID' => 0]],\n);\n\nvar_dump($portalFlagStateBatchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/feature-flags/2026-03/$APP_ID/flags/$FLAG_NAME/portals/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "portalStates": [\n {\n "flagState": "ABSENT",\n "portalId": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'cancel', - endpoint: '/crm/imports/2026-03/{importId}/cancel', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.imports > (method) cancel', - qualified: 'client.crm.imports.cancel', - params: ['importId: number;'], - response: - "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## cancel\n\n`client.crm.imports.cancel(importId: number): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/imports/2026-03/{importId}/cancel`\n\n### Parameters\n\n- `importId: number`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst actionResponse = await client.crm.imports.cancel(0);\n\nconsole.log(actionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.imports.cancel', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst actionResponse = await client.crm.imports.cancel(0);\n\nconsole.log(actionResponse.completedAt);", - }, - python: { - method: 'crm.imports.cancel', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naction_response = client.crm.imports.cancel(\n 0,\n)\nprint(action_response.completed_at)', - }, - java: { - method: 'crm().imports().cancel', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ActionResponse;\nimport com.hubspot.sdk.models.crm.imports.ImportCancelParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ActionResponse actionResponse = client.crm().imports().cancel(0L);\n }\n}', - }, - go: { - method: 'client.Crm.Imports.Cancel', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tactionResponse, err := client.Crm.Imports.Cancel(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", actionResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.imports.cancel', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naction_response = hubspot.crm.imports.cancel(0)\n\nputs(action_response)', - }, - php: { - method: 'crm->imports->cancel', - example: - "crm->imports->cancel(0);\n\nvar_dump($actionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID/cancel \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/imports/2026-03', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.imports > (method) create', - qualified: 'client.crm.imports.create', - params: ['files?: string;', 'importRequest?: string;'], - response: - "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", - markdown: - "## create\n\n`client.crm.imports.create(files?: string, importRequest?: string): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**post** `/crm/imports/2026-03`\n\n### Parameters\n\n- `files?: string`\n\n- `importRequest?: string`\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicImportResponse = await client.crm.imports.create();\n\nconsole.log(publicImportResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.imports.create', - example: - "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicImportResponse = await client.crm.imports.create();\n\nconsole.log(publicImportResponse.id);", - }, - python: { - method: 'crm.imports.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_import_response = client.crm.imports.create()\nprint(public_import_response.id)', - }, - java: { - method: 'crm().imports().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportCreateParams;\nimport com.hubspot.sdk.models.crm.imports.PublicImportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicImportResponse publicImportResponse = client.crm().imports().create();\n }\n}', - }, - go: { - method: 'client.Crm.Imports.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicImportResponse, err := client.Crm.Imports.New(context.TODO(), crm.ImportNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicImportResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.imports.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_import_response = hubspot.crm.imports.create\n\nputs(public_import_response)', - }, - php: { - method: 'crm->imports->create', - example: - "crm->imports->create(\n files: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n importRequest: 'importRequest',\n);\n\nvar_dump($publicImportResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/imports/2026-03 \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/imports/2026-03/{importId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.imports > (method) get', - qualified: 'client.crm.imports.get', - params: ['importId: number;'], - response: - "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", - markdown: - "## get\n\n`client.crm.imports.get(importId: number): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**get** `/crm/imports/2026-03/{importId}`\n\n### Parameters\n\n- `importId: number`\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicImportResponse = await client.crm.imports.get(0);\n\nconsole.log(publicImportResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.imports.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicImportResponse = await client.crm.imports.get(0);\n\nconsole.log(publicImportResponse.id);", - }, - python: { - method: 'crm.imports.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_import_response = client.crm.imports.get(\n 0,\n)\nprint(public_import_response.id)', - }, - java: { - method: 'crm().imports().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportGetParams;\nimport com.hubspot.sdk.models.crm.imports.PublicImportResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicImportResponse publicImportResponse = client.crm().imports().get(0L);\n }\n}', - }, - go: { - method: 'client.Crm.Imports.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicImportResponse, err := client.Crm.Imports.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicImportResponse.ID)\n}\n', - }, - ruby: { - method: 'crm.imports.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_import_response = hubspot.crm.imports.get(0)\n\nputs(public_import_response)', - }, - php: { - method: 'crm->imports->get', - example: - "crm->imports->get(0);\n\nvar_dump($publicImportResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/imports/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.imports > (method) list', - qualified: 'client.crm.imports.list', - params: ['after?: string;', 'limit?: number;'], - response: - "{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }", - markdown: - "## list\n\n`client.crm.imports.list(after?: string, limit?: number): { id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: public_import_metadata; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: import_template; }`\n\n**get** `/crm/imports/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: string; mappedObjectTypeIds: string[]; metadata: { counters: object; fileIds: string[]; objectLists: public_object_list_record[]; }; optOutImport: boolean; state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'; updatedAt: string; importName?: string; importRequestJson?: object; importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'; importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `mappedObjectTypeIds: string[]`\n - `metadata: { counters: object; fileIds: string[]; objectLists: { listId: string; objectType: string; }[]; }`\n - `optOutImport: boolean`\n - `state: 'CANCELED' | 'DEFERRED' | 'DONE' | 'FAILED' | 'PROCESSING' | 'REVERTED' | 'STARTED'`\n - `updatedAt: string`\n - `importName?: string`\n - `importRequestJson?: object`\n - `importSource?: 'API' | 'CRM_UI' | 'IMPORT' | 'MOBILE_ANDROID' | 'MOBILE_IOS' | 'SALESFORCE'`\n - `importTemplate?: { templateId: number; templateType: 'admin_defined' | 'previous_import' | 'user_file'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportResponse of client.crm.imports.list()) {\n console.log(publicImportResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.imports.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportResponse of client.crm.imports.list()) {\n console.log(publicImportResponse.id);\n}", - }, - python: { - method: 'crm.imports.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.imports.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().imports().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportListPage;\nimport com.hubspot.sdk.models.crm.imports.ImportListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportListPage page = client.crm().imports().list();\n }\n}', - }, - go: { - method: 'client.Crm.Imports.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Imports.List(context.TODO(), crm.ImportListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.imports.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.imports.list\n\nputs(page)', - }, - php: { - method: 'crm->imports->list', - example: - "crm->imports->list(after: 'after', limit: 0);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/imports/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_errors', - endpoint: '/crm/imports/2026-03/{importId}/errors', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.imports > (method) list_errors', - qualified: 'client.crm.imports.listErrors', - params: [ - 'importId: number;', - 'after?: string;', - 'includeErrorMessage?: boolean;', - 'includeRowData?: boolean;', - 'limit?: number;', - ], - response: - "{ id: string; createdAt: number; errorType: string; sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }; errorMessage?: string; extraContext?: string; invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }", - markdown: - "## list_errors\n\n`client.crm.imports.listErrors(importId: number, after?: string, includeErrorMessage?: boolean, includeRowData?: boolean, limit?: number): { id: string; createdAt: number; errorType: string; sourceData: import_row_core; errorMessage?: string; extraContext?: string; invalidPropertyValue?: property_value; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }`\n\n**get** `/crm/imports/2026-03/{importId}/errors`\n\n### Parameters\n\n- `importId: number`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `includeErrorMessage?: boolean`\n\n- `includeRowData?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; createdAt: number; errorType: string; sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }; errorMessage?: string; extraContext?: string; invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }; invalidValue?: string; invalidValueToDisplay?: string; knownColumnNumber?: number; objectType?: string; objectTypeId?: string; }`\n\n - `id: string`\n - `createdAt: number`\n - `errorType: string`\n - `sourceData: { additionalRowData: string[]; containsEncryptedProperties: boolean; fileId: number; lineNumber: number; rowData: string[]; pageName?: string; }`\n - `errorMessage?: string`\n - `extraContext?: string`\n - `invalidPropertyValue?: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }`\n - `invalidValue?: string`\n - `invalidValueToDisplay?: string`\n - `knownColumnNumber?: number`\n - `objectType?: string`\n - `objectTypeId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportError of client.crm.imports.listErrors(0)) {\n console.log(publicImportError);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.imports.listErrors', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicImportError of client.crm.imports.listErrors(0)) {\n console.log(publicImportError.id);\n}", - }, - python: { - method: 'crm.imports.list_errors', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.imports.list_errors(\n import_id=0,\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().imports().listErrors', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.imports.ImportListErrorsPage;\nimport com.hubspot.sdk.models.crm.imports.ImportListErrorsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportListErrorsPage page = client.crm().imports().listErrors(0L);\n }\n}', - }, - go: { - method: 'client.Crm.Imports.ListErrors', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Imports.ListErrors(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.ImportListErrorsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.imports.list_errors', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.imports.list_errors(0)\n\nputs(page)', - }, - php: { - method: 'crm->imports->listErrors', - example: - "crm->imports->listErrors(\n 0, after: 'after', includeErrorMessage: true, includeRowData: true, limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/imports/2026-03/$IMPORT_ID/errors \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_association_label_limits', - endpoint: '/crm/limits/2026-03/associations/labels', - httpMethod: 'get', - summary: 'Read association label limits', - description: 'Returns limits and usage for custom association labels', - stainlessPath: '(resource) crm.limits > (method) get_association_label_limits', - qualified: 'client.crm.limits.getAssociationLabelLimits', - params: ['fromObjectTypeId?: string;', 'toObjectTypeId?: string;'], - response: - '{ results: { allLabels: string[]; fromObjectType: limits_object_type_definition; limit: number; percentage: number; toObjectType: limits_object_type_definition; usage: number; }[]; }', - markdown: - "## get_association_label_limits\n\n`client.crm.limits.getAssociationLabelLimits(fromObjectTypeId?: string, toObjectTypeId?: string): { results: association_label_limit_response[]; }`\n\n**get** `/crm/limits/2026-03/associations/labels`\n\nReturns limits and usage for custom association labels\n\n### Parameters\n\n- `fromObjectTypeId?: string`\n\n- `toObjectTypeId?: string`\n\n### Returns\n\n- `{ results: { allLabels: string[]; fromObjectType: limits_object_type_definition; limit: number; percentage: number; toObjectType: limits_object_type_definition; usage: number; }[]; }`\n\n - `results: { allLabels: string[]; fromObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; }; limit: number; percentage: number; toObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; }; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseAssociationLabelLimitResponseNoPaging = await client.crm.limits.getAssociationLabelLimits();\n\nconsole.log(collectionResponseAssociationLabelLimitResponseNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getAssociationLabelLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseAssociationLabelLimitResponseNoPaging =\n await client.crm.limits.getAssociationLabelLimits();\n\nconsole.log(collectionResponseAssociationLabelLimitResponseNoPaging.results);", - }, - python: { - method: 'crm.limits.get_association_label_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_association_label_limit_response_no_paging = client.crm.limits.get_association_label_limits()\nprint(collection_response_association_label_limit_response_no_paging.results)', - }, - java: { - method: 'crm().limits().getAssociationLabelLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseAssociationLabelLimitResponseNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationLabelLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseAssociationLabelLimitResponseNoPaging collectionResponseAssociationLabelLimitResponseNoPaging = client.crm().limits().getAssociationLabelLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetAssociationLabelLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseAssociationLabelLimitResponseNoPaging, err := client.Crm.Limits.GetAssociationLabelLimits(context.TODO(), crm.LimitGetAssociationLabelLimitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseAssociationLabelLimitResponseNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.limits.get_association_label_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_association_label_limit_response_no_paging = hubspot.crm.limits.get_association_label_limits\n\nputs(collection_response_association_label_limit_response_no_paging)', - }, - php: { - method: 'crm->limits->getAssociationLabelLimits', - example: - "crm\n ->limits\n ->getAssociationLabelLimits(\n fromObjectTypeID: 'fromObjectTypeId', toObjectTypeID: 'toObjectTypeId'\n);\n\nvar_dump($collectionResponseAssociationLabelLimitResponseNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/associations/labels \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_association_records_limits_by_object_type', - endpoint: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}', - httpMethod: 'get', - summary: 'Read record association limits between two objects', - description: 'Returns records approaching or at association limits between two objects', - stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_by_object_type', - qualified: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', - params: ['fromObjectTypeId: string;', 'toObjectTypeId: string;'], - response: - '{ atLimitFromRecordSamples: { label: string; objectId: number; }[]; limit: number; nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }', - markdown: - "## get_association_records_limits_by_object_type\n\n`client.crm.limits.getAssociationRecordsLimitsByObjectType(fromObjectTypeId: string, toObjectTypeId: string): { atLimitFromRecordSamples: at_limit_record_sample[]; limit: number; nearLimitFromRecordSamples: near_limit_record_sample[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }`\n\n**get** `/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}`\n\nReturns records approaching or at association limits between two objects\n\n### Parameters\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n### Returns\n\n- `{ atLimitFromRecordSamples: { label: string; objectId: number; }[]; limit: number; nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]; totalRecordsAtLimit: number; totalRecordsNearLimit: number; }`\n\n - `atLimitFromRecordSamples: { label: string; objectId: number; }[]`\n - `limit: number`\n - `nearLimitFromRecordSamples: { label: string; objectId: number; percentage: number; usage: number; }[]`\n - `totalRecordsAtLimit: number`\n - `totalRecordsNearLimit: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationRecordLimitResponse = await client.crm.limits.getAssociationRecordsLimitsByObjectType('toObjectTypeId', { fromObjectTypeId: 'fromObjectTypeId' });\n\nconsole.log(associationRecordLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationRecordLimitResponse =\n await client.crm.limits.getAssociationRecordsLimitsByObjectType('toObjectTypeId', {\n fromObjectTypeId: 'fromObjectTypeId',\n });\n\nconsole.log(associationRecordLimitResponse.atLimitFromRecordSamples);", - }, - python: { - method: 'crm.limits.get_association_records_limits_by_object_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_record_limit_response = client.crm.limits.get_association_records_limits_by_object_type(\n to_object_type_id="toObjectTypeId",\n from_object_type_id="fromObjectTypeId",\n)\nprint(association_record_limit_response.at_limit_from_record_samples)', - }, - java: { - method: 'crm().limits().getAssociationRecordsLimitsByObjectType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.AssociationRecordLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsByObjectTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LimitGetAssociationRecordsLimitsByObjectTypeParams params = LimitGetAssociationRecordsLimitsByObjectTypeParams.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build();\n AssociationRecordLimitResponse associationRecordLimitResponse = client.crm().limits().getAssociationRecordsLimitsByObjectType(params);\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetAssociationRecordsLimitsByObjectType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationRecordLimitResponse, err := client.Crm.Limits.GetAssociationRecordsLimitsByObjectType(\n\t\tcontext.TODO(),\n\t\t"toObjectTypeId",\n\t\tcrm.LimitGetAssociationRecordsLimitsByObjectTypeParams{\n\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationRecordLimitResponse.AtLimitFromRecordSamples)\n}\n', - }, - ruby: { - method: 'crm.limits.get_association_records_limits_by_object_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_record_limit_response = hubspot.crm.limits.get_association_records_limits_by_object_type(\n "toObjectTypeId",\n from_object_type_id: "fromObjectTypeId"\n)\n\nputs(association_record_limit_response)', - }, - php: { - method: 'crm->limits->getAssociationRecordsLimitsByObjectType', - example: - "crm\n ->limits\n ->getAssociationRecordsLimitsByObjectType(\n 'toObjectTypeId', fromObjectTypeID: 'fromObjectTypeId'\n);\n\nvar_dump($associationRecordLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/$FROM_OBJECT_TYPE_ID/$TO_OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_association_records_limits_from_objects', - endpoint: '/crm/limits/2026-03/associations/records/from', - httpMethod: 'get', - summary: 'Read record association limits', - description: 'Returns objects with records approaching or at association limits', - stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_from_objects', - qualified: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', - response: - '{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }', - markdown: - "## get_association_records_limits_from_objects\n\n`client.crm.limits.getAssociationRecordsLimitsFromObjects(): { results: object_type_near_or_at_association_limit[]; }`\n\n**get** `/crm/limits/2026-03/associations/records/from`\n\nReturns objects with records approaching or at association limits\n\n### Returns\n\n- `{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }`\n\n - `results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = await client.crm.limits.getAssociationRecordsLimitsFromObjects();\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging =\n await client.crm.limits.getAssociationRecordsLimitsFromObjects();\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.results);", - }, - python: { - method: 'crm.limits.get_association_records_limits_from_objects', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_type_near_or_at_association_limit_no_paging = client.crm.limits.get_association_records_limits_from_objects()\nprint(collection_response_object_type_near_or_at_association_limit_no_paging.results)', - }, - java: { - method: 'crm().limits().getAssociationRecordsLimitsFromObjects', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsFromObjectsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = client.crm().limits().getAssociationRecordsLimitsFromObjects();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetAssociationRecordsLimitsFromObjects', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging, err := client.Crm.Limits.GetAssociationRecordsLimitsFromObjects(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.limits.get_association_records_limits_from_objects', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_type_near_or_at_association_limit_no_paging = hubspot.crm.limits.get_association_records_limits_from_objects\n\nputs(collection_response_object_type_near_or_at_association_limit_no_paging)', - }, - php: { - method: 'crm->limits->getAssociationRecordsLimitsFromObjects', - example: - "crm\n ->limits\n ->getAssociationRecordsLimitsFromObjects();\n\nvar_dump($collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/from \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_association_records_limits_to_objects', - endpoint: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to', - httpMethod: 'get', - summary: 'Read record association limits from an object', - description: 'Returns objects for which the from object has records approaching or at association limits', - stainlessPath: '(resource) crm.limits > (method) get_association_records_limits_to_objects', - qualified: 'client.crm.limits.getAssociationRecordsLimitsToObjects', - params: ['fromObjectTypeId: string;'], - response: - '{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }', - markdown: - "## get_association_records_limits_to_objects\n\n`client.crm.limits.getAssociationRecordsLimitsToObjects(fromObjectTypeId: string): { results: object_type_near_or_at_association_limit[]; }`\n\n**get** `/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to`\n\nReturns objects for which the from object has records approaching or at association limits\n\n### Parameters\n\n- `fromObjectTypeId: string`\n\n### Returns\n\n- `{ results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]; }`\n\n - `results: { hasRecordsAtLimit: boolean; hasRecordsNearLimit: boolean; objectTypeId: string; pluralLabel: string; singularLabel: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = await client.crm.limits.getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getAssociationRecordsLimitsToObjects', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging =\n await client.crm.limits.getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nconsole.log(collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.results);", - }, - python: { - method: 'crm.limits.get_association_records_limits_to_objects', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_type_near_or_at_association_limit_no_paging = client.crm.limits.get_association_records_limits_to_objects(\n "fromObjectTypeId",\n)\nprint(collection_response_object_type_near_or_at_association_limit_no_paging.results)', - }, - java: { - method: 'crm().limits().getAssociationRecordsLimitsToObjects', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging;\nimport com.hubspot.sdk.models.crm.limits.LimitGetAssociationRecordsLimitsToObjectsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging = client.crm().limits().getAssociationRecordsLimitsToObjects("fromObjectTypeId");\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetAssociationRecordsLimitsToObjects', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectTypeNearOrAtAssociationLimitNoPaging, err := client.Crm.Limits.GetAssociationRecordsLimitsToObjects(context.TODO(), "fromObjectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.limits.get_association_records_limits_to_objects', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_type_near_or_at_association_limit_no_paging = hubspot.crm.limits.get_association_records_limits_to_objects("fromObjectTypeId")\n\nputs(collection_response_object_type_near_or_at_association_limit_no_paging)', - }, - php: { - method: 'crm->limits->getAssociationRecordsLimitsToObjects', - example: - "crm\n ->limits\n ->getAssociationRecordsLimitsToObjects('fromObjectTypeId');\n\nvar_dump($collectionResponseObjectTypeNearOrAtAssociationLimitNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/associations/records/$FROM_OBJECT_TYPE_ID/to \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_calculated_property_limits', - endpoint: '/crm/limits/2026-03/calculated-properties', - httpMethod: 'get', - summary: 'Read calculation property limits', - description: 'Returns overall limit and per object usage for calculated properties', - stainlessPath: '(resource) crm.limits > (method) get_calculated_property_limits', - qualified: 'client.crm.limits.getCalculatedPropertyLimits', - response: - '{ byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }', - markdown: - "## get_calculated_property_limits\n\n`client.crm.limits.getCalculatedPropertyLimits(): { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n**get** `/crm/limits/2026-03/calculated-properties`\n\nReturns overall limit and per object usage for calculated properties\n\n### Returns\n\n- `{ byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n - `byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]`\n - `overallLimit: number`\n - `overallPercentage: number`\n - `overallUsage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst calculatedPropertyLimitResponse = await client.crm.limits.getCalculatedPropertyLimits();\n\nconsole.log(calculatedPropertyLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getCalculatedPropertyLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst calculatedPropertyLimitResponse = await client.crm.limits.getCalculatedPropertyLimits();\n\nconsole.log(calculatedPropertyLimitResponse.byObjectType);", - }, - python: { - method: 'crm.limits.get_calculated_property_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncalculated_property_limit_response = client.crm.limits.get_calculated_property_limits()\nprint(calculated_property_limit_response.by_object_type)', - }, - java: { - method: 'crm().limits().getCalculatedPropertyLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CalculatedPropertyLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCalculatedPropertyLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CalculatedPropertyLimitResponse calculatedPropertyLimitResponse = client.crm().limits().getCalculatedPropertyLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetCalculatedPropertyLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcalculatedPropertyLimitResponse, err := client.Crm.Limits.GetCalculatedPropertyLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", calculatedPropertyLimitResponse.ByObjectType)\n}\n', - }, - ruby: { - method: 'crm.limits.get_calculated_property_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncalculated_property_limit_response = hubspot.crm.limits.get_calculated_property_limits\n\nputs(calculated_property_limit_response)', - }, - php: { - method: 'crm->limits->getCalculatedPropertyLimits', - example: - "crm\n ->limits\n ->getCalculatedPropertyLimits();\n\nvar_dump($calculatedPropertyLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/calculated-properties \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_custom_object_type_limits', - endpoint: '/crm/limits/2026-03/custom-object-types', - httpMethod: 'get', - summary: 'Read custom object limits', - description: 'Returns limits and usage for custom object schemas', - stainlessPath: '(resource) crm.limits > (method) get_custom_object_type_limits', - qualified: 'client.crm.limits.getCustomObjectTypeLimits', - response: '{ limit: number; percentage: number; usage: number; }', - markdown: - "## get_custom_object_type_limits\n\n`client.crm.limits.getCustomObjectTypeLimits(): { limit: number; percentage: number; usage: number; }`\n\n**get** `/crm/limits/2026-03/custom-object-types`\n\nReturns limits and usage for custom object schemas\n\n### Returns\n\n- `{ limit: number; percentage: number; usage: number; }`\n\n - `limit: number`\n - `percentage: number`\n - `usage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst customObjectLimitResponse = await client.crm.limits.getCustomObjectTypeLimits();\n\nconsole.log(customObjectLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getCustomObjectTypeLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst customObjectLimitResponse = await client.crm.limits.getCustomObjectTypeLimits();\n\nconsole.log(customObjectLimitResponse.limit);", - }, - python: { - method: 'crm.limits.get_custom_object_type_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncustom_object_limit_response = client.crm.limits.get_custom_object_type_limits()\nprint(custom_object_limit_response.limit)', - }, - java: { - method: 'crm().limits().getCustomObjectTypeLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CustomObjectLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCustomObjectTypeLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomObjectLimitResponse customObjectLimitResponse = client.crm().limits().getCustomObjectTypeLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetCustomObjectTypeLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcustomObjectLimitResponse, err := client.Crm.Limits.GetCustomObjectTypeLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customObjectLimitResponse.Limit)\n}\n', - }, - ruby: { - method: 'crm.limits.get_custom_object_type_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncustom_object_limit_response = hubspot.crm.limits.get_custom_object_type_limits\n\nputs(custom_object_limit_response)', - }, - php: { - method: 'crm->limits->getCustomObjectTypeLimits', - example: - "crm->limits->getCustomObjectTypeLimits();\n\nvar_dump($customObjectLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/custom-object-types \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_custom_property_limits', - endpoint: '/crm/limits/2026-03/custom-properties', - httpMethod: 'get', - summary: 'Read custom property limits', - description: 'Returns limits and usage per object for custom properties', - stainlessPath: '(resource) crm.limits > (method) get_custom_property_limits', - qualified: 'client.crm.limits.getCustomPropertyLimits', - response: - '{ byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }', - markdown: - "## get_custom_property_limits\n\n`client.crm.limits.getCustomPropertyLimits(): { byObjectType: limit_and_usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n**get** `/crm/limits/2026-03/custom-properties`\n\nReturns limits and usage per object for custom properties\n\n### Returns\n\n- `{ byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n\n - `byObjectType: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n - `overallLimit: number`\n - `overallPercentage: number`\n - `overallUsage: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst customPropertyLimitResponse = await client.crm.limits.getCustomPropertyLimits();\n\nconsole.log(customPropertyLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getCustomPropertyLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst customPropertyLimitResponse = await client.crm.limits.getCustomPropertyLimits();\n\nconsole.log(customPropertyLimitResponse.byObjectType);", - }, - python: { - method: 'crm.limits.get_custom_property_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncustom_property_limit_response = client.crm.limits.get_custom_property_limits()\nprint(custom_property_limit_response.by_object_type)', - }, - java: { - method: 'crm().limits().getCustomPropertyLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.CustomPropertyLimitResponse;\nimport com.hubspot.sdk.models.crm.limits.LimitGetCustomPropertyLimitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomPropertyLimitResponse customPropertyLimitResponse = client.crm().limits().getCustomPropertyLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetCustomPropertyLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcustomPropertyLimitResponse, err := client.Crm.Limits.GetCustomPropertyLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", customPropertyLimitResponse.ByObjectType)\n}\n', - }, - ruby: { - method: 'crm.limits.get_custom_property_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncustom_property_limit_response = hubspot.crm.limits.get_custom_property_limits\n\nputs(custom_property_limit_response)', - }, - php: { - method: 'crm->limits->getCustomPropertyLimits', - example: - "crm->limits->getCustomPropertyLimits();\n\nvar_dump($customPropertyLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/custom-properties \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_pipeline_limits', - endpoint: '/crm/limits/2026-03/pipelines', - httpMethod: 'get', - summary: 'Read pipeline limits', - description: 'Returns limits and usage per object for pipelines', - stainlessPath: '(resource) crm.limits > (method) get_pipeline_limits', - qualified: 'client.crm.limits.getPipelineLimits', - response: - '{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }', - markdown: - "## get_pipeline_limits\n\n`client.crm.limits.getPipelineLimits(): { customObjectTypes: custom_object_record_limit_response; hubspotDefinedObjectTypes: limit_and_usage_for_object_type[]; }`\n\n**get** `/crm/limits/2026-03/pipelines`\n\nReturns limits and usage per object for pipelines\n\n### Returns\n\n- `{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }`\n\n - `customObjectTypes: { byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n - `hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineLimitResponse = await client.crm.limits.getPipelineLimits();\n\nconsole.log(pipelineLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getPipelineLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineLimitResponse = await client.crm.limits.getPipelineLimits();\n\nconsole.log(pipelineLimitResponse.customObjectTypes);", - }, - python: { - method: 'crm.limits.get_pipeline_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_limit_response = client.crm.limits.get_pipeline_limits()\nprint(pipeline_limit_response.custom_object_types)', - }, - java: { - method: 'crm().limits().getPipelineLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.LimitGetPipelineLimitsParams;\nimport com.hubspot.sdk.models.crm.limits.PipelineLimitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineLimitResponse pipelineLimitResponse = client.crm().limits().getPipelineLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetPipelineLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineLimitResponse, err := client.Crm.Limits.GetPipelineLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineLimitResponse.CustomObjectTypes)\n}\n', - }, - ruby: { - method: 'crm.limits.get_pipeline_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_limit_response = hubspot.crm.limits.get_pipeline_limits\n\nputs(pipeline_limit_response)', - }, - php: { - method: 'crm->limits->getPipelineLimits', - example: - "crm->limits->getPipelineLimits();\n\nvar_dump($pipelineLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/pipelines \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_record_limits', - endpoint: '/crm/limits/2026-03/records', - httpMethod: 'get', - summary: 'Read record limits', - description: 'Returns limits and usage per object for records', - stainlessPath: '(resource) crm.limits > (method) get_record_limits', - qualified: 'client.crm.limits.getRecordLimits', - response: - '{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }', - markdown: - "## get_record_limits\n\n`client.crm.limits.getRecordLimits(): { customObjectTypes: custom_object_record_limit_response; hubspotDefinedObjectTypes: limit_and_usage_for_object_type[]; }`\n\n**get** `/crm/limits/2026-03/records`\n\nReturns limits and usage per object for records\n\n### Returns\n\n- `{ customObjectTypes: { byObjectType: usage_for_object_type[]; overallLimit: number; overallPercentage: number; overallUsage: number; }; hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]; }`\n\n - `customObjectTypes: { byObjectType: { objectTypeId: string; pluralLabel: string; singularLabel: string; usage: number; }[]; overallLimit: number; overallPercentage: number; overallUsage: number; }`\n - `hubspotDefinedObjectTypes: { limit: number; objectTypeId: string; percentage: number; pluralLabel: string; singularLabel: string; usage: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst recordLimitResponse = await client.crm.limits.getRecordLimits();\n\nconsole.log(recordLimitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.limits.getRecordLimits', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst recordLimitResponse = await client.crm.limits.getRecordLimits();\n\nconsole.log(recordLimitResponse.customObjectTypes);", - }, - python: { - method: 'crm.limits.get_record_limits', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrecord_limit_response = client.crm.limits.get_record_limits()\nprint(record_limit_response.custom_object_types)', - }, - java: { - method: 'crm().limits().getRecordLimits', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.limits.LimitGetRecordLimitsParams;\nimport com.hubspot.sdk.models.crm.limits.RecordLimitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RecordLimitResponse recordLimitResponse = client.crm().limits().getRecordLimits();\n }\n}', - }, - go: { - method: 'client.Crm.Limits.GetRecordLimits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trecordLimitResponse, err := client.Crm.Limits.GetRecordLimits(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", recordLimitResponse.CustomObjectTypes)\n}\n', - }, - ruby: { - method: 'crm.limits.get_record_limits', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrecord_limit_response = hubspot.crm.limits.get_record_limits\n\nputs(record_limit_response)', - }, - php: { - method: 'crm->limits->getRecordLimits', - example: - "crm->limits->getRecordLimits();\n\nvar_dump($recordLimitResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/limits/2026-03/records \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'add_and_remove_memberships', - endpoint: '/crm/lists/2026-03/{listId}/memberships/add-and-remove', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) add_and_remove_memberships', - qualified: 'client.crm.lists.addAndRemoveMemberships', - params: ['listId: string;', 'recordIdsToAdd: string[];', 'recordIdsToRemove: string[];'], - response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', - markdown: - "## add_and_remove_memberships\n\n`client.crm.lists.addAndRemoveMemberships(listId: string, recordIdsToAdd: string[], recordIdsToRemove: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add-and-remove`\n\n### Parameters\n\n- `listId: string`\n\n- `recordIdsToAdd: string[]`\n\n- `recordIdsToRemove: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.addAndRemoveMemberships('listId', { recordIdsToAdd: ['string'], recordIdsToRemove: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.addAndRemoveMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.addAndRemoveMemberships('listId', {\n recordIdsToAdd: ['string'],\n recordIdsToRemove: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", - }, - python: { - method: 'crm.lists.add_and_remove_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.add_and_remove_memberships(\n list_id="listId",\n record_ids_to_add=["string"],\n record_ids_to_remove=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', - }, - java: { - method: 'crm().lists().addAndRemoveMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddAndRemoveMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipChangeRequest;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddAndRemoveMembershipsParams params = ListAddAndRemoveMembershipsParams.builder()\n .listId("listId")\n .membershipChangeRequest(MembershipChangeRequest.builder()\n .addRecordIdsToAdd("string")\n .addRecordIdsToRemove("string")\n .build())\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().addAndRemoveMemberships(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.AddAndRemoveMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.AddAndRemoveMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListAddAndRemoveMembershipsParams{\n\t\t\tMembershipChangeRequest: crm.MembershipChangeRequestParam{\n\t\t\t\tRecordIDsToAdd: []string{"string"},\n\t\t\t\tRecordIDsToRemove: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', - }, - ruby: { - method: 'crm.lists.add_and_remove_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.add_and_remove_memberships(\n "listId",\n record_ids_to_add: ["string"],\n record_ids_to_remove: ["string"]\n)\n\nputs(memberships_update_response)', - }, - php: { - method: 'crm->lists->addAndRemoveMemberships', - example: - "crm->lists->addAndRemoveMemberships(\n 'listId', recordIDsToAdd: ['string'], recordIDsToRemove: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add-and-remove \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "recordIdsToAdd": [\n "string"\n ],\n "recordIdsToRemove": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'add_memberships', - endpoint: '/crm/lists/2026-03/{listId}/memberships/add', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) add_memberships', - qualified: 'client.crm.lists.addMemberships', - params: ['listId: string;', 'body: string[];'], - response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', - markdown: - "## add_memberships\n\n`client.crm.lists.addMemberships(listId: string, body: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add`\n\n### Parameters\n\n- `listId: string`\n\n- `body: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.addMemberships('listId', { body: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.addMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.addMemberships('listId', {\n body: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", - }, - python: { - method: 'crm.lists.add_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.add_memberships(\n list_id="listId",\n body=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', - }, - java: { - method: 'crm().lists().addMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddMembershipsParams params = ListAddMembershipsParams.builder()\n .listId("listId")\n .addBody("string")\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().addMemberships(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.AddMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.AddMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListAddMembershipsParams{\n\t\t\tBody: []string{"string"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', - }, - ruby: { - method: 'crm.lists.add_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.add_memberships("listId", body: ["string"])\n\nputs(memberships_update_response)', - }, - php: { - method: 'crm->lists->addMemberships', - example: - "crm->lists->addMemberships(\n 'listId', body: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', - }, - }, - }, - { - name: 'add_memberships_from', - endpoint: '/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) add_memberships_from', - qualified: 'client.crm.lists.addMembershipsFrom', - params: ['listId: string;', 'sourceListId: string;'], - markdown: - "## add_memberships_from\n\n`client.crm.lists.addMembershipsFrom(listId: string, sourceListId: string): void`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}`\n\n### Parameters\n\n- `listId: string`\n\n- `sourceListId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.addMembershipsFrom('sourceListId', { listId: 'listId' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.addMembershipsFrom', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.addMembershipsFrom('sourceListId', { listId: 'listId' });", - }, - python: { - method: 'crm.lists.add_memberships_from', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.add_memberships_from(\n source_list_id="sourceListId",\n list_id="listId",\n)', - }, - java: { - method: 'crm().lists().addMembershipsFrom', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListAddMembershipsFromParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAddMembershipsFromParams params = ListAddMembershipsFromParams.builder()\n .listId("listId")\n .sourceListId("sourceListId")\n .build();\n client.crm().lists().addMembershipsFrom(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.AddMembershipsFrom', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.AddMembershipsFrom(\n\t\tcontext.TODO(),\n\t\t"sourceListId",\n\t\tcrm.ListAddMembershipsFromParams{\n\t\t\tListID: "listId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.add_memberships_from', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.add_memberships_from("sourceListId", list_id: "listId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->addMembershipsFrom', - example: - "crm->lists->addMembershipsFrom(\n 'sourceListId', listID: 'listId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/add-from/$SOURCE_LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'batch_read_memberships', - endpoint: '/crm/lists/2026-03/records/memberships/batch/read', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) batch_read_memberships', - qualified: 'client.crm.lists.batchReadMemberships', - params: ['inputs: { objectTypeId: string; recordId: string; }[];'], - response: - "{ completedAt: string; results: { objectTypeId: string; recordId: string; recordListMemberships: record_list_membership[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## batch_read_memberships\n\n`client.crm.lists.batchReadMemberships(inputs: { objectTypeId: string; recordId: string; }[]): { completedAt: string; results: record_id_with_memberships[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/lists/2026-03/records/memberships/batch/read`\n\n### Parameters\n\n- `inputs: { objectTypeId: string; recordId: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { objectTypeId: string; recordId: string; recordListMemberships: record_list_membership[]; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { objectTypeId: string; recordId: string; recordListMemberships: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseRecordIDWithMemberships = await client.crm.lists.batchReadMemberships({ inputs: [{ objectTypeId: 'objectTypeId', recordId: 'recordId' }] });\n\nconsole.log(batchResponseRecordIDWithMemberships);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.batchReadMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseRecordIDWithMemberships = await client.crm.lists.batchReadMemberships({\n inputs: [{ objectTypeId: 'objectTypeId', recordId: 'recordId' }],\n});\n\nconsole.log(batchResponseRecordIDWithMemberships.completedAt);", - }, - python: { - method: 'crm.lists.batch_read_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_record_id_with_memberships = client.crm.lists.batch_read_memberships(\n inputs=[{\n "object_type_id": "objectTypeId",\n "record_id": "recordId",\n }],\n)\nprint(batch_response_record_id_with_memberships.completed_at)', - }, - java: { - method: 'crm().lists().batchReadMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.BatchInputRecordIdInput;\nimport com.hubspot.sdk.models.crm.lists.BatchResponseRecordIdWithMemberships;\nimport com.hubspot.sdk.models.crm.lists.RecordIdInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputRecordIdInput params = BatchInputRecordIdInput.builder()\n .addInput(RecordIdInput.builder()\n .objectTypeId("objectTypeId")\n .recordId("recordId")\n .build())\n .build();\n BatchResponseRecordIdWithMemberships batchResponseRecordIdWithMemberships = client.crm().lists().batchReadMemberships(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.BatchReadMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseRecordIDWithMemberships, err := client.Crm.Lists.BatchReadMemberships(context.TODO(), crm.ListBatchReadMembershipsParams{\n\t\tBatchInputRecordIDInput: crm.BatchInputRecordIDInputParam{\n\t\t\tInputs: []crm.RecordIDInputParam{{\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tRecordID: "recordId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseRecordIDWithMemberships.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.lists.batch_read_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_record_id_with_memberships = hubspot.crm.lists.batch_read_memberships(inputs: [{objectTypeId: "objectTypeId", recordId: "recordId"}])\n\nputs(batch_response_record_id_with_memberships)', - }, - php: { - method: 'crm->lists->batchReadMemberships', - example: - "crm\n ->lists\n ->batchReadMemberships(\n inputs: [['objectTypeID' => 'objectTypeId', 'recordID' => 'recordId']]\n);\n\nvar_dump($batchResponseRecordIDWithMemberships);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/records/memberships/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "objectTypeId": "objectTypeId",\n "recordId": "recordId"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/lists/2026-03', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) create', - qualified: 'client.crm.lists.create', - params: [ - 'name: string;', - 'objectTypeId: string;', - 'processingType: string;', - 'customProperties?: object;', - "filterBranch?: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; };", - 'listFolderId?: number;', - 'listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; };', - 'membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; };', - ], - response: - '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', - markdown: - "## create\n\n`client.crm.lists.create(name: string, objectTypeId: string, processingType: string, customProperties?: object, filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }, listFolderId?: number, listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }, membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }): { list: public_object_list; }`\n\n**post** `/crm/lists/2026-03`\n\n### Parameters\n\n- `name: string`\n The name of the list, which must be globally unique across all public lists in the portal.\n\n- `objectTypeId: string`\n The object type ID of the type of objects that the list will store.\n\n- `processingType: string`\n The processing type of the list. One of: `SNAPSHOT`, `MANUAL`, or `DYNAMIC`.\n\n- `customProperties?: object`\n The list of custom properties to tie to the list. Custom property name is the key, the value is the value.\n\n- `filterBranch?: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; }`\n Filter branch object containing filtering criteria for the list\n\n- `listFolderId?: number`\n The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.\n\n- `listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }`\n - `teamsWithEditAccess: number[]`\n - `usersWithEditAccess: number[]`\n\n- `membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }`\n - `includeUnassigned?: boolean`\n Indicates whether unassigned memberships should be included.\n - `membershipTeamId?: number`\n The ID of the team associated with the membership.\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listCreateResponse = await client.crm.lists.create({\n name: 'name',\n objectTypeId: 'objectTypeId',\n processingType: 'processingType',\n});\n\nconsole.log(listCreateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listCreateResponse = await client.crm.lists.create({\n name: 'name',\n objectTypeId: 'objectTypeId',\n processingType: 'processingType',\n});\n\nconsole.log(listCreateResponse.list);", - }, - python: { - method: 'crm.lists.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_create_response = client.crm.lists.create(\n name="name",\n object_type_id="objectTypeId",\n processing_type="processingType",\n)\nprint(list_create_response.list)', - }, - java: { - method: 'crm().lists().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListCreateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListCreateRequest params = ListCreateRequest.builder()\n .name("name")\n .objectTypeId("objectTypeId")\n .processingType("processingType")\n .build();\n ListCreateResponse listCreateResponse = client.crm().lists().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistCreateResponse, err := client.Crm.Lists.New(context.TODO(), crm.ListNewParams{\n\t\tListCreateRequest: crm.ListCreateRequestParam{\n\t\t\tName: "name",\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tProcessingType: "processingType",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listCreateResponse.List)\n}\n', - }, - ruby: { - method: 'crm.lists.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_create_response = hubspot.crm.lists.create(name: "name", object_type_id: "objectTypeId", processing_type: "processingType")\n\nputs(list_create_response)', - }, - php: { - method: 'crm->lists->create', - example: - "crm->lists->create(\n name: 'name',\n objectTypeID: 'objectTypeId',\n processingType: 'processingType',\n customProperties: ['foo' => 'string'],\n filterBranch: [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'eventTypeID' => 'eventTypeId',\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'associationCategory' => 'associationCategory',\n 'associationTypeID' => 0,\n 'filterBranches' => [\n [\n 'filterBranches' => [],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'PROPERTY_ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n 'propertyWithObjectID' => 'propertyWithObjectId',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'UNIFIED_EVENTS',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'operator' => 'HAS_COMPLETED',\n 'coalescingRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n 'pruningRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'RESTRICTED',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ANY',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ALL',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'AND',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n listFolderID: 0,\n listPermissions: ['teamsWithEditAccess' => [0], 'usersWithEditAccess' => [0]],\n membershipSettings: ['includeUnassigned' => true, 'membershipTeamID' => 0],\n);\n\nvar_dump($listCreateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name",\n "objectTypeId": "objectTypeId",\n "processingType": "processingType"\n }\'', - }, - }, - }, - { - name: 'create_folder', - endpoint: '/crm/lists/2026-03/folders', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) create_folder', - qualified: 'client.crm.lists.createFolder', - params: ['name: string;', 'parentFolderId?: string;'], - response: - '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', - markdown: - "## create_folder\n\n`client.crm.lists.createFolder(name: string, parentFolderId?: string): { folder: public_list_folder; }`\n\n**post** `/crm/lists/2026-03/folders`\n\n### Parameters\n\n- `name: string`\n The name of the folder to be created.\n\n- `parentFolderId?: string`\n The folder this should be created in, if not specified will be created in the root folder 0.\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderCreateResponse = await client.crm.lists.createFolder({ name: 'name' });\n\nconsole.log(listFolderCreateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.createFolder', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderCreateResponse = await client.crm.lists.createFolder({ name: 'name' });\n\nconsole.log(listFolderCreateResponse.folder);", - }, - python: { - method: 'crm.lists.create_folder', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_create_response = client.crm.lists.create_folder(\n name="name",\n)\nprint(list_folder_create_response.folder)', - }, - java: { - method: 'crm().lists().createFolder', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderCreateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListFolderCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderCreateRequest params = ListFolderCreateRequest.builder()\n .name("name")\n .build();\n ListFolderCreateResponse listFolderCreateResponse = client.crm().lists().createFolder(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.NewFolder', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderCreateResponse, err := client.Crm.Lists.NewFolder(context.TODO(), crm.ListNewFolderParams{\n\t\tListFolderCreateRequest: crm.ListFolderCreateRequestParam{\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderCreateResponse.Folder)\n}\n', - }, - ruby: { - method: 'crm.lists.create_folder', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_create_response = hubspot.crm.lists.create_folder(name: "name")\n\nputs(list_folder_create_response)', - }, - php: { - method: 'crm->lists->createFolder', - example: - "crm->lists->createFolder(\n name: 'name', parentFolderID: 'parentFolderId'\n);\n\nvar_dump($listFolderCreateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'create_id_mapping', - endpoint: '/crm/lists/2026-03/idmapping', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) create_id_mapping', - qualified: 'client.crm.lists.createIDMapping', - params: ['body: string[];'], - response: - '{ legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]; missingLegacyListIds: string[]; }', - markdown: - "## create_id_mapping\n\n`client.crm.lists.createIDMapping(body: string[]): { legacyListIdsToIdsMapping: public_migration_mapping[]; missingLegacyListIds: string[]; }`\n\n**post** `/crm/lists/2026-03/idmapping`\n\n### Parameters\n\n- `body: string[]`\n\n### Returns\n\n- `{ legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]; missingLegacyListIds: string[]; }`\n\n - `legacyListIdsToIdsMapping: { legacyListId: string; listId: string; }[]`\n - `missingLegacyListIds: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBatchMigrationMapping = await client.crm.lists.createIDMapping({ body: ['string'] });\n\nconsole.log(publicBatchMigrationMapping);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.createIDMapping', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBatchMigrationMapping = await client.crm.lists.createIDMapping({ body: ['string'] });\n\nconsole.log(publicBatchMigrationMapping.legacyListIdsToIdsMapping);", - }, - python: { - method: 'crm.lists.create_id_mapping', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_batch_migration_mapping = client.crm.lists.create_id_mapping(\n body=["string"],\n)\nprint(public_batch_migration_mapping.legacy_list_ids_to_ids_mapping)', - }, - java: { - method: 'crm().lists().createIdMapping', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.PublicBatchMigrationMapping;\nimport java.util.List;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List params = List.of("string");\n PublicBatchMigrationMapping publicBatchMigrationMapping = client.crm().lists().createIdMapping(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.NewIDMapping', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBatchMigrationMapping, err := client.Crm.Lists.NewIDMapping(context.TODO(), crm.ListNewIDMappingParams{\n\t\tBody: []string{"string"},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBatchMigrationMapping.LegacyListIDsToIDsMapping)\n}\n', - }, - ruby: { - method: 'crm.lists.create_id_mapping', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_batch_migration_mapping = hubspot.crm.lists.create_id_mapping(body: ["string"])\n\nputs(public_batch_migration_mapping)', - }, - php: { - method: 'crm->lists->createIDMapping', - example: - "crm->lists->createIDMapping(\n body: ['string']\n);\n\nvar_dump($publicBatchMigrationMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/idmapping \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/lists/2026-03/{listId}', - httpMethod: 'delete', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) delete', - qualified: 'client.crm.lists.delete', - params: ['listId: string;'], - markdown: - "## delete\n\n`client.crm.lists.delete(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.delete('listId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.delete('listId');", - }, - python: { - method: 'crm.lists.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete(\n "listId",\n)', - }, - java: { - method: 'crm().lists().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().delete("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.Delete(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete("listId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->delete', - example: - "crm->lists->delete('listId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_folder', - endpoint: '/crm/lists/2026-03/folders/{folderId}', - httpMethod: 'delete', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) delete_folder', - qualified: 'client.crm.lists.deleteFolder', - params: ['folderId: string;'], - markdown: - "## delete_folder\n\n`client.crm.lists.deleteFolder(folderId: string): void`\n\n**delete** `/crm/lists/2026-03/folders/{folderId}`\n\n### Parameters\n\n- `folderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.deleteFolder('folderId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.deleteFolder', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.deleteFolder('folderId');", - }, - python: { - method: 'crm.lists.delete_folder', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete_folder(\n "folderId",\n)', - }, - java: { - method: 'crm().lists().deleteFolder', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().deleteFolder("folderId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.DeleteFolder', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.DeleteFolder(context.TODO(), "folderId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.delete_folder', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete_folder("folderId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->deleteFolder', - example: - "crm->lists->deleteFolder('folderId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_memberships', - endpoint: '/crm/lists/2026-03/{listId}/memberships', - httpMethod: 'delete', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) delete_memberships', - qualified: 'client.crm.lists.deleteMemberships', - params: ['listId: string;'], - markdown: - "## delete_memberships\n\n`client.crm.lists.deleteMemberships(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}/memberships`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.deleteMemberships('listId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.deleteMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.deleteMemberships('listId');", - }, - python: { - method: 'crm.lists.delete_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.delete_memberships(\n "listId",\n)', - }, - java: { - method: 'crm().lists().deleteMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListDeleteMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().deleteMemberships("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.DeleteMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.DeleteMemberships(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.delete_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.delete_memberships("listId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->deleteMemberships', - example: - "crm->lists->deleteMemberships('listId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/lists/2026-03/{listId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get', - qualified: 'client.crm.lists.get', - params: ['listId: string;', 'includeFilters?: boolean;'], - response: - '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', - markdown: - "## get\n\n`client.crm.lists.get(listId: string, includeFilters?: boolean): { list: public_object_list; }`\n\n**get** `/crm/lists/2026-03/{listId}`\n\n### Parameters\n\n- `listId: string`\n\n- `includeFilters?: boolean`\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFetchResponse = await client.crm.lists.get('listId');\n\nconsole.log(listFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFetchResponse = await client.crm.lists.get('listId');\n\nconsole.log(listFetchResponse.list);", - }, - python: { - method: 'crm.lists.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_fetch_response = client.crm.lists.get(\n list_id="listId",\n)\nprint(list_fetch_response.list)', - }, - java: { - method: 'crm().lists().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFetchResponse listFetchResponse = client.crm().lists().get("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFetchResponse, err := client.Crm.Lists.Get(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFetchResponse.List)\n}\n', - }, - ruby: { - method: 'crm.lists.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_fetch_response = hubspot.crm.lists.get("listId")\n\nputs(list_fetch_response)', - }, - php: { - method: 'crm->lists->get', - example: - "crm->lists->get('listId', includeFilters: true);\n\nvar_dump($listFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_object_type_and_name', - endpoint: '/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_by_object_type_and_name', - qualified: 'client.crm.lists.getByObjectTypeAndName', - params: ['objectTypeId: string;', 'listName: string;', 'includeFilters?: boolean;'], - response: - '{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', - markdown: - "## get_by_object_type_and_name\n\n`client.crm.lists.getByObjectTypeAndName(objectTypeId: string, listName: string, includeFilters?: boolean): { list: public_object_list; }`\n\n**get** `/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}`\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `listName: string`\n\n- `includeFilters?: boolean`\n\n### Returns\n\n- `{ list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `list: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFetchResponse = await client.crm.lists.getByObjectTypeAndName('listName', { objectTypeId: 'objectTypeId' });\n\nconsole.log(listFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getByObjectTypeAndName', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFetchResponse = await client.crm.lists.getByObjectTypeAndName('listName', {\n objectTypeId: 'objectTypeId',\n});\n\nconsole.log(listFetchResponse.list);", - }, - python: { - method: 'crm.lists.get_by_object_type_and_name', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_fetch_response = client.crm.lists.get_by_object_type_and_name(\n list_name="listName",\n object_type_id="objectTypeId",\n)\nprint(list_fetch_response.list)', - }, - java: { - method: 'crm().lists().getByObjectTypeAndName', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListGetByObjectTypeAndNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetByObjectTypeAndNameParams params = ListGetByObjectTypeAndNameParams.builder()\n .objectTypeId("objectTypeId")\n .listName("listName")\n .build();\n ListFetchResponse listFetchResponse = client.crm().lists().getByObjectTypeAndName(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetByObjectTypeAndName', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFetchResponse, err := client.Crm.Lists.GetByObjectTypeAndName(\n\t\tcontext.TODO(),\n\t\t"listName",\n\t\tcrm.ListGetByObjectTypeAndNameParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFetchResponse.List)\n}\n', - }, - ruby: { - method: 'crm.lists.get_by_object_type_and_name', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_fetch_response = hubspot.crm.lists.get_by_object_type_and_name("listName", object_type_id: "objectTypeId")\n\nputs(list_fetch_response)', - }, - php: { - method: 'crm->lists->getByObjectTypeAndName', - example: - "crm->lists->getByObjectTypeAndName(\n 'listName', objectTypeID: 'objectTypeId', includeFilters: true\n);\n\nvar_dump($listFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/object-type-id/$OBJECT_TYPE_ID/name/$LIST_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_id_mapping', - endpoint: '/crm/lists/2026-03/idmapping', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_id_mapping', - qualified: 'client.crm.lists.getIDMapping', - params: ['legacyListId?: string;'], - response: '{ legacyListId: string; listId: string; }', - markdown: - "## get_id_mapping\n\n`client.crm.lists.getIDMapping(legacyListId?: string): { legacyListId: string; listId: string; }`\n\n**get** `/crm/lists/2026-03/idmapping`\n\n### Parameters\n\n- `legacyListId?: string`\n\n### Returns\n\n- `{ legacyListId: string; listId: string; }`\n\n - `legacyListId: string`\n - `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicMigrationMapping = await client.crm.lists.getIDMapping();\n\nconsole.log(publicMigrationMapping);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getIDMapping', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicMigrationMapping = await client.crm.lists.getIDMapping();\n\nconsole.log(publicMigrationMapping.legacyListId);", - }, - python: { - method: 'crm.lists.get_id_mapping', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_migration_mapping = client.crm.lists.get_id_mapping()\nprint(public_migration_mapping.legacy_list_id)', - }, - java: { - method: 'crm().lists().getIdMapping', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetIdMappingParams;\nimport com.hubspot.sdk.models.crm.lists.PublicMigrationMapping;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMigrationMapping publicMigrationMapping = client.crm().lists().getIdMapping();\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetIDMapping', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicMigrationMapping, err := client.Crm.Lists.GetIDMapping(context.TODO(), crm.ListGetIDMappingParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicMigrationMapping.LegacyListID)\n}\n', - }, - ruby: { - method: 'crm.lists.get_id_mapping', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_migration_mapping = hubspot.crm.lists.get_id_mapping\n\nputs(public_migration_mapping)', - }, - php: { - method: 'crm->lists->getIDMapping', - example: - "crm->lists->getIDMapping(\n legacyListID: 'legacyListId'\n);\n\nvar_dump($publicMigrationMapping);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/idmapping \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_memberships_join_order', - endpoint: '/crm/lists/2026-03/{listId}/memberships/join-order', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_memberships_join_order', - qualified: 'client.crm.lists.getMembershipsJoinOrder', - params: ['listId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: '{ membershipTimestamp: string; recordId: string; }', - markdown: - "## get_memberships_join_order\n\n`client.crm.lists.getMembershipsJoinOrder(listId: string, after?: string, before?: string, limit?: number): { membershipTimestamp: string; recordId: string; }`\n\n**get** `/crm/lists/2026-03/{listId}/memberships/join-order`\n\n### Parameters\n\n- `listId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ membershipTimestamp: string; recordId: string; }`\n\n - `membershipTimestamp: string`\n - `recordId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.getMembershipsJoinOrder('listId')) {\n console.log(joinTimeAndRecordID);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getMembershipsJoinOrder', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.getMembershipsJoinOrder('listId')) {\n console.log(joinTimeAndRecordID.membershipTimestamp);\n}", - }, - python: { - method: 'crm.lists.get_memberships_join_order', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.lists.get_memberships_join_order(\n list_id="listId",\n)\npage = page.results[0]\nprint(page.membership_timestamp)', - }, - java: { - method: 'crm().lists().getMembershipsJoinOrder', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetMembershipsJoinOrderPage;\nimport com.hubspot.sdk.models.crm.lists.ListGetMembershipsJoinOrderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetMembershipsJoinOrderPage page = client.crm().lists().getMembershipsJoinOrder("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetMembershipsJoinOrder', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Lists.GetMembershipsJoinOrder(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetMembershipsJoinOrderParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.lists.get_memberships_join_order', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.lists.get_memberships_join_order("listId")\n\nputs(page)', - }, - php: { - method: 'crm->lists->getMembershipsJoinOrder', - example: - "crm->lists->getMembershipsJoinOrder(\n 'listId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/join-order \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_record_memberships', - endpoint: '/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_record_memberships', - qualified: 'client.crm.lists.getRecordMemberships', - params: ['objectTypeId: string;', 'recordId: string;'], - response: - '{ results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; paging?: { next?: next_page; prev?: previous_page; }; total?: number; }', - markdown: - "## get_record_memberships\n\n`client.crm.lists.getRecordMemberships(objectTypeId: string, recordId: string): { results: record_list_membership[]; paging?: paging; total?: number; }`\n\n**get** `/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships`\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `recordId: string`\n\n### Returns\n\n- `{ results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]; paging?: { next?: next_page; prev?: previous_page; }; total?: number; }`\n\n - `results: { firstAddedTimestamp: string; lastAddedTimestamp: string; listId: string; listVersion: number; isPublicList?: boolean; }[]`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n - `total?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst apiCollectionResponseRecordListMembership = await client.crm.lists.getRecordMemberships('recordId', { objectTypeId: 'objectTypeId' });\n\nconsole.log(apiCollectionResponseRecordListMembership);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getRecordMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst apiCollectionResponseRecordListMembership = await client.crm.lists.getRecordMemberships(\n 'recordId',\n { objectTypeId: 'objectTypeId' },\n);\n\nconsole.log(apiCollectionResponseRecordListMembership.results);", - }, - python: { - method: 'crm.lists.get_record_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\napi_collection_response_record_list_membership = client.crm.lists.get_record_memberships(\n record_id="recordId",\n object_type_id="objectTypeId",\n)\nprint(api_collection_response_record_list_membership.results)', - }, - java: { - method: 'crm().lists().getRecordMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ApiCollectionResponseRecordListMembership;\nimport com.hubspot.sdk.models.crm.lists.ListGetRecordMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListGetRecordMembershipsParams params = ListGetRecordMembershipsParams.builder()\n .objectTypeId("objectTypeId")\n .recordId("recordId")\n .build();\n ApiCollectionResponseRecordListMembership apiCollectionResponseRecordListMembership = client.crm().lists().getRecordMemberships(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetRecordMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tapiCollectionResponseRecordListMembership, err := client.Crm.Lists.GetRecordMemberships(\n\t\tcontext.TODO(),\n\t\t"recordId",\n\t\tcrm.ListGetRecordMembershipsParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", apiCollectionResponseRecordListMembership.Results)\n}\n', - }, - ruby: { - method: 'crm.lists.get_record_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\napi_collection_response_record_list_membership = hubspot.crm.lists.get_record_memberships("recordId", object_type_id: "objectTypeId")\n\nputs(api_collection_response_record_list_membership)', - }, - php: { - method: 'crm->lists->getRecordMemberships', - example: - "crm\n ->lists\n ->getRecordMemberships('recordId', objectTypeID: 'objectTypeId');\n\nvar_dump($apiCollectionResponseRecordListMembership);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/records/$OBJECT_TYPE_ID/$RECORD_ID/memberships \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_schedule_conversion', - endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_schedule_conversion', - qualified: 'client.crm.lists.getScheduleConversion', - params: ['listId: string;'], - response: - "{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }", - markdown: - "## get_schedule_conversion\n\n`client.crm.lists.getScheduleConversion(listId: string): { listId: string; convertedAt?: string; requestedConversionTime?: public_list_conversion_date | public_list_conversion_inactivity; }`\n\n**get** `/crm/lists/2026-03/{listId}/schedule-conversion`\n\n### Parameters\n\n- `listId: string`\n\n### Returns\n\n- `{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }`\n\n - `listId: string`\n - `convertedAt?: string`\n - `requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicListConversionResponse = await client.crm.lists.getScheduleConversion('listId');\n\nconsole.log(publicListConversionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getScheduleConversion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicListConversionResponse = await client.crm.lists.getScheduleConversion('listId');\n\nconsole.log(publicListConversionResponse.listId);", - }, - python: { - method: 'crm.lists.get_schedule_conversion', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_list_conversion_response = client.crm.lists.get_schedule_conversion(\n "listId",\n)\nprint(public_list_conversion_response.list_id)', - }, - java: { - method: 'crm().lists().getScheduleConversion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetScheduleConversionParams;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicListConversionResponse publicListConversionResponse = client.crm().lists().getScheduleConversion("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetScheduleConversion', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicListConversionResponse, err := client.Crm.Lists.GetScheduleConversion(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicListConversionResponse.ListID)\n}\n', - }, - ruby: { - method: 'crm.lists.get_schedule_conversion', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_list_conversion_response = hubspot.crm.lists.get_schedule_conversion("listId")\n\nputs(public_list_conversion_response)', - }, - php: { - method: 'crm->lists->getScheduleConversion', - example: - "crm->lists->getScheduleConversion(\n 'listId'\n);\n\nvar_dump($publicListConversionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_size_and_edits_history_between', - endpoint: '/crm/lists/2026-03/{listId}/size-and-edits-history/between', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) get_size_and_edits_history_between', - qualified: 'client.crm.lists.getSizeAndEditsHistoryBetween', - params: ['listId: string;', 'endDate?: string;', 'startDate?: string;'], - response: '{ editHistory: string[]; sizeHistory: { size: number; timestamp: string; }[]; }', - markdown: - "## get_size_and_edits_history_between\n\n`client.crm.lists.getSizeAndEditsHistoryBetween(listId: string, endDate?: string, startDate?: string): { editHistory: string[]; sizeHistory: list_size_data_point[]; }`\n\n**get** `/crm/lists/2026-03/{listId}/size-and-edits-history/between`\n\n### Parameters\n\n- `listId: string`\n\n- `endDate?: string`\n\n- `startDate?: string`\n\n### Returns\n\n- `{ editHistory: string[]; sizeHistory: { size: number; timestamp: string; }[]; }`\n\n - `editHistory: string[]`\n - `sizeHistory: { size: number; timestamp: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listSizeAndEditHistoryResponse = await client.crm.lists.getSizeAndEditsHistoryBetween('listId');\n\nconsole.log(listSizeAndEditHistoryResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.getSizeAndEditsHistoryBetween', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listSizeAndEditHistoryResponse = await client.crm.lists.getSizeAndEditsHistoryBetween(\n 'listId',\n);\n\nconsole.log(listSizeAndEditHistoryResponse.editHistory);", - }, - python: { - method: 'crm.lists.get_size_and_edits_history_between', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_size_and_edit_history_response = client.crm.lists.get_size_and_edits_history_between(\n list_id="listId",\n)\nprint(list_size_and_edit_history_response.edit_history)', - }, - java: { - method: 'crm().lists().getSizeAndEditsHistoryBetween', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListGetSizeAndEditsHistoryBetweenParams;\nimport com.hubspot.sdk.models.crm.lists.ListSizeAndEditHistoryResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListSizeAndEditHistoryResponse listSizeAndEditHistoryResponse = client.crm().lists().getSizeAndEditsHistoryBetween("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.GetSizeAndEditsHistoryBetween', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistSizeAndEditHistoryResponse, err := client.Crm.Lists.GetSizeAndEditsHistoryBetween(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListGetSizeAndEditsHistoryBetweenParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listSizeAndEditHistoryResponse.EditHistory)\n}\n', - }, - ruby: { - method: 'crm.lists.get_size_and_edits_history_between', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_size_and_edit_history_response = hubspot.crm.lists.get_size_and_edits_history_between("listId")\n\nputs(list_size_and_edit_history_response)', - }, - php: { - method: 'crm->lists->getSizeAndEditsHistoryBetween', - example: - "crm\n ->lists\n ->getSizeAndEditsHistoryBetween(\n 'listId',\n endDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n startDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($listSizeAndEditHistoryResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/size-and-edits-history/between \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/lists/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) list', - qualified: 'client.crm.lists.list', - params: ['includeFilters?: boolean;', 'listIds?: string[];'], - response: - '{ lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }[]; }', - markdown: - "## list\n\n`client.crm.lists.list(includeFilters?: boolean, listIds?: string[]): { lists: public_object_list[]; }`\n\n**get** `/crm/lists/2026-03`\n\n### Parameters\n\n- `includeFilters?: boolean`\n\n- `listIds?: string[]`\n\n### Returns\n\n- `{ lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }[]; }`\n\n - `lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listsByIDResponse = await client.crm.lists.list();\n\nconsole.log(listsByIDResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listsByIDResponse = await client.crm.lists.list();\n\nconsole.log(listsByIDResponse.lists);", - }, - python: { - method: 'crm.lists.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlists_by_id_response = client.crm.lists.list()\nprint(lists_by_id_response.lists)', - }, - java: { - method: 'crm().lists().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListListParams;\nimport com.hubspot.sdk.models.crm.lists.ListsByIdResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListsByIdResponse listsByIdResponse = client.crm().lists().list();\n }\n}', - }, - go: { - method: 'client.Crm.Lists.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistsByIDResponse, err := client.Crm.Lists.List(context.TODO(), crm.ListListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listsByIDResponse.Lists)\n}\n', - }, - ruby: { - method: 'crm.lists.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlists_by_id_response = hubspot.crm.lists.list\n\nputs(lists_by_id_response)', - }, - php: { - method: 'crm->lists->list', - example: - "crm->lists->list(\n includeFilters: true, listIDs: ['string']\n);\n\nvar_dump($listsByIDResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_by_search', - endpoint: '/crm/lists/2026-03/search', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) list_by_search', - qualified: 'client.crm.lists.listBySearch', - params: [ - 'listIds: string[];', - 'offset: number;', - 'processingTypes: string[];', - 'additional_filter_properties?: string[];', - 'count?: number;', - 'objectTypeId?: string;', - 'query?: string;', - 'sort?: string;', - ], - response: - '{ hasMore: boolean; lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]; offset: number; total: number; }', - markdown: - "## list_by_search\n\n`client.crm.lists.listBySearch(listIds: string[], offset: number, processingTypes: string[], additional_filter_properties?: string[], count?: number, objectTypeId?: string, query?: string, sort?: string): { hasMore: boolean; lists: public_object_list_search_result[]; offset: number; total: number; }`\n\n**post** `/crm/lists/2026-03/search`\n\n### Parameters\n\n- `listIds: string[]`\n ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included\n\n- `offset: number`\n Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.\n\n- `processingTypes: string[]`\n List processing types to be included in search results. If not specified, all lists with all processing types will be included.\n\n- `additional_filter_properties?: string[]`\n The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response.\n\nBy default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.\n\n- `count?: number`\n The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.\n\n- `objectTypeId?: string`\n\n- `query?: string`\n The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.\n\n- `sort?: string`\n Sort field and order\n\n### Returns\n\n- `{ hasMore: boolean; lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]; offset: number; total: number; }`\n\n - `hasMore: boolean`\n - `lists: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; additional_filter_properties?: object; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; updatedAt?: string; updatedById?: string; }[]`\n - `offset: number`\n - `total: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listSearchResponse = await client.crm.lists.listBySearch({\n listIds: ['string'],\n offset: 0,\n processingTypes: ['string'],\n});\n\nconsole.log(listSearchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.listBySearch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listSearchResponse = await client.crm.lists.listBySearch({\n listIds: ['string'],\n offset: 0,\n processingTypes: ['string'],\n});\n\nconsole.log(listSearchResponse.hasMore);", - }, - python: { - method: 'crm.lists.list_by_search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_search_response = client.crm.lists.list_by_search(\n list_ids=["string"],\n offset=0,\n processing_types=["string"],\n)\nprint(list_search_response.has_more)', - }, - java: { - method: 'crm().lists().listBySearch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListSearchRequest;\nimport com.hubspot.sdk.models.crm.lists.ListSearchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListSearchRequest params = ListSearchRequest.builder()\n .addListId("string")\n .offset(0)\n .addProcessingType("string")\n .build();\n ListSearchResponse listSearchResponse = client.crm().lists().listBySearch(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.ListBySearch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistSearchResponse, err := client.Crm.Lists.ListBySearch(context.TODO(), crm.ListListBySearchParams{\n\t\tListSearchRequest: crm.ListSearchRequestParam{\n\t\t\tListIDs: []string{"string"},\n\t\t\tOffset: 0,\n\t\t\tProcessingTypes: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listSearchResponse.HasMore)\n}\n', - }, - ruby: { - method: 'crm.lists.list_by_search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_search_response = hubspot.crm.lists.list_by_search(list_ids: ["string"], offset: 0, processing_types: ["string"])\n\nputs(list_search_response)', - }, - php: { - method: 'crm->lists->listBySearch', - example: - "crm->lists->listBySearch(\n listIDs: ['string'],\n offset: 0,\n processingTypes: ['string'],\n additionalFilterProperties: ['string'],\n count: 0,\n objectTypeID: 'objectTypeId',\n query: 'query',\n sort: 'sort',\n);\n\nvar_dump($listSearchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "listIds": [\n "string"\n ],\n "offset": 0,\n "processingTypes": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'list_folders', - endpoint: '/crm/lists/2026-03/folders', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) list_folders', - qualified: 'client.crm.lists.listFolders', - params: ['folderId?: string;'], - response: - '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', - markdown: - "## list_folders\n\n`client.crm.lists.listFolders(folderId?: string): { folder: public_list_folder; }`\n\n**get** `/crm/lists/2026-03/folders`\n\n### Parameters\n\n- `folderId?: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.listFolders();\n\nconsole.log(listFolderFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.listFolders', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.listFolders();\n\nconsole.log(listFolderFetchResponse.folder);", - }, - python: { - method: 'crm.lists.list_folders', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.list_folders()\nprint(list_folder_fetch_response.folder)', - }, - java: { - method: 'crm().lists().listFolders', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListListFoldersParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().listFolders();\n }\n}', - }, - go: { - method: 'client.Crm.Lists.ListFolders', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.ListFolders(context.TODO(), crm.ListListFoldersParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', - }, - ruby: { - method: 'crm.lists.list_folders', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.list_folders\n\nputs(list_folder_fetch_response)', - }, - php: { - method: 'crm->lists->listFolders', - example: - "crm->lists->listFolders(\n folderID: 'folderId'\n);\n\nvar_dump($listFolderFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_memberships', - endpoint: '/crm/lists/2026-03/{listId}/memberships', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) list_memberships', - qualified: 'client.crm.lists.listMemberships', - params: ['listId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: '{ membershipTimestamp: string; recordId: string; }', - markdown: - "## list_memberships\n\n`client.crm.lists.listMemberships(listId: string, after?: string, before?: string, limit?: number): { membershipTimestamp: string; recordId: string; }`\n\n**get** `/crm/lists/2026-03/{listId}/memberships`\n\n### Parameters\n\n- `listId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ membershipTimestamp: string; recordId: string; }`\n\n - `membershipTimestamp: string`\n - `recordId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.listMemberships('listId')) {\n console.log(joinTimeAndRecordID);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.listMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const joinTimeAndRecordID of client.crm.lists.listMemberships('listId')) {\n console.log(joinTimeAndRecordID.membershipTimestamp);\n}", - }, - python: { - method: 'crm.lists.list_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.lists.list_memberships(\n list_id="listId",\n)\npage = page.results[0]\nprint(page.membership_timestamp)', - }, - java: { - method: 'crm().lists().listMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListListMembershipsPage;\nimport com.hubspot.sdk.models.crm.lists.ListListMembershipsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListListMembershipsPage page = client.crm().lists().listMemberships("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.ListMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Lists.ListMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListListMembershipsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.lists.list_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.lists.list_memberships("listId")\n\nputs(page)', - }, - php: { - method: 'crm->lists->listMemberships', - example: - "crm->lists->listMemberships(\n 'listId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'move_folder', - endpoint: '/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) move_folder', - qualified: 'client.crm.lists.moveFolder', - params: ['folderId: string;', 'newParentFolderId: string;'], - response: - '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', - markdown: - "## move_folder\n\n`client.crm.lists.moveFolder(folderId: string, newParentFolderId: string): { folder: public_list_folder; }`\n\n**put** `/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}`\n\n### Parameters\n\n- `folderId: string`\n\n- `newParentFolderId: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.moveFolder('newParentFolderId', { folderId: 'folderId' });\n\nconsole.log(listFolderFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.moveFolder', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.moveFolder('newParentFolderId', {\n folderId: 'folderId',\n});\n\nconsole.log(listFolderFetchResponse.folder);", - }, - python: { - method: 'crm.lists.move_folder', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.move_folder(\n new_parent_folder_id="newParentFolderId",\n folder_id="folderId",\n)\nprint(list_folder_fetch_response.folder)', - }, - java: { - method: 'crm().lists().moveFolder', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListMoveFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListMoveFolderParams params = ListMoveFolderParams.builder()\n .folderId("folderId")\n .newParentFolderId("newParentFolderId")\n .build();\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().moveFolder(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.MoveFolder', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.MoveFolder(\n\t\tcontext.TODO(),\n\t\t"newParentFolderId",\n\t\tcrm.ListMoveFolderParams{\n\t\t\tFolderID: "folderId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', - }, - ruby: { - method: 'crm.lists.move_folder', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.move_folder("newParentFolderId", folder_id: "folderId")\n\nputs(list_folder_fetch_response)', - }, - php: { - method: 'crm->lists->moveFolder', - example: - "crm->lists->moveFolder(\n 'newParentFolderId', folderID: 'folderId'\n);\n\nvar_dump($listFolderFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID/move/$NEW_PARENT_FOLDER_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'move_list', - endpoint: '/crm/lists/2026-03/folders/move-list', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) move_list', - qualified: 'client.crm.lists.moveList', - params: ['listId: string;', 'newFolderId: string;'], - markdown: - "## move_list\n\n`client.crm.lists.moveList(listId: string, newFolderId: string): void`\n\n**put** `/crm/lists/2026-03/folders/move-list`\n\n### Parameters\n\n- `listId: string`\n The Id of the list to move.\n\n- `newFolderId: string`\n The Id of folder to move the list to, the root folder is Id 0.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.moveList({ listId: 'listId', newFolderId: 'newFolderId' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.moveList', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.moveList({ listId: 'listId', newFolderId: 'newFolderId' });", - }, - python: { - method: 'crm.lists.move_list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.move_list(\n list_id="listId",\n new_folder_id="newFolderId",\n)', - }, - java: { - method: 'crm().lists().moveList', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListMoveRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListMoveRequest params = ListMoveRequest.builder()\n .listId("listId")\n .newFolderId("newFolderId")\n .build();\n client.crm().lists().moveList(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.MoveList', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.MoveList(context.TODO(), crm.ListMoveListParams{\n\t\tListMoveRequest: crm.ListMoveRequestParam{\n\t\t\tListID: "listId",\n\t\t\tNewFolderID: "newFolderId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.move_list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.move_list(list_id: "listId", new_folder_id: "newFolderId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->moveList', - example: - "crm->lists->moveList(\n listID: 'listId', newFolderID: 'newFolderId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders/move-list \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "listId": "listId",\n "newFolderId": "newFolderId"\n }\'', - }, - }, - }, - { - name: 'remove_memberships', - endpoint: '/crm/lists/2026-03/{listId}/memberships/remove', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) remove_memberships', - qualified: 'client.crm.lists.removeMemberships', - params: ['listId: string;', 'body: string[];'], - response: '{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }', - markdown: - "## remove_memberships\n\n`client.crm.lists.removeMemberships(listId: string, body: string[]): { recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n**put** `/crm/lists/2026-03/{listId}/memberships/remove`\n\n### Parameters\n\n- `listId: string`\n\n- `body: string[]`\n\n### Returns\n\n- `{ recordIdsMissing: string[]; recordIdsRemoved: string[]; recordsIdsAdded: string[]; }`\n\n - `recordIdsMissing: string[]`\n - `recordIdsRemoved: string[]`\n - `recordsIdsAdded: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst membershipsUpdateResponse = await client.crm.lists.removeMemberships('listId', { body: ['string'] });\n\nconsole.log(membershipsUpdateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.removeMemberships', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst membershipsUpdateResponse = await client.crm.lists.removeMemberships('listId', {\n body: ['string'],\n});\n\nconsole.log(membershipsUpdateResponse.recordIdsMissing);", - }, - python: { - method: 'crm.lists.remove_memberships', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmemberships_update_response = client.crm.lists.remove_memberships(\n list_id="listId",\n body=["string"],\n)\nprint(memberships_update_response.record_ids_missing)', - }, - java: { - method: 'crm().lists().removeMemberships', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListRemoveMembershipsParams;\nimport com.hubspot.sdk.models.crm.lists.MembershipsUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListRemoveMembershipsParams params = ListRemoveMembershipsParams.builder()\n .listId("listId")\n .addBody("string")\n .build();\n MembershipsUpdateResponse membershipsUpdateResponse = client.crm().lists().removeMemberships(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.RemoveMemberships', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmembershipsUpdateResponse, err := client.Crm.Lists.RemoveMemberships(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListRemoveMembershipsParams{\n\t\t\tBody: []string{"string"},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", membershipsUpdateResponse.RecordIDsMissing)\n}\n', - }, - ruby: { - method: 'crm.lists.remove_memberships', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmemberships_update_response = hubspot.crm.lists.remove_memberships("listId", body: ["string"])\n\nputs(memberships_update_response)', - }, - php: { - method: 'crm->lists->removeMemberships', - example: - "crm->lists->removeMemberships(\n 'listId', body: ['string']\n);\n\nvar_dump($membershipsUpdateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/memberships/remove \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'[\n "string"\n ]\'', - }, - }, - }, - { - name: 'rename_folder', - endpoint: '/crm/lists/2026-03/folders/{folderId}/rename', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) rename_folder', - qualified: 'client.crm.lists.renameFolder', - params: ['folderId: string;', 'newFolderName?: string;'], - response: - '{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }', - markdown: - "## rename_folder\n\n`client.crm.lists.renameFolder(folderId: string, newFolderName?: string): { folder: public_list_folder; }`\n\n**put** `/crm/lists/2026-03/folders/{folderId}/rename`\n\n### Parameters\n\n- `folderId: string`\n\n- `newFolderName?: string`\n\n### Returns\n\n- `{ folder: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }; }`\n\n - `folder: { id: string; childLists: number[]; childNodes: { id: string; childLists: number[]; childNodes: public_list_folder[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }[]; parentFolderId: string; createdAt?: string; name?: string; updatedAt?: string; updatedContentsAt?: string; userId?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listFolderFetchResponse = await client.crm.lists.renameFolder('folderId');\n\nconsole.log(listFolderFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.renameFolder', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listFolderFetchResponse = await client.crm.lists.renameFolder('folderId');\n\nconsole.log(listFolderFetchResponse.folder);", - }, - python: { - method: 'crm.lists.rename_folder', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_folder_fetch_response = client.crm.lists.rename_folder(\n folder_id="folderId",\n)\nprint(list_folder_fetch_response.folder)', - }, - java: { - method: 'crm().lists().renameFolder', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFolderFetchResponse;\nimport com.hubspot.sdk.models.crm.lists.ListRenameFolderParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListFolderFetchResponse listFolderFetchResponse = client.crm().lists().renameFolder("folderId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.RenameFolder', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistFolderFetchResponse, err := client.Crm.Lists.RenameFolder(\n\t\tcontext.TODO(),\n\t\t"folderId",\n\t\tcrm.ListRenameFolderParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listFolderFetchResponse.Folder)\n}\n', - }, - ruby: { - method: 'crm.lists.rename_folder', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_folder_fetch_response = hubspot.crm.lists.rename_folder("folderId")\n\nputs(list_folder_fetch_response)', - }, - php: { - method: 'crm->lists->renameFolder', - example: - "crm->lists->renameFolder(\n 'folderId', newFolderName: 'newFolderName'\n);\n\nvar_dump($listFolderFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/folders/$FOLDER_ID/rename \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore', - endpoint: '/crm/lists/2026-03/{listId}/restore', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) restore', - qualified: 'client.crm.lists.restore', - params: ['listId: string;'], - markdown: - "## restore\n\n`client.crm.lists.restore(listId: string): void`\n\n**put** `/crm/lists/2026-03/{listId}/restore`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.restore('listId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.restore', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.restore('listId');", - }, - python: { - method: 'crm.lists.restore', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.restore(\n "listId",\n)', - }, - java: { - method: 'crm().lists().restore', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListRestoreParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().restore("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.Restore', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.Restore(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.restore', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.restore("listId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->restore', - example: - "crm->lists->restore('listId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/restore \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'schedule_conversion', - endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', - httpMethod: 'delete', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) schedule_conversion', - qualified: 'client.crm.lists.scheduleConversion', - params: ['listId: string;'], - markdown: - "## schedule_conversion\n\n`client.crm.lists.scheduleConversion(listId: string): void`\n\n**delete** `/crm/lists/2026-03/{listId}/schedule-conversion`\n\n### Parameters\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.lists.scheduleConversion('listId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.scheduleConversion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.lists.scheduleConversion('listId');", - }, - python: { - method: 'crm.lists.schedule_conversion', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.lists.schedule_conversion(\n "listId",\n)', - }, - java: { - method: 'crm().lists().scheduleConversion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListScheduleConversionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().lists().scheduleConversion("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.ScheduleConversion', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Lists.ScheduleConversion(context.TODO(), "listId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.lists.schedule_conversion', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.lists.schedule_conversion("listId")\n\nputs(result)', - }, - php: { - method: 'crm->lists->scheduleConversion', - example: - "crm->lists->scheduleConversion('listId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_list_filters', - endpoint: '/crm/lists/2026-03/{listId}/update-list-filters', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) update_list_filters', - qualified: 'client.crm.lists.updateListFilters', - params: [ - 'listId: string;', - "filterBranch: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; };", - 'enrollObjectsInWorkflows?: boolean;', - ], - response: - '{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', - markdown: - "## update_list_filters\n\n`client.crm.lists.updateListFilters(listId: string, filterBranch: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }, enrollObjectsInWorkflows?: boolean): { updatedList?: public_object_list; }`\n\n**put** `/crm/lists/2026-03/{listId}/update-list-filters`\n\n### Parameters\n\n- `listId: string`\n\n- `filterBranch: { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; } | { eventTypeId: string; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; pruningRefineBy?: { type: 'NUM_OCCURRENCES'; maxOccurrences?: number; minOccurrences?: number; } | { setType: string; type: 'SET_OCCURRENCES'; } | { comparison: string; timeOffset: public_time_offset; type: 'RELATIVE_COMPARATIVE'; } | { lowerBoundOffset: public_time_offset; rangeType: string; type: 'RELATIVE_RANGED'; upperBoundOffset: public_time_offset; } | { comparison: string; timestamp: number; type: 'ABSOLUTE_COMPARATIVE'; } | { lowerTimestamp: number; rangeType: string; type: 'ABSOLUTE_RANGED'; upperTimestamp: number; } | { type: 'ALL_HISTORY'; } | { includeObjectsWithNoValueSet: boolean; operationType: 'TIME_POINT'; operator: string; timePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; type: string; endpointBehavior?: string; propertyParser?: string; } | { includeObjectsWithNoValueSet: boolean; lowerBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; operationType: 'TIME_RANGED'; operator: string; type: 'TIME_RANGED'; upperBoundTimePoint: public_date_point | public_indexed_time_point | public_property_referenced_time; lowerBoundEndpointBehavior?: string; propertyParser?: string; upperBoundEndpointBehavior?: string; }; } | { filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: { filterType: 'PROPERTY'; operation: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; property: string; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'ASSOCIATION'; listId: string; operator: string; toObjectType?: string; toObjectTypeId?: string; } | { filterType: 'PAGE_VIEW'; operator: string; pageUrl: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; enableTracking?: boolean; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { ctaName: string; filterType: 'CTA'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventId: string; filterType: 'EVENT'; operator: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'FORM_SUBMISSION_ON_PAGE'; operator: 'FILLED_OUT' | 'NOT_FILLED_OUT'; pageId: string; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; formId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { eventTypeId: number; filterLines: public_event_filter_metadata[]; filterType: 'INTEGRATION_EVENT'; } | { acceptedStatuses: string[]; filterType: 'EMAIL_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType?: string; } | { acceptedOptStates: string[]; channel: string; filterType: 'COMMUNICATION_SUBSCRIPTION'; subscriptionIds: string[]; subscriptionType: string; businessUnitId?: string; } | { campaignId: string; filterType: 'CAMPAIGN_INFLUENCED'; } | { filterType: 'SURVEY_MONKEY'; operator: string; surveyId: string; } | { filterType: 'SURVEY_MONKEY_VALUE'; operator: string; surveyId: string; surveyQuestion: string; valueComparison: public_bool_property_operation | public_number_property_operation | public_string_property_operation | public_date_time_property_operation | public_ranged_date_property_operation | public_comparative_property_updated_operation | public_comparative_date_property_operation | public_rolling_date_range_property_operation | public_rolling_property_updated_operation | public_enumeration_property_operation | public_all_property_types_operation | public_ranged_number_property_operation | public_multi_string_property_operation | public_date_property_operation | public_calendar_date_property_operation | public_time_point_operation | public_ranged_time_operation; surveyAnswerColId?: string; surveyAnswerRowId?: string; } | { filterType: 'WEBINAR'; operator: string; webinarId?: string; } | { appId: string; emailId: string; filterType: 'EMAIL_EVENT'; level: string; operator: string; clickUrl?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'PRIVACY'; operator: string; privacyName: string; } | { adNetwork: string; entityType: string; filterType: 'ADS_SEARCH'; operator: string; searchTerms: string[]; searchTermType: string; } | { filterType: 'ADS_TIME'; pruningRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterType: 'IN_LIST'; listId: string; operator: string; metadata?: public_in_list_filter_metadata; } | { associationCategory: string; associationTypeId: number; coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'NUM_ASSOCIATIONS'; } | { filterLines: public_event_filter_metadata[]; filterType: 'UNIFIED_EVENTS'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; eventTypeId?: string; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { coalescingRefineBy: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; filterType: 'PROPERTY_ASSOCIATION'; listId: string; operator: string; propertyWithObjectId: string; toObjectTypeId?: string; } | { filterType: 'CONSTANT'; shouldAccept: boolean; source?: string; }[]; objectTypeId: string; operator: string; }`\n Updated filtering criteria for the list\n\n- `enrollObjectsInWorkflows?: boolean`\n\n### Returns\n\n- `{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listUpdateResponse = await client.crm.lists.updateListFilters('listId', { filterBranch: {\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n filterBranches: [{\n eventTypeId: 'eventTypeId',\n filterBranches: [{\n filterBranches: [{\n associationCategory: 'associationCategory',\n associationTypeId: 0,\n filterBranches: [{\n filterBranches: [],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'ASSOCIATION',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'PROPERTY_ASSOCIATION',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n propertyWithObjectId: 'propertyWithObjectId',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'UNIFIED_EVENTS',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n operator: 'HAS_COMPLETED',\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'RESTRICTED',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ANY',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ALL',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'AND',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n}],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [{\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n},\n property: 'property',\n}],\n} });\n\nconsole.log(listUpdateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.updateListFilters', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listUpdateResponse = await client.crm.lists.updateListFilters('listId', {\n filterBranch: {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n eventTypeId: 'eventTypeId',\n filterBranches: [\n {\n filterBranches: [\n {\n associationCategory: 'associationCategory',\n associationTypeId: 0,\n filterBranches: [\n {\n filterBranches: [],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'ASSOCIATION',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'PROPERTY_ASSOCIATION',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n objectTypeId: 'objectTypeId',\n operator: 'operator',\n propertyWithObjectId: 'propertyWithObjectId',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'UNIFIED_EVENTS',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n operator: 'HAS_COMPLETED',\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'RESTRICTED',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ANY',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'NOT_ALL',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'AND',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n ],\n filterBranchOperator: 'filterBranchOperator',\n filterBranchType: 'OR',\n filters: [\n {\n filterType: 'PROPERTY',\n operation: {\n includeObjectsWithNoValueSet: true,\n operationType: 'BOOL',\n operator: 'operator',\n value: true,\n },\n property: 'property',\n },\n ],\n },\n});\n\nconsole.log(listUpdateResponse.updatedList);", - }, - python: { - method: 'crm.lists.update_list_filters', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_update_response = client.crm.lists.update_list_filters(\n list_id="listId",\n filter_branch={\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "filter_branches": [{\n "event_type_id": "eventTypeId",\n "filter_branches": [{\n "filter_branches": [{\n "association_category": "associationCategory",\n "association_type_id": 0,\n "filter_branches": [{\n "filter_branches": [],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "OR",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "ASSOCIATION",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "object_type_id": "objectTypeId",\n "operator": "operator",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "PROPERTY_ASSOCIATION",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "object_type_id": "objectTypeId",\n "operator": "operator",\n "property_with_object_id": "propertyWithObjectId",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "UNIFIED_EVENTS",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n "operator": "HAS_COMPLETED",\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "RESTRICTED",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "NOT_ANY",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "NOT_ALL",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "AND",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n }],\n "filter_branch_operator": "filterBranchOperator",\n "filter_branch_type": "OR",\n "filters": [{\n "filter_type": "PROPERTY",\n "operation": {\n "include_objects_with_no_value_set": True,\n "operation_type": "BOOL",\n "operator": "operator",\n "value": True,\n },\n "property": "property",\n }],\n },\n)\nprint(list_update_response.updated_list)', - }, - java: { - method: 'crm().lists().updateListFilters', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListFilterUpdateRequest;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateListFiltersParams;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateResponse;\nimport com.hubspot.sdk.models.crm.lists.PublicAndFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicAssociationFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicBoolPropertyOperation;\nimport com.hubspot.sdk.models.crm.lists.PublicNotAllFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicNotAnyFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicOrFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicPropertyAssociationFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicPropertyFilter;\nimport com.hubspot.sdk.models.crm.lists.PublicRestrictedFilterBranch;\nimport com.hubspot.sdk.models.crm.lists.PublicUnifiedEventsFilterBranch;\nimport java.util.List;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateListFiltersParams params = ListUpdateListFiltersParams.builder()\n .listId("listId")\n .listFilterUpdateRequest(ListFilterUpdateRequest.builder()\n .filterBranch(PublicOrFilterBranch.builder()\n .addFilterBranch(PublicAndFilterBranch.builder()\n .addFilterBranch(PublicNotAllFilterBranch.builder()\n .addFilterBranch(PublicNotAnyFilterBranch.builder()\n .addFilterBranch(PublicRestrictedFilterBranch.builder()\n .addFilterBranch(PublicUnifiedEventsFilterBranch.builder()\n .eventTypeId("eventTypeId")\n .addFilterBranch(PublicPropertyAssociationFilterBranch.builder()\n .addFilterBranch(PublicAssociationFilterBranch.builder()\n .associationCategory("associationCategory")\n .associationTypeId(0)\n .addFilterBranch(PublicOrFilterBranch.builder()\n .filterBranches(List.of())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicOrFilterBranch.FilterBranchType.OR)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicAssociationFilterBranch.FilterBranchType.ASSOCIATION)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .objectTypeId("objectTypeId")\n .operator("operator")\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicPropertyAssociationFilterBranch.FilterBranchType.PROPERTY_ASSOCIATION)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .objectTypeId("objectTypeId")\n .operator("operator")\n .propertyWithObjectId("propertyWithObjectId")\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicUnifiedEventsFilterBranch.FilterBranchType.UNIFIED_EVENTS)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .operator(PublicUnifiedEventsFilterBranch.Operator.HAS_COMPLETED)\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicRestrictedFilterBranch.FilterBranchType.RESTRICTED)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicNotAnyFilterBranch.FilterBranchType.NOT_ANY)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicNotAllFilterBranch.FilterBranchType.NOT_ALL)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicAndFilterBranch.FilterBranchType.AND)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .filterBranchOperator("filterBranchOperator")\n .filterBranchType(PublicOrFilterBranch.FilterBranchType.OR)\n .addFilter(PublicPropertyFilter.builder()\n .filterType(PublicPropertyFilter.FilterType.PROPERTY)\n .operation(PublicBoolPropertyOperation.builder()\n .includeObjectsWithNoValueSet(true)\n .operationType(PublicBoolPropertyOperation.OperationType.BOOL)\n .operator("operator")\n .value(true)\n .build())\n .property("property")\n .build())\n .build())\n .build())\n .build();\n ListUpdateResponse listUpdateResponse = client.crm().lists().updateListFilters(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.UpdateListFilters', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistUpdateResponse, err := client.Crm.Lists.UpdateListFilters(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateListFiltersParams{\n\t\t\tListFilterUpdateRequest: crm.ListFilterUpdateRequestParam{\n\t\t\t\tFilterBranch: crm.ListFilterUpdateRequestFilterBranchUnionParam{\n\t\t\t\t\tOfOr: &crm.PublicOrFilterBranchParam{\n\t\t\t\t\t\tFilterBranches: []crm.PublicOrFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\tOfAnd: &crm.PublicAndFilterBranchParam{\n\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicAndFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\tOfNotAll: &crm.PublicNotAllFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicNotAllFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\tOfNotAny: &crm.PublicNotAnyFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicNotAnyFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfRestricted: &crm.PublicRestrictedFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicRestrictedFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfUnifiedEvents: &crm.PublicUnifiedEventsFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tEventTypeID: "eventTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicUnifiedEventsFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfPropertyAssociation: &crm.PublicPropertyAssociationFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicPropertyAssociationFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfAssociation: &crm.PublicAssociationFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tAssociationCategory: "associationCategory",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicAssociationFilterBranchFilterBranchUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfOr: &crm.PublicOrFilterBranchParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranches: []crm.PublicOrFilterBranchFilterBranchUnionParam{},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicOrFilterBranchFilterBranchTypeOr,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicOrFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicAssociationFilterBranchFilterBranchTypeAssociation,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicAssociationFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicPropertyAssociationFilterBranchFilterBranchTypePropertyAssociation,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicPropertyAssociationFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tPropertyWithObjectID: "propertyWithObjectId",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicUnifiedEventsFilterBranchFilterBranchTypeUnifiedEvents,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicUnifiedEventsFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: crm.PublicUnifiedEventsFilterBranchOperatorHasCompleted,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicRestrictedFilterBranchFilterBranchTypeRestricted,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicRestrictedFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicNotAnyFilterBranchFilterBranchTypeNotAny,\n\t\t\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicNotAnyFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicNotAllFilterBranchFilterBranchTypeNotAll,\n\t\t\t\t\t\t\t\t\t\tFilters: []crm.PublicNotAllFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\t\t\tFilterBranchType: crm.PublicAndFilterBranchFilterBranchTypeAnd,\n\t\t\t\t\t\t\t\tFilters: []crm.PublicAndFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t}},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t\tFilterBranchOperator: "filterBranchOperator",\n\t\t\t\t\t\tFilterBranchType: crm.PublicOrFilterBranchFilterBranchTypeOr,\n\t\t\t\t\t\tFilters: []crm.PublicOrFilterBranchFilterUnionParam{{\n\t\t\t\t\t\t\tOfProperty: &crm.PublicPropertyFilterParam{\n\t\t\t\t\t\t\t\tFilterType: crm.PublicPropertyFilterFilterTypeProperty,\n\t\t\t\t\t\t\t\tOperation: crm.PublicPropertyFilterOperationUnionParam{\n\t\t\t\t\t\t\t\t\tOfBool: &crm.PublicBoolPropertyOperationParam{\n\t\t\t\t\t\t\t\t\t\tIncludeObjectsWithNoValueSet: true,\n\t\t\t\t\t\t\t\t\t\tOperationType: crm.PublicBoolPropertyOperationOperationTypeBool,\n\t\t\t\t\t\t\t\t\t\tOperator: "operator",\n\t\t\t\t\t\t\t\t\t\tValue: true,\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tProperty: "property",\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listUpdateResponse.UpdatedList)\n}\n', - }, - ruby: { - method: 'crm.lists.update_list_filters', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_update_response = hubspot.crm.lists.update_list_filters(\n "listId",\n filter_branch: {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n filterBranches: [\n {\n eventTypeId: "eventTypeId",\n filterBranches: [\n {\n filterBranches: [\n {\n associationCategory: "associationCategory",\n associationTypeId: 0,\n filterBranches: [\n {\n filterBranches: [],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :OR,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :ASSOCIATION,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n objectTypeId: "objectTypeId",\n operator: "operator"\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :PROPERTY_ASSOCIATION,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n objectTypeId: "objectTypeId",\n operator: "operator",\n propertyWithObjectId: "propertyWithObjectId"\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :UNIFIED_EVENTS,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ],\n operator: :HAS_COMPLETED\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :RESTRICTED,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :NOT_ANY,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :NOT_ALL,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :AND,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n ],\n filterBranchOperator: "filterBranchOperator",\n filterBranchType: :OR,\n filters: [\n {\n filterType: :PROPERTY,\n operation: {includeObjectsWithNoValueSet: true, operationType: :BOOL, operator: "operator", value: true},\n property: "property"\n }\n ]\n }\n)\n\nputs(list_update_response)', - }, - php: { - method: 'crm->lists->updateListFilters', - example: - "crm->lists->updateListFilters(\n 'listId',\n filterBranch: [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'eventTypeID' => 'eventTypeId',\n 'filterBranches' => [\n [\n 'filterBranches' => [\n [\n 'associationCategory' => 'associationCategory',\n 'associationTypeID' => 0,\n 'filterBranches' => [\n [\n 'filterBranches' => [],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'PROPERTY_ASSOCIATION',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'objectTypeID' => 'objectTypeId',\n 'operator' => 'operator',\n 'propertyWithObjectID' => 'propertyWithObjectId',\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'UNIFIED_EVENTS',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n 'operator' => 'HAS_COMPLETED',\n 'coalescingRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n 'pruningRefineBy' => [\n 'type' => 'NUM_OCCURRENCES',\n 'maxOccurrences' => 0,\n 'minOccurrences' => 0,\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'RESTRICTED',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ANY',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'NOT_ALL',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'AND',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n ],\n 'filterBranchOperator' => 'filterBranchOperator',\n 'filterBranchType' => 'OR',\n 'filters' => [\n [\n 'filterType' => 'PROPERTY',\n 'operation' => [\n 'includeObjectsWithNoValueSet' => true,\n 'operationType' => 'BOOL',\n 'operator' => 'operator',\n 'value' => true,\n ],\n 'property' => 'property',\n ],\n ],\n ],\n enrollObjectsInWorkflows: true,\n);\n\nvar_dump($listUpdateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/update-list-filters \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "filterBranch": {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "filterBranches": [\n {\n "eventTypeId": "eventTypeId",\n "filterBranches": [\n {\n "filterBranches": [\n {\n "associationCategory": "associationCategory",\n "associationTypeId": 0,\n "filterBranches": [\n {\n "filterBranches": [],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "OR",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "ASSOCIATION",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "objectTypeId": "objectTypeId",\n "operator": "operator"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "PROPERTY_ASSOCIATION",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "objectTypeId": "objectTypeId",\n "operator": "operator",\n "propertyWithObjectId": "propertyWithObjectId"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "UNIFIED_EVENTS",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ],\n "operator": "HAS_COMPLETED"\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "RESTRICTED",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "NOT_ANY",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "NOT_ALL",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "AND",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n ],\n "filterBranchOperator": "filterBranchOperator",\n "filterBranchType": "OR",\n "filters": [\n {\n "filterType": "PROPERTY",\n "operation": {\n "includeObjectsWithNoValueSet": true,\n "operationType": "BOOL",\n "operator": "operator",\n "value": true\n },\n "property": "property"\n }\n ]\n }\n }\'', - }, - }, - }, - { - name: 'update_list_name', - endpoint: '/crm/lists/2026-03/{listId}/update-list-name', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) update_list_name', - qualified: 'client.crm.lists.updateListName', - params: ['listId: string;', 'includeFilters?: boolean;', 'listName?: string;'], - response: - '{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }', - markdown: - "## update_list_name\n\n`client.crm.lists.updateListName(listId: string, includeFilters?: boolean, listName?: string): { updatedList?: public_object_list; }`\n\n**put** `/crm/lists/2026-03/{listId}/update-list-name`\n\n### Parameters\n\n- `listId: string`\n\n- `includeFilters?: boolean`\n\n- `listName?: string`\n\n### Returns\n\n- `{ updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch; filtersUpdatedAt?: string; listPermissions?: public_list_permissions; membershipSettings?: public_membership_settings; size?: number; updatedAt?: string; updatedById?: string; }; }`\n\n - `updatedList?: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filterBranch?: { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'OR'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'AND'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ALL'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'NOT_ANY'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'RESTRICTED'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; } | { eventTypeId: string; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'UNIFIED_EVENTS'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; operator: 'HAS_COMPLETED' | 'HAS_NOT_COMPLETED'; coalescingRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; pruningRefineBy?: public_num_occurrences_refine_by | public_set_occurrences_refine_by | public_relative_comparative_timestamp_refine_by | public_relative_ranged_timestamp_refine_by | public_absolute_comparative_timestamp_refine_by | public_absolute_ranged_timestamp_refine_by | public_all_history_refine_by | public_time_point_operation | public_ranged_time_operation; } | { filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'PROPERTY_ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; propertyWithObjectId: string; } | { associationCategory: string; associationTypeId: number; filterBranches: public_or_filter_branch | public_and_filter_branch | public_not_all_filter_branch | public_not_any_filter_branch | public_restricted_filter_branch | public_unified_events_filter_branch | public_property_association_filter_branch | public_association_filter_branch[]; filterBranchOperator: string; filterBranchType: 'ASSOCIATION'; filters: public_property_filter | public_association_in_list_filter | public_page_view_analytics_filter | public_cta_analytics_filter | public_event_analytics_filter | public_form_submission_filter | public_form_submission_on_page_filter | public_integration_event_filter | public_email_subscription_filter | public_communication_subscription_filter | public_campaign_influenced_filter | public_survey_monkey_filter | public_survey_monkey_value_filter | public_webinar_filter | public_email_event_filter | public_privacy_analytics_filter | public_ads_search_filter | public_ads_time_filter | public_in_list_filter | public_num_associations_filter | public_unified_events_filter | public_property_association_in_list_filter | public_constant_filter[]; objectTypeId: string; operator: string; }; filtersUpdatedAt?: string; listPermissions?: { teamsWithEditAccess: number[]; usersWithEditAccess: number[]; }; membershipSettings?: { includeUnassigned?: boolean; membershipTeamId?: number; }; size?: number; updatedAt?: string; updatedById?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst listUpdateResponse = await client.crm.lists.updateListName('listId');\n\nconsole.log(listUpdateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.lists.updateListName', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst listUpdateResponse = await client.crm.lists.updateListName('listId');\n\nconsole.log(listUpdateResponse.updatedList);", - }, - python: { - method: 'crm.lists.update_list_name', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nlist_update_response = client.crm.lists.update_list_name(\n list_id="listId",\n)\nprint(list_update_response.updated_list)', - }, - java: { - method: 'crm().lists().updateListName', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateListNameParams;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateResponse listUpdateResponse = client.crm().lists().updateListName("listId");\n }\n}', - }, - go: { - method: 'client.Crm.Lists.UpdateListName', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tlistUpdateResponse, err := client.Crm.Lists.UpdateListName(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateListNameParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", listUpdateResponse.UpdatedList)\n}\n', - }, - ruby: { - method: 'crm.lists.update_list_name', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nlist_update_response = hubspot.crm.lists.update_list_name("listId")\n\nputs(list_update_response)', - }, - php: { - method: 'crm->lists->updateListName', - example: - "crm->lists->updateListName(\n 'listId', includeFilters: true, listName: 'listName'\n);\n\nvar_dump($listUpdateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/update-list-name \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_schedule_conversion', - endpoint: '/crm/lists/2026-03/{listId}/schedule-conversion', - httpMethod: 'put', - summary: '', - description: '', - stainlessPath: '(resource) crm.lists > (method) update_schedule_conversion', - qualified: 'client.crm.lists.updateScheduleConversion', - params: [ - 'listId: string;', - "public_list_conversion_time: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; };", - ], - response: - "{ listId: string; convertedAt?: string; requestedConversionTime?: { conversionType: 'CONVERSION_DATE'; day: number; month: number; year: number; } | { conversionType: 'INACTIVITY'; offset: number; timeUnit: 'DAY' | 'MONTH' | 'WEEK'; }; }", - perLanguage: { - typescript: { - method: 'client.crm.lists.updateScheduleConversion', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicListConversionResponse = await client.crm.lists.updateScheduleConversion('listId', {\n conversionType: 'CONVERSION_DATE',\n day: 0,\n month: 0,\n year: 0,\n});\n\nconsole.log(publicListConversionResponse.listId);", - }, - python: { - method: 'crm.lists.update_schedule_conversion', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_list_conversion_response = client.crm.lists.update_schedule_conversion(\n list_id="listId",\n conversion_type="CONVERSION_DATE",\n day=0,\n month=0,\n year=0,\n)\nprint(public_list_conversion_response.list_id)', - }, - java: { - method: 'crm().lists().updateScheduleConversion', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.lists.ListUpdateScheduleConversionParams;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionDate;\nimport com.hubspot.sdk.models.crm.lists.PublicListConversionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListUpdateScheduleConversionParams params = ListUpdateScheduleConversionParams.builder()\n .listId("listId")\n .publicListConversionTime(PublicListConversionDate.builder()\n .conversionType(PublicListConversionDate.ConversionType.CONVERSION_DATE)\n .day(0)\n .month(0)\n .year(0)\n .build())\n .build();\n PublicListConversionResponse publicListConversionResponse = client.crm().lists().updateScheduleConversion(params);\n }\n}', - }, - go: { - method: 'client.Crm.Lists.UpdateScheduleConversion', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicListConversionResponse, err := client.Crm.Lists.UpdateScheduleConversion(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tcrm.ListUpdateScheduleConversionParams{\n\t\t\tPublicListConversionTime: crm.PublicListConversionTimeUnionParam{\n\t\t\t\tOfConversionDate: &crm.PublicListConversionDateParam{\n\t\t\t\t\tConversionType: crm.PublicListConversionDateConversionTypeConversionDate,\n\t\t\t\t\tDay: 0,\n\t\t\t\t\tMonth: 0,\n\t\t\t\t\tYear: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicListConversionResponse.ListID)\n}\n', - }, - ruby: { - method: 'crm.lists.update_schedule_conversion', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_list_conversion_response = hubspot.crm.lists.update_schedule_conversion(\n "listId",\n public_list_conversion_time: {conversionType: :CONVERSION_DATE, day: 0, month: 0, year: 0}\n)\n\nputs(public_list_conversion_response)', - }, - php: { - method: 'crm->lists->updateScheduleConversion', - example: - "crm->lists->updateScheduleConversion(\n 'listId',\n conversionType: 'INACTIVITY',\n day: 0,\n month: 0,\n year: 0,\n offset: 0,\n timeUnit: 'DAY',\n);\n\nvar_dump($publicListConversionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/lists/2026-03/$LIST_ID/schedule-conversion \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionType": "CONVERSION_DATE",\n "day": 0,\n "month": 0,\n "year": 0\n }\'', - }, - }, - }, - { - name: 'get_all', - endpoint: '/crm/object-library/2026-03/enablement', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.object_library.enablement > (method) get_all', - qualified: 'client.crm.objectLibrary.enablement.getAll', - response: '{ enablementByObjectTypeId: object; }', - markdown: - "## get_all\n\n`client.crm.objectLibrary.enablement.getAll(): { enablementByObjectTypeId: object; }`\n\n**get** `/crm/object-library/2026-03/enablement`\n\n### Returns\n\n- `{ enablementByObjectTypeId: object; }`\n\n - `enablementByObjectTypeId: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst portalObjectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getAll();\n\nconsole.log(portalObjectTypeEnablementPublicResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectLibrary.enablement.getAll', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst portalObjectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getAll();\n\nconsole.log(portalObjectTypeEnablementPublicResponse.enablementByObjectTypeId);", - }, - python: { - method: 'crm.object_library.enablement.get_all', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nportal_object_type_enablement_public_response = client.crm.object_library.enablement.get_all()\nprint(portal_object_type_enablement_public_response.enablement_by_object_type_id)', - }, - java: { - method: 'crm().objectLibrary().enablement().getAll', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.EnablementGetAllParams;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.PortalObjectTypeEnablementPublicResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PortalObjectTypeEnablementPublicResponse portalObjectTypeEnablementPublicResponse = client.crm().objectLibrary().enablement().getAll();\n }\n}', - }, - go: { - method: 'client.Crm.ObjectLibrary.Enablement.GetAll', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tportalObjectTypeEnablementPublicResponse, err := client.Crm.ObjectLibrary.Enablement.GetAll(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", portalObjectTypeEnablementPublicResponse.EnablementByObjectTypeID)\n}\n', - }, - ruby: { - method: 'crm.object_library.enablement.get_all', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nportal_object_type_enablement_public_response = hubspot.crm.object_library.enablement.get_all\n\nputs(portal_object_type_enablement_public_response)', - }, - php: { - method: 'crm->objectLibrary->enablement->getAll', - example: - "crm\n ->objectLibrary\n ->enablement\n ->getAll();\n\nvar_dump($portalObjectTypeEnablementPublicResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/object-library/2026-03/enablement \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_object_type_id', - endpoint: '/crm/object-library/2026-03/enablement/{objectTypeId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.object_library.enablement > (method) get_by_object_type_id', - qualified: 'client.crm.objectLibrary.enablement.getByObjectTypeID', - params: ['objectTypeId: string;'], - response: '{ enablement: boolean; }', - markdown: - "## get_by_object_type_id\n\n`client.crm.objectLibrary.enablement.getByObjectTypeID(objectTypeId: string): { enablement: boolean; }`\n\n**get** `/crm/object-library/2026-03/enablement/{objectTypeId}`\n\n### Parameters\n\n- `objectTypeId: string`\n\n### Returns\n\n- `{ enablement: boolean; }`\n\n - `enablement: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeEnablementPublicResponse = await client.crm.objectLibrary.enablement.getByObjectTypeID('objectTypeId');\n\nconsole.log(objectTypeEnablementPublicResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectLibrary.enablement.getByObjectTypeID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeEnablementPublicResponse =\n await client.crm.objectLibrary.enablement.getByObjectTypeID('objectTypeId');\n\nconsole.log(objectTypeEnablementPublicResponse.enablement);", - }, - python: { - method: 'crm.object_library.enablement.get_by_object_type_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_enablement_public_response = client.crm.object_library.enablement.get_by_object_type_id(\n "objectTypeId",\n)\nprint(object_type_enablement_public_response.enablement)', - }, - java: { - method: 'crm().objectLibrary().enablement().getByObjectTypeId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.EnablementGetByObjectTypeIdParams;\nimport com.hubspot.sdk.models.crm.objectlibrary.enablement.ObjectTypeEnablementPublicResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectTypeEnablementPublicResponse objectTypeEnablementPublicResponse = client.crm().objectLibrary().enablement().getByObjectTypeId("objectTypeId");\n }\n}', - }, - go: { - method: 'client.Crm.ObjectLibrary.Enablement.GetByObjectTypeID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeEnablementPublicResponse, err := client.Crm.ObjectLibrary.Enablement.GetByObjectTypeID(context.TODO(), "objectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeEnablementPublicResponse.Enablement)\n}\n', - }, - ruby: { - method: 'crm.object_library.enablement.get_by_object_type_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_enablement_public_response = hubspot.crm.object_library.enablement.get_by_object_type_id("objectTypeId")\n\nputs(object_type_enablement_public_response)', - }, - php: { - method: 'crm->objectLibrary->enablement->getByObjectTypeID', - example: - "crm\n ->objectLibrary\n ->enablement\n ->getByObjectTypeID('objectTypeId');\n\nvar_dump($objectTypeEnablementPublicResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/object-library/2026-03/enablement/$OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/crm-object-schemas/2026-03/schemas', - httpMethod: 'post', - summary: 'Create a new custom object schema.', - description: 'Create a new custom object schema by defining its properties and associations.', - stainlessPath: '(resource) crm.object_schemas > (method) create', - qualified: 'client.crm.objectSchemas.create', - params: [ - 'allowsSensitiveProperties: boolean;', - 'associatedObjects: string[];', - 'labels: { plural?: string; singular?: string; };', - 'name: string;', - "properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[];", - 'requiredProperties: string[];', - 'searchableProperties: string[];', - 'secondaryDisplayProperties: string[];', - 'description?: string;', - 'primaryDisplayProperty?: string;', - ], - response: - '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', - markdown: - "## create\n\n`client.crm.objectSchemas.create(allowsSensitiveProperties: boolean, associatedObjects: string[], labels: { plural?: string; singular?: string; }, name: string, properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[], requiredProperties: string[], searchableProperties: string[], secondaryDisplayProperties: string[], description?: string, primaryDisplayProperty?: string): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**post** `/crm-object-schemas/2026-03/schemas`\n\nCreate a new custom object schema by defining its properties and associations.\n\n### Parameters\n\n- `allowsSensitiveProperties: boolean`\n Determines if the object type can include properties that are marked as sensitive.\n\n- `associatedObjects: string[]`\n Associations defined for this object type.\n\n- `labels: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `name: string`\n A unique name for this object. For internal use only.\n\n- `properties: { fieldType: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; description?: string; displayOrder?: number; externalOptionsReferenceType?: string; formField?: boolean; groupName?: string; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; optionSortStrategy?: 'ALPHABETICAL' | 'DISPLAY_ORDER'; referencedObjectType?: string; searchableInGlobalSearch?: boolean; showCurrencySymbol?: boolean; textDisplayHint?: string; }[]`\n Properties defined for this object type.\n\n- `requiredProperties: string[]`\n The names of properties that should be **required** when creating an object of this type.\n\n- `searchableProperties: string[]`\n Names of properties that will be indexed for this object type in by HubSpot's product search.\n\n- `secondaryDisplayProperties: string[]`\n The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.\n\n- `description?: string`\n A brief explanation of the object type.\n\n- `primaryDisplayProperty?: string`\n The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.crm.objectSchemas.create({\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: {},\n name: 'name',\n properties: [{\n fieldType: 'fieldType',\n label: 'label',\n name: 'name',\n type: 'bool',\n}],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n});\n\nconsole.log(objectSchema);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.crm.objectSchemas.create({\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: {},\n name: 'name',\n properties: [\n {\n fieldType: 'fieldType',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n});\n\nconsole.log(objectSchema.id);", - }, - python: { - method: 'crm.object_schemas.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.crm.object_schemas.create(\n allows_sensitive_properties=True,\n associated_objects=["string"],\n labels={},\n name="name",\n properties=[{\n "field_type": "fieldType",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n required_properties=["string"],\n searchable_properties=["string"],\n secondary_display_properties=["string"],\n)\nprint(object_schema.id)', - }, - java: { - method: 'crm().objectSchemas().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionLabels;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchema;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaEgg;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectTypePropertyCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaEgg params = ObjectSchemaEgg.builder()\n .allowsSensitiveProperties(true)\n .addAssociatedObject("string")\n .labels(ObjectTypeDefinitionLabels.builder().build())\n .name("name")\n .addProperty(ObjectTypePropertyCreate.builder()\n .fieldType("fieldType")\n .label("label")\n .name("name")\n .type(ObjectTypePropertyCreate.Type.BOOL)\n .build())\n .addRequiredProperty("string")\n .addSearchableProperty("string")\n .addSecondaryDisplayProperty("string")\n .build();\n ObjectSchema objectSchema = client.crm().objectSchemas().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Crm.ObjectSchemas.New(context.TODO(), crm.ObjectSchemaNewParams{\n\t\tObjectSchemaEgg: crm.ObjectSchemaEggParam{\n\t\t\tAllowsSensitiveProperties: true,\n\t\t\tAssociatedObjects: []string{"string"},\n\t\t\tLabels: shared.ObjectTypeDefinitionLabelsParam{},\n\t\t\tName: "name",\n\t\t\tProperties: []crm.ObjectTypePropertyCreateParam{{\n\t\t\t\tFieldType: "fieldType",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: crm.ObjectTypePropertyCreateTypeBool,\n\t\t\t}},\n\t\t\tRequiredProperties: []string{"string"},\n\t\t\tSearchableProperties: []string{"string"},\n\t\t\tSecondaryDisplayProperties: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.crm.object_schemas.create(\n allows_sensitive_properties: true,\n associated_objects: ["string"],\n labels: {},\n name: "name",\n properties: [{fieldType: "fieldType", label: "label", name: "name", type: :bool}],\n required_properties: ["string"],\n searchable_properties: ["string"],\n secondary_display_properties: ["string"]\n)\n\nputs(object_schema)', - }, - php: { - method: 'crm->objectSchemas->create', - example: - "crm->objectSchemas->create(\n allowsSensitiveProperties: true,\n associatedObjects: ['string'],\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n name: 'name',\n properties: [\n [\n 'fieldType' => 'fieldType',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptionsReferenceType' => 'externalOptionsReferenceType',\n 'formField' => true,\n 'groupName' => 'groupName',\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'optionSortStrategy' => 'ALPHABETICAL',\n 'referencedObjectType' => 'referencedObjectType',\n 'searchableInGlobalSearch' => true,\n 'showCurrencySymbol' => true,\n 'textDisplayHint' => 'domain_name',\n ],\n ],\n requiredProperties: ['string'],\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n description: 'description',\n primaryDisplayProperty: 'primaryDisplayProperty',\n);\n\nvar_dump($objectSchema);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "allowsSensitiveProperties": true,\n "associatedObjects": [\n "string"\n ],\n "labels": {},\n "name": "name",\n "properties": [\n {\n "fieldType": "fieldType",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ],\n "requiredProperties": [\n "string"\n ],\n "searchableProperties": [\n "string"\n ],\n "secondaryDisplayProperties": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create_association', - endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}/associations', - httpMethod: 'post', - summary: 'Create an association for a specified object type.', - description: - 'Create a new association between the specified object type and another object type. This operation requires the definition of the association attributes, such as the primary and target object type IDs.', - stainlessPath: '(resource) crm.object_schemas > (method) create_association', - qualified: 'client.crm.objectSchemas.createAssociation', - params: ['objectType: string;', 'fromObjectTypeId: string;', 'toObjectTypeId: string;', 'name?: string;'], - response: - '{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }', - markdown: - "## create_association\n\n`client.crm.objectSchemas.createAssociation(objectType: string, fromObjectTypeId: string, toObjectTypeId: string, name?: string): { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n\n**post** `/crm-object-schemas/2026-03/schemas/{objectType}/associations`\n\nCreate a new association between the specified object type and another object type. This operation requires the definition of the association attributes, such as the primary and target object type IDs.\n\n### Parameters\n\n- `objectType: string`\n\n- `fromObjectTypeId: string`\n\n- `toObjectTypeId: string`\n\n- `name?: string`\n\n### Returns\n\n- `{ id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }`\n The definition of an association\n\n - `id: string`\n - `fromObjectTypeId: string`\n - `toObjectTypeId: string`\n - `createdAt?: string`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst associationDefinition = await client.crm.objectSchemas.createAssociation('objectType', { fromObjectTypeId: 'fromObjectTypeId', toObjectTypeId: 'toObjectTypeId' });\n\nconsole.log(associationDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.createAssociation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst associationDefinition = await client.crm.objectSchemas.createAssociation('objectType', {\n fromObjectTypeId: 'fromObjectTypeId',\n toObjectTypeId: 'toObjectTypeId',\n});\n\nconsole.log(associationDefinition.id);", - }, - python: { - method: 'crm.object_schemas.create_association', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nassociation_definition = client.crm.object_schemas.create_association(\n object_type="objectType",\n from_object_type_id="fromObjectTypeId",\n to_object_type_id="toObjectTypeId",\n)\nprint(association_definition.id)', - }, - java: { - method: 'crm().objectSchemas().createAssociation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationDefinition;\nimport com.hubspot.sdk.models.AssociationDefinitionEgg;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaCreateAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaCreateAssociationParams params = ObjectSchemaCreateAssociationParams.builder()\n .objectType("objectType")\n .associationDefinitionEgg(AssociationDefinitionEgg.builder()\n .fromObjectTypeId("fromObjectTypeId")\n .toObjectTypeId("toObjectTypeId")\n .build())\n .build();\n AssociationDefinition associationDefinition = client.crm().objectSchemas().createAssociation(params);\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.NewAssociation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tassociationDefinition, err := client.Crm.ObjectSchemas.NewAssociation(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaNewAssociationParams{\n\t\t\tAssociationDefinitionEgg: shared.AssociationDefinitionEggParam{\n\t\t\t\tFromObjectTypeID: "fromObjectTypeId",\n\t\t\t\tToObjectTypeID: "toObjectTypeId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", associationDefinition.ID)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.create_association', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nassociation_definition = hubspot.crm.object_schemas.create_association(\n "objectType",\n from_object_type_id: "fromObjectTypeId",\n to_object_type_id: "toObjectTypeId"\n)\n\nputs(association_definition)', - }, - php: { - method: 'crm->objectSchemas->createAssociation', - example: - "crm->objectSchemas->createAssociation(\n 'objectType',\n fromObjectTypeID: 'fromObjectTypeId',\n toObjectTypeID: 'toObjectTypeId',\n name: 'name',\n);\n\nvar_dump($associationDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE/associations \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromObjectTypeId": "fromObjectTypeId",\n "toObjectTypeId": "toObjectTypeId"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', - httpMethod: 'delete', - summary: 'Delete the schema of a specified custom object.', - description: - 'Remove a custom object schema from the account using its object type ID or fully qualified name.', - stainlessPath: '(resource) crm.object_schemas > (method) delete', - qualified: 'client.crm.objectSchemas.delete', - params: ['objectType: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.crm.objectSchemas.delete(objectType: string, archived?: boolean): void`\n\n**delete** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nRemove a custom object schema from the account using its object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objectSchemas.delete('objectType')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objectSchemas.delete('objectType');", - }, - python: { - method: 'crm.object_schemas.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.object_schemas.delete(\n object_type="objectType",\n)', - }, - java: { - method: 'crm().objectSchemas().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objectSchemas().delete("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.ObjectSchemas.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.object_schemas.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.object_schemas.delete("objectType")\n\nputs(result)', - }, - php: { - method: 'crm->objectSchemas->delete', - example: - "crm->objectSchemas->delete('objectType', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_association', - endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}', - httpMethod: 'delete', - summary: 'Delete an existing association for a specified object type.', - description: - 'Remove an association between two object types identified by the association identifier and object type. This operation is irreversible and will permanently delete the specified association.', - stainlessPath: '(resource) crm.object_schemas > (method) delete_association', - qualified: 'client.crm.objectSchemas.deleteAssociation', - params: ['objectType: string;', 'associationIdentifier: string;'], - markdown: - "## delete_association\n\n`client.crm.objectSchemas.deleteAssociation(objectType: string, associationIdentifier: string): void`\n\n**delete** `/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}`\n\nRemove an association between two object types identified by the association identifier and object type. This operation is irreversible and will permanently delete the specified association.\n\n### Parameters\n\n- `objectType: string`\n\n- `associationIdentifier: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objectSchemas.deleteAssociation('associationIdentifier', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.deleteAssociation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objectSchemas.deleteAssociation('associationIdentifier', {\n objectType: 'objectType',\n});", - }, - python: { - method: 'crm.object_schemas.delete_association', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.object_schemas.delete_association(\n association_identifier="associationIdentifier",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().objectSchemas().deleteAssociation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaDeleteAssociationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaDeleteAssociationParams params = ObjectSchemaDeleteAssociationParams.builder()\n .objectType("objectType")\n .associationIdentifier("associationIdentifier")\n .build();\n client.crm().objectSchemas().deleteAssociation(params);\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.DeleteAssociation', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.ObjectSchemas.DeleteAssociation(\n\t\tcontext.TODO(),\n\t\t"associationIdentifier",\n\t\tcrm.ObjectSchemaDeleteAssociationParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.object_schemas.delete_association', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.object_schemas.delete_association("associationIdentifier", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->objectSchemas->deleteAssociation', - example: - "crm->objectSchemas->deleteAssociation(\n 'associationIdentifier', objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE/associations/$ASSOCIATION_IDENTIFIER \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', - httpMethod: 'get', - summary: 'Retrieve the schema of a specified custom object.', - description: - 'Retrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name.', - stainlessPath: '(resource) crm.object_schemas > (method) get', - qualified: 'client.crm.objectSchemas.get', - params: [ - 'objectType: string;', - 'includeAssociationDefinitions?: boolean;', - 'includeAuditMetadata?: boolean;', - 'includePropertyDefinitions?: boolean;', - ], - response: - '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }', - markdown: - "## get\n\n`client.crm.objectSchemas.get(objectType: string, includeAssociationDefinitions?: boolean, includeAuditMetadata?: boolean, includePropertyDefinitions?: boolean): { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n**get** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nRetrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `includeAssociationDefinitions?: boolean`\n\n- `includeAuditMetadata?: boolean`\n\n- `includePropertyDefinitions?: boolean`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `createdByUserId?: number`\n - `description?: string`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n - `updatedByUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectSchema = await client.crm.objectSchemas.get('objectType');\n\nconsole.log(objectSchema);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectSchema = await client.crm.objectSchemas.get('objectType');\n\nconsole.log(objectSchema.id);", - }, - python: { - method: 'crm.object_schemas.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_schema = client.crm.object_schemas.get(\n object_type="objectType",\n)\nprint(object_schema.id)', - }, - java: { - method: 'crm().objectSchemas().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchema;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchema objectSchema = client.crm().objectSchemas().get("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectSchema, err := client.Crm.ObjectSchemas.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectSchema.ID)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_schema = hubspot.crm.object_schemas.get("objectType")\n\nputs(object_schema)', - }, - php: { - method: 'crm->objectSchemas->get', - example: - "crm->objectSchemas->get(\n 'objectType',\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n);\n\nvar_dump($objectSchema);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm-object-schemas/2026-03/schemas', - httpMethod: 'get', - summary: 'Retrieve all custom object schemas.', - description: - 'Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.', - stainlessPath: '(resource) crm.object_schemas > (method) list', - qualified: 'client.crm.objectSchemas.list', - params: [ - 'archived?: boolean;', - 'includeAssociationDefinitions?: boolean;', - 'includeAuditMetadata?: boolean;', - 'includePropertyDefinitions?: boolean;', - ], - response: - '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', - markdown: - "## list\n\n`client.crm.objectSchemas.list(archived?: boolean, includeAssociationDefinitions?: boolean, includeAuditMetadata?: boolean, includePropertyDefinitions?: boolean): { results: object_schema[]; }`\n\n**get** `/crm-object-schemas/2026-03/schemas`\n\nRetrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.\n\n### Parameters\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includeAssociationDefinitions?: boolean`\n\n- `includeAuditMetadata?: boolean`\n\n- `includePropertyDefinitions?: boolean`\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.list();\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.list();\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", - }, - python: { - method: 'crm.object_schemas.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.crm.object_schemas.list()\nprint(collection_response_object_schema_no_paging.results)', - }, - java: { - method: 'crm().objectSchemas().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.crm().objectSchemas().list();\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Crm.ObjectSchemas.List(context.TODO(), crm.ObjectSchemaListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.crm.object_schemas.list\n\nputs(collection_response_object_schema_no_paging)', - }, - php: { - method: 'crm->objectSchemas->list', - example: - "crm->objectSchemas->list(\n archived: true,\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/crm-object-schemas/2026-03/schemas/{objectType}', - httpMethod: 'patch', - summary: 'Update the schema of a specified custom object.', - description: - 'Update attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name.', - stainlessPath: '(resource) crm.object_schemas > (method) update', - qualified: 'client.crm.objectSchemas.update', - params: [ - 'objectType: string;', - 'clearDescription: boolean;', - 'allowsSensitiveProperties?: boolean;', - 'description?: string;', - 'labels?: { plural?: string; singular?: string; };', - 'primaryDisplayProperty?: string;', - 'requiredProperties?: string[];', - 'restorable?: boolean;', - 'searchableProperties?: string[];', - 'secondaryDisplayProperties?: string[];', - ], - response: - '{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }', - markdown: - "## update\n\n`client.crm.objectSchemas.update(objectType: string, clearDescription: boolean, allowsSensitiveProperties?: boolean, description?: string, labels?: { plural?: string; singular?: string; }, primaryDisplayProperty?: string, requiredProperties?: string[], restorable?: boolean, searchableProperties?: string[], secondaryDisplayProperties?: string[]): { id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n**patch** `/crm-object-schemas/2026-03/schemas/{objectType}`\n\nUpdate attributes of a custom object schema, such as properties and labels, using the object type ID or fully qualified name.\n\n### Parameters\n\n- `objectType: string`\n\n- `clearDescription: boolean`\n\n- `allowsSensitiveProperties?: boolean`\n\n- `description?: string`\n\n- `labels?: { plural?: string; singular?: string; }`\n - `plural?: string`\n - `singular?: string`\n\n- `primaryDisplayProperty?: string`\n\n- `requiredProperties?: string[]`\n\n- `restorable?: boolean`\n\n- `searchableProperties?: string[]`\n\n- `secondaryDisplayProperties?: string[]`\n\n### Returns\n\n- `{ id: string; allowsSensitiveProperties: boolean; archived: boolean; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; description?: string; portalId?: number; primaryDisplayProperty?: string; updatedAt?: string; }`\n\n - `id: string`\n - `allowsSensitiveProperties: boolean`\n - `archived: boolean`\n - `fullyQualifiedName: string`\n - `labels: { plural?: string; singular?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `requiredProperties: string[]`\n - `searchableProperties: string[]`\n - `secondaryDisplayProperties: string[]`\n - `createdAt?: string`\n - `description?: string`\n - `portalId?: number`\n - `primaryDisplayProperty?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst objectTypeDefinition = await client.crm.objectSchemas.update('objectType', { clearDescription: true });\n\nconsole.log(objectTypeDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst objectTypeDefinition = await client.crm.objectSchemas.update('objectType', {\n clearDescription: true,\n});\n\nconsole.log(objectTypeDefinition.id);", - }, - python: { - method: 'crm.object_schemas.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nobject_type_definition = client.crm.object_schemas.update(\n object_type="objectType",\n clear_description=True,\n)\nprint(object_type_definition.id)', - }, - java: { - method: 'crm().objectSchemas().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.ObjectTypeDefinition;\nimport com.hubspot.sdk.models.ObjectTypeDefinitionPatch;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaUpdateParams params = ObjectSchemaUpdateParams.builder()\n .objectType("objectType")\n .objectTypeDefinitionPatch(ObjectTypeDefinitionPatch.builder()\n .clearDescription(true)\n .build())\n .build();\n ObjectTypeDefinition objectTypeDefinition = client.crm().objectSchemas().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tobjectTypeDefinition, err := client.Crm.ObjectSchemas.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectSchemaUpdateParams{\n\t\t\tObjectTypeDefinitionPatch: shared.ObjectTypeDefinitionPatchParam{\n\t\t\t\tClearDescription: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", objectTypeDefinition.ID)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nobject_type_definition = hubspot.crm.object_schemas.update("objectType", clear_description: true)\n\nputs(object_type_definition)', - }, - php: { - method: 'crm->objectSchemas->update', - example: - "crm->objectSchemas->update(\n 'objectType',\n clearDescription: true,\n allowsSensitiveProperties: true,\n description: 'description',\n labels: ['plural' => 'plural', 'singular' => 'singular'],\n primaryDisplayProperty: 'primaryDisplayProperty',\n requiredProperties: ['string'],\n restorable: true,\n searchableProperties: ['string'],\n secondaryDisplayProperties: ['string'],\n);\n\nvar_dump($objectTypeDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/$OBJECT_TYPE \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearDescription": true\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm-object-schemas/2026-03/schemas/batch/read', - httpMethod: 'post', - summary: 'Retrieve multiple custom object schemas in a batch request.', - description: - 'Retrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call.', - stainlessPath: '(resource) crm.object_schemas.batch > (method) get', - qualified: 'client.crm.objectSchemas.batch.get', - params: [ - 'includeAssociationDefinitions: boolean;', - 'includeAuditMetadata: boolean;', - 'includePropertyDefinitions: boolean;', - 'inputs: string[];', - ], - response: - '{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }', - markdown: - "## get\n\n`client.crm.objectSchemas.batch.get(includeAssociationDefinitions: boolean, includeAuditMetadata: boolean, includePropertyDefinitions: boolean, inputs: string[]): { results: object_schema[]; }`\n\n**post** `/crm-object-schemas/2026-03/schemas/batch/read`\n\nRetrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call.\n\n### Parameters\n\n- `includeAssociationDefinitions: boolean`\n Indicates whether to include association definitions in the response.\n\n- `includeAuditMetadata: boolean`\n Indicates whether to include audit metadata in the response.\n\n- `includePropertyDefinitions: boolean`\n Indicates whether to include property definitions in the response.\n\n- `inputs: string[]`\n\n### Returns\n\n- `{ results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: association_definition[]; fullyQualifiedName: string; labels: object_type_definition_labels; name: string; objectTypeId: string; properties: property[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]; }`\n\n - `results: { id: string; allowsSensitiveProperties: boolean; archived: boolean; associations: { id: string; fromObjectTypeId: string; toObjectTypeId: string; createdAt?: string; name?: string; updatedAt?: string; }[]; fullyQualifiedName: string; labels: { plural?: string; singular?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; requiredProperties: string[]; searchableProperties: string[]; secondaryDisplayProperties: string[]; createdAt?: string; createdByUserId?: number; description?: string; primaryDisplayProperty?: string; updatedAt?: string; updatedByUserId?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.batch.get({\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n});\n\nconsole.log(collectionResponseObjectSchemaNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objectSchemas.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseObjectSchemaNoPaging = await client.crm.objectSchemas.batch.get({\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n});\n\nconsole.log(collectionResponseObjectSchemaNoPaging.results);", - }, - python: { - method: 'crm.object_schemas.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_object_schema_no_paging = client.crm.object_schemas.batch.get(\n include_association_definitions=True,\n include_audit_metadata=True,\n include_property_definitions=True,\n inputs=["string"],\n)\nprint(collection_response_object_schema_no_paging.results)', - }, - java: { - method: 'crm().objectSchemas().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objectschemas.CollectionResponseObjectSchemaNoPaging;\nimport com.hubspot.sdk.models.crm.objectschemas.ObjectSchemaBatchReadRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSchemaBatchReadRequest params = ObjectSchemaBatchReadRequest.builder()\n .includeAssociationDefinitions(true)\n .includeAuditMetadata(true)\n .includePropertyDefinitions(true)\n .addInput("string")\n .build();\n CollectionResponseObjectSchemaNoPaging collectionResponseObjectSchemaNoPaging = client.crm().objectSchemas().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.ObjectSchemas.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseObjectSchemaNoPaging, err := client.Crm.ObjectSchemas.Batch.Get(context.TODO(), crm.ObjectSchemaBatchGetParams{\n\t\tObjectSchemaBatchReadRequest: crm.ObjectSchemaBatchReadRequestParam{\n\t\t\tIncludeAssociationDefinitions: true,\n\t\t\tIncludeAuditMetadata: true,\n\t\t\tIncludePropertyDefinitions: true,\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseObjectSchemaNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.object_schemas.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_object_schema_no_paging = hubspot.crm.object_schemas.batch.get(\n include_association_definitions: true,\n include_audit_metadata: true,\n include_property_definitions: true,\n inputs: ["string"]\n)\n\nputs(collection_response_object_schema_no_paging)', - }, - php: { - method: 'crm->objectSchemas->batch->get', - example: - "crm\n ->objectSchemas\n ->batch\n ->get(\n includeAssociationDefinitions: true,\n includeAuditMetadata: true,\n includePropertyDefinitions: true,\n inputs: ['string'],\n);\n\nvar_dump($collectionResponseObjectSchemaNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm-object-schemas/2026-03/schemas/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "includeAssociationDefinitions": true,\n "includeAuditMetadata": true,\n "includePropertyDefinitions": true,\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/calls', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.', - stainlessPath: '(resource) crm.objects.calls > (method) create', - qualified: 'client.crm.objects.calls.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.calls.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/calls`\n\nCreate a call with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard calls is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.calls.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.calls.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.calls.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.calls.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().calls().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().calls().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Calls.New(context.TODO(), crm.ObjectCallNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.calls.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->calls->create', - example: - "crm->objects->calls->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/calls/{callId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{callId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.calls > (method) delete', - qualified: 'client.crm.objects.calls.delete', - params: ['callId: string;'], - markdown: - "## delete\n\n`client.crm.objects.calls.delete(callId: string): void`\n\n**delete** `/crm/objects/2026-03/calls/{callId}`\n\nMove an Object identified by `{callId}` to the recycling bin.\n\n### Parameters\n\n- `callId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.calls.delete('callId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.calls.delete('callId');", - }, - python: { - method: 'crm.objects.calls.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.calls.delete(\n "callId",\n)', - }, - java: { - method: 'crm().objects().calls().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.calls.CallDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().calls().delete("callId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Calls.Delete(context.TODO(), "callId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.calls.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.calls.delete("callId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->calls->delete', - example: - "crm->objects->calls->delete('callId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/calls/{callId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.calls > (method) get', - qualified: 'client.crm.objects.calls.get', - params: [ - 'callId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.calls.get(callId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/calls/{callId}`\n\nRead an Object identified by `{callId}`. `{callId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `callId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.calls.get('callId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.calls.get('callId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.calls.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.calls.get(\n call_id="callId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().calls().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.calls.CallGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().calls().get("callId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Calls.Get(\n\t\tcontext.TODO(),\n\t\t"callId",\n\t\tcrm.ObjectCallGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.calls.get("callId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->calls->get', - example: - "crm->objects->calls->get(\n 'callId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/calls', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of calls. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.calls > (method) list', - qualified: 'client.crm.objects.calls.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.calls.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/calls`\n\nRead a page of calls. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.calls.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.calls.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.calls.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.calls.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().calls().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.calls.CallListPage;\nimport com.hubspot.sdk.models.crm.objects.calls.CallListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallListPage page = client.crm().objects().calls().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Calls.List(context.TODO(), crm.ObjectCallListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.calls.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->calls->list', - example: - "crm->objects->calls->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/calls/search', - httpMethod: 'post', - summary: 'Search for calls', - description: - 'Search for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.calls > (method) search', - qualified: 'client.crm.objects.calls.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.calls.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/calls/search`\n\nSearch for calls by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.calls.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.calls.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.calls.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.calls.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().calls().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().calls().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Calls.Search(context.TODO(), crm.ObjectCallSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.calls.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->calls->search', - example: - "crm\n ->objects\n ->calls\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/calls/{callId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.calls > (method) update', - qualified: 'client.crm.objects.calls.update', - params: ['callId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.calls.update(callId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/calls/{callId}`\n\nPerform a partial update of an Object identified by `{callId}`or optionally a unique property value as specified by the `idProperty` query param. `{callId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `callId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.calls.update('callId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.calls.update('callId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.calls.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.calls.update(\n call_id="callId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().calls().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.calls.CallUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CallUpdateParams params = CallUpdateParams.builder()\n .callId("callId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().calls().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Calls.Update(\n\t\tcontext.TODO(),\n\t\t"callId",\n\t\tcrm.ObjectCallUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.calls.update("callId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->calls->update', - example: - "crm->objects->calls->update(\n 'callId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/$CALL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/calls/batch/create', - httpMethod: 'post', - summary: 'Create a batch of calls', - description: - 'Create a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', - stainlessPath: '(resource) crm.objects.calls.batch > (method) create', - qualified: 'client.crm.objects.calls.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.calls.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/create`\n\nCreate a batch of calls. The `inputs` array can contain a `properties` object to define property values for each record, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.calls.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().calls().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.New(context.TODO(), crm.ObjectCallBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->calls->batch->create', - example: - "crm->objects->calls->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/calls/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of calls by ID', - description: - 'Archive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).', - stainlessPath: '(resource) crm.objects.calls.batch > (method) delete', - qualified: 'client.crm.objects.calls.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.calls.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/calls/batch/archive`\n\nArchive a batch of calls by ID. Deleted calls can be restored within 90 days of being deleted, but call recordings recording will be permanently deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.calls.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.calls.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.calls.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.calls.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().calls().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().calls().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Calls.Batch.Delete(context.TODO(), crm.ObjectCallBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.calls.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.calls.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->calls->batch->delete', - example: - "crm->objects->calls->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/calls/batch/read', - httpMethod: 'post', - summary: 'Read a batch of calls by internal ID, or unique property values', - description: 'Retrieve a batch of calls by ID.', - stainlessPath: '(resource) crm.objects.calls.batch > (method) get', - qualified: 'client.crm.objects.calls.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.calls.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/read`\n\nRetrieve a batch of calls by ID.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.calls.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().calls().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.Get(context.TODO(), crm.ObjectCallBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->calls->batch->get', - example: - "crm->objects->calls->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/calls/batch/update', - httpMethod: 'post', - summary: 'Update a batch of calls by internal ID, or unique property values', - description: 'Update a batch of calls by ID.', - stainlessPath: '(resource) crm.objects.calls.batch > (method) update', - qualified: 'client.crm.objects.calls.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.calls.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/update`\n\nUpdate a batch of calls by ID.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.calls.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.calls.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.calls.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().calls().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().calls().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Calls.Batch.Update(context.TODO(), crm.ObjectCallBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.calls.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->calls->batch->update', - example: - "crm->objects->calls->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/calls/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of calls by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.calls.batch > (method) upsert', - qualified: 'client.crm.objects.calls.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.calls.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/calls/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.calls.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.calls.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.calls.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.calls.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.calls.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().calls().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().calls().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Calls.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Calls.Batch.Upsert(context.TODO(), crm.ObjectCallBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.calls.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.calls.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->calls->batch->upsert', - example: - "crm\n ->objects\n ->calls\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/calls/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/carts', - httpMethod: 'post', - summary: 'Create a cart', - description: - 'Create a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.', - stainlessPath: '(resource) crm.objects.carts > (method) create', - qualified: 'client.crm.objects.carts.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.carts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/carts`\n\nCreate a cart with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard carts is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.carts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.carts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.carts.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.carts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().carts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().carts().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Carts.New(context.TODO(), crm.ObjectCartNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.carts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->carts->create', - example: - "crm->objects->carts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/carts/{cartId}', - httpMethod: 'delete', - summary: 'Delete a cart', - description: 'Delete a cart by its ID, moving it to the recycling bin.', - stainlessPath: '(resource) crm.objects.carts > (method) delete', - qualified: 'client.crm.objects.carts.delete', - params: ['cartId: string;'], - markdown: - "## delete\n\n`client.crm.objects.carts.delete(cartId: string): void`\n\n**delete** `/crm/objects/2026-03/carts/{cartId}`\n\nDelete a cart by its ID, moving it to the recycling bin.\n\n### Parameters\n\n- `cartId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.carts.delete('cartId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.carts.delete('cartId');", - }, - python: { - method: 'crm.objects.carts.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.carts.delete(\n "cartId",\n)', - }, - java: { - method: 'crm().objects().carts().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.carts.CartDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().carts().delete("cartId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Carts.Delete(context.TODO(), "cartId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.carts.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.carts.delete("cartId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->carts->delete', - example: - "crm->objects->carts->delete('cartId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/carts/{cartId}', - httpMethod: 'get', - summary: 'Retrieve a cart', - description: - 'Retrieve a cart by its ID. You can control what is returned via the `properties` query parameter.', - stainlessPath: '(resource) crm.objects.carts > (method) get', - qualified: 'client.crm.objects.carts.get', - params: [ - 'cartId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.carts.get(cartId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/carts/{cartId}`\n\nRetrieve a cart by its ID. You can control what is returned via the `properties` query parameter.\n\n### Parameters\n\n- `cartId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.carts.get('cartId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.carts.get('cartId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.carts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.carts.get(\n cart_id="cartId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().carts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.carts.CartGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().carts().get("cartId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Carts.Get(\n\t\tcontext.TODO(),\n\t\t"cartId",\n\t\tcrm.ObjectCartGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.carts.get("cartId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->carts->get', - example: - "crm->objects->carts->get(\n 'cartId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/carts', - httpMethod: 'get', - summary: 'Retrieve carts', - description: 'Retrieve all carts. You can control what is returned via the `properties` query parameter.', - stainlessPath: '(resource) crm.objects.carts > (method) list', - qualified: 'client.crm.objects.carts.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.carts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/carts`\n\nRetrieve all carts. You can control what is returned via the `properties` query parameter.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.carts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.carts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.carts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.carts.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().carts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.carts.CartListPage;\nimport com.hubspot.sdk.models.crm.objects.carts.CartListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CartListPage page = client.crm().objects().carts().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Carts.List(context.TODO(), crm.ObjectCartListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.carts.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->carts->list', - example: - "crm->objects->carts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/carts/search', - httpMethod: 'post', - summary: 'Search for carts', - description: - 'Search for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results.', - stainlessPath: '(resource) crm.objects.carts > (method) search', - qualified: 'client.crm.objects.carts.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.carts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/carts/search`\n\nSearch for carts based on the specified search criteria, such as filters and properties, and retrieve the matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.carts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.carts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.carts.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.carts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().carts().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().carts().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Carts.Search(context.TODO(), crm.ObjectCartSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.carts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->carts->search', - example: - "crm\n ->objects\n ->carts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/carts/{cartId}', - httpMethod: 'patch', - summary: 'Update a cart', - description: - 'Perform a partial update of a cart, specified by its ID. Alternatively, you can specify a cart by a unique property value using the `idProperty` query parameter. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.carts > (method) update', - qualified: 'client.crm.objects.carts.update', - params: ['cartId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.carts.update(cartId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/carts/{cartId}`\n\nPerform a partial update of a cart, specified by its ID. Alternatively, you can specify a cart by a unique property value using the `idProperty` query parameter. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `cartId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.carts.update('cartId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.carts.update('cartId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.carts.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.carts.update(\n cart_id="cartId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().carts().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.carts.CartUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CartUpdateParams params = CartUpdateParams.builder()\n .cartId("cartId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().carts().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Carts.Update(\n\t\tcontext.TODO(),\n\t\t"cartId",\n\t\tcrm.ObjectCartUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.carts.update("cartId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->carts->update', - example: - "crm->objects->carts->update(\n 'cartId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/$CART_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/carts/batch/create', - httpMethod: 'post', - summary: 'Create a batch of carts', - description: 'Create a batch of carts with specified properties and associations.', - stainlessPath: '(resource) crm.objects.carts.batch > (method) create', - qualified: 'client.crm.objects.carts.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.carts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/create`\n\nCreate a batch of carts with specified properties and associations.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.carts.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().carts().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.New(context.TODO(), crm.ObjectCartBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->carts->batch->create', - example: - "crm->objects->carts->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/carts/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of carts', - description: 'Archive a batch of carts identified by their IDs.', - stainlessPath: '(resource) crm.objects.carts.batch > (method) delete', - qualified: 'client.crm.objects.carts.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.carts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/carts/batch/archive`\n\nArchive a batch of carts identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.carts.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.carts.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.carts.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.carts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().carts().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().carts().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Carts.Batch.Delete(context.TODO(), crm.ObjectCartBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.carts.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.carts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->carts->batch->delete', - example: - "crm->objects->carts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/carts/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of carts', - description: - 'Retrieve carts by ID, or include the `idProperty` parameter to retrieve carts by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.carts.batch > (method) get', - qualified: 'client.crm.objects.carts.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.carts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/read`\n\nRetrieve carts by ID, or include the `idProperty` parameter to retrieve carts by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.carts.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().carts().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.Get(context.TODO(), crm.ObjectCartBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->carts->batch->get', - example: - "crm->objects->carts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/carts/batch/update', - httpMethod: 'post', - summary: 'Update a batch of carts', - description: 'Update a batch of carts using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.carts.batch > (method) update', - qualified: 'client.crm.objects.carts.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.carts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/update`\n\nUpdate a batch of carts using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.carts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.carts.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.carts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().carts().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().carts().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Carts.Batch.Update(context.TODO(), crm.ObjectCartBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.carts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->carts->batch->update', - example: - "crm->objects->carts->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/carts/batch/upsert', - httpMethod: 'post', - summary: 'Upsert a batch of carts', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query parameter.', - stainlessPath: '(resource) crm.objects.carts.batch > (method) upsert', - qualified: 'client.crm.objects.carts.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.carts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/carts/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query parameter.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.carts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.carts.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.carts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.carts.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.carts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().carts().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().carts().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Carts.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Carts.Batch.Upsert(context.TODO(), crm.ObjectCartBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.carts.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.carts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->carts->batch->upsert', - example: - "crm\n ->objects\n ->carts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/carts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/commerce_payments', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) create', - qualified: 'client.crm.objects.commercePayments.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.commercePayments.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments`\n\nCreate a commerce payment with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard commerce payments is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.commercePayments.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.commercePayments.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.commerce_payments.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.commerce_payments.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().commercePayments().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().commercePayments().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.CommercePayments.New(context.TODO(), crm.ObjectCommercePaymentNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.commerce_payments.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->create', - example: - "crm->objects->commercePayments->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{commercePaymentId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) delete', - qualified: 'client.crm.objects.commercePayments.delete', - params: ['commercePaymentId: string;'], - markdown: - "## delete\n\n`client.crm.objects.commercePayments.delete(commercePaymentId: string): void`\n\n**delete** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nMove an Object identified by `{commercePaymentId}` to the recycling bin.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.commercePayments.delete('commercePaymentId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.commercePayments.delete('commercePaymentId');", - }, - python: { - method: 'crm.objects.commerce_payments.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.commerce_payments.delete(\n "commercePaymentId",\n)', - }, - java: { - method: 'crm().objects().commercePayments().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().commercePayments().delete("commercePaymentId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.CommercePayments.Delete(context.TODO(), "commercePaymentId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.commerce_payments.delete("commercePaymentId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->commercePayments->delete', - example: - "crm->objects->commercePayments->delete('commercePaymentId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) get', - qualified: 'client.crm.objects.commercePayments.get', - params: [ - 'commercePaymentId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.commercePayments.get(commercePaymentId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nRead an Object identified by `{commercePaymentId}`. `{commercePaymentId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.commercePayments.get('commercePaymentId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.commercePayments.get(\n 'commercePaymentId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.commerce_payments.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.commerce_payments.get(\n commerce_payment_id="commercePaymentId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().commercePayments().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().commercePayments().get("commercePaymentId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.CommercePayments.Get(\n\t\tcontext.TODO(),\n\t\t"commercePaymentId",\n\t\tcrm.ObjectCommercePaymentGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.commerce_payments.get("commercePaymentId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->commercePayments->get', - example: - "crm\n ->objects\n ->commercePayments\n ->get(\n 'commercePaymentId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/commerce_payments', - httpMethod: 'get', - summary: 'List', - description: - 'Read a page of commerce payments. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) list', - qualified: 'client.crm.objects.commercePayments.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.commercePayments.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/commerce_payments`\n\nRead a page of commerce payments. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.commercePayments.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.commercePayments.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.commerce_payments.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.commerce_payments.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().commercePayments().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentListPage;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommercePaymentListPage page = client.crm().objects().commercePayments().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.CommercePayments.List(context.TODO(), crm.ObjectCommercePaymentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.commerce_payments.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->commercePayments->list', - example: - "crm->objects->commercePayments->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/commerce_payments/search', - httpMethod: 'post', - summary: 'Search for commerce payments using specified criteria.', - description: - 'Execute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) search', - qualified: 'client.crm.objects.commercePayments.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.commercePayments.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/search`\n\nExecute a search for commerce payments based on the provided filter groups, properties, and sorting options. This endpoint allows for complex queries to retrieve specific payment records from the CRM.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.commercePayments.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.commercePayments.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.commerce_payments.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.commerce_payments.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().commercePayments().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().commercePayments().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.CommercePayments.Search(context.TODO(), crm.ObjectCommercePaymentSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.commerce_payments.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->search', - example: - "crm\n ->objects\n ->commercePayments\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.commerce_payments > (method) update', - qualified: 'client.crm.objects.commercePayments.update', - params: ['commercePaymentId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.commercePayments.update(commercePaymentId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/commerce_payments/{commercePaymentId}`\n\nPerform a partial update of an Object identified by `{commercePaymentId}`or optionally a unique property value as specified by the `idProperty` query param. `{commercePaymentId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `commercePaymentId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.commercePayments.update('commercePaymentId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.commercePayments.update('commercePaymentId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.commerce_payments.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.commerce_payments.update(\n commerce_payment_id="commercePaymentId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().commercePayments().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.commercepayments.CommercePaymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommercePaymentUpdateParams params = CommercePaymentUpdateParams.builder()\n .commercePaymentId("commercePaymentId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().commercePayments().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.CommercePayments.Update(\n\t\tcontext.TODO(),\n\t\t"commercePaymentId",\n\t\tcrm.ObjectCommercePaymentUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.commerce_payments.update("commercePaymentId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->update', - example: - "crm->objects->commercePayments->update(\n 'commercePaymentId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/$COMMERCE_PAYMENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/commerce_payments/batch/create', - httpMethod: 'post', - summary: 'Create a batch of commerce payments', - description: - 'Create multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs.', - stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) create', - qualified: 'client.crm.objects.commercePayments.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.commercePayments.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/create`\n\nCreate multiple commerce payment records in a single request, returning the details of each created payment, including their unique IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.commerce_payments.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().commercePayments().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.New(context.TODO(), crm.ObjectCommercePaymentBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->batch->create', - example: - "crm\n ->objects\n ->commercePayments\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/commerce_payments/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of commerce payments by ID', - description: - 'Archive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system.', - stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) delete', - qualified: 'client.crm.objects.commercePayments.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.commercePayments.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/archive`\n\nArchive a batch of commerce payments by their IDs. This operation moves the specified payments to the archive, making them inactive in the system.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.commercePayments.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.commercePayments.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.commerce_payments.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.commerce_payments.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().commercePayments().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().commercePayments().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.CommercePayments.Batch.Delete(context.TODO(), crm.ObjectCommercePaymentBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.commerce_payments.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->commercePayments->batch->delete', - example: - "crm->objects->commercePayments->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/commerce_payments/batch/read', - httpMethod: 'post', - summary: 'Read a batch of commerce payments by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) get', - qualified: 'client.crm.objects.commercePayments.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.commercePayments.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.commerce_payments.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().commercePayments().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.Get(context.TODO(), crm.ObjectCommercePaymentBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->batch->get', - example: - "crm\n ->objects\n ->commercePayments\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/commerce_payments/batch/update', - httpMethod: 'post', - summary: 'Update a batch of commerce payments by internal ID, or unique property values', - description: - 'Update multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values.', - stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) update', - qualified: 'client.crm.objects.commercePayments.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.commercePayments.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/update`\n\nUpdate multiple commerce payment records using their internal IDs or unique property values. This operation allows you to modify existing payment records in bulk by providing a list of records with their respective IDs and updated property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.commercePayments.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.commerce_payments.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.commerce_payments.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().commercePayments().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().commercePayments().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.CommercePayments.Batch.Update(context.TODO(), crm.ObjectCommercePaymentBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.commerce_payments.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->commercePayments->batch->update', - example: - "crm\n ->objects\n ->commercePayments\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/commerce_payments/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of commerce payments by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.commerce_payments.batch > (method) upsert', - qualified: 'client.crm.objects.commercePayments.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.commercePayments.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/commerce_payments/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.commercePayments.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.commercePayments.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject =\n await client.crm.objects.commercePayments.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n });\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.commerce_payments.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.commerce_payments.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().commercePayments().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().commercePayments().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.CommercePayments.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.CommercePayments.Batch.Upsert(context.TODO(), crm.ObjectCommercePaymentBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.commerce_payments.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.commerce_payments.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->commercePayments->batch->upsert', - example: - "crm\n ->objects\n ->commercePayments\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/commerce_payments/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/communications', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.', - stainlessPath: '(resource) crm.objects.communications > (method) create', - qualified: 'client.crm.objects.communications.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.communications.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/communications`\n\nCreate a communication with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard communications is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.communications.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.communications.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.communications.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.communications.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().communications().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().communications().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Communications.New(context.TODO(), crm.ObjectCommunicationNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.communications.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->communications->create', - example: - "crm->objects->communications->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/communications/{communicationId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{communicationId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.communications > (method) delete', - qualified: 'client.crm.objects.communications.delete', - params: ['communicationId: string;'], - markdown: - "## delete\n\n`client.crm.objects.communications.delete(communicationId: string): void`\n\n**delete** `/crm/objects/2026-03/communications/{communicationId}`\n\nMove an Object identified by `{communicationId}` to the recycling bin.\n\n### Parameters\n\n- `communicationId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.communications.delete('communicationId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.communications.delete('communicationId');", - }, - python: { - method: 'crm.objects.communications.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.communications.delete(\n "communicationId",\n)', - }, - java: { - method: 'crm().objects().communications().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().communications().delete("communicationId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Communications.Delete(context.TODO(), "communicationId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.communications.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.communications.delete("communicationId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->communications->delete', - example: - "crm->objects->communications->delete('communicationId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/communications/{communicationId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.communications > (method) get', - qualified: 'client.crm.objects.communications.get', - params: [ - 'communicationId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.communications.get(communicationId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/communications/{communicationId}`\n\nRead an Object identified by `{communicationId}`. `{communicationId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `communicationId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.communications.get('communicationId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.communications.get(\n 'communicationId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.communications.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.communications.get(\n communication_id="communicationId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().communications().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().communications().get("communicationId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Communications.Get(\n\t\tcontext.TODO(),\n\t\t"communicationId",\n\t\tcrm.ObjectCommunicationGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.communications.get("communicationId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->communications->get', - example: - "crm\n ->objects\n ->communications\n ->get(\n 'communicationId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/communications', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of communications. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.communications > (method) list', - qualified: 'client.crm.objects.communications.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.communications.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/communications`\n\nRead a page of communications. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.communications.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.communications.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.communications.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.communications.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().communications().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationListPage;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationListPage page = client.crm().objects().communications().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Communications.List(context.TODO(), crm.ObjectCommunicationListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.communications.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->communications->list', - example: - "crm->objects->communications->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/communications/search', - httpMethod: 'post', - summary: 'Search for messages', - description: - 'Search for messages by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.communications > (method) search', - qualified: 'client.crm.objects.communications.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.communications.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/communications/search`\n\nSearch for messages by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.communications.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.communications.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.communications.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.communications.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().communications().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().communications().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Communications.Search(context.TODO(), crm.ObjectCommunicationSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.communications.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->communications->search', - example: - "crm\n ->objects\n ->communications\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/communications/{communicationId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.communications > (method) update', - qualified: 'client.crm.objects.communications.update', - params: ['communicationId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.communications.update(communicationId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/communications/{communicationId}`\n\nPerform a partial update of an Object identified by `{communicationId}`or optionally a unique property value as specified by the `idProperty` query param. `{communicationId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `communicationId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.communications.update('communicationId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.communications.update('communicationId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.communications.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.communications.update(\n communication_id="communicationId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().communications().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.communications.CommunicationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CommunicationUpdateParams params = CommunicationUpdateParams.builder()\n .communicationId("communicationId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().communications().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Communications.Update(\n\t\tcontext.TODO(),\n\t\t"communicationId",\n\t\tcrm.ObjectCommunicationUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.communications.update("communicationId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->communications->update', - example: - "crm->objects->communications->update(\n 'communicationId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/$COMMUNICATION_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/communications/batch/create', - httpMethod: 'post', - summary: 'Create a batch of communications', - description: - 'Create a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', - stainlessPath: '(resource) crm.objects.communications.batch > (method) create', - qualified: 'client.crm.objects.communications.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.communications.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/create`\n\nCreate a batch of messages. The `inputs` array can contain a `properties` object to define property values for each message, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.communications.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().communications().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.New(context.TODO(), crm.ObjectCommunicationBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->communications->batch->create', - example: - "crm\n ->objects\n ->communications\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/communications/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of communications by ID', - description: - 'Delete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).', - stainlessPath: '(resource) crm.objects.communications.batch > (method) delete', - qualified: 'client.crm.objects.communications.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.communications.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/communications/batch/archive`\n\nDelete a batch of messages by ID. A deleted message can be restored within 90 days of being deleted. Learn more about [restoring activity records](https://knowledge.hubspot.com/records/restore-deleted-activity-in-a-record).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.communications.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.communications.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.communications.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.communications.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().communications().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().communications().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Communications.Batch.Delete(context.TODO(), crm.ObjectCommunicationBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.communications.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.communications.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->communications->batch->delete', - example: - "crm->objects->communications->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/communications/batch/read', - httpMethod: 'post', - summary: 'Read a batch of communications by internal ID, or unique property values', - description: - 'Retrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). ', - stainlessPath: '(resource) crm.objects.communications.batch > (method) get', - qualified: 'client.crm.objects.communications.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.communications.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/read`\n\nRetrieve a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.communications.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().communications().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.Get(context.TODO(), crm.ObjectCommunicationBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->communications->batch->get', - example: - "crm\n ->objects\n ->communications\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/communications/batch/update', - httpMethod: 'post', - summary: 'Update a batch of communications by internal ID, or unique property values', - description: - 'Update a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.communications.batch > (method) update', - qualified: 'client.crm.objects.communications.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.communications.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/update`\n\nUpdate a batch of messages by ID (`communicationId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.communications.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.communications.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.communications.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().communications().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().communications().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Communications.Batch.Update(context.TODO(), crm.ObjectCommunicationBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.communications.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->communications->batch->update', - example: - "crm\n ->objects\n ->communications\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/communications/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of communications by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.communications.batch > (method) upsert', - qualified: 'client.crm.objects.communications.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.communications.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/communications/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.communications.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.communications.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.communications.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.communications.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.communications.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().communications().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().communications().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Communications.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Communications.Batch.Upsert(context.TODO(), crm.ObjectCommunicationBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.communications.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.communications.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->communications->batch->upsert', - example: - "crm\n ->objects\n ->communications\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/communications/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/companies', - httpMethod: 'post', - summary: 'Create a company', - description: - 'Create a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', - stainlessPath: '(resource) crm.objects.companies > (method) create', - qualified: 'client.crm.objects.companies.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.companies.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/companies`\n\nCreate a single company. Include a `properties` object to define [property values](https://developers.hubspot.com/docs/guides/api/crm/properties) for the company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.companies.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().companies().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.New(context.TODO(), crm.ObjectCompanyNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->companies->create', - example: - "crm->objects->companies->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/companies/{companyId}', - httpMethod: 'delete', - summary: 'Archive a company', - description: - 'Delete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', - stainlessPath: '(resource) crm.objects.companies > (method) delete', - qualified: 'client.crm.objects.companies.delete', - params: ['companyId: string;'], - markdown: - "## delete\n\n`client.crm.objects.companies.delete(companyId: string): void`\n\n**delete** `/crm/objects/2026-03/companies/{companyId}`\n\nDelete a company by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `companyId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.companies.delete('companyId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.companies.delete('companyId');", - }, - python: { - method: 'crm.objects.companies.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.companies.delete(\n "companyId",\n)', - }, - java: { - method: 'crm().objects().companies().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().companies().delete("companyId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Companies.Delete(context.TODO(), "companyId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.companies.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.companies.delete("companyId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->companies->delete', - example: - "crm->objects->companies->delete('companyId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/companies/{companyId}', - httpMethod: 'get', - summary: 'Retrieve a company', - description: - 'Retrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.', - stainlessPath: '(resource) crm.objects.companies > (method) get', - qualified: 'client.crm.objects.companies.get', - params: [ - 'companyId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.companies.get(companyId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/companies/{companyId}`\n\nRetrieve a company by its ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `companyId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.companies.get('companyId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.companies.get('companyId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.companies.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.companies.get(\n company_id="companyId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().companies().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().companies().get("companyId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Companies.Get(\n\t\tcontext.TODO(),\n\t\t"companyId",\n\t\tcrm.ObjectCompanyGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.companies.get("companyId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->companies->get', - example: - "crm->objects->companies->get(\n 'companyId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/companies', - httpMethod: 'get', - summary: 'Retrieve companies', - description: - 'Retrieve all companies, using query parameters to control the information that gets returned.', - stainlessPath: '(resource) crm.objects.companies > (method) list', - qualified: 'client.crm.objects.companies.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.companies.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/companies`\n\nRetrieve all companies, using query parameters to control the information that gets returned.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.companies.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.companies.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.companies.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.companies.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().companies().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyListPage;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyListPage page = client.crm().objects().companies().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Companies.List(context.TODO(), crm.ObjectCompanyListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.companies.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->companies->list', - example: - "crm->objects->companies->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/companies/merge', - httpMethod: 'post', - summary: 'Merge two companies', - description: - 'Merge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).', - stainlessPath: '(resource) crm.objects.companies > (method) merge', - qualified: 'client.crm.objects.companies.merge', - params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.companies.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/companies/merge`\n\nMerge two company records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.companies.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().companies().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.Merge(context.TODO(), crm.ObjectCompanyMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->companies->merge', - example: - "crm->objects->companies->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/companies/search', - httpMethod: 'post', - summary: 'Search for companies', - description: - 'Search for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.companies > (method) search', - qualified: 'client.crm.objects.companies.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.companies.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/companies/search`\n\nSearch for companies by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.companies.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.companies.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.companies.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.companies.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().companies().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().companies().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Companies.Search(context.TODO(), crm.ObjectCompanySearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.companies.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->companies->search', - example: - "crm\n ->objects\n ->companies\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/companies/{companyId}', - httpMethod: 'patch', - summary: 'Update a company', - description: - 'Update a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.companies > (method) update', - qualified: 'client.crm.objects.companies.update', - params: ['companyId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.companies.update(companyId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/companies/{companyId}`\n\nUpdate a company by ID (`companyId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `companyId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.companies.update('companyId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.companies.update('companyId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.companies.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.companies.update(\n company_id="companyId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().companies().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.companies.CompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyUpdateParams params = CompanyUpdateParams.builder()\n .companyId("companyId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().companies().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Companies.Update(\n\t\tcontext.TODO(),\n\t\t"companyId",\n\t\tcrm.ObjectCompanyUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.companies.update("companyId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->companies->update', - example: - "crm->objects->companies->update(\n 'companyId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/$COMPANY_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/companies/batch/create', - httpMethod: 'post', - summary: 'Create a batch of companies', - description: - 'Create a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', - stainlessPath: '(resource) crm.objects.companies.batch > (method) create', - qualified: 'client.crm.objects.companies.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.companies.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/create`\n\nCreate a batch of companies. The `inputs` array can contain a `properties` object to define property values for each company, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.companies.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().companies().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.New(context.TODO(), crm.ObjectCompanyBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->companies->batch->create', - example: - "crm\n ->objects\n ->companies\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/companies/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of companies', - description: - 'Delete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', - stainlessPath: '(resource) crm.objects.companies.batch > (method) delete', - qualified: 'client.crm.objects.companies.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.companies.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/companies/batch/archive`\n\nDelete a batch of companies by ID. Deleted companies can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.companies.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.companies.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.companies.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.companies.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().companies().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().companies().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Companies.Batch.Delete(context.TODO(), crm.ObjectCompanyBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.companies.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.companies.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->companies->batch->delete', - example: - "crm->objects->companies->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/companies/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of companies', - description: - 'Retrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.', - stainlessPath: '(resource) crm.objects.companies.batch > (method) get', - qualified: 'client.crm.objects.companies.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.companies.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/read`\n\nRetrieve a batch of companies by ID (`companyId`) or by a unique property (`idProperty`). You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.companies.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().companies().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.Get(context.TODO(), crm.ObjectCompanyBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->companies->batch->get', - example: - "crm->objects->companies->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/companies/batch/update', - httpMethod: 'post', - summary: 'Update a batch of companies', - description: 'Update a batch of companies by ID.', - stainlessPath: '(resource) crm.objects.companies.batch > (method) update', - qualified: 'client.crm.objects.companies.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.companies.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/update`\n\nUpdate a batch of companies by ID.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.companies.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.companies.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.companies.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().companies().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().companies().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Companies.Batch.Update(context.TODO(), crm.ObjectCompanyBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.companies.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->companies->batch->update', - example: - "crm\n ->objects\n ->companies\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/companies/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of companies by unique property values', - description: - 'Create or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.companies.batch > (method) upsert', - qualified: 'client.crm.objects.companies.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.companies.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/companies/batch/upsert`\n\nCreate or update companies identified by a unique property value as specified by the `idProperty` query parameter. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.companies.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.companies.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.companies.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.companies.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.companies.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().companies().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().companies().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Companies.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Companies.Batch.Upsert(context.TODO(), crm.ObjectCompanyBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.companies.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.companies.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->companies->batch->upsert', - example: - "crm\n ->objects\n ->companies\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/companies/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/contacts', - httpMethod: 'post', - summary: 'Create a contact', - description: 'Create a contact', - stainlessPath: '(resource) crm.objects.contacts > (method) create', - qualified: 'client.crm.objects.contacts.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.contacts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/contacts`\n\nCreate a contact\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.contacts.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().contacts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.New(context.TODO(), crm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->create', - example: - "crm->objects->contacts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/contacts/{contactId}', - httpMethod: 'delete', - summary: '', - description: - 'Delete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).', - stainlessPath: '(resource) crm.objects.contacts > (method) delete', - qualified: 'client.crm.objects.contacts.delete', - params: ['contactId: string;'], - markdown: - "## delete\n\n`client.crm.objects.contacts.delete(contactId: string): void`\n\n**delete** `/crm/objects/2026-03/contacts/{contactId}`\n\nDelete a contact by ID. Deleted contacts can be restored within 90 days of deletion. Learn more about the [data impacted by contact deletions](https://knowledge.hubspot.com/privacy-and-consent/understand-restorable-and-permanent-contact-deletions) and how to [restore archived records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `contactId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.delete('contactId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.delete('contactId');", - }, - python: { - method: 'crm.objects.contacts.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.delete(\n "contactId",\n)', - }, - java: { - method: 'crm().objects().contacts().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().contacts().delete("contactId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.Delete(context.TODO(), "contactId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.delete("contactId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->contacts->delete', - example: - "crm->objects->contacts->delete('contactId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'gdpr_delete', - endpoint: '/crm/objects/2026-03/contacts/gdpr-delete', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts > (method) gdpr_delete', - qualified: 'client.crm.objects.contacts.gdprDelete', - params: ['objectId: string;', 'idProperty?: string;'], - markdown: - "## gdpr_delete\n\n`client.crm.objects.contacts.gdprDelete(objectId: string, idProperty?: string): void`\n\n**post** `/crm/objects/2026-03/contacts/gdpr-delete`\n\n### Parameters\n\n- `objectId: string`\n The ID of the contact to permanently delete.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object. An alternative to identifying a contact by ID.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.gdprDelete({ objectId: 'objectId' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.gdprDelete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.gdprDelete({ objectId: 'objectId' });", - }, - python: { - method: 'crm.objects.contacts.gdpr_delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.gdpr_delete(\n object_id="objectId",\n)', - }, - java: { - method: 'crm().objects().contacts().gdprDelete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.PublicGdprDeleteInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicGdprDeleteInput params = PublicGdprDeleteInput.builder()\n .objectId("objectId")\n .build();\n client.crm().objects().contacts().gdprDelete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.GdprDelete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.GdprDelete(context.TODO(), crm.ObjectContactGdprDeleteParams{\n\t\tPublicGdprDeleteInput: crm.PublicGdprDeleteInputParam{\n\t\t\tObjectID: "objectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.gdpr_delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.gdpr_delete(object_id_: "objectId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->contacts->gdprDelete', - example: - "crm->objects->contacts->gdprDelete(\n objectID: 'objectId', idProperty: 'idProperty'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/gdpr-delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectId": "objectId"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/contacts/{contactId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts > (method) get', - qualified: 'client.crm.objects.contacts.get', - params: [ - 'contactId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.contacts.get(contactId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contacts/{contactId}`\n\n### Parameters\n\n- `contactId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.contacts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.contacts.get(\n contact_id="contactId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().contacts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().contacts().get("contactId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Contacts.Get(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contacts.get("contactId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->contacts->get', - example: - "crm->objects->contacts->get(\n 'contactId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/contacts', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts > (method) list', - qualified: 'client.crm.objects.contacts.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.contacts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contacts`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.contacts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.contacts.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().contacts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContactListPage page = client.crm().objects().contacts().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Contacts.List(context.TODO(), crm.ObjectContactListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.contacts.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->contacts->list', - example: - "crm->objects->contacts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/contacts/merge', - httpMethod: 'post', - summary: 'Merge two contacts', - description: 'Merge two contacts', - stainlessPath: '(resource) crm.objects.contacts > (method) merge', - qualified: 'client.crm.objects.contacts.merge', - params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.contacts.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/merge`\n\nMerge two contacts\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.contacts.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().contacts().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.Merge(context.TODO(), crm.ObjectContactMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->merge', - example: - "crm->objects->contacts->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/contacts/search', - httpMethod: 'post', - summary: 'Search for contacts', - description: - 'Search for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.contacts > (method) search', - qualified: 'client.crm.objects.contacts.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.contacts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/contacts/search`\n\nSearch for contacts by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.contacts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.contacts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.contacts.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.contacts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().contacts().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().contacts().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Contacts.Search(context.TODO(), crm.ObjectContactSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.contacts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->search', - example: - "crm\n ->objects\n ->contacts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/contacts/{contactId}', - httpMethod: 'patch', - summary: '', - description: - 'Update an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.contacts > (method) update', - qualified: 'client.crm.objects.contacts.update', - params: ['contactId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.contacts.update(contactId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/contacts/{contactId}`\n\nUpdate an existing contact, identified by ID or email/unique property value. To identify a contact by ID, include the ID in the request URL path. To identify a contact by their email or other unique property, include the email/property value in the request URL path, and add the `idProperty` query parameter (`/crm/v3/objects/contacts/jon@website.com?idProperty=email`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `contactId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.contacts.update('contactId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.contacts.update('contactId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.contacts.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.contacts.update(\n contact_id="contactId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().contacts().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContactUpdateParams params = ContactUpdateParams.builder()\n .contactId("contactId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().contacts().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Contacts.Update(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.contacts.update("contactId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->update', - example: - "crm->objects->contacts->update(\n 'contactId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/$CONTACT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/contacts/batch/create', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts.batch > (method) create', - qualified: 'client.crm.objects.contacts.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.contacts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/create`\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.contacts.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().contacts().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.New(context.TODO(), crm.ObjectContactBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->batch->create', - example: - "crm\n ->objects\n ->contacts\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/contacts/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of contacts', - description: 'Archive a batch of contacts', - stainlessPath: '(resource) crm.objects.contacts.batch > (method) delete', - qualified: 'client.crm.objects.contacts.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.contacts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/contacts/batch/archive`\n\nArchive a batch of contacts\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.contacts.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.contacts.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.contacts.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.contacts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().contacts().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().contacts().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Contacts.Batch.Delete(context.TODO(), crm.ObjectContactBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.contacts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->contacts->batch->delete', - example: - "crm->objects->contacts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/contacts/batch/read', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts.batch > (method) get', - qualified: 'client.crm.objects.contacts.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.contacts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/read`\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.contacts.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().contacts().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.Get(context.TODO(), crm.ObjectContactBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->batch->get', - example: - "crm->objects->contacts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/contacts/batch/update', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts.batch > (method) update', - qualified: 'client.crm.objects.contacts.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.contacts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/update`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contacts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.contacts.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contacts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().contacts().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contacts().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contacts.Batch.Update(context.TODO(), crm.ObjectContactBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contacts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->contacts->batch->update', - example: - "crm\n ->objects\n ->contacts\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/contacts/batch/upsert', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.contacts.batch > (method) upsert', - qualified: 'client.crm.objects.contacts.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.contacts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contacts/batch/upsert`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.contacts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contacts.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.contacts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.contacts.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.contacts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().contacts().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().contacts().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contacts.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Contacts.Batch.Upsert(context.TODO(), crm.ObjectContactBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.contacts.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.contacts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->contacts->batch->upsert', - example: - "crm\n ->objects\n ->contacts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contacts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/contracts/{contractId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{contractId}`. `{contractId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.contracts > (method) get', - qualified: 'client.crm.objects.contracts.get', - params: [ - 'contractId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.contracts.get(contractId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contracts/{contractId}`\n\nRead an Object identified by `{contractId}`. `{contractId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `contractId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contracts.get('contractId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contracts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.contracts.get('contractId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.contracts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.contracts.get(\n contract_id="contractId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().contracts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().contracts().get("contractId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contracts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Contracts.Get(\n\t\tcontext.TODO(),\n\t\t"contractId",\n\t\tcrm.ObjectContractGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.contracts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contracts.get("contractId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->contracts->get', - example: - "crm->objects->contracts->get(\n 'contractId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contracts/$CONTRACT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/contracts', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of contracts. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.contracts > (method) list', - qualified: 'client.crm.objects.contracts.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.contracts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/contracts`\n\nRead a page of contracts. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contracts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contracts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.contracts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.contracts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.contracts.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().contracts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractListPage;\nimport com.hubspot.sdk.models.crm.objects.contracts.ContractListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ContractListPage page = client.crm().objects().contracts().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contracts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Contracts.List(context.TODO(), crm.ObjectContractListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.contracts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.contracts.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->contracts->list', - example: - "crm->objects->contracts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contracts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/contracts/batch/read', - httpMethod: 'post', - summary: 'Read a batch of contracts by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.contracts.batch > (method) get', - qualified: 'client.crm.objects.contracts.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.contracts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/contracts/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contracts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.contracts.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.contracts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.contracts.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.contracts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().contracts().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().contracts().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Contracts.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Contracts.Batch.Get(context.TODO(), crm.ObjectContractBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.contracts.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.contracts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->contracts->batch->get', - example: - "crm->objects->contracts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/contracts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-410', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided.', - stainlessPath: '(resource) crm.objects.courses > (method) create', - qualified: 'client.crm.objects.courses.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.courses.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-410`\n\nCreate a course with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard courses is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.courses.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.courses.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.courses.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.courses.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().courses().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().courses().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Courses.New(context.TODO(), crm.ObjectCourseNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.courses.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->courses->create', - example: - "crm->objects->courses->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-410/{courseId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{courseId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.courses > (method) delete', - qualified: 'client.crm.objects.courses.delete', - params: ['courseId: string;'], - markdown: - "## delete\n\n`client.crm.objects.courses.delete(courseId: string): void`\n\n**delete** `/crm/objects/2026-03/0-410/{courseId}`\n\nMove an Object identified by `{courseId}` to the recycling bin.\n\n### Parameters\n\n- `courseId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.courses.delete('courseId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.courses.delete('courseId');", - }, - python: { - method: 'crm.objects.courses.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.courses.delete(\n "courseId",\n)', - }, - java: { - method: 'crm().objects().courses().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().courses().delete("courseId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Courses.Delete(context.TODO(), "courseId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.courses.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.courses.delete("courseId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->courses->delete', - example: - "crm->objects->courses->delete('courseId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-410/{courseId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.courses > (method) get', - qualified: 'client.crm.objects.courses.get', - params: [ - 'courseId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.courses.get(courseId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-410/{courseId}`\n\nRead an Object identified by `{courseId}`. `{courseId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `courseId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.courses.get('courseId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.courses.get('courseId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.courses.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.courses.get(\n course_id="courseId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().courses().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().courses().get("courseId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Courses.Get(\n\t\tcontext.TODO(),\n\t\t"courseId",\n\t\tcrm.ObjectCourseGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.courses.get("courseId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->courses->get', - example: - "crm->objects->courses->get(\n 'courseId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/0-410', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of courses. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.courses > (method) list', - qualified: 'client.crm.objects.courses.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.courses.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-410`\n\nRead a page of courses. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.courses.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.courses.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.courses.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.courses.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().courses().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseListPage;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CourseListPage page = client.crm().objects().courses().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Courses.List(context.TODO(), crm.ObjectCourseListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.courses.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->courses->list', - example: - "crm->objects->courses->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/0-410/search', - httpMethod: 'post', - summary: 'Search for objects', - description: 'Fetch objects using a search query', - stainlessPath: '(resource) crm.objects.courses > (method) search', - qualified: 'client.crm.objects.courses.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.courses.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-410/search`\n\nFetch objects using a search query\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.courses.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.courses.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.courses.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.courses.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().courses().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().courses().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Courses.Search(context.TODO(), crm.ObjectCourseSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.courses.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->courses->search', - example: - "crm\n ->objects\n ->courses\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-410/{courseId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.courses > (method) update', - qualified: 'client.crm.objects.courses.update', - params: ['courseId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.courses.update(courseId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-410/{courseId}`\n\nPerform a partial update of an Object identified by `{courseId}`or optionally a unique property value as specified by the `idProperty` query param. `{courseId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `courseId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.courses.update('courseId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.courses.update('courseId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.courses.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.courses.update(\n course_id="courseId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().courses().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.courses.CourseUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CourseUpdateParams params = CourseUpdateParams.builder()\n .courseId("courseId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().courses().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Courses.Update(\n\t\tcontext.TODO(),\n\t\t"courseId",\n\t\tcrm.ObjectCourseUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.courses.update("courseId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->courses->update', - example: - "crm->objects->courses->update(\n 'courseId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/$COURSE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-410/batch/create', - httpMethod: 'post', - summary: 'Create a batch of courses', - description: 'Create a batch of objects', - stainlessPath: '(resource) crm.objects.courses.batch > (method) create', - qualified: 'client.crm.objects.courses.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.courses.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.courses.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().courses().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.New(context.TODO(), crm.ObjectCourseBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->courses->batch->create', - example: - "crm\n ->objects\n ->courses\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-410/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of courses by ID', - description: 'Archive a batch of objects', - stainlessPath: '(resource) crm.objects.courses.batch > (method) delete', - qualified: 'client.crm.objects.courses.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.courses.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-410/batch/archive`\n\nArchive a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.courses.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.courses.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.courses.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.courses.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().courses().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().courses().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Courses.Batch.Delete(context.TODO(), crm.ObjectCourseBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.courses.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.courses.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->courses->batch->delete', - example: - "crm->objects->courses->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-410/batch/read', - httpMethod: 'post', - summary: 'Read a batch of courses by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.courses.batch > (method) get', - qualified: 'client.crm.objects.courses.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.courses.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.courses.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().courses().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.Get(context.TODO(), crm.ObjectCourseBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->courses->batch->get', - example: - "crm->objects->courses->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-410/batch/update', - httpMethod: 'post', - summary: 'Update a batch of courses by internal ID, or unique property values', - description: 'Update a batch of objects', - stainlessPath: '(resource) crm.objects.courses.batch > (method) update', - qualified: 'client.crm.objects.courses.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.courses.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/update`\n\nUpdate a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.courses.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.courses.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.courses.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().courses().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().courses().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Courses.Batch.Update(context.TODO(), crm.ObjectCourseBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.courses.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->courses->batch->update', - example: - "crm\n ->objects\n ->courses\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/0-410/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of courses by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.courses.batch > (method) upsert', - qualified: 'client.crm.objects.courses.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.courses.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-410/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.courses.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.courses.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.courses.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.courses.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.courses.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().courses().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().courses().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Courses.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Courses.Batch.Upsert(context.TODO(), crm.ObjectCourseBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.courses.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.courses.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->courses->batch->upsert', - example: - "crm\n ->objects\n ->courses\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-410/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/{objectType}', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.', - stainlessPath: '(resource) crm.objects.custom > (method) create', - qualified: 'client.crm.objects.custom.create', - params: [ - 'objectType: string;', - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.custom.create(objectType: string, associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}`\n\nCreate a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.\n\n### Parameters\n\n- `objectType: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.create('objectType', {\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.create('objectType', {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.custom.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.create(\n object_type="objectType",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().custom().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomCreateParams params = CustomCreateParams.builder()\n .objectType("objectType")\n .simplePublicObjectInputForCreate(SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomNewParams{\n\t\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.create(\n "objectType",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->custom->create', - example: - "crm->objects->custom->create(\n 'objectType',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{objectId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.custom > (method) delete', - qualified: 'client.crm.objects.custom.delete', - params: ['objectType: string;', 'objectId: string;'], - markdown: - "## delete\n\n`client.crm.objects.custom.delete(objectType: string, objectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nMove an Object identified by `{objectId}` to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.custom.delete('objectId', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.custom.delete('objectId', { objectType: 'objectType' });", - }, - python: { - method: 'crm.objects.custom.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.custom.delete(\n object_id="objectId",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().objects().custom().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomDeleteParams params = CustomDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n client.crm().objects().custom().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Custom.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.custom.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.custom.delete("objectId", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->objects->custom->delete', - example: - "crm->objects->custom->delete(\n 'objectId', objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.custom > (method) get', - qualified: 'client.crm.objects.custom.get', - params: [ - 'objectType: string;', - 'objectId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.custom.get(objectType: string, objectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nRead an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.custom.get('objectId', { objectType: 'objectType' });\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.custom.get('objectId', {\n objectType: 'objectType',\n});\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.custom.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.custom.get(\n object_id="objectId",\n object_type="objectType",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().custom().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomGetParams params = CustomGetParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().custom().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Custom.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.custom.get("objectId", object_type: "objectType")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->custom->get', - example: - "crm->objects->custom->get(\n 'objectId',\n objectType: 'objectType',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/{objectType}', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of objects. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.custom > (method) list', - qualified: 'client.crm.objects.custom.list', - params: [ - 'objectType: string;', - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.custom.list(objectType: string, after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}`\n\nRead a page of objects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.custom.list('objectType')) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.custom.list(\n 'objectType',\n)) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.custom.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.custom.list(\n object_type="objectType",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().custom().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomListPage;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomListPage page = client.crm().objects().custom().list("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Custom.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.custom.list("objectType")\n\nputs(page)', - }, - php: { - method: 'crm->objects->custom->list', - example: - "crm->objects->custom->list(\n 'objectType',\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/{objectType}/merge', - httpMethod: 'post', - summary: 'Merge two objects with same type', - description: - 'Merge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it.', - stainlessPath: '(resource) crm.objects.custom > (method) merge', - qualified: 'client.crm.objects.custom.merge', - params: ['objectType: string;', 'objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.custom.merge(objectType: string, objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/merge`\n\nMerge two CRM objects of the same type by specifying one as the primary object and the other as the object to be merged into it.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.merge('objectType', { objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.merge('objectType', {\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.custom.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.merge(\n object_type="objectType",\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().custom().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomMergeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomMergeParams params = CustomMergeParams.builder()\n .objectType("objectType")\n .publicMergeInput(PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.Merge(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomMergeParams{\n\t\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.merge(\n "objectType",\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->custom->merge', - example: - "crm->objects->custom->merge(\n 'objectType',\n objectIDToMerge: 'objectIdToMerge',\n primaryObjectID: 'primaryObjectId',\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/{objectType}/search', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.custom > (method) search', - qualified: 'client.crm.objects.custom.search', - params: [ - 'objectType: string;', - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.custom.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.custom.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.custom.search(\n 'objectType',\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.custom.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.custom.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().custom().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomSearchParams params = CustomSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().custom().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Custom.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.custom.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->custom->search', - example: - "crm\n ->objects\n ->custom\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.custom > (method) update', - qualified: 'client.crm.objects.custom.update', - params: ['objectType: string;', 'objectId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.custom.update(objectType: string, objectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nPerform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.custom.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.custom.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.custom.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.custom.update(\n object_id="objectId",\n object_type="objectType",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().custom().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.custom.CustomUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CustomUpdateParams params = CustomUpdateParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().custom().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Custom.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectCustomUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.custom.update("objectId", object_type: "objectType", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->custom->update', - example: - "crm->objects->custom->update(\n 'objectId',\n objectType: 'objectType',\n properties: ['foo' => 'string'],\n idProperty: 'idProperty',\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/{objectType}/batch/create', - httpMethod: 'post', - summary: 'Create a batch of objects', - description: 'Create a batch of objects', - stainlessPath: '(resource) crm.objects.custom.batch > (method) create', - qualified: 'client.crm.objects.custom.batch.create', - params: [ - 'objectType: string;', - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.custom.batch.create(objectType: string, inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.create('objectType', { inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.create('objectType', {\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.custom.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.create(\n object_type="objectType",\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().custom().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputForCreate(BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchNewParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.create(\n "objectType",\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->custom->batch->create', - example: - "crm->objects->custom->batch->create(\n 'objectType',\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/{objectType}/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of objects by ID', - description: 'Archive a batch of objects by ID', - stainlessPath: '(resource) crm.objects.custom.batch > (method) delete', - qualified: 'client.crm.objects.custom.batch.delete', - params: ['objectType: string;', 'inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.custom.batch.delete(objectType: string, inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/archive`\n\nArchive a batch of objects by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.custom.batch.delete('objectType', { inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.custom.batch.delete('objectType', { inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.custom.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.custom.batch.delete(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().custom().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectId(BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build())\n .build();\n client.crm().objects().custom().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Custom.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchDeleteParams{\n\t\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.custom.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.custom.batch.delete("objectType", inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->custom->batch->delete', - example: - "crm->objects->custom->batch->delete(\n 'objectType', inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/{objectType}/batch/read', - httpMethod: 'post', - summary: 'Read a batch of objects by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.custom.batch > (method) get', - qualified: 'client.crm.objects.custom.batch.get', - params: [ - 'objectType: string;', - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.custom.batch.get(objectType: string, inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.custom.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.get(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().custom().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputSimplePublicObjectId(BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchGetParams{\n\t\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.get(\n "objectType",\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->custom->batch->get', - example: - "crm->objects->custom->batch->get(\n 'objectType',\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/{objectType}/batch/update', - httpMethod: 'post', - summary: 'Update a batch of objects by internal ID, or unique property values', - description: 'Update a batch of objects by internal ID, or unique property values', - stainlessPath: '(resource) crm.objects.custom.batch > (method) update', - qualified: 'client.crm.objects.custom.batch.update', - params: [ - 'objectType: string;', - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.custom.batch.update(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/update`\n\nUpdate a batch of objects by internal ID, or unique property values\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.update('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.custom.batch.update('objectType', {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.custom.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.custom.batch.update(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().custom().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpdateParams params = BatchUpdateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInput(BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().custom().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Custom.Batch.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchUpdateParams{\n\t\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.custom.batch.update("objectType", inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->custom->batch->update', - example: - "crm->objects->custom->batch->update(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/{objectType}/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of objects by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.custom.batch > (method) upsert', - qualified: 'client.crm.objects.custom.batch.upsert', - params: [ - 'objectType: string;', - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.custom.batch.upsert(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.custom.batch.upsert('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.custom.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.custom.batch.upsert(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.custom.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.custom.batch.upsert(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().custom().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.custom.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputUpsert(BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().custom().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Custom.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Custom.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectCustomBatchUpsertParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.custom.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.custom.batch.upsert("objectType", inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->custom->batch->upsert', - example: - "crm\n ->objects\n ->custom\n ->batch\n ->upsert(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-3', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.', - stainlessPath: '(resource) crm.objects.deals > (method) create', - qualified: 'client.crm.objects.deals.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.deals.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-3`\n\nCreate a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.deals.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().deals().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.New(context.TODO(), crm.ObjectDealNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->deals->create', - example: - "crm->objects->deals->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-3/{dealId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{dealId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.deals > (method) delete', - qualified: 'client.crm.objects.deals.delete', - params: ['dealId: string;'], - markdown: - "## delete\n\n`client.crm.objects.deals.delete(dealId: string): void`\n\n**delete** `/crm/objects/2026-03/0-3/{dealId}`\n\nMove an Object identified by `{dealId}` to the recycling bin.\n\n### Parameters\n\n- `dealId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.deals.delete('dealId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.deals.delete('dealId');", - }, - python: { - method: 'crm.objects.deals.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.deals.delete(\n "dealId",\n)', - }, - java: { - method: 'crm().objects().deals().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.deals.DealDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().deals().delete("dealId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Deals.Delete(context.TODO(), "dealId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.deals.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.deals.delete("dealId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->deals->delete', - example: - "crm->objects->deals->delete('dealId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-3/{dealId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.deals > (method) get', - qualified: 'client.crm.objects.deals.get', - params: [ - 'dealId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.deals.get(dealId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-3/{dealId}`\n\nRead an Object identified by `{dealId}`. `{dealId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `dealId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.deals.get('dealId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.deals.get('dealId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.deals.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.deals.get(\n deal_id="dealId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().deals().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.deals.DealGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().deals().get("dealId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Deals.Get(\n\t\tcontext.TODO(),\n\t\t"dealId",\n\t\tcrm.ObjectDealGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.deals.get("dealId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->deals->get', - example: - "crm->objects->deals->get(\n 'dealId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/0-3', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of deals. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.deals > (method) list', - qualified: 'client.crm.objects.deals.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.deals.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-3`\n\nRead a page of deals. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.deals.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.deals.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.deals.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.deals.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().deals().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.deals.DealListPage;\nimport com.hubspot.sdk.models.crm.objects.deals.DealListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DealListPage page = client.crm().objects().deals().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Deals.List(context.TODO(), crm.ObjectDealListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.deals.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->deals->list', - example: - "crm->objects->deals->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/0-3/merge', - httpMethod: 'post', - summary: 'Merge two deals with same type', - description: 'Combine two deals of the same type into a single deal.', - stainlessPath: '(resource) crm.objects.deals > (method) merge', - qualified: 'client.crm.objects.deals.merge', - params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.deals.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/merge`\n\nCombine two deals of the same type into a single deal.\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.deals.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().deals().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.Merge(context.TODO(), crm.ObjectDealMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->deals->merge', - example: - "crm->objects->deals->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/0-3/search', - httpMethod: 'post', - summary: 'Search for deals using various filters and criteria to retrieve specific records.', - description: 'Search for deals using specified criteria and filters.', - stainlessPath: '(resource) crm.objects.deals > (method) search', - qualified: 'client.crm.objects.deals.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.deals.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-3/search`\n\nSearch for deals using specified criteria and filters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.deals.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.deals.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.deals.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.deals.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().deals().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().deals().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Deals.Search(context.TODO(), crm.ObjectDealSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.deals.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->deals->search', - example: - "crm\n ->objects\n ->deals\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-3/{dealId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.deals > (method) update', - qualified: 'client.crm.objects.deals.update', - params: ['dealId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.deals.update(dealId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-3/{dealId}`\n\nPerform a partial update of an Object identified by `{dealId}`or optionally a unique property value as specified by the `idProperty` query param. `{dealId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `dealId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.deals.update('dealId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.deals.update('dealId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.deals.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.deals.update(\n deal_id="dealId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().deals().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.deals.DealUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DealUpdateParams params = DealUpdateParams.builder()\n .dealId("dealId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().deals().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Deals.Update(\n\t\tcontext.TODO(),\n\t\t"dealId",\n\t\tcrm.ObjectDealUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.deals.update("dealId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->deals->update', - example: - "crm->objects->deals->update(\n 'dealId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/$DEAL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-3/batch/create', - httpMethod: 'post', - summary: 'Create a batch of deals', - description: 'Create multiple deals in a single request.', - stainlessPath: '(resource) crm.objects.deals.batch > (method) create', - qualified: 'client.crm.objects.deals.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.deals.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/create`\n\nCreate multiple deals in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.deals.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().deals().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.New(context.TODO(), crm.ObjectDealBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->deals->batch->create', - example: - "crm->objects->deals->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-3/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of deals by ID', - description: 'Archive multiple deals using their IDs.', - stainlessPath: '(resource) crm.objects.deals.batch > (method) delete', - qualified: 'client.crm.objects.deals.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.deals.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-3/batch/archive`\n\nArchive multiple deals using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.deals.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.deals.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.deals.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.deals.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().deals().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().deals().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Deals.Batch.Delete(context.TODO(), crm.ObjectDealBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.deals.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.deals.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->deals->batch->delete', - example: - "crm->objects->deals->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-3/batch/read', - httpMethod: 'post', - summary: 'Read a batch of deals by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.deals.batch > (method) get', - qualified: 'client.crm.objects.deals.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.deals.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.deals.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().deals().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.Get(context.TODO(), crm.ObjectDealBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->deals->batch->get', - example: - "crm->objects->deals->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-3/batch/update', - httpMethod: 'post', - summary: 'Update a batch of deals by internal ID, or unique property values', - description: 'Update multiple deals using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.deals.batch > (method) update', - qualified: 'client.crm.objects.deals.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.deals.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/update`\n\nUpdate multiple deals using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.deals.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.deals.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.deals.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().deals().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().deals().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Deals.Batch.Update(context.TODO(), crm.ObjectDealBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.deals.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->deals->batch->update', - example: - "crm->objects->deals->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/0-3/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of deals by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.deals.batch > (method) upsert', - qualified: 'client.crm.objects.deals.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.deals.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-3/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.deals.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.deals.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.deals.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.deals.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.deals.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().deals().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().deals().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Deals.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Deals.Batch.Upsert(context.TODO(), crm.ObjectDealBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.deals.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.deals.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->deals->batch->upsert', - example: - "crm\n ->objects\n ->deals\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-3/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/discounts', - httpMethod: 'post', - summary: '', - description: - 'Create a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.', - stainlessPath: '(resource) crm.objects.discounts > (method) create', - qualified: 'client.crm.objects.discounts.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.discounts.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/discounts`\n\nCreate a discount with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard discounts is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.discounts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.discounts.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.discounts.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.discounts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().discounts().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().discounts().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Discounts.New(context.TODO(), crm.ObjectDiscountNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.discounts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->create', - example: - "crm->objects->discounts->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/discounts/{discountId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Archive', - stainlessPath: '(resource) crm.objects.discounts > (method) delete', - qualified: 'client.crm.objects.discounts.delete', - params: ['discountId: string;'], - markdown: - "## delete\n\n`client.crm.objects.discounts.delete(discountId: string): void`\n\n**delete** `/crm/objects/2026-03/discounts/{discountId}`\n\nArchive\n\n### Parameters\n\n- `discountId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.discounts.delete('discountId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.discounts.delete('discountId');", - }, - python: { - method: 'crm.objects.discounts.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.discounts.delete(\n "discountId",\n)', - }, - java: { - method: 'crm().objects().discounts().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().discounts().delete("discountId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Discounts.Delete(context.TODO(), "discountId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.discounts.delete("discountId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->discounts->delete', - example: - "crm->objects->discounts->delete('discountId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/discounts/{discountId}', - httpMethod: 'get', - summary: '', - description: - 'Read an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.discounts > (method) get', - qualified: 'client.crm.objects.discounts.get', - params: [ - 'discountId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.discounts.get(discountId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/discounts/{discountId}`\n\nRead an Object identified by `{discountId}`. `{discountId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `discountId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.discounts.get('discountId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.discounts.get('discountId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.discounts.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.discounts.get(\n discount_id="discountId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().discounts().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().discounts().get("discountId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Discounts.Get(\n\t\tcontext.TODO(),\n\t\t"discountId",\n\t\tcrm.ObjectDiscountGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.discounts.get("discountId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->discounts->get', - example: - "crm->objects->discounts->get(\n 'discountId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/discounts', - httpMethod: 'get', - summary: 'List', - description: 'List', - stainlessPath: '(resource) crm.objects.discounts > (method) list', - qualified: 'client.crm.objects.discounts.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.discounts.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/discounts`\n\nList\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.discounts.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.discounts.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.discounts.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.discounts.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().discounts().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountListPage;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DiscountListPage page = client.crm().objects().discounts().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Discounts.List(context.TODO(), crm.ObjectDiscountListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.discounts.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->discounts->list', - example: - "crm->objects->discounts->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/discounts/search', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.discounts > (method) search', - qualified: 'client.crm.objects.discounts.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.discounts.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/discounts/search`\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.discounts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.discounts.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.discounts.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.discounts.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().discounts().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().discounts().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Discounts.Search(context.TODO(), crm.ObjectDiscountSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.discounts.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->search', - example: - "crm\n ->objects\n ->discounts\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/discounts/{discountId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.discounts > (method) update', - qualified: 'client.crm.objects.discounts.update', - params: ['discountId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.discounts.update(discountId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/discounts/{discountId}`\n\nPerform a partial update of an Object identified by `{discountId}`or optionally a unique property value as specified by the `idProperty` query param. `{discountId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `discountId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.discounts.update('discountId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.discounts.update('discountId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.discounts.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.discounts.update(\n discount_id="discountId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().discounts().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.discounts.DiscountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DiscountUpdateParams params = DiscountUpdateParams.builder()\n .discountId("discountId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().discounts().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Discounts.Update(\n\t\tcontext.TODO(),\n\t\t"discountId",\n\t\tcrm.ObjectDiscountUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.discounts.update("discountId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->update', - example: - "crm->objects->discounts->update(\n 'discountId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/$DISCOUNT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/discounts/batch/create', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.discounts.batch > (method) create', - qualified: 'client.crm.objects.discounts.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.discounts.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/create`\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.discounts.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().discounts().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.New(context.TODO(), crm.ObjectDiscountBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->batch->create', - example: - "crm\n ->objects\n ->discounts\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/discounts/batch/archive', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.discounts.batch > (method) delete', - qualified: 'client.crm.objects.discounts.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.discounts.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/discounts/batch/archive`\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.discounts.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.discounts.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.discounts.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.discounts.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().discounts().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().discounts().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Discounts.Batch.Delete(context.TODO(), crm.ObjectDiscountBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.discounts.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->discounts->batch->delete', - example: - "crm->objects->discounts->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/discounts/batch/read', - httpMethod: 'post', - summary: '', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.discounts.batch > (method) get', - qualified: 'client.crm.objects.discounts.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.discounts.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.discounts.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().discounts().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.Get(context.TODO(), crm.ObjectDiscountBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->batch->get', - example: - "crm->objects->discounts->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/discounts/batch/update', - httpMethod: 'post', - summary: 'Update a batch of discounts by internal ID, or unique property values', - description: 'Update a batch of discounts by internal ID, or unique property values', - stainlessPath: '(resource) crm.objects.discounts.batch > (method) update', - qualified: 'client.crm.objects.discounts.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.discounts.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/update`\n\nUpdate a batch of discounts by internal ID, or unique property values\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.discounts.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.discounts.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.discounts.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().discounts().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().discounts().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Discounts.Batch.Update(context.TODO(), crm.ObjectDiscountBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.discounts.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->discounts->batch->update', - example: - "crm\n ->objects\n ->discounts\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/discounts/batch/upsert', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.discounts.batch > (method) upsert', - qualified: 'client.crm.objects.discounts.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.discounts.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/discounts/batch/upsert`\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.discounts.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.discounts.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.discounts.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.discounts.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.discounts.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().discounts().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().discounts().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Discounts.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Discounts.Batch.Upsert(context.TODO(), crm.ObjectDiscountBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.discounts.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.discounts.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->discounts->batch->upsert', - example: - "crm\n ->objects\n ->discounts\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/discounts/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/emails', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.', - stainlessPath: '(resource) crm.objects.emails > (method) create', - qualified: 'client.crm.objects.emails.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.emails.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/emails`\n\nCreate a email with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard emails is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.emails.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.emails.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.emails.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.emails.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().emails().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().emails().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Emails.New(context.TODO(), crm.ObjectEmailNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.emails.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->emails->create', - example: - "crm->objects->emails->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/emails/{emailId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{emailId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.emails > (method) delete', - qualified: 'client.crm.objects.emails.delete', - params: ['emailId: string;'], - markdown: - "## delete\n\n`client.crm.objects.emails.delete(emailId: string): void`\n\n**delete** `/crm/objects/2026-03/emails/{emailId}`\n\nMove an Object identified by `{emailId}` to the recycling bin.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.emails.delete('emailId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.emails.delete('emailId');", - }, - python: { - method: 'crm.objects.emails.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.emails.delete(\n "emailId",\n)', - }, - java: { - method: 'crm().objects().emails().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().emails().delete("emailId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Emails.Delete(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.emails.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.emails.delete("emailId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->emails->delete', - example: - "crm->objects->emails->delete('emailId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/emails/{emailId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.emails > (method) get', - qualified: 'client.crm.objects.emails.get', - params: [ - 'emailId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.emails.get(emailId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/emails/{emailId}`\n\nRead an Object identified by `{emailId}`. `{emailId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.emails.get('emailId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.emails.get('emailId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.emails.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.emails.get(\n email_id="emailId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().emails().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().emails().get("emailId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Emails.Get(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tcrm.ObjectEmailGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.emails.get("emailId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->emails->get', - example: - "crm->objects->emails->get(\n 'emailId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/emails', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of emails. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.emails > (method) list', - qualified: 'client.crm.objects.emails.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.emails.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/emails`\n\nRead a page of emails. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.emails.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.emails.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.emails.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.emails.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().emails().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailListPage;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListPage page = client.crm().objects().emails().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Emails.List(context.TODO(), crm.ObjectEmailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.emails.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->emails->list', - example: - "crm->objects->emails->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/emails/search', - httpMethod: 'post', - summary: 'Search for emails using specified criteria and filters.', - description: - 'Perform a search for emails based on the provided query parameters and return matching results.', - stainlessPath: '(resource) crm.objects.emails > (method) search', - qualified: 'client.crm.objects.emails.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.emails.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/emails/search`\n\nPerform a search for emails based on the provided query parameters and return matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.emails.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.emails.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.emails.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.emails.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().emails().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().emails().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Emails.Search(context.TODO(), crm.ObjectEmailSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.emails.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->emails->search', - example: - "crm\n ->objects\n ->emails\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/emails/{emailId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.emails > (method) update', - qualified: 'client.crm.objects.emails.update', - params: ['emailId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.emails.update(emailId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/emails/{emailId}`\n\nPerform a partial update of an Object identified by `{emailId}`or optionally a unique property value as specified by the `idProperty` query param. `{emailId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `emailId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.emails.update('emailId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.emails.update('emailId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.emails.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.emails.update(\n email_id="emailId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().emails().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.emails.EmailUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateParams params = EmailUpdateParams.builder()\n .emailId("emailId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().emails().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Emails.Update(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tcrm.ObjectEmailUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.emails.update("emailId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->emails->update', - example: - "crm->objects->emails->update(\n 'emailId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/$EMAIL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/emails/batch/create', - httpMethod: 'post', - summary: 'Create a batch of emails', - description: 'Create a batch of emails with specified properties and return the created objects.', - stainlessPath: '(resource) crm.objects.emails.batch > (method) create', - qualified: 'client.crm.objects.emails.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.emails.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/create`\n\nCreate a batch of emails with specified properties and return the created objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.emails.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().emails().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.New(context.TODO(), crm.ObjectEmailBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->emails->batch->create', - example: - "crm->objects->emails->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/emails/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of emails by ID', - description: 'Archive a batch of emails identified by their IDs.', - stainlessPath: '(resource) crm.objects.emails.batch > (method) delete', - qualified: 'client.crm.objects.emails.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.emails.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/emails/batch/archive`\n\nArchive a batch of emails identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.emails.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.emails.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.emails.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.emails.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().emails().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().emails().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Emails.Batch.Delete(context.TODO(), crm.ObjectEmailBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.emails.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.emails.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->emails->batch->delete', - example: - "crm->objects->emails->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/emails/batch/read', - httpMethod: 'post', - summary: 'Read a batch of emails by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.emails.batch > (method) get', - qualified: 'client.crm.objects.emails.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.emails.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.emails.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().emails().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.Get(context.TODO(), crm.ObjectEmailBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->emails->batch->get', - example: - "crm->objects->emails->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/emails/batch/update', - httpMethod: 'post', - summary: 'Update a batch of emails by internal ID, or unique property values', - description: 'Update a batch of emails using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.emails.batch > (method) update', - qualified: 'client.crm.objects.emails.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.emails.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/update`\n\nUpdate a batch of emails using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.emails.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.emails.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.emails.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().emails().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().emails().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Emails.Batch.Update(context.TODO(), crm.ObjectEmailBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.emails.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->emails->batch->update', - example: - "crm->objects->emails->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/emails/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of emails by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.emails.batch > (method) upsert', - qualified: 'client.crm.objects.emails.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.emails.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/emails/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.emails.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.emails.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.emails.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.emails.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.emails.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().emails().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().emails().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Emails.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Emails.Batch.Upsert(context.TODO(), crm.ObjectEmailBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.emails.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.emails.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->emails->batch->upsert', - example: - "crm\n ->objects\n ->emails\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/emails/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.feedback_submissions > (method) get', - qualified: 'client.crm.objects.feedbackSubmissions.get', - params: [ - 'feedbackSubmissionId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.feedbackSubmissions.get(feedbackSubmissionId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}`\n\nRead an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `feedbackSubmissionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.feedbackSubmissions.get('feedbackSubmissionId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.feedbackSubmissions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.feedbackSubmissions.get(\n 'feedbackSubmissionId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.feedback_submissions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.feedback_submissions.get(\n feedback_submission_id="feedbackSubmissionId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().feedbackSubmissions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().feedbackSubmissions().get("feedbackSubmissionId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.FeedbackSubmissions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.FeedbackSubmissions.Get(\n\t\tcontext.TODO(),\n\t\t"feedbackSubmissionId",\n\t\tcrm.ObjectFeedbackSubmissionGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.feedback_submissions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.feedback_submissions.get("feedbackSubmissionId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->feedbackSubmissions->get', - example: - "crm\n ->objects\n ->feedbackSubmissions\n ->get(\n 'feedbackSubmissionId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/$FEEDBACK_SUBMISSION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/feedback_submissions', - httpMethod: 'get', - summary: 'List', - description: - 'Read a page of feedback submissions. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.feedback_submissions > (method) list', - qualified: 'client.crm.objects.feedbackSubmissions.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.feedbackSubmissions.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/feedback_submissions`\n\nRead a page of feedback submissions. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.feedbackSubmissions.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.feedbackSubmissions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.feedbackSubmissions.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.feedback_submissions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.feedback_submissions.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().feedbackSubmissions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionListPage;\nimport com.hubspot.sdk.models.crm.objects.feedbacksubmissions.FeedbackSubmissionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeedbackSubmissionListPage page = client.crm().objects().feedbackSubmissions().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.FeedbackSubmissions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.FeedbackSubmissions.List(context.TODO(), crm.ObjectFeedbackSubmissionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.feedback_submissions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.feedback_submissions.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->feedbackSubmissions->list', - example: - "crm->objects->feedbackSubmissions->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/feedback_submissions/search', - httpMethod: 'post', - summary: 'Search for feedback submissions using specified criteria.', - description: - 'Execute a search to retrieve feedback submissions based on defined filters, properties, and sorting options.', - stainlessPath: '(resource) crm.objects.feedback_submissions > (method) search', - qualified: 'client.crm.objects.feedbackSubmissions.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.feedbackSubmissions.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/feedback_submissions/search`\n\nExecute a search to retrieve feedback submissions based on defined filters, properties, and sorting options.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.feedbackSubmissions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.feedbackSubmissions.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.feedbackSubmissions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.feedback_submissions.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.feedback_submissions.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().feedbackSubmissions().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().feedbackSubmissions().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.FeedbackSubmissions.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.FeedbackSubmissions.Search(context.TODO(), crm.ObjectFeedbackSubmissionSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.feedback_submissions.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.feedback_submissions.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->feedbackSubmissions->search', - example: - "crm\n ->objects\n ->feedbackSubmissions\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/feedback_submissions/batch/read', - httpMethod: 'post', - summary: 'Read a batch of feedback submissions by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.feedback_submissions.batch > (method) get', - qualified: 'client.crm.objects.feedbackSubmissions.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.feedbackSubmissions.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/feedback_submissions/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.feedbackSubmissions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.feedbackSubmissions.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.feedbackSubmissions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.feedback_submissions.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.feedback_submissions.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().feedbackSubmissions().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().feedbackSubmissions().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.FeedbackSubmissions.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.FeedbackSubmissions.Batch.Get(context.TODO(), crm.ObjectFeedbackSubmissionBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.feedback_submissions.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.feedback_submissions.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->feedbackSubmissions->batch->get', - example: - "crm\n ->objects\n ->feedbackSubmissions\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/feedback_submissions/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/fees', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.', - stainlessPath: '(resource) crm.objects.fees > (method) create', - qualified: 'client.crm.objects.fees.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.fees.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/fees`\n\nCreate a fee with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard fees is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.fees.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.fees.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.fees.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.fees.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().fees().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().fees().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Fees.New(context.TODO(), crm.ObjectFeeNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.fees.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->fees->create', - example: - "crm->objects->fees->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/fees/{feeId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{feeId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.fees > (method) delete', - qualified: 'client.crm.objects.fees.delete', - params: ['feeId: string;'], - markdown: - "## delete\n\n`client.crm.objects.fees.delete(feeId: string): void`\n\n**delete** `/crm/objects/2026-03/fees/{feeId}`\n\nMove an Object identified by `{feeId}` to the recycling bin.\n\n### Parameters\n\n- `feeId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.fees.delete('feeId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.fees.delete('feeId');", - }, - python: { - method: 'crm.objects.fees.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.fees.delete(\n "feeId",\n)', - }, - java: { - method: 'crm().objects().fees().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().fees().delete("feeId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Fees.Delete(context.TODO(), "feeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.fees.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.fees.delete("feeId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->fees->delete', - example: - "crm->objects->fees->delete('feeId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/fees/{feeId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.fees > (method) get', - qualified: 'client.crm.objects.fees.get', - params: [ - 'feeId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.fees.get(feeId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/fees/{feeId}`\n\nRead an Object identified by `{feeId}`. `{feeId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `feeId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.fees.get('feeId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.fees.get('feeId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.fees.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.fees.get(\n fee_id="feeId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().fees().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().fees().get("feeId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Fees.Get(\n\t\tcontext.TODO(),\n\t\t"feeId",\n\t\tcrm.ObjectFeeGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.fees.get("feeId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->fees->get', - example: - "crm->objects->fees->get(\n 'feeId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/fees', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of fees. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.fees > (method) list', - qualified: 'client.crm.objects.fees.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.fees.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/fees`\n\nRead a page of fees. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.fees.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.fees.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.fees.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.fees.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().fees().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeListPage;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeeListPage page = client.crm().objects().fees().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Fees.List(context.TODO(), crm.ObjectFeeListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.fees.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->fees->list', - example: - "crm->objects->fees->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/fees/search', - httpMethod: 'post', - summary: 'Search for fees using specified criteria.', - description: - 'Perform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results.', - stainlessPath: '(resource) crm.objects.fees > (method) search', - qualified: 'client.crm.objects.fees.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.fees.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/fees/search`\n\nPerform a search for fees based on various filters and criteria defined in the request body. The search can include specific properties, sorting options, and pagination details to refine the results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.fees.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.fees.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.fees.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.fees.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().fees().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().fees().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Fees.Search(context.TODO(), crm.ObjectFeeSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.fees.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->fees->search', - example: - "crm\n ->objects\n ->fees\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/fees/{feeId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.fees > (method) update', - qualified: 'client.crm.objects.fees.update', - params: ['feeId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.fees.update(feeId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/fees/{feeId}`\n\nPerform a partial update of an Object identified by `{feeId}`or optionally a unique property value as specified by the `idProperty` query param. `{feeId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `feeId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.fees.update('feeId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.fees.update('feeId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.fees.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.fees.update(\n fee_id="feeId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().fees().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.fees.FeeUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FeeUpdateParams params = FeeUpdateParams.builder()\n .feeId("feeId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().fees().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Fees.Update(\n\t\tcontext.TODO(),\n\t\t"feeId",\n\t\tcrm.ObjectFeeUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.fees.update("feeId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->fees->update', - example: - "crm->objects->fees->update(\n 'feeId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/$FEE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/fees/batch/create', - httpMethod: 'post', - summary: 'Create a batch of fees', - description: - 'Create multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers.', - stainlessPath: '(resource) crm.objects.fees.batch > (method) create', - qualified: 'client.crm.objects.fees.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.fees.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/create`\n\nCreate multiple fees in a single request by providing a batch of fee objects with their properties and associations. This operation returns a list of the created fee objects, including their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.fees.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().fees().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.New(context.TODO(), crm.ObjectFeeBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->fees->batch->create', - example: - "crm->objects->fees->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/fees/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of fees by ID', - description: 'Archive multiple fees by their IDs, effectively moving them to the recycling bin.', - stainlessPath: '(resource) crm.objects.fees.batch > (method) delete', - qualified: 'client.crm.objects.fees.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.fees.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/fees/batch/archive`\n\nArchive multiple fees by their IDs, effectively moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.fees.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.fees.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.fees.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.fees.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().fees().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().fees().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Fees.Batch.Delete(context.TODO(), crm.ObjectFeeBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.fees.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.fees.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->fees->batch->delete', - example: - "crm->objects->fees->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/fees/batch/read', - httpMethod: 'post', - summary: 'Read a batch of fees by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.fees.batch > (method) get', - qualified: 'client.crm.objects.fees.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.fees.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.fees.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().fees().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.Get(context.TODO(), crm.ObjectFeeBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->fees->batch->get', - example: - "crm->objects->fees->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/fees/batch/update', - httpMethod: 'post', - summary: 'Update a batch of fees by internal ID, or unique property values', - description: - 'Update multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk.', - stainlessPath: '(resource) crm.objects.fees.batch > (method) update', - qualified: 'client.crm.objects.fees.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.fees.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/update`\n\nUpdate multiple fee records in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of several fees simultaneously, streamlining the process of managing fee data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.fees.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.fees.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.fees.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().fees().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().fees().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Fees.Batch.Update(context.TODO(), crm.ObjectFeeBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.fees.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->fees->batch->update', - example: - "crm->objects->fees->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/fees/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of fees by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.fees.batch > (method) upsert', - qualified: 'client.crm.objects.fees.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.fees.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/fees/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.fees.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.fees.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.fees.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.fees.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.fees.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().fees().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().fees().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Fees.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Fees.Batch.Upsert(context.TODO(), crm.ObjectFeeBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.fees.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.fees.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->fees->batch->upsert', - example: - "crm\n ->objects\n ->fees\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/fees/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/{objectType}', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.', - stainlessPath: '(resource) crm.objects.generic_objects > (method) create', - qualified: 'client.crm.objects.genericObjects.create', - params: [ - 'objectType: string;', - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.genericObjects.create(objectType: string, associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}`\n\nCreate a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.\n\n### Parameters\n\n- `objectType: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.genericObjects.create('objectType', {\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.genericObjects.create('objectType', {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.generic_objects.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.generic_objects.create(\n object_type="objectType",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().genericObjects().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectCreateParams params = GenericObjectCreateParams.builder()\n .objectType("objectType")\n .simplePublicObjectInputForCreate(SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().genericObjects().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GenericObjects.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectNewParams{\n\t\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.generic_objects.create(\n "objectType",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->create', - example: - "crm->objects->genericObjects->create(\n 'objectType',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{objectId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.generic_objects > (method) delete', - qualified: 'client.crm.objects.genericObjects.delete', - params: ['objectType: string;', 'objectId: string;'], - markdown: - "## delete\n\n`client.crm.objects.genericObjects.delete(objectType: string, objectId: string): void`\n\n**delete** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nMove an Object identified by `{objectId}` to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.genericObjects.delete('objectId', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.genericObjects.delete('objectId', { objectType: 'objectType' });", - }, - python: { - method: 'crm.objects.generic_objects.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.generic_objects.delete(\n object_id="objectId",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().objects().genericObjects().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectDeleteParams params = GenericObjectDeleteParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n client.crm().objects().genericObjects().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GenericObjects.Delete(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.generic_objects.delete("objectId", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->objects->genericObjects->delete', - example: - "crm->objects->genericObjects->delete(\n 'objectId', objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.generic_objects > (method) get', - qualified: 'client.crm.objects.genericObjects.get', - params: [ - 'objectType: string;', - 'objectId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.genericObjects.get(objectType: string, objectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nRead an Object identified by `{objectId}`. `{objectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.genericObjects.get('objectId', { objectType: 'objectType' });\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.genericObjects.get('objectId', {\n objectType: 'objectType',\n});\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.generic_objects.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.generic_objects.get(\n object_id="objectId",\n object_type="objectType",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().genericObjects().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectGetParams params = GenericObjectGetParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .build();\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().genericObjects().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.GenericObjects.Get(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.generic_objects.get("objectId", object_type: "objectType")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->genericObjects->get', - example: - "crm\n ->objects\n ->genericObjects\n ->get(\n 'objectId',\n objectType: 'objectType',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/{objectType}', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of objects. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.generic_objects > (method) list', - qualified: 'client.crm.objects.genericObjects.list', - params: [ - 'objectType: string;', - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.genericObjects.list(objectType: string, after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/{objectType}`\n\nRead a page of objects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `objectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.genericObjects.list('objectType')) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.genericObjects.list(\n 'objectType',\n)) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.generic_objects.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.generic_objects.list(\n object_type="objectType",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().genericObjects().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectListPage;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectListPage page = client.crm().objects().genericObjects().list("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.GenericObjects.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.generic_objects.list("objectType")\n\nputs(page)', - }, - php: { - method: 'crm->objects->genericObjects->list', - example: - "crm->objects->genericObjects->list(\n 'objectType',\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/{objectType}/search', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.generic_objects > (method) search', - qualified: 'client.crm.objects.genericObjects.search', - params: [ - 'objectType: string;', - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.genericObjects.search(objectType: string, after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/{objectType}/search`\n\n### Parameters\n\n- `objectType: string`\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.genericObjects.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.genericObjects.search('objectType', {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.generic_objects.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.generic_objects.search(\n object_type="objectType",\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().genericObjects().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectSearchParams params = GenericObjectSearchParams.builder()\n .objectType("objectType")\n .publicObjectSearchRequest(PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build())\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().genericObjects().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.GenericObjects.Search(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectSearchParams{\n\t\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\t\tAfter: "after",\n\t\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tLimit: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSorts: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.generic_objects.search(\n "objectType",\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->search', - example: - "crm\n ->objects\n ->genericObjects\n ->search(\n 'objectType',\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/{objectType}/{objectId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.generic_objects > (method) update', - qualified: 'client.crm.objects.genericObjects.update', - params: ['objectType: string;', 'objectId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.genericObjects.update(objectType: string, objectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/{objectType}/{objectId}`\n\nPerform a partial update of an Object identified by `{objectId}`or optionally a unique property value as specified by the `idProperty` query param. `{objectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `objectType: string`\n\n- `objectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.genericObjects.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.genericObjects.update('objectId', {\n objectType: 'objectType',\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.generic_objects.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.generic_objects.update(\n object_id="objectId",\n object_type="objectType",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().genericObjects().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.GenericObjectUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GenericObjectUpdateParams params = GenericObjectUpdateParams.builder()\n .objectType("objectType")\n .objectId("objectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().genericObjects().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GenericObjects.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tcrm.ObjectGenericObjectUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.generic_objects.update(\n "objectId",\n object_type: "objectType",\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->update', - example: - "crm->objects->genericObjects->update(\n 'objectId',\n objectType: 'objectType',\n properties: ['foo' => 'string'],\n idProperty: 'idProperty',\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/{objectType}/batch/create', - httpMethod: 'post', - summary: 'Create a batch of objects', - description: 'Create a batch of objects', - stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) create', - qualified: 'client.crm.objects.genericObjects.batch.create', - params: [ - 'objectType: string;', - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.genericObjects.batch.create(objectType: string, inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.create('objectType', { inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.create(\n 'objectType',\n {\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.generic_objects.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.create(\n object_type="objectType",\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().genericObjects().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputForCreate(BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchNewParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\t\tID: "id",\n\t\t\t\t\t\t},\n\t\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t\t}},\n\t\t\t\t\t}},\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.create(\n "objectType",\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->batch->create', - example: - "crm\n ->objects\n ->genericObjects\n ->batch\n ->create(\n 'objectType',\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/{objectType}/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of objects by ID', - description: 'Archive a batch of objects by ID', - stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) delete', - qualified: 'client.crm.objects.genericObjects.batch.delete', - params: ['objectType: string;', 'inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.genericObjects.batch.delete(objectType: string, inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/archive`\n\nArchive a batch of objects by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.genericObjects.batch.delete('objectType', { inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.genericObjects.batch.delete('objectType', { inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.generic_objects.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.generic_objects.batch.delete(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().genericObjects().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectId(BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build())\n .build();\n client.crm().objects().genericObjects().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GenericObjects.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchDeleteParams{\n\t\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.generic_objects.batch.delete("objectType", inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->genericObjects->batch->delete', - example: - "crm->objects->genericObjects->batch->delete(\n 'objectType', inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/{objectType}/batch/read', - httpMethod: 'post', - summary: 'Read a batch of objects by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) get', - qualified: 'client.crm.objects.genericObjects.batch.get', - params: [ - 'objectType: string;', - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.genericObjects.batch.get(objectType: string, inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.get('objectType', {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.get(\n 'objectType',\n {\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.generic_objects.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.get(\n object_type="objectType",\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().genericObjects().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputSimplePublicObjectId(BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchGetParams{\n\t\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\t\tID: "430001",\n\t\t\t\t}},\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.get(\n "objectType",\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->batch->get', - example: - "crm\n ->objects\n ->genericObjects\n ->batch\n ->get(\n 'objectType',\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/{objectType}/batch/update', - httpMethod: 'post', - summary: 'Update a batch of objects by internal ID, or unique property values', - description: 'Update a batch of objects by internal ID, or unique property values', - stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) update', - qualified: 'client.crm.objects.genericObjects.batch.update', - params: [ - 'objectType: string;', - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.genericObjects.batch.update(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/update`\n\nUpdate a batch of objects by internal ID, or unique property values\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.update('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.genericObjects.batch.update(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.generic_objects.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.generic_objects.batch.update(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().genericObjects().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpdateParams params = BatchUpdateParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInput(BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().genericObjects().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GenericObjects.Batch.Update(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchUpdateParams{\n\t\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.generic_objects.batch.update(\n "objectType",\n inputs: [{id: "id", properties: {foo: "string"}}]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->genericObjects->batch->update', - example: - "crm\n ->objects\n ->genericObjects\n ->batch\n ->update(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/{objectType}/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of objects by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.generic_objects.batch > (method) upsert', - qualified: 'client.crm.objects.genericObjects.batch.upsert', - params: [ - 'objectType: string;', - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.genericObjects.batch.upsert(objectType: string, inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/{objectType}/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.genericObjects.batch.upsert('objectType', { inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.genericObjects.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.genericObjects.batch.upsert(\n 'objectType',\n {\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.generic_objects.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.generic_objects.batch.upsert(\n object_type="objectType",\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().genericObjects().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.genericobjects.batch.BatchUpsertParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchUpsertParams params = BatchUpsertParams.builder()\n .objectType("objectType")\n .batchInputSimplePublicObjectBatchInputUpsert(BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().genericObjects().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GenericObjects.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.GenericObjects.Batch.Upsert(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.ObjectGenericObjectBatchUpsertParams{\n\t\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\t\tID: "id",\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.generic_objects.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.generic_objects.batch.upsert(\n "objectType",\n inputs: [{id: "id", properties: {foo: "string"}}]\n)\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->genericObjects->batch->upsert', - example: - "crm\n ->objects\n ->genericObjects\n ->batch\n ->upsert(\n 'objectType',\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/$OBJECT_TYPE/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/goal_targets', - httpMethod: 'post', - summary: 'Create a goal target', - description: - 'Create a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) create', - qualified: 'client.crm.objects.goalTargets.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.goalTargets.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets`\n\nCreate a goal target with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard goal targets is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.goalTargets.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.goalTargets.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.goal_targets.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.goal_targets.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().goalTargets().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().goalTargets().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GoalTargets.New(context.TODO(), crm.ObjectGoalTargetNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.goal_targets.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->create', - example: - "crm->objects->goalTargets->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - httpMethod: 'delete', - summary: 'Delete a goal target', - description: 'Delete a goal target by `{goalTargetId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) delete', - qualified: 'client.crm.objects.goalTargets.delete', - params: ['goalTargetId: string;'], - markdown: - "## delete\n\n`client.crm.objects.goalTargets.delete(goalTargetId: string): void`\n\n**delete** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nDelete a goal target by `{goalTargetId}` to the recycling bin.\n\n### Parameters\n\n- `goalTargetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.goalTargets.delete('goalTargetId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.goalTargets.delete('goalTargetId');", - }, - python: { - method: 'crm.objects.goal_targets.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.goal_targets.delete(\n "goalTargetId",\n)', - }, - java: { - method: 'crm().objects().goalTargets().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().goalTargets().delete("goalTargetId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GoalTargets.Delete(context.TODO(), "goalTargetId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.goal_targets.delete("goalTargetId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->goalTargets->delete', - example: - "crm->objects->goalTargets->delete('goalTargetId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - httpMethod: 'get', - summary: 'Retrieve a goal target', - description: - 'Retrieve a goal target by its ID. You can specify what is returned using the `properties` query parameter.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) get', - qualified: 'client.crm.objects.goalTargets.get', - params: [ - 'goalTargetId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.goalTargets.get(goalTargetId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nRetrieve a goal target by its ID. You can specify what is returned using the `properties` query parameter.\n\n### Parameters\n\n- `goalTargetId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.goalTargets.get('goalTargetId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.goalTargets.get('goalTargetId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.goal_targets.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.goal_targets.get(\n goal_target_id="goalTargetId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().goalTargets().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().goalTargets().get("goalTargetId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.GoalTargets.Get(\n\t\tcontext.TODO(),\n\t\t"goalTargetId",\n\t\tcrm.ObjectGoalTargetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.goal_targets.get("goalTargetId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->goalTargets->get', - example: - "crm->objects->goalTargets->get(\n 'goalTargetId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/goal_targets', - httpMethod: 'get', - summary: 'Retrieve goal targets', - description: 'Read a page of goal targets. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) list', - qualified: 'client.crm.objects.goalTargets.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.goalTargets.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/goal_targets`\n\nRead a page of goal targets. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.goalTargets.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.goalTargets.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.goal_targets.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.goal_targets.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().goalTargets().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetListPage;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GoalTargetListPage page = client.crm().objects().goalTargets().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.GoalTargets.List(context.TODO(), crm.ObjectGoalTargetListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.goal_targets.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->goalTargets->list', - example: - "crm->objects->goalTargets->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/goal_targets/search', - httpMethod: 'post', - summary: 'Search for goal targets', - description: 'Search for goal targets using specified criteria.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) search', - qualified: 'client.crm.objects.goalTargets.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.goalTargets.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/goal_targets/search`\n\nSearch for goal targets using specified criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.goalTargets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.goalTargets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.goal_targets.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.goal_targets.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().goalTargets().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().goalTargets().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.GoalTargets.Search(context.TODO(), crm.ObjectGoalTargetSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.goal_targets.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->search', - example: - "crm\n ->objects\n ->goalTargets\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - httpMethod: 'patch', - summary: 'Update a goal target', - description: - 'Perform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.goal_targets > (method) update', - qualified: 'client.crm.objects.goalTargets.update', - params: ['goalTargetId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.goalTargets.update(goalTargetId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/goal_targets/{goalTargetId}`\n\nPerform a partial update of an Object identified by `{goalTargetId}`or optionally a unique property value as specified by the `idProperty` query param. `{goalTargetId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `goalTargetId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.goalTargets.update('goalTargetId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.goalTargets.update('goalTargetId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.goal_targets.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.goal_targets.update(\n goal_target_id="goalTargetId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().goalTargets().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.goaltargets.GoalTargetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GoalTargetUpdateParams params = GoalTargetUpdateParams.builder()\n .goalTargetId("goalTargetId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().goalTargets().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.GoalTargets.Update(\n\t\tcontext.TODO(),\n\t\t"goalTargetId",\n\t\tcrm.ObjectGoalTargetUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.goal_targets.update("goalTargetId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->update', - example: - "crm->objects->goalTargets->update(\n 'goalTargetId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/$GOAL_TARGET_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/goal_targets/batch/create', - httpMethod: 'post', - summary: 'Create goal targets', - description: 'Create multiple goal targets in a single batch operation.', - stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) create', - qualified: 'client.crm.objects.goalTargets.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.goalTargets.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/create`\n\nCreate multiple goal targets in a single batch operation.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.goal_targets.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().goalTargets().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.New(context.TODO(), crm.ObjectGoalTargetBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->batch->create', - example: - "crm\n ->objects\n ->goalTargets\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/goal_targets/batch/archive', - httpMethod: 'post', - summary: 'Delete goal targets', - description: 'Archive multiple goal targets in a single batch operation using their IDs.', - stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) delete', - qualified: 'client.crm.objects.goalTargets.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.goalTargets.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/archive`\n\nArchive multiple goal targets in a single batch operation using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.goalTargets.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.goalTargets.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.goal_targets.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.goal_targets.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().goalTargets().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().goalTargets().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.GoalTargets.Batch.Delete(context.TODO(), crm.ObjectGoalTargetBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.goal_targets.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->goalTargets->batch->delete', - example: - "crm->objects->goalTargets->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/goal_targets/batch/read', - httpMethod: 'post', - summary: 'Retrieve goal targets', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) get', - qualified: 'client.crm.objects.goalTargets.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.goalTargets.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.goal_targets.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().goalTargets().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.Get(context.TODO(), crm.ObjectGoalTargetBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->batch->get', - example: - "crm\n ->objects\n ->goalTargets\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/goal_targets/batch/update', - httpMethod: 'post', - summary: 'Update goal targets', - description: - 'Update multiple goal targets in a single batch operation using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) update', - qualified: 'client.crm.objects.goalTargets.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.goalTargets.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/update`\n\nUpdate multiple goal targets in a single batch operation using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.goalTargets.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.goal_targets.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.goal_targets.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().goalTargets().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().goalTargets().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.GoalTargets.Batch.Update(context.TODO(), crm.ObjectGoalTargetBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.goal_targets.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->goalTargets->batch->update', - example: - "crm\n ->objects\n ->goalTargets\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/goal_targets/batch/upsert', - httpMethod: 'post', - summary: 'Upsert goal tagets', - description: - "Create and update a batch of goal targets by a unique property. Goal targets that don't exist will be created, while existing goal targets will be updated.", - stainlessPath: '(resource) crm.objects.goal_targets.batch > (method) upsert', - qualified: 'client.crm.objects.goalTargets.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.goalTargets.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/goal_targets/batch/upsert`\n\nCreate and update a batch of goal targets by a unique property. Goal targets that don't exist will be created, while existing goal targets will be updated.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.goalTargets.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.goalTargets.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.goalTargets.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.goal_targets.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.goal_targets.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().goalTargets().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().goalTargets().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.GoalTargets.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.GoalTargets.Batch.Upsert(context.TODO(), crm.ObjectGoalTargetBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.goal_targets.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.goal_targets.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->goalTargets->batch->upsert', - example: - "crm\n ->objects\n ->goalTargets\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/goal_targets/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/invoices', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.', - stainlessPath: '(resource) crm.objects.invoices > (method) create', - qualified: 'client.crm.objects.invoices.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.invoices.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/invoices`\n\nCreate a invoice with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard invoices is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.invoices.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.invoices.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.invoices.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.invoices.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().invoices().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().invoices().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Invoices.New(context.TODO(), crm.ObjectInvoiceNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.invoices.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->create', - example: - "crm->objects->invoices->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{invoiceId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.invoices > (method) delete', - qualified: 'client.crm.objects.invoices.delete', - params: ['invoiceId: string;'], - markdown: - "## delete\n\n`client.crm.objects.invoices.delete(invoiceId: string): void`\n\n**delete** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nMove an Object identified by `{invoiceId}` to the recycling bin.\n\n### Parameters\n\n- `invoiceId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.invoices.delete('invoiceId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.invoices.delete('invoiceId');", - }, - python: { - method: 'crm.objects.invoices.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.invoices.delete(\n "invoiceId",\n)', - }, - java: { - method: 'crm().objects().invoices().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().invoices().delete("invoiceId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Invoices.Delete(context.TODO(), "invoiceId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.invoices.delete("invoiceId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->invoices->delete', - example: - "crm->objects->invoices->delete('invoiceId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.invoices > (method) get', - qualified: 'client.crm.objects.invoices.get', - params: [ - 'invoiceId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.invoices.get(invoiceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nRead an Object identified by `{invoiceId}`. `{invoiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `invoiceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.invoices.get('invoiceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.invoices.get('invoiceId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.invoices.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.invoices.get(\n invoice_id="invoiceId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().invoices().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().invoices().get("invoiceId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Invoices.Get(\n\t\tcontext.TODO(),\n\t\t"invoiceId",\n\t\tcrm.ObjectInvoiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.invoices.get("invoiceId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->invoices->get', - example: - "crm->objects->invoices->get(\n 'invoiceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/invoices', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of invoices. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.invoices > (method) list', - qualified: 'client.crm.objects.invoices.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.invoices.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/invoices`\n\nRead a page of invoices. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.invoices.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.invoices.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.invoices.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.invoices.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().invoices().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceListPage;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n InvoiceListPage page = client.crm().objects().invoices().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Invoices.List(context.TODO(), crm.ObjectInvoiceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.invoices.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->invoices->list', - example: - "crm->objects->invoices->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/invoices/search', - httpMethod: 'post', - summary: 'Search for invoices using specified criteria.', - description: - 'Execute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups.', - stainlessPath: '(resource) crm.objects.invoices > (method) search', - qualified: 'client.crm.objects.invoices.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.invoices.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/invoices/search`\n\nExecute a search for invoices based on filter criteria, sorting options, and properties to include in the response. This endpoint supports pagination and allows for complex queries using multiple filter groups.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.invoices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.invoices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.invoices.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.invoices.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().invoices().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().invoices().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Invoices.Search(context.TODO(), crm.ObjectInvoiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.invoices.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->search', - example: - "crm\n ->objects\n ->invoices\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/invoices/{invoiceId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.invoices > (method) update', - qualified: 'client.crm.objects.invoices.update', - params: ['invoiceId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.invoices.update(invoiceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/invoices/{invoiceId}`\n\nPerform a partial update of an Object identified by `{invoiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{invoiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `invoiceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.invoices.update('invoiceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.invoices.update('invoiceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.invoices.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.invoices.update(\n invoice_id="invoiceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().invoices().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.invoices.InvoiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n InvoiceUpdateParams params = InvoiceUpdateParams.builder()\n .invoiceId("invoiceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().invoices().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Invoices.Update(\n\t\tcontext.TODO(),\n\t\t"invoiceId",\n\t\tcrm.ObjectInvoiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.invoices.update("invoiceId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->update', - example: - "crm->objects->invoices->update(\n 'invoiceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/$INVOICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/invoices/batch/create', - httpMethod: 'post', - summary: 'Create a batch of invoices', - description: - 'Create multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs.', - stainlessPath: '(resource) crm.objects.invoices.batch > (method) create', - qualified: 'client.crm.objects.invoices.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.invoices.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/create`\n\nCreate multiple invoices at once by providing a batch of invoice data, and receive a response with details of the created invoices, including their IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.invoices.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().invoices().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.New(context.TODO(), crm.ObjectInvoiceBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->batch->create', - example: - "crm\n ->objects\n ->invoices\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/invoices/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of invoices by ID', - description: - 'Archive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference.', - stainlessPath: '(resource) crm.objects.invoices.batch > (method) delete', - qualified: 'client.crm.objects.invoices.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.invoices.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/invoices/batch/archive`\n\nArchive multiple invoices by their IDs in a single request. This operation moves the specified invoices to the archive, making them inactive but retrievable for future reference.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.invoices.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.invoices.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.invoices.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.invoices.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().invoices().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().invoices().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Invoices.Batch.Delete(context.TODO(), crm.ObjectInvoiceBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.invoices.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->invoices->batch->delete', - example: - "crm->objects->invoices->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/invoices/batch/read', - httpMethod: 'post', - summary: 'Read a batch of invoices by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.invoices.batch > (method) get', - qualified: 'client.crm.objects.invoices.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.invoices.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.invoices.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().invoices().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.Get(context.TODO(), crm.ObjectInvoiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->batch->get', - example: - "crm->objects->invoices->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/invoices/batch/update', - httpMethod: 'post', - summary: 'Update a batch of invoices by internal ID, or unique property values', - description: - 'Update multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records.', - stainlessPath: '(resource) crm.objects.invoices.batch > (method) update', - qualified: 'client.crm.objects.invoices.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.invoices.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/update`\n\nUpdate multiple invoices in a single request using either their internal IDs or unique property values. This endpoint allows for efficient batch processing of invoice updates, ensuring that changes are applied consistently across multiple records.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.invoices.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.invoices.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.invoices.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().invoices().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().invoices().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Invoices.Batch.Update(context.TODO(), crm.ObjectInvoiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.invoices.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->invoices->batch->update', - example: - "crm\n ->objects\n ->invoices\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/invoices/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of invoices by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.invoices.batch > (method) upsert', - qualified: 'client.crm.objects.invoices.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.invoices.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/invoices/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.invoices.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.invoices.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.invoices.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.invoices.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.invoices.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().invoices().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().invoices().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Invoices.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Invoices.Batch.Upsert(context.TODO(), crm.ObjectInvoiceBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.invoices.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.invoices.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->invoices->batch->upsert', - example: - "crm\n ->objects\n ->invoices\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/invoices/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/leads', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.', - stainlessPath: '(resource) crm.objects.leads > (method) create', - qualified: 'client.crm.objects.leads.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.leads.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/leads`\n\nCreate a lead with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard leads is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.leads.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.leads.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.leads.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.leads.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().leads().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().leads().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Leads.New(context.TODO(), crm.ObjectLeadNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.leads.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->leads->create', - example: - "crm->objects->leads->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/leads/{leadsId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{leadsId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.leads > (method) delete', - qualified: 'client.crm.objects.leads.delete', - params: ['leadsId: string;'], - markdown: - "## delete\n\n`client.crm.objects.leads.delete(leadsId: string): void`\n\n**delete** `/crm/objects/2026-03/leads/{leadsId}`\n\nMove an Object identified by `{leadsId}` to the recycling bin.\n\n### Parameters\n\n- `leadsId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.leads.delete('leadsId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.leads.delete('leadsId');", - }, - python: { - method: 'crm.objects.leads.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.leads.delete(\n "leadsId",\n)', - }, - java: { - method: 'crm().objects().leads().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().leads().delete("leadsId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Leads.Delete(context.TODO(), "leadsId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.leads.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.leads.delete("leadsId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->leads->delete', - example: - "crm->objects->leads->delete('leadsId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/leads/{leadsId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.leads > (method) get', - qualified: 'client.crm.objects.leads.get', - params: [ - 'leadsId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.leads.get(leadsId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/leads/{leadsId}`\n\nRead an Object identified by `{leadsId}`. `{leadsId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `leadsId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.leads.get('leadsId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.leads.get('leadsId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.leads.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.leads.get(\n leads_id="leadsId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().leads().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().leads().get("leadsId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Leads.Get(\n\t\tcontext.TODO(),\n\t\t"leadsId",\n\t\tcrm.ObjectLeadGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.leads.get("leadsId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->leads->get', - example: - "crm->objects->leads->get(\n 'leadsId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/leads', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of leads. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.leads > (method) list', - qualified: 'client.crm.objects.leads.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.leads.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/leads`\n\nRead a page of leads. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.leads.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.leads.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.leads.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.leads.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().leads().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadListPage;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LeadListPage page = client.crm().objects().leads().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Leads.List(context.TODO(), crm.ObjectLeadListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.leads.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->leads->list', - example: - "crm->objects->leads->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/leads/search', - httpMethod: 'post', - summary: 'Search for leads using specified criteria.', - description: - 'Perform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.', - stainlessPath: '(resource) crm.objects.leads > (method) search', - qualified: 'client.crm.objects.leads.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.leads.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/leads/search`\n\nPerform a search for leads based on the provided filter groups, properties, and sorting options. The request allows for pagination and can return up to 200 results per page.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.leads.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.leads.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.leads.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.leads.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().leads().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().leads().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Leads.Search(context.TODO(), crm.ObjectLeadSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.leads.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->leads->search', - example: - "crm\n ->objects\n ->leads\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/leads/{leadsId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.leads > (method) update', - qualified: 'client.crm.objects.leads.update', - params: ['leadsId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.leads.update(leadsId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/leads/{leadsId}`\n\nPerform a partial update of an Object identified by `{leadsId}`or optionally a unique property value as specified by the `idProperty` query param. `{leadsId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `leadsId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.leads.update('leadsId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.leads.update('leadsId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.leads.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.leads.update(\n leads_id="leadsId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().leads().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.leads.LeadUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LeadUpdateParams params = LeadUpdateParams.builder()\n .leadsId("leadsId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().leads().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Leads.Update(\n\t\tcontext.TODO(),\n\t\t"leadsId",\n\t\tcrm.ObjectLeadUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.leads.update("leadsId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->leads->update', - example: - "crm->objects->leads->update(\n 'leadsId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/$LEADS_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/leads/batch/create', - httpMethod: 'post', - summary: 'Create a batch of leads', - description: - 'Create multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.', - stainlessPath: '(resource) crm.objects.leads.batch > (method) create', - qualified: 'client.crm.objects.leads.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.leads.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/create`\n\nCreate multiple lead records in a single request by providing a batch of lead data. This endpoint allows for efficient creation of leads by processing them together, which can be useful for syncing data from other systems or importing large datasets.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.leads.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().leads().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.New(context.TODO(), crm.ObjectLeadBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->leads->batch->create', - example: - "crm->objects->leads->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/leads/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of leads by ID', - description: 'Archive multiple leads by their IDs in a single request, moving them to the recycling bin.', - stainlessPath: '(resource) crm.objects.leads.batch > (method) delete', - qualified: 'client.crm.objects.leads.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.leads.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/leads/batch/archive`\n\nArchive multiple leads by their IDs in a single request, moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.leads.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.leads.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.leads.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.leads.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().leads().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().leads().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Leads.Batch.Delete(context.TODO(), crm.ObjectLeadBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.leads.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.leads.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->leads->batch->delete', - example: - "crm->objects->leads->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/leads/batch/read', - httpMethod: 'post', - summary: 'Read a batch of leads by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.leads.batch > (method) get', - qualified: 'client.crm.objects.leads.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.leads.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.leads.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().leads().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.Get(context.TODO(), crm.ObjectLeadBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->leads->batch->get', - example: - "crm->objects->leads->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/leads/batch/update', - httpMethod: 'post', - summary: 'Update a batch of leads by internal ID, or unique property values', - description: - "Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.", - stainlessPath: '(resource) crm.objects.leads.batch > (method) update', - qualified: 'client.crm.objects.leads.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.leads.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/update`\n\nUpdate multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.leads.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.leads.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.leads.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().leads().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().leads().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Leads.Batch.Update(context.TODO(), crm.ObjectLeadBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.leads.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->leads->batch->update', - example: - "crm->objects->leads->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/leads/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of leads by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.leads.batch > (method) upsert', - qualified: 'client.crm.objects.leads.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.leads.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/leads/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.leads.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.leads.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.leads.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.leads.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.leads.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().leads().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().leads().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Leads.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Leads.Batch.Upsert(context.TODO(), crm.ObjectLeadBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.leads.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.leads.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->leads->batch->upsert', - example: - "crm\n ->objects\n ->leads\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/leads/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/line_items', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.', - stainlessPath: '(resource) crm.objects.line_items > (method) create', - qualified: 'client.crm.objects.lineItems.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.lineItems.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/line_items`\n\nCreate a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.lineItems.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.lineItems.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.line_items.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.line_items.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().lineItems().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().lineItems().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.LineItems.New(context.TODO(), crm.ObjectLineItemNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.line_items.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->create', - example: - "crm->objects->lineItems->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{lineItemId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.line_items > (method) delete', - qualified: 'client.crm.objects.lineItems.delete', - params: ['lineItemId: string;'], - markdown: - "## delete\n\n`client.crm.objects.lineItems.delete(lineItemId: string): void`\n\n**delete** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nMove an Object identified by `{lineItemId}` to the recycling bin.\n\n### Parameters\n\n- `lineItemId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.lineItems.delete('lineItemId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.lineItems.delete('lineItemId');", - }, - python: { - method: 'crm.objects.line_items.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.line_items.delete(\n "lineItemId",\n)', - }, - java: { - method: 'crm().objects().lineItems().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().lineItems().delete("lineItemId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.LineItems.Delete(context.TODO(), "lineItemId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.line_items.delete("lineItemId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->lineItems->delete', - example: - "crm->objects->lineItems->delete('lineItemId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.line_items > (method) get', - qualified: 'client.crm.objects.lineItems.get', - params: [ - 'lineItemId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.lineItems.get(lineItemId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nRead an Object identified by `{lineItemId}`. `{lineItemId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `lineItemId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.lineItems.get('lineItemId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.lineItems.get('lineItemId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.line_items.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.line_items.get(\n line_item_id="lineItemId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().lineItems().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().lineItems().get("lineItemId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.LineItems.Get(\n\t\tcontext.TODO(),\n\t\t"lineItemId",\n\t\tcrm.ObjectLineItemGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.line_items.get("lineItemId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->lineItems->get', - example: - "crm->objects->lineItems->get(\n 'lineItemId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/line_items', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of line items. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.line_items > (method) list', - qualified: 'client.crm.objects.lineItems.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.lineItems.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/line_items`\n\nRead a page of line items. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.lineItems.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.lineItems.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.line_items.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.line_items.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().lineItems().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemListPage;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LineItemListPage page = client.crm().objects().lineItems().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.LineItems.List(context.TODO(), crm.ObjectLineItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.line_items.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->lineItems->list', - example: - "crm->objects->lineItems->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/line_items/search', - httpMethod: 'post', - summary: 'Search for line items', - description: - 'Execute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations.', - stainlessPath: '(resource) crm.objects.line_items > (method) search', - qualified: 'client.crm.objects.lineItems.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.lineItems.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/line_items/search`\n\nExecute a search for line items based on filters, properties, and sorting options provided in the request body. This endpoint allows you to retrieve line items that match specific conditions, facilitating targeted data retrieval in CRM operations.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.lineItems.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.lineItems.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.line_items.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.line_items.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().lineItems().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().lineItems().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.LineItems.Search(context.TODO(), crm.ObjectLineItemSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.line_items.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->search', - example: - "crm\n ->objects\n ->lineItems\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/line_items/{lineItemId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{lineItemId}`or optionally a unique property value as specified by the `idProperty` query param. `{lineItemId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.line_items > (method) update', - qualified: 'client.crm.objects.lineItems.update', - params: ['lineItemId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.lineItems.update(lineItemId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/line_items/{lineItemId}`\n\nPerform a partial update of an Object identified by `{lineItemId}`or optionally a unique property value as specified by the `idProperty` query param. `{lineItemId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `lineItemId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.lineItems.update('lineItemId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.lineItems.update('lineItemId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.line_items.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.line_items.update(\n line_item_id="lineItemId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().lineItems().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.lineitems.LineItemUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n LineItemUpdateParams params = LineItemUpdateParams.builder()\n .lineItemId("lineItemId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().lineItems().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.LineItems.Update(\n\t\tcontext.TODO(),\n\t\t"lineItemId",\n\t\tcrm.ObjectLineItemUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.line_items.update("lineItemId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->update', - example: - "crm->objects->lineItems->update(\n 'lineItemId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/$LINE_ITEM_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/line_items/batch/create', - httpMethod: 'post', - summary: 'Create a batch of line items', - description: - 'Create multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers.', - stainlessPath: '(resource) crm.objects.line_items.batch > (method) create', - qualified: 'client.crm.objects.lineItems.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.lineItems.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/create`\n\nCreate multiple line items in a single request by providing the necessary properties and associations for each item. This endpoint allows for efficient batch processing of line items, returning the created objects with their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.line_items.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().lineItems().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.New(context.TODO(), crm.ObjectLineItemBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->batch->create', - example: - "crm\n ->objects\n ->lineItems\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/line_items/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of line items by ID', - description: 'Archive multiple line items simultaneously by specifying their IDs in the request body.', - stainlessPath: '(resource) crm.objects.line_items.batch > (method) delete', - qualified: 'client.crm.objects.lineItems.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.lineItems.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/line_items/batch/archive`\n\nArchive multiple line items simultaneously by specifying their IDs in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.lineItems.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.lineItems.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.line_items.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.line_items.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().lineItems().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().lineItems().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.LineItems.Batch.Delete(context.TODO(), crm.ObjectLineItemBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.line_items.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->lineItems->batch->delete', - example: - "crm->objects->lineItems->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/line_items/batch/read', - httpMethod: 'post', - summary: 'Read a batch of line items by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.line_items.batch > (method) get', - qualified: 'client.crm.objects.lineItems.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.lineItems.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.line_items.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().lineItems().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.Get(context.TODO(), crm.ObjectLineItemBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->batch->get', - example: - "crm->objects->lineItems->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/line_items/batch/update', - httpMethod: 'post', - summary: 'Update a batch of line items by internal ID, or unique property values', - description: - 'Update multiple line items using their internal IDs or unique property values. This endpoint allows for batch processing of updates, ensuring efficient modification of line item records in bulk.', - stainlessPath: '(resource) crm.objects.line_items.batch > (method) update', - qualified: 'client.crm.objects.lineItems.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.lineItems.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/update`\n\nUpdate multiple line items using their internal IDs or unique property values. This endpoint allows for batch processing of updates, ensuring efficient modification of line item records in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.lineItems.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.line_items.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.line_items.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().lineItems().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().lineItems().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.LineItems.Batch.Update(context.TODO(), crm.ObjectLineItemBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.line_items.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->lineItems->batch->update', - example: - "crm\n ->objects\n ->lineItems\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/line_items/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of line items by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.line_items.batch > (method) upsert', - qualified: 'client.crm.objects.lineItems.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.lineItems.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/line_items/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.lineItems.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.lineItems.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.lineItems.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.line_items.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.line_items.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().lineItems().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().lineItems().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.LineItems.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.LineItems.Batch.Upsert(context.TODO(), crm.ObjectLineItemBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.line_items.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.line_items.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->lineItems->batch->upsert', - example: - "crm\n ->objects\n ->lineItems\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/line_items/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-420', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided.', - stainlessPath: '(resource) crm.objects.listings > (method) create', - qualified: 'client.crm.objects.listings.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.listings.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-420`\n\nCreate a listing with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard listings is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.listings.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.listings.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.listings.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.listings.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().listings().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().listings().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Listings.New(context.TODO(), crm.ObjectListingNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.listings.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->listings->create', - example: - "crm->objects->listings->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-420/{listingId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{listingId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.listings > (method) delete', - qualified: 'client.crm.objects.listings.delete', - params: ['listingId: string;'], - markdown: - "## delete\n\n`client.crm.objects.listings.delete(listingId: string): void`\n\n**delete** `/crm/objects/2026-03/0-420/{listingId}`\n\nMove an Object identified by `{listingId}` to the recycling bin.\n\n### Parameters\n\n- `listingId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.listings.delete('listingId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.listings.delete('listingId');", - }, - python: { - method: 'crm.objects.listings.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.listings.delete(\n "listingId",\n)', - }, - java: { - method: 'crm().objects().listings().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().listings().delete("listingId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Listings.Delete(context.TODO(), "listingId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.listings.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.listings.delete("listingId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->listings->delete', - example: - "crm->objects->listings->delete('listingId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-420/{listingId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.listings > (method) get', - qualified: 'client.crm.objects.listings.get', - params: [ - 'listingId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.listings.get(listingId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-420/{listingId}`\n\nRead an Object identified by `{listingId}`. `{listingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `listingId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.listings.get('listingId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.listings.get('listingId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.listings.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.listings.get(\n listing_id="listingId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().listings().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().listings().get("listingId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Listings.Get(\n\t\tcontext.TODO(),\n\t\t"listingId",\n\t\tcrm.ObjectListingGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.listings.get("listingId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->listings->get', - example: - "crm->objects->listings->get(\n 'listingId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/0-420', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of listings. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.listings > (method) list', - qualified: 'client.crm.objects.listings.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.listings.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-420`\n\nRead a page of listings. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.listings.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.listings.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.listings.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.listings.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().listings().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingListPage;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListingListPage page = client.crm().objects().listings().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Listings.List(context.TODO(), crm.ObjectListingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.listings.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->listings->list', - example: - "crm->objects->listings->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/0-420/search', - httpMethod: 'post', - summary: 'Search for listings using various criteria and filters.', - description: 'Execute a search query to find listings based on specified filters and properties.', - stainlessPath: '(resource) crm.objects.listings > (method) search', - qualified: 'client.crm.objects.listings.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.listings.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-420/search`\n\nExecute a search query to find listings based on specified filters and properties.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.listings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.listings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.listings.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.listings.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().listings().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().listings().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Listings.Search(context.TODO(), crm.ObjectListingSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.listings.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->listings->search', - example: - "crm\n ->objects\n ->listings\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-420/{listingId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.listings > (method) update', - qualified: 'client.crm.objects.listings.update', - params: ['listingId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.listings.update(listingId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-420/{listingId}`\n\nPerform a partial update of an Object identified by `{listingId}`or optionally a unique property value as specified by the `idProperty` query param. `{listingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `listingId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.listings.update('listingId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.listings.update('listingId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.listings.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.listings.update(\n listing_id="listingId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().listings().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.listings.ListingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListingUpdateParams params = ListingUpdateParams.builder()\n .listingId("listingId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().listings().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Listings.Update(\n\t\tcontext.TODO(),\n\t\t"listingId",\n\t\tcrm.ObjectListingUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.listings.update("listingId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->listings->update', - example: - "crm->objects->listings->update(\n 'listingId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/$LISTING_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-420/batch/create', - httpMethod: 'post', - summary: 'Create a batch of listings', - description: 'Create multiple listings in a single request.', - stainlessPath: '(resource) crm.objects.listings.batch > (method) create', - qualified: 'client.crm.objects.listings.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.listings.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/create`\n\nCreate multiple listings in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.listings.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().listings().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.New(context.TODO(), crm.ObjectListingBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->listings->batch->create', - example: - "crm\n ->objects\n ->listings\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-420/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of listings by ID', - description: 'Archive multiple listings by their IDs.', - stainlessPath: '(resource) crm.objects.listings.batch > (method) delete', - qualified: 'client.crm.objects.listings.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.listings.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-420/batch/archive`\n\nArchive multiple listings by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.listings.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.listings.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.listings.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.listings.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().listings().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().listings().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Listings.Batch.Delete(context.TODO(), crm.ObjectListingBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.listings.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.listings.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->listings->batch->delete', - example: - "crm->objects->listings->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-420/batch/read', - httpMethod: 'post', - summary: 'Read a batch of listings by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.listings.batch > (method) get', - qualified: 'client.crm.objects.listings.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.listings.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.listings.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().listings().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.Get(context.TODO(), crm.ObjectListingBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->listings->batch->get', - example: - "crm->objects->listings->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-420/batch/update', - httpMethod: 'post', - summary: 'Update a batch of listings by internal ID, or unique property values', - description: 'Update multiple listings using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.listings.batch > (method) update', - qualified: 'client.crm.objects.listings.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.listings.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/update`\n\nUpdate multiple listings using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.listings.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.listings.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.listings.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().listings().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().listings().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Listings.Batch.Update(context.TODO(), crm.ObjectListingBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.listings.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->listings->batch->update', - example: - "crm\n ->objects\n ->listings\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/0-420/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of listings by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.listings.batch > (method) upsert', - qualified: 'client.crm.objects.listings.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.listings.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-420/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.listings.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.listings.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.listings.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.listings.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.listings.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().listings().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().listings().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Listings.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Listings.Batch.Upsert(context.TODO(), crm.ObjectListingBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.listings.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.listings.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->listings->batch->upsert', - example: - "crm\n ->objects\n ->listings\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-420/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/meetings', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.', - stainlessPath: '(resource) crm.objects.meetings > (method) create', - qualified: 'client.crm.objects.meetings.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.meetings.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/meetings`\n\nCreate a meeting with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard meetings is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.meetings.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.meetings.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.meetings.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.meetings.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().meetings().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().meetings().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Meetings.New(context.TODO(), crm.ObjectMeetingNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.meetings.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->create', - example: - "crm->objects->meetings->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/meetings/{meetingId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{meetingId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.meetings > (method) delete', - qualified: 'client.crm.objects.meetings.delete', - params: ['meetingId: string;'], - markdown: - "## delete\n\n`client.crm.objects.meetings.delete(meetingId: string): void`\n\n**delete** `/crm/objects/2026-03/meetings/{meetingId}`\n\nMove an Object identified by `{meetingId}` to the recycling bin.\n\n### Parameters\n\n- `meetingId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.meetings.delete('meetingId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.meetings.delete('meetingId');", - }, - python: { - method: 'crm.objects.meetings.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.meetings.delete(\n "meetingId",\n)', - }, - java: { - method: 'crm().objects().meetings().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().meetings().delete("meetingId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Meetings.Delete(context.TODO(), "meetingId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.meetings.delete("meetingId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->meetings->delete', - example: - "crm->objects->meetings->delete('meetingId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/meetings/{meetingId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.meetings > (method) get', - qualified: 'client.crm.objects.meetings.get', - params: [ - 'meetingId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.meetings.get(meetingId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/meetings/{meetingId}`\n\nRead an Object identified by `{meetingId}`. `{meetingId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `meetingId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.meetings.get('meetingId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.meetings.get('meetingId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.meetings.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.meetings.get(\n meeting_id="meetingId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().meetings().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().meetings().get("meetingId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Meetings.Get(\n\t\tcontext.TODO(),\n\t\t"meetingId",\n\t\tcrm.ObjectMeetingGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.meetings.get("meetingId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->meetings->get', - example: - "crm->objects->meetings->get(\n 'meetingId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/meetings', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of meetings. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.meetings > (method) list', - qualified: 'client.crm.objects.meetings.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.meetings.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/meetings`\n\nRead a page of meetings. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.meetings.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.meetings.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.meetings.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.meetings.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().meetings().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingListPage;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MeetingListPage page = client.crm().objects().meetings().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Meetings.List(context.TODO(), crm.ObjectMeetingListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.meetings.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->meetings->list', - example: - "crm->objects->meetings->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/meetings/search', - httpMethod: 'post', - summary: 'Search for meetings', - description: - 'Search for meetings by filtering on properties, searching through associations, and sorting results.', - stainlessPath: '(resource) crm.objects.meetings > (method) search', - qualified: 'client.crm.objects.meetings.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.meetings.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/meetings/search`\n\nSearch for meetings by filtering on properties, searching through associations, and sorting results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.meetings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.meetings.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.meetings.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.meetings.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().meetings().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().meetings().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Meetings.Search(context.TODO(), crm.ObjectMeetingSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.meetings.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->search', - example: - "crm\n ->objects\n ->meetings\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/meetings/{meetingId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.meetings > (method) update', - qualified: 'client.crm.objects.meetings.update', - params: ['meetingId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.meetings.update(meetingId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/meetings/{meetingId}`\n\nPerform a partial update of an Object identified by `{meetingId}`or optionally a unique property value as specified by the `idProperty` query param. `{meetingId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `meetingId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.meetings.update('meetingId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.meetings.update('meetingId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.meetings.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.meetings.update(\n meeting_id="meetingId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().meetings().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.meetings.MeetingUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MeetingUpdateParams params = MeetingUpdateParams.builder()\n .meetingId("meetingId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().meetings().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Meetings.Update(\n\t\tcontext.TODO(),\n\t\t"meetingId",\n\t\tcrm.ObjectMeetingUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.meetings.update("meetingId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->update', - example: - "crm->objects->meetings->update(\n 'meetingId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/$MEETING_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/meetings/batch/create', - httpMethod: 'post', - summary: 'Create a batch of meetings', - description: - 'Create a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.', - stainlessPath: '(resource) crm.objects.meetings.batch > (method) create', - qualified: 'client.crm.objects.meetings.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.meetings.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/create`\n\nCreate a batch of meetings. The `inputs` array can contain a `properties` object to define property values for the record, along with an `associations` array to define relationships with other object records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.meetings.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().meetings().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.New(context.TODO(), crm.ObjectMeetingBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->batch->create', - example: - "crm\n ->objects\n ->meetings\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/meetings/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of meetings by ID', - description: 'Delete a batch of meetings by ID.', - stainlessPath: '(resource) crm.objects.meetings.batch > (method) delete', - qualified: 'client.crm.objects.meetings.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.meetings.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/meetings/batch/archive`\n\nDelete a batch of meetings by ID.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.meetings.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.meetings.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.meetings.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.meetings.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().meetings().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().meetings().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Meetings.Batch.Delete(context.TODO(), crm.ObjectMeetingBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.meetings.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->meetings->batch->delete', - example: - "crm->objects->meetings->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/meetings/batch/read', - httpMethod: 'post', - summary: 'Read a batch of meetings by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.meetings.batch > (method) get', - qualified: 'client.crm.objects.meetings.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.meetings.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.meetings.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().meetings().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.Get(context.TODO(), crm.ObjectMeetingBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->batch->get', - example: - "crm->objects->meetings->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/meetings/batch/update', - httpMethod: 'post', - summary: 'Update a batch of meetings by internal ID, or unique property values', - description: - 'Update a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.meetings.batch > (method) update', - qualified: 'client.crm.objects.meetings.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.meetings.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/update`\n\nUpdate a batch of meetings by ID (`objectId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.meetings.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.meetings.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.meetings.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().meetings().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().meetings().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Meetings.Batch.Update(context.TODO(), crm.ObjectMeetingBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.meetings.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->meetings->batch->update', - example: - "crm\n ->objects\n ->meetings\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/meetings/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of meetings by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.meetings.batch > (method) upsert', - qualified: 'client.crm.objects.meetings.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.meetings.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/meetings/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.meetings.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.meetings.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.meetings.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.meetings.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.meetings.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().meetings().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().meetings().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Meetings.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Meetings.Batch.Upsert(context.TODO(), crm.ObjectMeetingBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.meetings.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.meetings.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->meetings->batch->upsert', - example: - "crm\n ->objects\n ->meetings\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/meetings/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/notes', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.', - stainlessPath: '(resource) crm.objects.notes > (method) create', - qualified: 'client.crm.objects.notes.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.notes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/notes`\n\nCreate a note with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard notes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.notes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.notes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.notes.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.notes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().notes().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().notes().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Notes.New(context.TODO(), crm.ObjectNoteNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.notes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->notes->create', - example: - "crm->objects->notes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/notes/{noteId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{noteId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.notes > (method) delete', - qualified: 'client.crm.objects.notes.delete', - params: ['noteId: string;'], - markdown: - "## delete\n\n`client.crm.objects.notes.delete(noteId: string): void`\n\n**delete** `/crm/objects/2026-03/notes/{noteId}`\n\nMove an Object identified by `{noteId}` to the recycling bin.\n\n### Parameters\n\n- `noteId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.notes.delete('noteId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.notes.delete('noteId');", - }, - python: { - method: 'crm.objects.notes.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.notes.delete(\n "noteId",\n)', - }, - java: { - method: 'crm().objects().notes().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().notes().delete("noteId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Notes.Delete(context.TODO(), "noteId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.notes.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.notes.delete("noteId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->notes->delete', - example: - "crm->objects->notes->delete('noteId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/notes/{noteId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.notes > (method) get', - qualified: 'client.crm.objects.notes.get', - params: [ - 'noteId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.notes.get(noteId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/notes/{noteId}`\n\nRead an Object identified by `{noteId}`. `{noteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `noteId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.notes.get('noteId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.notes.get('noteId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.notes.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.notes.get(\n note_id="noteId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().notes().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().notes().get("noteId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Notes.Get(\n\t\tcontext.TODO(),\n\t\t"noteId",\n\t\tcrm.ObjectNoteGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.notes.get("noteId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->notes->get', - example: - "crm->objects->notes->get(\n 'noteId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/notes', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of notes. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.notes > (method) list', - qualified: 'client.crm.objects.notes.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.notes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/notes`\n\nRead a page of notes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.notes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.notes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.notes.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.notes.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().notes().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteListPage;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n NoteListPage page = client.crm().objects().notes().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Notes.List(context.TODO(), crm.ObjectNoteListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.notes.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->notes->list', - example: - "crm->objects->notes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/notes/search', - httpMethod: 'post', - summary: 'Search for notes based on specified criteria.', - description: - 'Execute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.', - stainlessPath: '(resource) crm.objects.notes > (method) search', - qualified: 'client.crm.objects.notes.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.notes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/notes/search`\n\nExecute a search for notes using filters, sorting options, and other query parameters to refine the results. This endpoint allows for complex queries to locate specific notes within the CRM system.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.notes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.notes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.notes.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.notes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().notes().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().notes().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Notes.Search(context.TODO(), crm.ObjectNoteSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.notes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->notes->search', - example: - "crm\n ->objects\n ->notes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/notes/{noteId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.notes > (method) update', - qualified: 'client.crm.objects.notes.update', - params: ['noteId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.notes.update(noteId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/notes/{noteId}`\n\nPerform a partial update of an Object identified by `{noteId}`or optionally a unique property value as specified by the `idProperty` query param. `{noteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `noteId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.notes.update('noteId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.notes.update('noteId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.notes.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.notes.update(\n note_id="noteId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().notes().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.notes.NoteUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n NoteUpdateParams params = NoteUpdateParams.builder()\n .noteId("noteId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().notes().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Notes.Update(\n\t\tcontext.TODO(),\n\t\t"noteId",\n\t\tcrm.ObjectNoteUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.notes.update("noteId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->notes->update', - example: - "crm->objects->notes->update(\n 'noteId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/$NOTE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/notes/batch/create', - httpMethod: 'post', - summary: 'Create a batch of notes', - description: - 'Create multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.', - stainlessPath: '(resource) crm.objects.notes.batch > (method) create', - qualified: 'client.crm.objects.notes.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.notes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/create`\n\nCreate multiple notes in a single request by providing the necessary properties for each note. This operation returns the created notes with their unique identifiers.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.notes.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().notes().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.New(context.TODO(), crm.ObjectNoteBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->notes->batch->create', - example: - "crm->objects->notes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/notes/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of notes by ID', - description: - 'Archive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.', - stainlessPath: '(resource) crm.objects.notes.batch > (method) delete', - qualified: 'client.crm.objects.notes.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.notes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/notes/batch/archive`\n\nArchive multiple notes by their IDs in a single request. This operation moves the specified notes to the recycling bin, making them inaccessible from regular queries.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.notes.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.notes.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.notes.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.notes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().notes().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().notes().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Notes.Batch.Delete(context.TODO(), crm.ObjectNoteBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.notes.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.notes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->notes->batch->delete', - example: - "crm->objects->notes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/notes/batch/read', - httpMethod: 'post', - summary: 'Read a batch of notes by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.notes.batch > (method) get', - qualified: 'client.crm.objects.notes.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.notes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.notes.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().notes().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.Get(context.TODO(), crm.ObjectNoteBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->notes->batch->get', - example: - "crm->objects->notes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/notes/batch/update', - httpMethod: 'post', - summary: 'Update a batch of notes by internal ID, or unique property values', - description: - 'Update multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.', - stainlessPath: '(resource) crm.objects.notes.batch > (method) update', - qualified: 'client.crm.objects.notes.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.notes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/update`\n\nUpdate multiple notes using their internal IDs or unique property values. This operation allows you to modify the properties of several notes in a single request, streamlining the process of managing note data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.notes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.notes.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.notes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().notes().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().notes().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Notes.Batch.Update(context.TODO(), crm.ObjectNoteBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.notes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->notes->batch->update', - example: - "crm->objects->notes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/notes/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of notes by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.notes.batch > (method) upsert', - qualified: 'client.crm.objects.notes.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.notes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/notes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.notes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.notes.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.notes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.notes.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.notes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().notes().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().notes().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Notes.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Notes.Batch.Upsert(context.TODO(), crm.ObjectNoteBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.notes.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.notes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->notes->batch->upsert', - example: - "crm\n ->objects\n ->notes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/notes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/orders', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.', - stainlessPath: '(resource) crm.objects.orders > (method) create', - qualified: 'client.crm.objects.orders.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.orders.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/orders`\n\nCreate a order with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard orders is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.orders.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.orders.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.orders.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.orders.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().orders().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().orders().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Orders.New(context.TODO(), crm.ObjectOrderNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.orders.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->orders->create', - example: - "crm->objects->orders->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/orders/{orderId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{orderId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.orders > (method) delete', - qualified: 'client.crm.objects.orders.delete', - params: ['orderId: string;'], - markdown: - "## delete\n\n`client.crm.objects.orders.delete(orderId: string): void`\n\n**delete** `/crm/objects/2026-03/orders/{orderId}`\n\nMove an Object identified by `{orderId}` to the recycling bin.\n\n### Parameters\n\n- `orderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.orders.delete('orderId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.orders.delete('orderId');", - }, - python: { - method: 'crm.objects.orders.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.orders.delete(\n "orderId",\n)', - }, - java: { - method: 'crm().objects().orders().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().orders().delete("orderId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Orders.Delete(context.TODO(), "orderId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.orders.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.orders.delete("orderId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->orders->delete', - example: - "crm->objects->orders->delete('orderId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/orders/{orderId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.orders > (method) get', - qualified: 'client.crm.objects.orders.get', - params: [ - 'orderId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.orders.get(orderId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/orders/{orderId}`\n\nRead an Object identified by `{orderId}`. `{orderId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `orderId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.orders.get('orderId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.orders.get('orderId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.orders.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.orders.get(\n order_id="orderId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().orders().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().orders().get("orderId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Orders.Get(\n\t\tcontext.TODO(),\n\t\t"orderId",\n\t\tcrm.ObjectOrderGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.orders.get("orderId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->orders->get', - example: - "crm->objects->orders->get(\n 'orderId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/orders', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of orders. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.orders > (method) list', - qualified: 'client.crm.objects.orders.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.orders.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/orders`\n\nRead a page of orders. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.orders.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.orders.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.orders.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.orders.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().orders().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderListPage;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OrderListPage page = client.crm().objects().orders().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Orders.List(context.TODO(), crm.ObjectOrderListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.orders.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->orders->list', - example: - "crm->objects->orders->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/orders/search', - httpMethod: 'post', - summary: - 'Search for orders in the CRM using various filters and sorting options to retrieve specific order data.', - description: 'Execute a search for orders using specified criteria and return matching results.', - stainlessPath: '(resource) crm.objects.orders > (method) search', - qualified: 'client.crm.objects.orders.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.orders.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/orders/search`\n\nExecute a search for orders using specified criteria and return matching results.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.orders.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.orders.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.orders.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.orders.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().orders().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().orders().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Orders.Search(context.TODO(), crm.ObjectOrderSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.orders.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->orders->search', - example: - "crm\n ->objects\n ->orders\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/orders/{orderId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.orders > (method) update', - qualified: 'client.crm.objects.orders.update', - params: ['orderId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.orders.update(orderId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/orders/{orderId}`\n\nPerform a partial update of an Object identified by `{orderId}`or optionally a unique property value as specified by the `idProperty` query param. `{orderId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `orderId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.orders.update('orderId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.orders.update('orderId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.orders.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.orders.update(\n order_id="orderId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().orders().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.orders.OrderUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OrderUpdateParams params = OrderUpdateParams.builder()\n .orderId("orderId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().orders().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Orders.Update(\n\t\tcontext.TODO(),\n\t\t"orderId",\n\t\tcrm.ObjectOrderUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.orders.update("orderId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->orders->update', - example: - "crm->objects->orders->update(\n 'orderId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/$ORDER_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/orders/batch/create', - httpMethod: 'post', - summary: 'Create a batch of orders', - description: 'Create a batch of orders in the system.', - stainlessPath: '(resource) crm.objects.orders.batch > (method) create', - qualified: 'client.crm.objects.orders.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.orders.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/create`\n\nCreate a batch of orders in the system.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.orders.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().orders().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.New(context.TODO(), crm.ObjectOrderBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->orders->batch->create', - example: - "crm->objects->orders->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/orders/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of orders by ID', - description: 'Archive a batch of orders identified by their IDs.', - stainlessPath: '(resource) crm.objects.orders.batch > (method) delete', - qualified: 'client.crm.objects.orders.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.orders.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/orders/batch/archive`\n\nArchive a batch of orders identified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.orders.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.orders.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.orders.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.orders.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().orders().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().orders().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Orders.Batch.Delete(context.TODO(), crm.ObjectOrderBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.orders.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.orders.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->orders->batch->delete', - example: - "crm->objects->orders->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/orders/batch/read', - httpMethod: 'post', - summary: 'Read a batch of orders by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.orders.batch > (method) get', - qualified: 'client.crm.objects.orders.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.orders.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.orders.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().orders().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.Get(context.TODO(), crm.ObjectOrderBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->orders->batch->get', - example: - "crm->objects->orders->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/orders/batch/update', - httpMethod: 'post', - summary: 'Update a batch of orders by internal ID, or unique property values', - description: 'Update a batch of orders using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.orders.batch > (method) update', - qualified: 'client.crm.objects.orders.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.orders.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/update`\n\nUpdate a batch of orders using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.orders.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.orders.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.orders.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().orders().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().orders().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Orders.Batch.Update(context.TODO(), crm.ObjectOrderBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.orders.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->orders->batch->update', - example: - "crm->objects->orders->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/orders/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of orders by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.orders.batch > (method) upsert', - qualified: 'client.crm.objects.orders.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.orders.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/orders/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.orders.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.orders.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.orders.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.orders.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.orders.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().orders().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().orders().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Orders.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Orders.Batch.Upsert(context.TODO(), crm.ObjectOrderBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.orders.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.orders.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->orders->batch->upsert', - example: - "crm\n ->objects\n ->orders\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/orders/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}', - httpMethod: 'get', - summary: 'Retrieve details of a specific partner client.', - description: - 'Retrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes.', - stainlessPath: '(resource) crm.objects.partner_clients > (method) get', - qualified: 'client.crm.objects.partnerClients.get', - params: [ - 'partnerClientId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.partnerClients.get(partnerClientId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients/{partnerClientId}`\n\nRetrieve detailed information about a specific partner client, including selected properties and associations. This endpoint is useful for accessing comprehensive client data for analysis or integration purposes.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerClients.get('partnerClientId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerClients.get(\n 'partnerClientId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.partner_clients.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.partner_clients.get(\n partner_client_id="partnerClientId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().partnerClients().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().partnerClients().get("partnerClientId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PartnerClients.Get(\n\t\tcontext.TODO(),\n\t\t"partnerClientId",\n\t\tcrm.ObjectPartnerClientGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.partner_clients.get("partnerClientId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->partnerClients->get', - example: - "crm\n ->objects\n ->partnerClients\n ->get(\n 'partnerClientId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/partner_clients', - httpMethod: 'get', - summary: 'Retrieve a list of partner clients.', - description: - "Retrieve a list of partner clients with optional filtering by deleted status, associations, and specific properties. The response can be paginated using the 'after' parameter.", - stainlessPath: '(resource) crm.objects.partner_clients > (method) list', - qualified: 'client.crm.objects.partnerClients.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.partnerClients.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients`\n\nRetrieve a list of partner clients with optional filtering by deleted status, associations, and specific properties. The response can be paginated using the 'after' parameter.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.partnerClients.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.partnerClients.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.partner_clients.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_clients.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().partnerClients().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListPage;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientListPage page = client.crm().objects().partnerClients().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerClients.List(context.TODO(), crm.ObjectPartnerClientListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_clients.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->partnerClients->list', - example: - "crm->objects->partnerClients->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_associations', - endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}', - httpMethod: 'get', - summary: 'List associations of a partner client by type', - description: - 'Retrieve a list of associations for a specific partner client based on the specified object type.', - stainlessPath: '(resource) crm.objects.partner_clients > (method) list_associations', - qualified: 'client.crm.objects.partnerClients.listAssociations', - params: ['partnerClientId: string;', 'toObjectType: string;', 'after?: string;', 'limit?: number;'], - response: - "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", - markdown: - "## list_associations\n\n`client.crm.objects.partnerClients.listAssociations(partnerClientId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}`\n\nRetrieve a list of associations for a specific partner client based on the specified object type.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerClients.listAssociations('toObjectType', { partnerClientId: 'partnerClientId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.listAssociations', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerClients.listAssociations(\n 'toObjectType',\n { partnerClientId: 'partnerClientId' },\n)) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", - }, - python: { - method: 'crm.objects.partner_clients.list_associations', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_clients.list_associations(\n to_object_type="toObjectType",\n partner_client_id="partnerClientId",\n)\npage = page.results[0]\nprint(page.association_types)', - }, - java: { - method: 'crm().objects().partnerClients().listAssociations', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListAssociationsPage;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientListAssociationsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientListAssociationsParams params = PartnerClientListAssociationsParams.builder()\n .partnerClientId("partnerClientId")\n .toObjectType("toObjectType")\n .build();\n PartnerClientListAssociationsPage page = client.crm().objects().partnerClients().listAssociations(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.ListAssociations', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerClients.ListAssociations(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.ObjectPartnerClientListAssociationsParams{\n\t\t\tPartnerClientID: "partnerClientId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.list_associations', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_clients.list_associations(\n "toObjectType",\n partner_client_id: "partnerClientId"\n)\n\nputs(page)', - }, - php: { - method: 'crm->objects->partnerClients->listAssociations', - example: - "crm->objects->partnerClients->listAssociations(\n 'toObjectType', partnerClientID: 'partnerClientId', after: 'after', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/partner_clients/search', - httpMethod: 'post', - summary: 'Search for partner clients using specified criteria.', - description: - 'Execute a search for partner clients based on defined filters, properties, and sorting options. This endpoint allows you to retrieve partner client data that matches the search criteria, facilitating integration and data synchronization with third-party systems.', - stainlessPath: '(resource) crm.objects.partner_clients > (method) search', - qualified: 'client.crm.objects.partnerClients.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.partnerClients.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/partner_clients/search`\n\nExecute a search for partner clients based on defined filters, properties, and sorting options. This endpoint allows you to retrieve partner client data that matches the search criteria, facilitating integration and data synchronization with third-party systems.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.partnerClients.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.partnerClients.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.partner_clients.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.partner_clients.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().partnerClients().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().partnerClients().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PartnerClients.Search(context.TODO(), crm.ObjectPartnerClientSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.partner_clients.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerClients->search', - example: - "crm\n ->objects\n ->partnerClients\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/partner_clients/{partnerClientId}', - httpMethod: 'patch', - summary: 'Update properties of a specific partner client.', - description: 'Update the specified properties of an existing partner client.', - stainlessPath: '(resource) crm.objects.partner_clients > (method) update', - qualified: 'client.crm.objects.partnerClients.update', - params: ['partnerClientId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.partnerClients.update(partnerClientId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/partner_clients/{partnerClientId}`\n\nUpdate the specified properties of an existing partner client.\n\n### Parameters\n\n- `partnerClientId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.partnerClients.update('partnerClientId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.partnerClients.update('partnerClientId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.partner_clients.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.partner_clients.update(\n partner_client_id="partnerClientId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().partnerClients().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.partnerclients.PartnerClientUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerClientUpdateParams params = PartnerClientUpdateParams.builder()\n .partnerClientId("partnerClientId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().partnerClients().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PartnerClients.Update(\n\t\tcontext.TODO(),\n\t\t"partnerClientId",\n\t\tcrm.ObjectPartnerClientUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.partner_clients.update("partnerClientId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->partnerClients->update', - example: - "crm->objects->partnerClients->update(\n 'partnerClientId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/$PARTNER_CLIENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/partner_clients/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of partner client objects.', - description: - 'Retrieve multiple partner client objects in a single request by specifying their IDs. This endpoint is useful for efficiently accessing data for multiple clients at once, particularly when integrating with third-party systems.', - stainlessPath: '(resource) crm.objects.partner_clients.batch > (method) get', - qualified: 'client.crm.objects.partnerClients.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.partnerClients.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_clients/batch/read`\n\nRetrieve multiple partner client objects in a single request by specifying their IDs. This endpoint is useful for efficiently accessing data for multiple clients at once, particularly when integrating with third-party systems.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.partner_clients.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_clients.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().partnerClients().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerClients().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerClients.Batch.Get(context.TODO(), crm.ObjectPartnerClientBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_clients.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerClients->batch->get', - example: - "crm\n ->objects\n ->partnerClients\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/partner_clients/batch/update', - httpMethod: 'post', - summary: 'Update multiple partner client records in a single request.', - description: - 'This endpoint allows you to update several partner client records at once by providing a batch of CRM object records with their respective IDs and properties. It is useful for synchronizing data across systems or making bulk updates efficiently.', - stainlessPath: '(resource) crm.objects.partner_clients.batch > (method) update', - qualified: 'client.crm.objects.partnerClients.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.partnerClients.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_clients/batch/update`\n\nThis endpoint allows you to update several partner client records at once by providing a batch of CRM object records with their respective IDs and properties. It is useful for synchronizing data across systems or making bulk updates efficiently.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerClients.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerClients.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.partner_clients.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_clients.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().partnerClients().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerClients().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerClients.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerClients.Batch.Update(context.TODO(), crm.ObjectPartnerClientBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_clients.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_clients.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerClients->batch->update', - example: - "crm\n ->objects\n ->partnerClients\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_clients/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{partnerServiceId}`. `{partnerServiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.partner_services > (method) get', - qualified: 'client.crm.objects.partnerServices.get', - params: [ - 'partnerServiceId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.partnerServices.get(partnerServiceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/partner_services/{partnerServiceId}`\n\nRead an Object identified by `{partnerServiceId}`. `{partnerServiceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerServices.get('partnerServiceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.partnerServices.get(\n 'partnerServiceId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.partner_services.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.partner_services.get(\n partner_service_id="partnerServiceId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().partnerServices().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().partnerServices().get("partnerServiceId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PartnerServices.Get(\n\t\tcontext.TODO(),\n\t\t"partnerServiceId",\n\t\tcrm.ObjectPartnerServiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.partner_services.get("partnerServiceId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->partnerServices->get', - example: - "crm\n ->objects\n ->partnerServices\n ->get(\n 'partnerServiceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}', - httpMethod: 'get', - summary: 'List associations of a partner service by type', - description: - 'Retrieve a list of associations for a specific partner service, filtered by the type of associated object.', - stainlessPath: '(resource) crm.objects.partner_services > (method) list', - qualified: 'client.crm.objects.partnerServices.list', - params: ['partnerServiceId: string;', 'toObjectType: string;', 'after?: string;', 'limit?: number;'], - response: - "{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }", - markdown: - "## list\n\n`client.crm.objects.partnerServices.list(partnerServiceId: string, toObjectType: string, after?: string, limit?: number): { associationTypes: association_spec_with_label[]; toObjectId: string; }`\n\n**get** `/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}`\n\nRetrieve a list of associations for a specific partner service, filtered by the type of associated object.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `toObjectType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]; toObjectId: string; }`\n Represents an object that is associated with multiple other objects, with optional context.\n\n - `associationTypes: { category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; typeId: number; label?: string; }[]`\n - `toObjectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerServices.list('toObjectType', { partnerServiceId: 'partnerServiceId' })) {\n console.log(multiAssociatedObjectWithLabel);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const multiAssociatedObjectWithLabel of client.crm.objects.partnerServices.list(\n 'toObjectType',\n { partnerServiceId: 'partnerServiceId' },\n)) {\n console.log(multiAssociatedObjectWithLabel.associationTypes);\n}", - }, - python: { - method: 'crm.objects.partner_services.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.partner_services.list(\n to_object_type="toObjectType",\n partner_service_id="partnerServiceId",\n)\npage = page.results[0]\nprint(page.association_types)', - }, - java: { - method: 'crm().objects().partnerServices().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceListPage;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerServiceListParams params = PartnerServiceListParams.builder()\n .partnerServiceId("partnerServiceId")\n .toObjectType("toObjectType")\n .build();\n PartnerServiceListPage page = client.crm().objects().partnerServices().list(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PartnerServices.List(\n\t\tcontext.TODO(),\n\t\t"toObjectType",\n\t\tcrm.ObjectPartnerServiceListParams{\n\t\t\tPartnerServiceID: "partnerServiceId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.partner_services.list("toObjectType", partner_service_id: "partnerServiceId")\n\nputs(page)', - }, - php: { - method: 'crm->objects->partnerServices->list', - example: - "crm->objects->partnerServices->list(\n 'toObjectType', partnerServiceID: 'partnerServiceId', after: 'after', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID/associations/$TO_OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/partner_services/search', - httpMethod: 'post', - summary: 'Search for partner services using specified criteria.', - description: - 'Execute a search query to find partner services based on defined filters, properties, and sorting options. This endpoint allows you to retrieve a collection of partner services that match the specified search criteria.', - stainlessPath: '(resource) crm.objects.partner_services > (method) search', - qualified: 'client.crm.objects.partnerServices.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.partnerServices.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/partner_services/search`\n\nExecute a search query to find partner services based on defined filters, properties, and sorting options. This endpoint allows you to retrieve a collection of partner services that match the specified search criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.partnerServices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject =\n await client.crm.objects.partnerServices.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n });\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.partner_services.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.partner_services.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().partnerServices().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().partnerServices().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PartnerServices.Search(context.TODO(), crm.ObjectPartnerServiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.partner_services.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerServices->search', - example: - "crm\n ->objects\n ->partnerServices\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/partner_services/{partnerServiceId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.partner_services > (method) update', - qualified: 'client.crm.objects.partnerServices.update', - params: ['partnerServiceId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.partnerServices.update(partnerServiceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/partner_services/{partnerServiceId}`\n\nPerform a partial update of an Object identified by `{partnerServiceId}`or optionally a unique property value as specified by the `idProperty` query param. `{partnerServiceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `partnerServiceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.partnerServices.update('partnerServiceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.partnerServices.update('partnerServiceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.partner_services.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.partner_services.update(\n partner_service_id="partnerServiceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().partnerServices().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.partnerservices.PartnerServiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PartnerServiceUpdateParams params = PartnerServiceUpdateParams.builder()\n .partnerServiceId("partnerServiceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().partnerServices().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PartnerServices.Update(\n\t\tcontext.TODO(),\n\t\t"partnerServiceId",\n\t\tcrm.ObjectPartnerServiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.partner_services.update("partnerServiceId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->partnerServices->update', - example: - "crm->objects->partnerServices->update(\n 'partnerServiceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/$PARTNER_SERVICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/partner_services/batch/read', - httpMethod: 'post', - summary: 'Read a batch of partner services by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.partner_services.batch > (method) get', - qualified: 'client.crm.objects.partnerServices.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.partnerServices.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_services/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.partner_services.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_services.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().partnerServices().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerServices().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerServices.Batch.Get(context.TODO(), crm.ObjectPartnerServiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_services.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerServices->batch->get', - example: - "crm\n ->objects\n ->partnerServices\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/partner_services/batch/update', - httpMethod: 'post', - summary: 'Update a batch of partner services by internal ID, or unique property values', - description: - 'Update multiple partner services using their internal IDs or unique property values. This operation allows for batch processing of updates, ensuring efficient synchronization of service data between HubSpot and other systems.', - stainlessPath: '(resource) crm.objects.partner_services.batch > (method) update', - qualified: 'client.crm.objects.partnerServices.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.partnerServices.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/partner_services/batch/update`\n\nUpdate multiple partner services using their internal IDs or unique property values. This operation allows for batch processing of updates, ensuring efficient synchronization of service data between HubSpot and other systems.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.partnerServices.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.partnerServices.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.partner_services.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.partner_services.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().partnerServices().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().partnerServices().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PartnerServices.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PartnerServices.Batch.Update(context.TODO(), crm.ObjectPartnerServiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.partner_services.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.partner_services.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->partnerServices->batch->update', - example: - "crm\n ->objects\n ->partnerServices\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/partner_services/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/postal_mail', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a postal mail object with the given properties and return a copy of the object, including the ID. ', - stainlessPath: '(resource) crm.objects.postal_mail > (method) create', - qualified: 'client.crm.objects.postalMail.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.postalMail.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail`\n\nCreate a postal mail object with the given properties and return a copy of the object, including the ID. \n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.postalMail.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.postalMail.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.postal_mail.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.postal_mail.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().postalMail().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().postalMail().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PostalMail.New(context.TODO(), crm.ObjectPostalMailNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.postal_mail.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->create', - example: - "crm->objects->postalMail->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move the postal mail object with the ID `{postalMailId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.postal_mail > (method) delete', - qualified: 'client.crm.objects.postalMail.delete', - params: ['postalMailId: string;'], - markdown: - "## delete\n\n`client.crm.objects.postalMail.delete(postalMailId: string): void`\n\n**delete** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\nMove the postal mail object with the ID `{postalMailId}` to the recycling bin.\n\n### Parameters\n\n- `postalMailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.postalMail.delete('postalMailId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.postalMail.delete('postalMailId');", - }, - python: { - method: 'crm.objects.postal_mail.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.postal_mail.delete(\n "postalMailId",\n)', - }, - java: { - method: 'crm().objects().postalMail().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().postalMail().delete("postalMailId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.PostalMail.Delete(context.TODO(), "postalMailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.postal_mail.delete("postalMailId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->postalMail->delete', - example: - "crm->objects->postalMail->delete('postalMailId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.postal_mail > (method) get', - qualified: 'client.crm.objects.postalMail.get', - params: [ - 'postalMailId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.postalMail.get(postalMailId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\n### Parameters\n\n- `postalMailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.postalMail.get('postalMailId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.postalMail.get('postalMailId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.postal_mail.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.postal_mail.get(\n postal_mail_id="postalMailId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().postalMail().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().postalMail().get("postalMailId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.PostalMail.Get(\n\t\tcontext.TODO(),\n\t\t"postalMailId",\n\t\tcrm.ObjectPostalMailGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.postal_mail.get("postalMailId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->postalMail->get', - example: - "crm->objects->postalMail->get(\n 'postalMailId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/postal_mail', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.postal_mail > (method) list', - qualified: 'client.crm.objects.postalMail.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.postalMail.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/postal_mail`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.postalMail.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.postalMail.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.postal_mail.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.postal_mail.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().postalMail().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailListPage;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostalMailListPage page = client.crm().objects().postalMail().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.PostalMail.List(context.TODO(), crm.ObjectPostalMailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.postal_mail.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->postalMail->list', - example: - "crm->objects->postalMail->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/postal_mail/search', - httpMethod: 'post', - summary: 'Search', - description: 'Search for postal mail objects using specific criteria in the request.', - stainlessPath: '(resource) crm.objects.postal_mail > (method) search', - qualified: 'client.crm.objects.postalMail.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.postalMail.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/postal_mail/search`\n\nSearch for postal mail objects using specific criteria in the request.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.postalMail.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.postalMail.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.postal_mail.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.postal_mail.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().postalMail().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().postalMail().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.PostalMail.Search(context.TODO(), crm.ObjectPostalMailSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.postal_mail.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->search', - example: - "crm\n ->objects\n ->postalMail\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/postal_mail/{postalMailId}', - httpMethod: 'patch', - summary: '', - description: '', - stainlessPath: '(resource) crm.objects.postal_mail > (method) update', - qualified: 'client.crm.objects.postalMail.update', - params: ['postalMailId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.postalMail.update(postalMailId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/postal_mail/{postalMailId}`\n\n### Parameters\n\n- `postalMailId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.postalMail.update('postalMailId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.postalMail.update('postalMailId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.postal_mail.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.postal_mail.update(\n postal_mail_id="postalMailId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().postalMail().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.postalmail.PostalMailUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PostalMailUpdateParams params = PostalMailUpdateParams.builder()\n .postalMailId("postalMailId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().postalMail().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.PostalMail.Update(\n\t\tcontext.TODO(),\n\t\t"postalMailId",\n\t\tcrm.ObjectPostalMailUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.postal_mail.update("postalMailId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->update', - example: - "crm->objects->postalMail->update(\n 'postalMailId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/$POSTAL_MAIL_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/postal_mail/batch/create', - httpMethod: 'post', - summary: 'Batch create', - description: 'Create a batch of postal mail objects.', - stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) create', - qualified: 'client.crm.objects.postalMail.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.postalMail.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/create`\n\nCreate a batch of postal mail objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.postal_mail.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().postalMail().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.New(context.TODO(), crm.ObjectPostalMailBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->batch->create', - example: - "crm\n ->objects\n ->postalMail\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/postal_mail/batch/archive', - httpMethod: 'post', - summary: 'Batch archive', - description: 'Archive a batch of postal mail objects using their IDs.', - stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) delete', - qualified: 'client.crm.objects.postalMail.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.postalMail.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/archive`\n\nArchive a batch of postal mail objects using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.postalMail.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.postalMail.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.postal_mail.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.postal_mail.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().postalMail().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().postalMail().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.PostalMail.Batch.Delete(context.TODO(), crm.ObjectPostalMailBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.postal_mail.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->postalMail->batch->delete', - example: - "crm->objects->postalMail->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/postal_mail/batch/read', - httpMethod: 'post', - summary: '', - description: 'Retrieve multiple postal mail objects using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) get', - qualified: 'client.crm.objects.postalMail.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.postalMail.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/read`\n\nRetrieve multiple postal mail objects using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.postal_mail.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().postalMail().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.Get(context.TODO(), crm.ObjectPostalMailBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->batch->get', - example: - "crm\n ->objects\n ->postalMail\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/postal_mail/batch/update', - httpMethod: 'post', - summary: '', - description: 'Update multiple postal mail objects in a single request.', - stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) update', - qualified: 'client.crm.objects.postalMail.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.postalMail.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/update`\n\nUpdate multiple postal mail objects in a single request.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.postalMail.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.postal_mail.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.postal_mail.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().postalMail().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().postalMail().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.PostalMail.Batch.Update(context.TODO(), crm.ObjectPostalMailBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.postal_mail.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->postalMail->batch->update', - example: - "crm\n ->objects\n ->postalMail\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/postal_mail/batch/upsert', - httpMethod: 'post', - summary: 'Batch upsert', - description: - 'Create or update postal mails identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.postal_mail.batch > (method) upsert', - qualified: 'client.crm.objects.postalMail.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.postalMail.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/postal_mail/batch/upsert`\n\nCreate or update postal mails identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.postalMail.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.postalMail.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.postalMail.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.postal_mail.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.postal_mail.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().postalMail().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().postalMail().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.PostalMail.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.PostalMail.Batch.Upsert(context.TODO(), crm.ObjectPostalMailBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.postal_mail.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.postal_mail.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->postalMail->batch->upsert', - example: - "crm\n ->objects\n ->postalMail\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/postal_mail/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/products', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.', - stainlessPath: '(resource) crm.objects.products > (method) create', - qualified: 'client.crm.objects.products.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.products.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/products`\n\nCreate a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.products.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.products.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.products.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.products.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().products().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().products().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Products.New(context.TODO(), crm.ObjectProductNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.products.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.products.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->products->create', - example: - "crm->objects->products->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/products/{productId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{productId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.products > (method) delete', - qualified: 'client.crm.objects.products.delete', - params: ['productId: string;'], - markdown: - "## delete\n\n`client.crm.objects.products.delete(productId: string): void`\n\n**delete** `/crm/objects/2026-03/products/{productId}`\n\nMove an Object identified by `{productId}` to the recycling bin.\n\n### Parameters\n\n- `productId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.products.delete('productId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.products.delete('productId');", - }, - python: { - method: 'crm.objects.products.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.products.delete(\n "productId",\n)', - }, - java: { - method: 'crm().objects().products().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.products.ProductDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().products().delete("productId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Products.Delete(context.TODO(), "productId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.products.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.products.delete("productId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->products->delete', - example: - "crm->objects->products->delete('productId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/products/{productId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.products > (method) get', - qualified: 'client.crm.objects.products.get', - params: [ - 'productId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.products.get(productId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/products/{productId}`\n\nRead an Object identified by `{productId}`. `{productId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `productId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.products.get('productId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.products.get('productId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.products.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.products.get(\n product_id="productId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().products().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.products.ProductGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().products().get("productId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Products.Get(\n\t\tcontext.TODO(),\n\t\t"productId",\n\t\tcrm.ObjectProductGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.products.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.products.get("productId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->products->get', - example: - "crm->objects->products->get(\n 'productId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/products', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of products. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.products > (method) list', - qualified: 'client.crm.objects.products.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.products.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/products`\n\nRead a page of products. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.products.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.products.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.products.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.products.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().products().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.products.ProductListPage;\nimport com.hubspot.sdk.models.crm.objects.products.ProductListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProductListPage page = client.crm().objects().products().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Products.List(context.TODO(), crm.ObjectProductListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.products.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.products.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->products->list', - example: - "crm->objects->products->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/products/search', - httpMethod: 'post', - summary: 'Search for products using specified criteria.', - description: - 'Execute a search for products based on defined filters, properties, and sorting options. This endpoint allows for detailed querying of product data within the CRM, enabling users to retrieve specific product information by applying multiple filter groups and sorting criteria.', - stainlessPath: '(resource) crm.objects.products > (method) search', - qualified: 'client.crm.objects.products.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.products.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/products/search`\n\nExecute a search for products based on defined filters, properties, and sorting options. This endpoint allows for detailed querying of product data within the CRM, enabling users to retrieve specific product information by applying multiple filter groups and sorting criteria.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.products.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.products.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.products.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.products.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().products().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().products().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Products.Search(context.TODO(), crm.ObjectProductSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.products.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.products.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->products->search', - example: - "crm\n ->objects\n ->products\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/products/{productId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.products > (method) update', - qualified: 'client.crm.objects.products.update', - params: ['productId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.products.update(productId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/products/{productId}`\n\nPerform a partial update of an Object identified by `{productId}`or optionally a unique property value as specified by the `idProperty` query param. `{productId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `productId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.products.update('productId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.products.update('productId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.products.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.products.update(\n product_id="productId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().products().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.products.ProductUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProductUpdateParams params = ProductUpdateParams.builder()\n .productId("productId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().products().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Products.Update(\n\t\tcontext.TODO(),\n\t\t"productId",\n\t\tcrm.ObjectProductUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.products.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.products.update("productId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->products->update', - example: - "crm->objects->products->update(\n 'productId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/$PRODUCT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/products/batch/create', - httpMethod: 'post', - summary: 'Create a batch of products', - description: - 'Create multiple products in a single request by specifying their properties, and receive a response containing the details of the created products.', - stainlessPath: '(resource) crm.objects.products.batch > (method) create', - qualified: 'client.crm.objects.products.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.products.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/create`\n\nCreate multiple products in a single request by specifying their properties, and receive a response containing the details of the created products.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.products.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().products().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.New(context.TODO(), crm.ObjectProductBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.products.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->products->batch->create', - example: - "crm\n ->objects\n ->products\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/products/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of products by ID', - description: - 'Archive multiple products at once by providing their IDs. This operation moves the specified products to the recycling bin, effectively removing them from active use without permanently deleting them.', - stainlessPath: '(resource) crm.objects.products.batch > (method) delete', - qualified: 'client.crm.objects.products.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.products.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/products/batch/archive`\n\nArchive multiple products at once by providing their IDs. This operation moves the specified products to the recycling bin, effectively removing them from active use without permanently deleting them.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.products.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.products.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.products.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.products.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().products().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().products().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Products.Batch.Delete(context.TODO(), crm.ObjectProductBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.products.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.products.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->products->batch->delete', - example: - "crm->objects->products->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/products/batch/read', - httpMethod: 'post', - summary: 'Read a batch of products by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.products.batch > (method) get', - qualified: 'client.crm.objects.products.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.products.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.products.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().products().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.Get(context.TODO(), crm.ObjectProductBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.products.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->products->batch->get', - example: - "crm->objects->products->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/products/batch/update', - httpMethod: 'post', - summary: 'Update a batch of products by internal ID, or unique property values', - description: - 'Update multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error.', - stainlessPath: '(resource) crm.objects.products.batch > (method) update', - qualified: 'client.crm.objects.products.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.products.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/update`\n\nUpdate multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.products.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.products.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.products.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().products().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().products().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Products.Batch.Update(context.TODO(), crm.ObjectProductBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.products.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.products.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->products->batch->update', - example: - "crm\n ->objects\n ->products\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/products/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of products by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.products.batch > (method) upsert', - qualified: 'client.crm.objects.products.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.products.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/products/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.products.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.products.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.products.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.products.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.products.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().products().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().products().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Products.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Products.Batch.Upsert(context.TODO(), crm.ObjectProductBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.products.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.products.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->products->batch->upsert', - example: - "crm\n ->objects\n ->products\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/products/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/projects', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a project with the given properties and return a copy of the object, including the ID.', - stainlessPath: '(resource) crm.objects.projects > (method) create', - qualified: 'client.crm.objects.projects.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.projects.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/projects`\n\nCreate a project with the given properties and return a copy of the object, including the ID.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.projects.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().projects().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.New(context.TODO(), crm.ObjectProjectNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->projects->create', - example: - "crm->objects->projects->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/projects/{projectId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{projectId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.projects > (method) delete', - qualified: 'client.crm.objects.projects.delete', - params: ['projectId: string;'], - markdown: - "## delete\n\n`client.crm.objects.projects.delete(projectId: string): void`\n\n**delete** `/crm/objects/2026-03/projects/{projectId}`\n\nMove an Object identified by `{projectId}` to the recycling bin.\n\n### Parameters\n\n- `projectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.projects.delete('projectId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.projects.delete('projectId');", - }, - python: { - method: 'crm.objects.projects.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.projects.delete(\n "projectId",\n)', - }, - java: { - method: 'crm().objects().projects().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().projects().delete("projectId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Projects.Delete(context.TODO(), "projectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.projects.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.projects.delete("projectId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->projects->delete', - example: - "crm->objects->projects->delete('projectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/projects/{projectId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.projects > (method) get', - qualified: 'client.crm.objects.projects.get', - params: [ - 'projectId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.projects.get(projectId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/projects/{projectId}`\n\nRead an Object identified by `{projectId}`. `{projectId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `projectId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.projects.get('projectId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.projects.get('projectId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.projects.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.projects.get(\n project_id="projectId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().projects().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().projects().get("projectId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Projects.Get(\n\t\tcontext.TODO(),\n\t\t"projectId",\n\t\tcrm.ObjectProjectGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.projects.get("projectId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->projects->get', - example: - "crm->objects->projects->get(\n 'projectId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/projects', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of projects. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.projects > (method) list', - qualified: 'client.crm.objects.projects.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.projects.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/projects`\n\nRead a page of projects. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.projects.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.projects.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.projects.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.projects.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().projects().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectListPage;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProjectListPage page = client.crm().objects().projects().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Projects.List(context.TODO(), crm.ObjectProjectListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.projects.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->projects->list', - example: - "crm->objects->projects->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/projects/merge', - httpMethod: 'post', - summary: 'Merge two projects', - description: - 'Merge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).', - stainlessPath: '(resource) crm.objects.projects > (method) merge', - qualified: 'client.crm.objects.projects.merge', - params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.projects.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/projects/merge`\n\nMerge two project records. Learn more about [merging records](https://knowledge.hubspot.com/records/merge-records).\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.projects.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().projects().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.Merge(context.TODO(), crm.ObjectProjectMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->projects->merge', - example: - "crm->objects->projects->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/projects/search', - httpMethod: 'post', - summary: 'Search for projects', - description: - 'Search for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.projects > (method) search', - qualified: 'client.crm.objects.projects.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.projects.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/projects/search`\n\nSearch for projects by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.projects.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.projects.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.projects.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.projects.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().projects().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().projects().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Projects.Search(context.TODO(), crm.ObjectProjectSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.projects.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->projects->search', - example: - "crm\n ->objects\n ->projects\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/projects/{projectId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.projects > (method) update', - qualified: 'client.crm.objects.projects.update', - params: ['projectId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.projects.update(projectId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/projects/{projectId}`\n\nPerform a partial update of an Object identified by `{projectId}`or optionally a unique property value as specified by the `idProperty` query param. `{projectId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `projectId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.projects.update('projectId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.projects.update('projectId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.projects.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.projects.update(\n project_id="projectId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().projects().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.projects.ProjectUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ProjectUpdateParams params = ProjectUpdateParams.builder()\n .projectId("projectId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().projects().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Projects.Update(\n\t\tcontext.TODO(),\n\t\t"projectId",\n\t\tcrm.ObjectProjectUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.projects.update("projectId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->projects->update', - example: - "crm->objects->projects->update(\n 'projectId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/$PROJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/projects/batch/create', - httpMethod: 'post', - summary: 'Create a batch of projects', - description: 'Create multiple projects in a single request.', - stainlessPath: '(resource) crm.objects.projects.batch > (method) create', - qualified: 'client.crm.objects.projects.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.projects.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/create`\n\nCreate multiple projects in a single request.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.projects.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().projects().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.New(context.TODO(), crm.ObjectProjectBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->projects->batch->create', - example: - "crm\n ->objects\n ->projects\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/projects/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of projects', - description: 'Archive multiple projects using their IDs.', - stainlessPath: '(resource) crm.objects.projects.batch > (method) delete', - qualified: 'client.crm.objects.projects.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.projects.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/projects/batch/archive`\n\nArchive multiple projects using their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.projects.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.projects.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.projects.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.projects.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().projects().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().projects().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Projects.Batch.Delete(context.TODO(), crm.ObjectProjectBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.projects.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.projects.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->projects->batch->delete', - example: - "crm->objects->projects->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/projects/batch/read', - httpMethod: 'post', - summary: 'Read a batch of projects', - description: - 'Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.', - stainlessPath: '(resource) crm.objects.projects.batch > (method) get', - qualified: 'client.crm.objects.projects.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.projects.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/read`\n\nRetrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.projects.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().projects().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.Get(context.TODO(), crm.ObjectProjectBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->projects->batch->get', - example: - "crm->objects->projects->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/projects/batch/update', - httpMethod: 'post', - summary: 'Update a batch of projects', - description: 'Update multiple projects using their internal IDs or unique property values.', - stainlessPath: '(resource) crm.objects.projects.batch > (method) update', - qualified: 'client.crm.objects.projects.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.projects.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/update`\n\nUpdate multiple projects using their internal IDs or unique property values.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.projects.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.projects.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.projects.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().projects().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().projects().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Projects.Batch.Update(context.TODO(), crm.ObjectProjectBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.projects.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->projects->batch->update', - example: - "crm\n ->objects\n ->projects\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/projects/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of projects', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.projects.batch > (method) upsert', - qualified: 'client.crm.objects.projects.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.projects.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/projects/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.projects.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.projects.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.projects.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.projects.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.projects.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().projects().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().projects().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Projects.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Projects.Batch.Upsert(context.TODO(), crm.ObjectProjectBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.projects.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.projects.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->projects->batch->upsert', - example: - "crm\n ->objects\n ->projects\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/projects/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/quotes', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.', - stainlessPath: '(resource) crm.objects.quotes > (method) create', - qualified: 'client.crm.objects.quotes.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.quotes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/quotes`\n\nCreate a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard quotes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.quotes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.quotes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.quotes.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.quotes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().quotes().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().quotes().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Quotes.New(context.TODO(), crm.ObjectQuoteNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.quotes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->create', - example: - "crm->objects->quotes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/quotes/{quoteId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{quoteId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.quotes > (method) delete', - qualified: 'client.crm.objects.quotes.delete', - params: ['quoteId: string;'], - markdown: - "## delete\n\n`client.crm.objects.quotes.delete(quoteId: string): void`\n\n**delete** `/crm/objects/2026-03/quotes/{quoteId}`\n\nMove an Object identified by `{quoteId}` to the recycling bin.\n\n### Parameters\n\n- `quoteId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.quotes.delete('quoteId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.quotes.delete('quoteId');", - }, - python: { - method: 'crm.objects.quotes.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.quotes.delete(\n "quoteId",\n)', - }, - java: { - method: 'crm().objects().quotes().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().quotes().delete("quoteId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Quotes.Delete(context.TODO(), "quoteId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.quotes.delete("quoteId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->quotes->delete', - example: - "crm->objects->quotes->delete('quoteId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/quotes/{quoteId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.quotes > (method) get', - qualified: 'client.crm.objects.quotes.get', - params: [ - 'quoteId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.quotes.get(quoteId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/quotes/{quoteId}`\n\nRead an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `quoteId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.quotes.get('quoteId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.quotes.get('quoteId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.quotes.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.quotes.get(\n quote_id="quoteId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().quotes().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().quotes().get("quoteId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Quotes.Get(\n\t\tcontext.TODO(),\n\t\t"quoteId",\n\t\tcrm.ObjectQuoteGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.quotes.get("quoteId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->quotes->get', - example: - "crm->objects->quotes->get(\n 'quoteId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/quotes', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of quotes. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.quotes > (method) list', - qualified: 'client.crm.objects.quotes.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.quotes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/quotes`\n\nRead a page of quotes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.quotes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.quotes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.quotes.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.quotes.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().quotes().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteListPage;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n QuoteListPage page = client.crm().objects().quotes().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Quotes.List(context.TODO(), crm.ObjectQuoteListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.quotes.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->quotes->list', - example: - "crm->objects->quotes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/quotes/search', - httpMethod: 'post', - summary: 'Search for quotes using specified criteria.', - description: - 'Execute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets.', - stainlessPath: '(resource) crm.objects.quotes > (method) search', - qualified: 'client.crm.objects.quotes.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.quotes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/quotes/search`\n\nExecute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.quotes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.quotes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.quotes.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.quotes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().quotes().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().quotes().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Quotes.Search(context.TODO(), crm.ObjectQuoteSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.quotes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->search', - example: - "crm\n ->objects\n ->quotes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/quotes/{quoteId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.quotes > (method) update', - qualified: 'client.crm.objects.quotes.update', - params: ['quoteId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.quotes.update(quoteId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/quotes/{quoteId}`\n\nPerform a partial update of an Object identified by `{quoteId}`or optionally a unique property value as specified by the `idProperty` query param. `{quoteId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `quoteId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.quotes.update('quoteId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.quotes.update('quoteId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.quotes.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.quotes.update(\n quote_id="quoteId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().quotes().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.quotes.QuoteUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n QuoteUpdateParams params = QuoteUpdateParams.builder()\n .quoteId("quoteId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().quotes().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Quotes.Update(\n\t\tcontext.TODO(),\n\t\t"quoteId",\n\t\tcrm.ObjectQuoteUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.quotes.update("quoteId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->update', - example: - "crm->objects->quotes->update(\n 'quoteId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/$QUOTE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/quotes/batch/create', - httpMethod: 'post', - summary: 'Create a batch of quotes', - description: - 'Create multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations.', - stainlessPath: '(resource) crm.objects.quotes.batch > (method) create', - qualified: 'client.crm.objects.quotes.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.quotes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/create`\n\nCreate multiple quotes in a single request by providing a batch of quote objects, each with its own properties and optional associations.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.quotes.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().quotes().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.New(context.TODO(), crm.ObjectQuoteBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->batch->create', - example: - "crm->objects->quotes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/quotes/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of quotes by ID', - description: - 'Archive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin.', - stainlessPath: '(resource) crm.objects.quotes.batch > (method) delete', - qualified: 'client.crm.objects.quotes.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.quotes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/quotes/batch/archive`\n\nArchive multiple quotes by their IDs in a single request, effectively moving them to the recycling bin.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.quotes.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.quotes.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.quotes.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.quotes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().quotes().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().quotes().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Quotes.Batch.Delete(context.TODO(), crm.ObjectQuoteBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.quotes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->quotes->batch->delete', - example: - "crm->objects->quotes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/quotes/batch/read', - httpMethod: 'post', - summary: 'Read a batch of quotes by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.quotes.batch > (method) get', - qualified: 'client.crm.objects.quotes.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.quotes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.quotes.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().quotes().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.Get(context.TODO(), crm.ObjectQuoteBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->batch->get', - example: - "crm->objects->quotes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/quotes/batch/update', - httpMethod: 'post', - summary: 'Update a batch of quotes by internal ID, or unique property values', - description: - 'Update multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request.', - stainlessPath: '(resource) crm.objects.quotes.batch > (method) update', - qualified: 'client.crm.objects.quotes.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.quotes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/update`\n\nUpdate multiple quotes using their internal IDs or unique property values. This endpoint allows batch processing of quote updates, ensuring efficient management of multiple records in a single request.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.quotes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.quotes.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.quotes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().quotes().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().quotes().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Quotes.Batch.Update(context.TODO(), crm.ObjectQuoteBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.quotes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->quotes->batch->update', - example: - "crm->objects->quotes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/quotes/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of quotes by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.quotes.batch > (method) upsert', - qualified: 'client.crm.objects.quotes.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.quotes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/quotes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.quotes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.quotes.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.quotes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.quotes.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.quotes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().quotes().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().quotes().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Quotes.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Quotes.Batch.Upsert(context.TODO(), crm.ObjectQuoteBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.quotes.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.quotes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->quotes->batch->upsert', - example: - "crm\n ->objects\n ->quotes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/quotes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-162', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided.', - stainlessPath: '(resource) crm.objects.services > (method) create', - qualified: 'client.crm.objects.services.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.services.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/0-162`\n\nCreate a service with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard services is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.services.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.services.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.services.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.services.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().services().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().services().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Services.New(context.TODO(), crm.ObjectServiceNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.services.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.services.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->services->create', - example: - "crm->objects->services->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-162/{serviceId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{serviceId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.services > (method) delete', - qualified: 'client.crm.objects.services.delete', - params: ['serviceId: string;'], - markdown: - "## delete\n\n`client.crm.objects.services.delete(serviceId: string): void`\n\n**delete** `/crm/objects/2026-03/0-162/{serviceId}`\n\nMove an Object identified by `{serviceId}` to the recycling bin.\n\n### Parameters\n\n- `serviceId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.services.delete('serviceId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.services.delete('serviceId');", - }, - python: { - method: 'crm.objects.services.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.services.delete(\n "serviceId",\n)', - }, - java: { - method: 'crm().objects().services().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().services().delete("serviceId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Services.Delete(context.TODO(), "serviceId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.services.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.services.delete("serviceId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->services->delete', - example: - "crm->objects->services->delete('serviceId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-162/{serviceId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.services > (method) get', - qualified: 'client.crm.objects.services.get', - params: [ - 'serviceId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.services.get(serviceId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-162/{serviceId}`\n\nRead an Object identified by `{serviceId}`. `{serviceId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `serviceId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.services.get('serviceId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.services.get('serviceId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.services.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.services.get(\n service_id="serviceId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().services().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().services().get("serviceId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Services.Get(\n\t\tcontext.TODO(),\n\t\t"serviceId",\n\t\tcrm.ObjectServiceGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.services.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.services.get("serviceId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->services->get', - example: - "crm->objects->services->get(\n 'serviceId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/0-162', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of services. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.services > (method) list', - qualified: 'client.crm.objects.services.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.services.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/0-162`\n\nRead a page of services. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.services.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.services.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.services.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.services.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().services().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceListPage;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ServiceListPage page = client.crm().objects().services().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Services.List(context.TODO(), crm.ObjectServiceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.services.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.services.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->services->list', - example: - "crm->objects->services->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/0-162/search', - httpMethod: 'post', - summary: 'Search across objects', - description: 'Fetch objects via a search query', - stainlessPath: '(resource) crm.objects.services > (method) search', - qualified: 'client.crm.objects.services.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.services.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/0-162/search`\n\nFetch objects via a search query\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.services.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.services.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.services.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.services.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().services().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().services().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Services.Search(context.TODO(), crm.ObjectServiceSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.services.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.services.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->services->search', - example: - "crm\n ->objects\n ->services\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-162/{serviceId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.services > (method) update', - qualified: 'client.crm.objects.services.update', - params: ['serviceId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.services.update(serviceId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/0-162/{serviceId}`\n\nPerform a partial update of an Object identified by `{serviceId}`or optionally a unique property value as specified by the `idProperty` query param. `{serviceId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `serviceId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.services.update('serviceId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.services.update('serviceId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.services.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.services.update(\n service_id="serviceId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().services().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.services.ServiceUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ServiceUpdateParams params = ServiceUpdateParams.builder()\n .serviceId("serviceId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().services().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Services.Update(\n\t\tcontext.TODO(),\n\t\t"serviceId",\n\t\tcrm.ObjectServiceUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.services.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.services.update("serviceId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->services->update', - example: - "crm->objects->services->update(\n 'serviceId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/$SERVICE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/0-162/batch/create', - httpMethod: 'post', - summary: 'Create a batch of services', - description: 'Create a batch of objects', - stainlessPath: '(resource) crm.objects.services.batch > (method) create', - qualified: 'client.crm.objects.services.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.services.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/create`\n\nCreate a batch of objects\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.services.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().services().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.New(context.TODO(), crm.ObjectServiceBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.services.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->services->batch->create', - example: - "crm\n ->objects\n ->services\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/0-162/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of services by ID', - description: 'Archive a batch of objects', - stainlessPath: '(resource) crm.objects.services.batch > (method) delete', - qualified: 'client.crm.objects.services.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.services.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/0-162/batch/archive`\n\nArchive a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.services.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.services.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.services.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.services.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().services().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().services().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Services.Batch.Delete(context.TODO(), crm.ObjectServiceBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.services.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.services.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->services->batch->delete', - example: - "crm->objects->services->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/0-162/batch/read', - httpMethod: 'post', - summary: 'Read a batch of services by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.services.batch > (method) get', - qualified: 'client.crm.objects.services.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.services.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.services.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().services().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.Get(context.TODO(), crm.ObjectServiceBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.services.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->services->batch->get', - example: - "crm->objects->services->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/0-162/batch/update', - httpMethod: 'post', - summary: 'Update a batch of services by internal ID, or unique property values', - description: 'Update a batch of objects', - stainlessPath: '(resource) crm.objects.services.batch > (method) update', - qualified: 'client.crm.objects.services.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.services.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/update`\n\nUpdate a batch of objects\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.services.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.services.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.services.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().services().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().services().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Services.Batch.Update(context.TODO(), crm.ObjectServiceBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.services.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.services.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->services->batch->update', - example: - "crm\n ->objects\n ->services\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/0-162/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of services by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.services.batch > (method) upsert', - qualified: 'client.crm.objects.services.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.services.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/0-162/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.services.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.services.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.services.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.services.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.services.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().services().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().services().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Services.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Services.Batch.Upsert(context.TODO(), crm.ObjectServiceBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.services.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.services.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->services->batch->upsert', - example: - "crm\n ->objects\n ->services\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/0-162/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/subscriptions', - httpMethod: 'post', - summary: 'Create a new subscription object.', - description: 'Create a new subscription object with specified properties and optional associations.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) create', - qualified: 'client.crm.objects.subscriptions.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.subscriptions.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions`\n\nCreate a new subscription object with specified properties and optional associations.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.subscriptions.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.subscriptions.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.subscriptions.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.subscriptions.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().subscriptions().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().subscriptions().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Subscriptions.New(context.TODO(), crm.ObjectSubscriptionNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.subscriptions.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->create', - example: - "crm->objects->subscriptions->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - httpMethod: 'delete', - summary: 'Delete a subscription.', - description: 'Delete a specific subscription by its ID.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) delete', - qualified: 'client.crm.objects.subscriptions.delete', - params: ['subscriptionId: string;'], - markdown: - "## delete\n\n`client.crm.objects.subscriptions.delete(subscriptionId: string): void`\n\n**delete** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nDelete a specific subscription by its ID.\n\n### Parameters\n\n- `subscriptionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.subscriptions.delete('subscriptionId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.subscriptions.delete('subscriptionId');", - }, - python: { - method: 'crm.objects.subscriptions.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.subscriptions.delete(\n "subscriptionId",\n)', - }, - java: { - method: 'crm().objects().subscriptions().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().subscriptions().delete("subscriptionId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Subscriptions.Delete(context.TODO(), "subscriptionId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.subscriptions.delete("subscriptionId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->subscriptions->delete', - example: - "crm->objects->subscriptions->delete('subscriptionId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - httpMethod: 'get', - summary: 'Retrieve a subscription.', - description: 'Retrieve a specific subscription by its ID, including its properties and associations.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) get', - qualified: 'client.crm.objects.subscriptions.get', - params: [ - 'subscriptionId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.subscriptions.get(subscriptionId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nRetrieve a specific subscription by its ID, including its properties and associations.\n\n### Parameters\n\n- `subscriptionId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.subscriptions.get('subscriptionId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.subscriptions.get(\n 'subscriptionId',\n);\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.subscriptions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.subscriptions.get(\n subscription_id="subscriptionId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().subscriptions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().subscriptions().get("subscriptionId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Subscriptions.Get(\n\t\tcontext.TODO(),\n\t\t"subscriptionId",\n\t\tcrm.ObjectSubscriptionGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.subscriptions.get("subscriptionId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->subscriptions->get', - example: - "crm->objects->subscriptions->get(\n 'subscriptionId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/subscriptions', - httpMethod: 'get', - summary: 'Retrieve a list of subscription objects.', - description: - 'Retrieve a list of subscription objects, with options to filter by properties, associations, and archived status.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) list', - qualified: 'client.crm.objects.subscriptions.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.subscriptions.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/subscriptions`\n\nRetrieve a list of subscription objects, with options to filter by properties, associations, and archived status.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.subscriptions.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.subscriptions.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.subscriptions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.subscriptions.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().subscriptions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionListPage;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionListPage page = client.crm().objects().subscriptions().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Subscriptions.List(context.TODO(), crm.ObjectSubscriptionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.subscriptions.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->subscriptions->list', - example: - "crm->objects->subscriptions->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/subscriptions/search', - httpMethod: 'post', - summary: 'Search for CRM commerce subscriptions using specified criteria.', - description: - 'Execute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) search', - qualified: 'client.crm.objects.subscriptions.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.subscriptions.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/subscriptions/search`\n\nExecute a search for CRM commerce subscriptions based on defined filters, properties, and sorting options. This endpoint allows for complex queries to retrieve specific subscription data, supporting pagination and a variety of search parameters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.subscriptions.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.subscriptions.search(\n {\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n },\n);\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.subscriptions.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.subscriptions.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().subscriptions().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().subscriptions().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Subscriptions.Search(context.TODO(), crm.ObjectSubscriptionSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.subscriptions.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->search', - example: - "crm\n ->objects\n ->subscriptions\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - httpMethod: 'patch', - summary: 'Update a subscription.', - description: 'Update a specific subscription by its ID with new property values.', - stainlessPath: '(resource) crm.objects.subscriptions > (method) update', - qualified: 'client.crm.objects.subscriptions.update', - params: ['subscriptionId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.subscriptions.update(subscriptionId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/subscriptions/{subscriptionId}`\n\nUpdate a specific subscription by its ID with new property values.\n\n### Parameters\n\n- `subscriptionId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.subscriptions.update('subscriptionId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.subscriptions.update('subscriptionId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.subscriptions.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.subscriptions.update(\n subscription_id="subscriptionId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().subscriptions().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.subscriptions.SubscriptionUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionUpdateParams params = SubscriptionUpdateParams.builder()\n .subscriptionId("subscriptionId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().subscriptions().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Subscriptions.Update(\n\t\tcontext.TODO(),\n\t\t"subscriptionId",\n\t\tcrm.ObjectSubscriptionUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.subscriptions.update("subscriptionId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->update', - example: - "crm->objects->subscriptions->update(\n 'subscriptionId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/$SUBSCRIPTION_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/subscriptions/batch/create', - httpMethod: 'post', - summary: 'Batch create subscription objects.', - description: - 'Create multiple subscription objects in a single batch operation, allowing for efficient data entry and management.', - stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) create', - qualified: 'client.crm.objects.subscriptions.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.subscriptions.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/create`\n\nCreate multiple subscription objects in a single batch operation, allowing for efficient data entry and management.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.subscriptions.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().subscriptions().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.New(context.TODO(), crm.ObjectSubscriptionBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->batch->create', - example: - "crm\n ->objects\n ->subscriptions\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/subscriptions/batch/archive', - httpMethod: 'post', - summary: 'Archive multiple subscription objects in a single request.', - description: 'Archive a batch of subscription objects by providing their IDs in the request body.', - stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) delete', - qualified: 'client.crm.objects.subscriptions.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.subscriptions.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/archive`\n\nArchive a batch of subscription objects by providing their IDs in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.subscriptions.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.subscriptions.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.subscriptions.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.subscriptions.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().subscriptions().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().subscriptions().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Subscriptions.Batch.Delete(context.TODO(), crm.ObjectSubscriptionBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.subscriptions.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->subscriptions->batch->delete', - example: - "crm->objects->subscriptions->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/subscriptions/batch/read', - httpMethod: 'post', - summary: 'Retrieve a batch of subscription objects by IDs.', - description: - 'Retrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories.', - stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) get', - qualified: 'client.crm.objects.subscriptions.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.subscriptions.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/read`\n\nRetrieve a batch of CRM subscription objects by their IDs, including specified properties and their histories.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.subscriptions.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().subscriptions().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.Get(context.TODO(), crm.ObjectSubscriptionBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->batch->get', - example: - "crm\n ->objects\n ->subscriptions\n ->batch\n ->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/subscriptions/batch/update', - httpMethod: 'post', - summary: 'Update multiple subscriptions in a batch.', - description: - 'Update multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records.', - stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) update', - qualified: 'client.crm.objects.subscriptions.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.subscriptions.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/update`\n\nUpdate multiple subscription objects in a single batch operation, allowing for efficient modifications of CRM subscription records.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.subscriptions.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.subscriptions.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.subscriptions.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().subscriptions().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().subscriptions().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Subscriptions.Batch.Update(context.TODO(), crm.ObjectSubscriptionBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.subscriptions.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->subscriptions->batch->update', - example: - "crm\n ->objects\n ->subscriptions\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/subscriptions/batch/upsert', - httpMethod: 'post', - summary: 'Perform a batch upsert operation on subscription objects.', - description: - 'This endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects.', - stainlessPath: '(resource) crm.objects.subscriptions.batch > (method) upsert', - qualified: 'client.crm.objects.subscriptions.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.subscriptions.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/subscriptions/batch/upsert`\n\nThis endpoint allows you to perform a batch upsert operation on subscription objects, which will either update existing records or create new ones if they do not already exist. The operation returns the status, timestamps, and a list of successfully processed objects.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.subscriptions.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.subscriptions.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.subscriptions.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.subscriptions.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.subscriptions.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().subscriptions().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().subscriptions().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Subscriptions.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Subscriptions.Batch.Upsert(context.TODO(), crm.ObjectSubscriptionBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.subscriptions.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.subscriptions.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->subscriptions->batch->upsert', - example: - "crm\n ->objects\n ->subscriptions\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/subscriptions/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/tasks', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.', - stainlessPath: '(resource) crm.objects.tasks > (method) create', - qualified: 'client.crm.objects.tasks.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.tasks.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tasks`\n\nCreate a task with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tasks is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tasks.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tasks.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.tasks.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tasks.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().tasks().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tasks().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tasks.New(context.TODO(), crm.ObjectTaskNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tasks.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->create', - example: - "crm->objects->tasks->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/tasks/{taskId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{taskId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.tasks > (method) delete', - qualified: 'client.crm.objects.tasks.delete', - params: ['taskId: string;'], - markdown: - "## delete\n\n`client.crm.objects.tasks.delete(taskId: string): void`\n\n**delete** `/crm/objects/2026-03/tasks/{taskId}`\n\nMove an Object identified by `{taskId}` to the recycling bin.\n\n### Parameters\n\n- `taskId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tasks.delete('taskId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tasks.delete('taskId');", - }, - python: { - method: 'crm.objects.tasks.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tasks.delete(\n "taskId",\n)', - }, - java: { - method: 'crm().objects().tasks().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().tasks().delete("taskId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tasks.Delete(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tasks.delete("taskId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->tasks->delete', - example: - "crm->objects->tasks->delete('taskId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/tasks/{taskId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.tasks > (method) get', - qualified: 'client.crm.objects.tasks.get', - params: [ - 'taskId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.tasks.get(taskId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tasks/{taskId}`\n\nRead an Object identified by `{taskId}`. `{taskId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `taskId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tasks.get('taskId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tasks.get('taskId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.tasks.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.tasks.get(\n task_id="taskId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().tasks().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().tasks().get("taskId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Tasks.Get(\n\t\tcontext.TODO(),\n\t\t"taskId",\n\t\tcrm.ObjectTaskGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.tasks.get("taskId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->tasks->get', - example: - "crm->objects->tasks->get(\n 'taskId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/tasks', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of tasks. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.tasks > (method) list', - qualified: 'client.crm.objects.tasks.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.tasks.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tasks`\n\nRead a page of tasks. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tasks.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tasks.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.tasks.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.tasks.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().tasks().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskListPage;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaskListPage page = client.crm().objects().tasks().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Tasks.List(context.TODO(), crm.ObjectTaskListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.tasks.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->tasks->list', - example: - "crm->objects->tasks->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/tasks/search', - httpMethod: 'post', - summary: 'Search for tasks using specified criteria.', - description: - 'Execute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.', - stainlessPath: '(resource) crm.objects.tasks > (method) search', - qualified: 'client.crm.objects.tasks.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.tasks.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/tasks/search`\n\nExecute a search for tasks based on the provided criteria, including filters, properties, and sorting options. This allows for retrieving tasks that match specific conditions or property values.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tasks.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tasks.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.tasks.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.tasks.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().tasks().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().tasks().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Tasks.Search(context.TODO(), crm.ObjectTaskSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.tasks.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->search', - example: - "crm\n ->objects\n ->tasks\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/tasks/{taskId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.tasks > (method) update', - qualified: 'client.crm.objects.tasks.update', - params: ['taskId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.tasks.update(taskId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/tasks/{taskId}`\n\nPerform a partial update of an Object identified by `{taskId}`or optionally a unique property value as specified by the `idProperty` query param. `{taskId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `taskId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tasks.update('taskId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tasks.update('taskId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.tasks.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tasks.update(\n task_id="taskId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().tasks().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.tasks.TaskUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaskUpdateParams params = TaskUpdateParams.builder()\n .taskId("taskId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tasks().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tasks.Update(\n\t\tcontext.TODO(),\n\t\t"taskId",\n\t\tcrm.ObjectTaskUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tasks.update("taskId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->update', - example: - "crm->objects->tasks->update(\n 'taskId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/$TASK_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/tasks/batch/create', - httpMethod: 'post', - summary: 'Create a batch of tasks', - description: - 'Create multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.', - stainlessPath: '(resource) crm.objects.tasks.batch > (method) create', - qualified: 'client.crm.objects.tasks.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.tasks.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/create`\n\nCreate multiple tasks in a single request by providing a batch of task properties and associations. This endpoint allows for efficient task creation by processing multiple tasks together.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tasks.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tasks().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.New(context.TODO(), crm.ObjectTaskBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->batch->create', - example: - "crm->objects->tasks->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/tasks/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of tasks by ID', - description: - 'Archive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.', - stainlessPath: '(resource) crm.objects.tasks.batch > (method) delete', - qualified: 'client.crm.objects.tasks.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.tasks.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/tasks/batch/archive`\n\nArchive a batch of tasks by their IDs, moving them to the recycling bin. This operation requires a list of task IDs to be provided in the request body.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tasks.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tasks.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.tasks.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tasks.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().tasks().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().tasks().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tasks.Batch.Delete(context.TODO(), crm.ObjectTaskBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tasks.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->tasks->batch->delete', - example: - "crm->objects->tasks->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/tasks/batch/read', - httpMethod: 'post', - summary: 'Read a batch of tasks by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.tasks.batch > (method) get', - qualified: 'client.crm.objects.tasks.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.tasks.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tasks.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tasks().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.Get(context.TODO(), crm.ObjectTaskBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->batch->get', - example: - "crm->objects->tasks->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/tasks/batch/update', - httpMethod: 'post', - summary: 'Update a batch of tasks by internal ID, or unique property values', - description: - 'Update multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.', - stainlessPath: '(resource) crm.objects.tasks.batch > (method) update', - qualified: 'client.crm.objects.tasks.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.tasks.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/update`\n\nUpdate multiple tasks in a single request using their internal IDs or unique property values. This operation allows you to modify the properties of each task in the batch, ensuring efficient management of task data.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tasks.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tasks.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tasks.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tasks().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tasks().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tasks.Batch.Update(context.TODO(), crm.ObjectTaskBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tasks.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tasks->batch->update', - example: - "crm->objects->tasks->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/tasks/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of tasks by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.tasks.batch > (method) upsert', - qualified: 'client.crm.objects.tasks.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.tasks.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tasks/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tasks.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tasks.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tasks.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.tasks.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.tasks.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().tasks().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().tasks().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tasks.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Tasks.Batch.Upsert(context.TODO(), crm.ObjectTaskBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tasks.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.tasks.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->tasks->batch->upsert', - example: - "crm\n ->objects\n ->tasks\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tasks/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/taxes', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.', - stainlessPath: '(resource) crm.objects.taxes > (method) create', - qualified: 'client.crm.objects.taxes.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.taxes.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/taxes`\n\nCreate a tax with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard taxes is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.taxes.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.taxes.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.taxes.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.taxes.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().taxes().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().taxes().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Taxes.New(context.TODO(), crm.ObjectTaxNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.taxes.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->create', - example: - "crm->objects->taxes->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/taxes/{taxId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{taxId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.taxes > (method) delete', - qualified: 'client.crm.objects.taxes.delete', - params: ['taxId: string;'], - markdown: - "## delete\n\n`client.crm.objects.taxes.delete(taxId: string): void`\n\n**delete** `/crm/objects/2026-03/taxes/{taxId}`\n\nMove an Object identified by `{taxId}` to the recycling bin.\n\n### Parameters\n\n- `taxId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.taxes.delete('taxId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.taxes.delete('taxId');", - }, - python: { - method: 'crm.objects.taxes.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.taxes.delete(\n "taxId",\n)', - }, - java: { - method: 'crm().objects().taxes().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().taxes().delete("taxId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Taxes.Delete(context.TODO(), "taxId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.taxes.delete("taxId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->taxes->delete', - example: - "crm->objects->taxes->delete('taxId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/taxes/{taxId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.taxes > (method) get', - qualified: 'client.crm.objects.taxes.get', - params: [ - 'taxId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.taxes.get(taxId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/taxes/{taxId}`\n\nRead an Object identified by `{taxId}`. `{taxId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `taxId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.taxes.get('taxId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.taxes.get('taxId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.taxes.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.taxes.get(\n tax_id="taxId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().taxes().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().taxes().get("taxId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Taxes.Get(\n\t\tcontext.TODO(),\n\t\t"taxId",\n\t\tcrm.ObjectTaxGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.taxes.get("taxId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->taxes->get', - example: - "crm->objects->taxes->get(\n 'taxId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/taxes', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of taxes. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.taxes > (method) list', - qualified: 'client.crm.objects.taxes.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.taxes.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/taxes`\n\nRead a page of taxes. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.taxes.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.taxes.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.taxes.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.taxes.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().taxes().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxListPage;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxListPage page = client.crm().objects().taxes().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Taxes.List(context.TODO(), crm.ObjectTaxListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.taxes.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->taxes->list', - example: - "crm->objects->taxes->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/taxes/search', - httpMethod: 'post', - summary: 'Search for taxes using specified criteria.', - description: - 'Execute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters.', - stainlessPath: '(resource) crm.objects.taxes > (method) search', - qualified: 'client.crm.objects.taxes.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.taxes.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/taxes/search`\n\nExecute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.taxes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.taxes.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.taxes.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.taxes.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().taxes().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().taxes().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Taxes.Search(context.TODO(), crm.ObjectTaxSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.taxes.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->search', - example: - "crm\n ->objects\n ->taxes\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/taxes/{taxId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.taxes > (method) update', - qualified: 'client.crm.objects.taxes.update', - params: ['taxId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.taxes.update(taxId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/taxes/{taxId}`\n\nPerform a partial update of an Object identified by `{taxId}`or optionally a unique property value as specified by the `idProperty` query param. `{taxId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `taxId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.taxes.update('taxId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.taxes.update('taxId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.taxes.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.taxes.update(\n tax_id="taxId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().taxes().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.taxes.TaxUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxUpdateParams params = TaxUpdateParams.builder()\n .taxId("taxId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().taxes().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Taxes.Update(\n\t\tcontext.TODO(),\n\t\t"taxId",\n\t\tcrm.ObjectTaxUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.taxes.update("taxId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->update', - example: - "crm->objects->taxes->update(\n 'taxId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/$TAX_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/taxes/batch/create', - httpMethod: 'post', - summary: 'Create a batch of taxes', - description: - 'Create multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects.', - stainlessPath: '(resource) crm.objects.taxes.batch > (method) create', - qualified: 'client.crm.objects.taxes.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.taxes.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/create`\n\nCreate multiple tax records in a single request, each with specified properties and optional associations, and receive a response with details of the created objects.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.taxes.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().taxes().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.New(context.TODO(), crm.ObjectTaxBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->batch->create', - example: - "crm->objects->taxes->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/taxes/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of taxes by ID', - description: 'Archive multiple taxes by their IDs in a single request.', - stainlessPath: '(resource) crm.objects.taxes.batch > (method) delete', - qualified: 'client.crm.objects.taxes.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.taxes.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/taxes/batch/archive`\n\nArchive multiple taxes by their IDs in a single request.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.taxes.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.taxes.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.taxes.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.taxes.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().taxes().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().taxes().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Taxes.Batch.Delete(context.TODO(), crm.ObjectTaxBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.taxes.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->taxes->batch->delete', - example: - "crm->objects->taxes->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/taxes/batch/read', - httpMethod: 'post', - summary: 'Read a batch of taxes by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.taxes.batch > (method) get', - qualified: 'client.crm.objects.taxes.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.taxes.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.taxes.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().taxes().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.Get(context.TODO(), crm.ObjectTaxBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->batch->get', - example: - "crm->objects->taxes->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/taxes/batch/update', - httpMethod: 'post', - summary: 'Update a batch of taxes by internal ID, or unique property values', - description: - 'Update multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk.', - stainlessPath: '(resource) crm.objects.taxes.batch > (method) update', - qualified: 'client.crm.objects.taxes.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.taxes.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/update`\n\nUpdate multiple tax records using their internal IDs or unique property values. This operation allows for batch processing of updates to tax objects, ensuring efficient management of tax data in bulk.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.taxes.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.taxes.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.taxes.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().taxes().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().taxes().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Taxes.Batch.Update(context.TODO(), crm.ObjectTaxBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.taxes.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->taxes->batch->update', - example: - "crm->objects->taxes->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/taxes/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of taxes by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.taxes.batch > (method) upsert', - qualified: 'client.crm.objects.taxes.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.taxes.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/taxes/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.taxes.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.taxes.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.taxes.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.taxes.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.taxes.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().taxes().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().taxes().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Taxes.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Taxes.Batch.Upsert(context.TODO(), crm.ObjectTaxBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.taxes.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.taxes.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->taxes->batch->upsert', - example: - "crm\n ->objects\n ->taxes\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/taxes/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/tickets', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.', - stainlessPath: '(resource) crm.objects.tickets > (method) create', - qualified: 'client.crm.objects.tickets.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.tickets.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tickets`\n\nCreate a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.tickets.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().tickets().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.New(context.TODO(), crm.ObjectTicketNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->create', - example: - "crm->objects->tickets->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/tickets/{ticketId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{ticketId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.tickets > (method) delete', - qualified: 'client.crm.objects.tickets.delete', - params: ['ticketId: string;'], - markdown: - "## delete\n\n`client.crm.objects.tickets.delete(ticketId: string): void`\n\n**delete** `/crm/objects/2026-03/tickets/{ticketId}`\n\nMove an Object identified by `{ticketId}` to the recycling bin.\n\n### Parameters\n\n- `ticketId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tickets.delete('ticketId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tickets.delete('ticketId');", - }, - python: { - method: 'crm.objects.tickets.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tickets.delete(\n "ticketId",\n)', - }, - java: { - method: 'crm().objects().tickets().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().tickets().delete("ticketId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tickets.Delete(context.TODO(), "ticketId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tickets.delete("ticketId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->tickets->delete', - example: - "crm->objects->tickets->delete('ticketId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/tickets/{ticketId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.tickets > (method) get', - qualified: 'client.crm.objects.tickets.get', - params: [ - 'ticketId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.tickets.get(ticketId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tickets/{ticketId}`\n\nRead an Object identified by `{ticketId}`. `{ticketId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `ticketId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tickets.get('ticketId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.tickets.get('ticketId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.tickets.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.tickets.get(\n ticket_id="ticketId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().tickets().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().tickets().get("ticketId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Tickets.Get(\n\t\tcontext.TODO(),\n\t\t"ticketId",\n\t\tcrm.ObjectTicketGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.tickets.get("ticketId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->tickets->get', - example: - "crm->objects->tickets->get(\n 'ticketId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/tickets', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of tickets. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.tickets > (method) list', - qualified: 'client.crm.objects.tickets.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.tickets.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/tickets`\n\nRead a page of tickets. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tickets.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.tickets.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.tickets.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.tickets.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().tickets().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketListPage;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TicketListPage page = client.crm().objects().tickets().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Tickets.List(context.TODO(), crm.ObjectTicketListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.tickets.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->tickets->list', - example: - "crm->objects->tickets->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'merge', - endpoint: '/crm/objects/2026-03/tickets/merge', - httpMethod: 'post', - summary: 'Merge two tickets', - description: 'Merge two tickets, combining them into one ticket record.', - stainlessPath: '(resource) crm.objects.tickets > (method) merge', - qualified: 'client.crm.objects.tickets.merge', - params: ['objectIdToMerge: string;', 'primaryObjectId: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## merge\n\n`client.crm.objects.tickets.merge(objectIdToMerge: string, primaryObjectId: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/merge`\n\nMerge two tickets, combining them into one ticket record.\n\n### Parameters\n\n- `objectIdToMerge: string`\n The ID of the company to merge into the primary.\n\n- `primaryObjectId: string`\n The ID of the primary company, which the other will merge into.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.merge({ objectIdToMerge: 'objectIdToMerge', primaryObjectId: 'primaryObjectId' });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.merge', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.merge({\n objectIdToMerge: 'objectIdToMerge',\n primaryObjectId: 'primaryObjectId',\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.tickets.merge', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.merge(\n object_id_to_merge="objectIdToMerge",\n primary_object_id="primaryObjectId",\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().tickets().merge', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicMergeInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicMergeInput params = PublicMergeInput.builder()\n .objectIdToMerge("objectIdToMerge")\n .primaryObjectId("primaryObjectId")\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().merge(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Merge', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.Merge(context.TODO(), crm.ObjectTicketMergeParams{\n\t\tPublicMergeInput: crm.PublicMergeInputParam{\n\t\t\tObjectIDToMerge: "objectIdToMerge",\n\t\t\tPrimaryObjectID: "primaryObjectId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.merge', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.merge(\n object_id_to_merge: "objectIdToMerge",\n primary_object_id: "primaryObjectId"\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->merge', - example: - "crm->objects->tickets->merge(\n objectIDToMerge: 'objectIdToMerge', primaryObjectID: 'primaryObjectId'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/merge \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "objectIdToMerge": "objectIdToMerge",\n "primaryObjectId": "primaryObjectId"\n }\'', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/tickets/search', - httpMethod: 'post', - summary: 'Search for tickets', - description: - 'Search for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).', - stainlessPath: '(resource) crm.objects.tickets > (method) search', - qualified: 'client.crm.objects.tickets.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.tickets.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/tickets/search`\n\nSearch for tickets by filtering on properties, searching through associations, and sorting results. Learn more about [CRM search](https://developers.hubspot.com/docs/guides/api/crm/search#make-a-search-request).\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tickets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.tickets.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.tickets.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.tickets.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().tickets().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().tickets().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Tickets.Search(context.TODO(), crm.ObjectTicketSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.tickets.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->search', - example: - "crm\n ->objects\n ->tickets\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/tickets/{ticketId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.tickets > (method) update', - qualified: 'client.crm.objects.tickets.update', - params: ['ticketId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.tickets.update(ticketId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/tickets/{ticketId}`\n\nPerform a partial update of an Object identified by `{ticketId}`or optionally a unique property value as specified by the `idProperty` query param. `{ticketId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `ticketId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.tickets.update('ticketId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.tickets.update('ticketId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.tickets.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.tickets.update(\n ticket_id="ticketId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().tickets().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.tickets.TicketUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TicketUpdateParams params = TicketUpdateParams.builder()\n .ticketId("ticketId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().tickets().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Tickets.Update(\n\t\tcontext.TODO(),\n\t\t"ticketId",\n\t\tcrm.ObjectTicketUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.tickets.update("ticketId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->update', - example: - "crm->objects->tickets->update(\n 'ticketId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/$TICKET_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/tickets/batch/create', - httpMethod: 'post', - summary: 'Create a batch of tickets', - description: - 'Create a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.', - stainlessPath: '(resource) crm.objects.tickets.batch > (method) create', - qualified: 'client.crm.objects.tickets.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.tickets.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/create`\n\nCreate a batch of tickets. The `inputs` array can contain a `properties` object to define property values for the ticket, along with an `associations` array to define [associations](https://developers.hubspot.com/docs/guides/api/crm/associations/associations-v4) with other CRM records.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tickets.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tickets().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.New(context.TODO(), crm.ObjectTicketBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->batch->create', - example: - "crm\n ->objects\n ->tickets\n ->batch\n ->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/tickets/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of tickets by ID', - description: - 'Delete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).', - stainlessPath: '(resource) crm.objects.tickets.batch > (method) delete', - qualified: 'client.crm.objects.tickets.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.tickets.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/tickets/batch/archive`\n\nDelete a batch of tickets by ID. Deleted tickets can be restored within 90 days of deletion. Learn more about [restoring records](https://knowledge.hubspot.com/records/restore-deleted-records).\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.tickets.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.tickets.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.tickets.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.tickets.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().tickets().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().tickets().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Tickets.Batch.Delete(context.TODO(), crm.ObjectTicketBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.tickets.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->tickets->batch->delete', - example: - "crm->objects->tickets->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/tickets/batch/read', - httpMethod: 'post', - summary: 'Read a batch of tickets by internal ID, or unique property values', - description: 'Retrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). ', - stainlessPath: '(resource) crm.objects.tickets.batch > (method) get', - qualified: 'client.crm.objects.tickets.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.tickets.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/read`\n\nRetrieve a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tickets.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tickets().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.Get(context.TODO(), crm.ObjectTicketBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->batch->get', - example: - "crm->objects->tickets->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/tickets/batch/update', - httpMethod: 'post', - summary: 'Update a batch of tickets by internal ID, or unique property values', - description: - 'Update a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.tickets.batch > (method) update', - qualified: 'client.crm.objects.tickets.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.tickets.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/update`\n\nUpdate a batch of tickets by ID (`ticketId`) or unique property value (`idProperty`). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.tickets.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.tickets.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.tickets.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().tickets().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().tickets().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Tickets.Batch.Update(context.TODO(), crm.ObjectTicketBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.tickets.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->tickets->batch->update', - example: - "crm\n ->objects\n ->tickets\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/tickets/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of tickets by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.tickets.batch > (method) upsert', - qualified: 'client.crm.objects.tickets.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.tickets.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/tickets/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tickets.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.tickets.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.tickets.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.tickets.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.tickets.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().tickets().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().tickets().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Tickets.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Tickets.Batch.Upsert(context.TODO(), crm.ObjectTicketBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.tickets.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.tickets.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->tickets->batch->upsert', - example: - "crm\n ->objects\n ->tickets\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/tickets/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/users', - httpMethod: 'post', - summary: 'Create', - description: - 'Create a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.', - stainlessPath: '(resource) crm.objects.users > (method) create', - qualified: 'client.crm.objects.users.create', - params: [ - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - 'properties: object;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## create\n\n`client.crm.objects.users.create(associations: { to: public_object_id; types: association_spec[]; }[], properties: object): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**post** `/crm/objects/2026-03/users`\n\nCreate a user with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard users is provided.\n\n### Parameters\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `properties: object`\n Key-value pairs for setting properties for the new object.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.users.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.users.create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.users.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.users.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().users().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().users().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Users.New(context.TODO(), crm.ObjectUserNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.users.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.users.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n)\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->users->create', - example: - "crm->objects->users->create(\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n properties: ['foo' => 'string'],\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/users/{userId}', - httpMethod: 'delete', - summary: 'Archive', - description: 'Move an Object identified by `{userId}` to the recycling bin.', - stainlessPath: '(resource) crm.objects.users > (method) delete', - qualified: 'client.crm.objects.users.delete', - params: ['userId: string;'], - markdown: - "## delete\n\n`client.crm.objects.users.delete(userId: string): void`\n\n**delete** `/crm/objects/2026-03/users/{userId}`\n\nMove an Object identified by `{userId}` to the recycling bin.\n\n### Parameters\n\n- `userId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.users.delete('userId')\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.users.delete('userId');", - }, - python: { - method: 'crm.objects.users.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.users.delete(\n "userId",\n)', - }, - java: { - method: 'crm().objects().users().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.users.UserDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.crm().objects().users().delete("userId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Users.Delete(context.TODO(), "userId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.users.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.users.delete("userId")\n\nputs(result)', - }, - php: { - method: 'crm->objects->users->delete', - example: - "crm->objects->users->delete('userId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/users/{userId}', - httpMethod: 'get', - summary: 'Read', - description: - 'Read an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.users > (method) get', - qualified: 'client.crm.objects.users.get', - params: [ - 'userId: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'idProperty?: string;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## get\n\n`client.crm.objects.users.get(userId: string, archived?: boolean, associations?: string[], idProperty?: string, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/users/{userId}`\n\nRead an Object identified by `{userId}`. `{userId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.users.get('userId');\n\nconsole.log(simplePublicObjectWithAssociations);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObjectWithAssociations = await client.crm.objects.users.get('userId');\n\nconsole.log(simplePublicObjectWithAssociations.id);", - }, - python: { - method: 'crm.objects.users.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object_with_associations = client.crm.objects.users.get(\n user_id="userId",\n)\nprint(simple_public_object_with_associations.id)', - }, - java: { - method: 'crm().objects().users().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.users.UserGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SimplePublicObjectWithAssociations simplePublicObjectWithAssociations = client.crm().objects().users().get("userId");\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObjectWithAssociations, err := client.Crm.Objects.Users.Get(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tcrm.ObjectUserGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.users.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.users.get("userId")\n\nputs(simple_public_object_with_associations)', - }, - php: { - method: 'crm->objects->users->get', - example: - "crm->objects->users->get(\n 'userId',\n archived: true,\n associations: ['string'],\n idProperty: 'idProperty',\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($simplePublicObjectWithAssociations);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/objects/2026-03/users', - httpMethod: 'get', - summary: 'List', - description: 'Read a page of users. Control what is returned via the `properties` query param.', - stainlessPath: '(resource) crm.objects.users > (method) list', - qualified: 'client.crm.objects.users.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'associations?: string[];', - 'limit?: number;', - 'properties?: string[];', - 'propertiesWithHistory?: string[];', - ], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## list\n\n`client.crm.objects.users.list(after?: string, archived?: boolean, associations?: string[], limit?: number, properties?: string[], propertiesWithHistory?: string[]): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**get** `/crm/objects/2026-03/users`\n\nRead a page of users. Control what is returned via the `properties` query param.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `associations?: string[]`\n A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `properties?: string[]`\n A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.\n\n- `propertiesWithHistory?: string[]`\n A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; associations?: object; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `associations?: object`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.users.list()) {\n console.log(simplePublicObjectWithAssociations);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const simplePublicObjectWithAssociations of client.crm.objects.users.list()) {\n console.log(simplePublicObjectWithAssociations.id);\n}", - }, - python: { - method: 'crm.objects.users.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.objects.users.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().objects().users().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.users.UserListPage;\nimport com.hubspot.sdk.models.crm.objects.users.UserListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserListPage page = client.crm().objects().users().list();\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Objects.Users.List(context.TODO(), crm.ObjectUserListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.objects.users.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.objects.users.list\n\nputs(page)', - }, - php: { - method: 'crm->objects->users->list', - example: - "crm->objects->users->list(\n after: 'after',\n archived: true,\n associations: ['string'],\n limit: 0,\n properties: ['string'],\n propertiesWithHistory: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/crm/objects/2026-03/users/search', - httpMethod: 'post', - summary: 'Search for users based on specified criteria.', - description: - 'Execute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request.', - stainlessPath: '(resource) crm.objects.users > (method) search', - qualified: 'client.crm.objects.users.search', - params: [ - 'after: string;', - 'filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[];', - 'limit: number;', - 'properties: string[];', - 'sorts: string[];', - 'query?: string;', - ], - response: - '{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search\n\n`client.crm.objects.users.search(after: string, filterGroups: { filters: filter[]; }[], limit: number, properties: string[], sorts: string[], query?: string): { results: simple_public_object[]; total: number; paging?: paging; }`\n\n**post** `/crm/objects/2026-03/users/search`\n\nExecute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request.\n\n### Parameters\n\n- `after: string`\n A paging cursor token for retrieving subsequent pages.\n\n- `filterGroups: { filters: { operator: string; propertyName: string; highValue?: string; value?: string; values?: string[]; }[]; }[]`\n Up to 6 groups of filters defining additional query criteria.\n\n- `limit: number`\n The maximum results to return, up to 200 objects.\n\n- `properties: string[]`\n A list of property names to include in the response.\n\n- `sorts: string[]`\n Specifies sorting order based on object properties.\n\n- `query?: string`\n The search query string, up to 3000 characters.\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n Represents a list of simple objects returned from an API request, along with the total count of objects available.\n\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.users.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalSimplePublicObject = await client.crm.objects.users.search({\n after: 'after',\n filterGroups: [{ filters: [{ operator: 'BETWEEN', propertyName: 'propertyName' }] }],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n});\n\nconsole.log(collectionResponseWithTotalSimplePublicObject.results);", - }, - python: { - method: 'crm.objects.users.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_simple_public_object = client.crm.objects.users.search(\n after="after",\n filter_groups=[{\n "filters": [{\n "operator": "BETWEEN",\n "property_name": "propertyName",\n }]\n }],\n limit=0,\n properties=["string"],\n sorts=["string"],\n)\nprint(collection_response_with_total_simple_public_object.results)', - }, - java: { - method: 'crm().objects().users().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.CollectionResponseWithTotalSimplePublicObject;\nimport com.hubspot.sdk.models.crm.Filter;\nimport com.hubspot.sdk.models.crm.FilterGroup;\nimport com.hubspot.sdk.models.crm.PublicObjectSearchRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicObjectSearchRequest params = PublicObjectSearchRequest.builder()\n .after("after")\n .addFilterGroup(FilterGroup.builder()\n .addFilter(Filter.builder()\n .operator(Filter.Operator.BETWEEN)\n .propertyName("propertyName")\n .build())\n .build())\n .limit(0)\n .addProperty("string")\n .addSort("string")\n .build();\n CollectionResponseWithTotalSimplePublicObject collectionResponseWithTotalSimplePublicObject = client.crm().objects().users().search(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalSimplePublicObject, err := client.Crm.Objects.Users.Search(context.TODO(), crm.ObjectUserSearchParams{\n\t\tPublicObjectSearchRequest: crm.PublicObjectSearchRequestParam{\n\t\t\tAfter: "after",\n\t\t\tFilterGroups: []crm.FilterGroupParam{{\n\t\t\t\tFilters: []crm.FilterParam{{\n\t\t\t\t\tOperator: crm.FilterOperatorBetween,\n\t\t\t\t\tPropertyName: "propertyName",\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tLimit: 0,\n\t\t\tProperties: []string{"string"},\n\t\t\tSorts: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalSimplePublicObject.Results)\n}\n', - }, - ruby: { - method: 'crm.objects.users.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_simple_public_object = hubspot.crm.objects.users.search(\n after: "after",\n filter_groups: [{filters: [{operator: :BETWEEN, propertyName: "propertyName"}]}],\n limit: 0,\n properties: ["string"],\n sorts: ["string"]\n)\n\nputs(collection_response_with_total_simple_public_object)', - }, - php: { - method: 'crm->objects->users->search', - example: - "crm\n ->objects\n ->users\n ->search(\n after: 'after',\n filterGroups: [\n [\n 'filters' => [\n [\n 'operator' => 'BETWEEN',\n 'propertyName' => 'propertyName',\n 'highValue' => 'highValue',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n ],\n limit: 0,\n properties: ['string'],\n sorts: ['string'],\n query: 'query',\n);\n\nvar_dump($collectionResponseWithTotalSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/search \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "after": "after",\n "filterGroups": [\n {\n "filters": [\n {\n "operator": "BETWEEN",\n "propertyName": "propertyName"\n }\n ]\n }\n ],\n "limit": 0,\n "properties": [\n "string"\n ],\n "sorts": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/users/{userId}', - httpMethod: 'patch', - summary: 'Update', - description: - 'Perform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.', - stainlessPath: '(resource) crm.objects.users > (method) update', - qualified: 'client.crm.objects.users.update', - params: ['userId: string;', 'properties: object;', 'idProperty?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }', - markdown: - "## update\n\n`client.crm.objects.users.update(userId: string, properties: object, idProperty?: string): { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n\n**patch** `/crm/objects/2026-03/users/{userId}`\n\nPerform a partial update of an Object identified by `{userId}`or optionally a unique property value as specified by the `idProperty` query param. `{userId}` refers to the internal object ID by default, and the `idProperty` query param refers to a property whose values are unique for the object. Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.\n\n### Parameters\n\n- `userId: string`\n\n- `properties: object`\n Key value pairs representing the properties of the object.\n\n- `idProperty?: string`\n The name of a property whose values are unique for this object type\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }`\n A simple public object.\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `objectWriteTraceId?: string`\n - `propertiesWithHistory?: object`\n - `url?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst simplePublicObject = await client.crm.objects.users.update('userId', { properties: { foo: 'string' } });\n\nconsole.log(simplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst simplePublicObject = await client.crm.objects.users.update('userId', {\n properties: { foo: 'string' },\n});\n\nconsole.log(simplePublicObject.id);", - }, - python: { - method: 'crm.objects.users.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsimple_public_object = client.crm.objects.users.update(\n user_id="userId",\n properties={\n "foo": "string"\n },\n)\nprint(simple_public_object.id)', - }, - java: { - method: 'crm().objects().users().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInput;\nimport com.hubspot.sdk.models.crm.objects.users.UserUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserUpdateParams params = UserUpdateParams.builder()\n .userId("userId")\n .simplePublicObjectInput(SimplePublicObjectInput.builder()\n .properties(SimplePublicObjectInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n SimplePublicObject simplePublicObject = client.crm().objects().users().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsimplePublicObject, err := client.Crm.Objects.Users.Update(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tcrm.ObjectUserUpdateParams{\n\t\t\tSimplePublicObjectInput: crm.SimplePublicObjectInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", simplePublicObject.ID)\n}\n', - }, - ruby: { - method: 'crm.objects.users.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object = hubspot.crm.objects.users.update("userId", properties: {foo: "string"})\n\nputs(simple_public_object)', - }, - php: { - method: 'crm->objects->users->update', - example: - "crm->objects->users->update(\n 'userId', properties: ['foo' => 'string'], idProperty: 'idProperty'\n);\n\nvar_dump($simplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/$USER_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/objects/2026-03/users/batch/create', - httpMethod: 'post', - summary: 'Create a batch of users', - description: - 'Create multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs.', - stainlessPath: '(resource) crm.objects.users.batch > (method) create', - qualified: 'client.crm.objects.users.batch.create', - params: [ - 'inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.objects.users.batch.create(inputs: { associations: public_associations_for_object[]; properties: object; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/create`\n\nCreate multiple users in a single request by providing a batch of user properties and associations. This endpoint returns the created users along with their IDs.\n\n### Parameters\n\n- `inputs: { associations: { to: public_object_id; types: association_spec[]; }[]; properties: object; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.create({ inputs: [{\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.create({\n inputs: [\n {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.users.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.create(\n inputs=[{\n "associations": [{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().users().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputForCreate;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputForCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputForCreate params = BatchInputSimplePublicObjectBatchInputForCreate.builder()\n .addInput(SimplePublicObjectBatchInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectBatchInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.New(context.TODO(), crm.ObjectUserBatchNewParams{\n\t\tBatchInputSimplePublicObjectBatchInputForCreate: crm.BatchInputSimplePublicObjectBatchInputForCreateParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputForCreateParam{{\n\t\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\t\tID: "id",\n\t\t\t\t\t},\n\t\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t\t}},\n\t\t\t\t}},\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.users.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.create(\n inputs: [\n {\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n properties: {foo: "string"}\n }\n ]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->users->batch->create', - example: - "crm->objects->users->batch->create(\n inputs: [\n [\n 'associations' => [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n [\n 'associationCategory' => 'HUBSPOT_DEFINED',\n 'associationTypeID' => 0,\n ],\n ],\n ],\n ],\n 'properties' => ['foo' => 'string'],\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/objects/2026-03/users/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of users by ID', - description: - 'Archive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use.', - stainlessPath: '(resource) crm.objects.users.batch > (method) delete', - qualified: 'client.crm.objects.users.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.crm.objects.users.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/crm/objects/2026-03/users/batch/archive`\n\nArchive multiple users by their IDs in a single request. This operation moves the specified users to the recycling bin, effectively deactivating them from active use.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.objects.users.batch.delete({ inputs: [{ id: '430001' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.objects.users.batch.delete({ inputs: [{ id: '430001' }] });", - }, - python: { - method: 'crm.objects.users.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.objects.users.batch.delete(\n inputs=[{\n "id": "430001"\n }],\n)', - }, - java: { - method: 'crm().objects().users().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectId params = BatchInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .build();\n client.crm().objects().users().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Objects.Users.Batch.Delete(context.TODO(), crm.ObjectUserBatchDeleteParams{\n\t\tBatchInputSimplePublicObjectID: crm.BatchInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.objects.users.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.objects.users.batch.delete(inputs: [{id: "430001"}])\n\nputs(result)', - }, - php: { - method: 'crm->objects->users->batch->delete', - example: - "crm->objects->users->batch->delete(\n inputs: [['id' => '430001']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/objects/2026-03/users/batch/read', - httpMethod: 'post', - summary: 'Read a batch of users by internal ID, or unique property values', - description: - 'Retrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. ', - stainlessPath: '(resource) crm.objects.users.batch > (method) get', - qualified: 'client.crm.objects.users.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'properties: string[];', - 'propertiesWithHistory: string[];', - 'archived?: boolean;', - 'idProperty?: string;', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.objects.users.batch.get(inputs: { id: string; }[], properties: string[], propertiesWithHistory: string[], archived?: boolean, idProperty?: string): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/read`\n\nRetrieve records by record ID or include the `idProperty` parameter to retrieve records by a custom unique value property. \n\n### Parameters\n\n- `inputs: { id: string; }[]`\n\n- `properties: string[]`\n Key-value pairs for setting properties for the new object.\n\n- `propertiesWithHistory: string[]`\n Key-value pairs for setting properties for the new object and their histories.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: string`\n When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.get({\n inputs: [{ id: '430001' }],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.users.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.get(\n inputs=[{\n "id": "430001"\n }],\n properties=["string"],\n properties_with_history=["string"],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().users().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.BatchReadInputSimplePublicObjectId;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectId;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchReadInputSimplePublicObjectId params = BatchReadInputSimplePublicObjectId.builder()\n .addInput(SimplePublicObjectId.builder()\n .id("430001")\n .build())\n .addProperty("string")\n .addPropertiesWithHistory("string")\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.Get(context.TODO(), crm.ObjectUserBatchGetParams{\n\t\tBatchReadInputSimplePublicObjectID: crm.BatchReadInputSimplePublicObjectIDParam{\n\t\t\tInputs: []crm.SimplePublicObjectIDParam{{\n\t\t\t\tID: "430001",\n\t\t\t}},\n\t\t\tProperties: []string{"string"},\n\t\t\tPropertiesWithHistory: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.users.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.get(\n inputs: [{id: "430001"}],\n properties: ["string"],\n properties_with_history: ["string"]\n)\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->users->batch->get', - example: - "crm->objects->users->batch->get(\n inputs: [['id' => '430001']],\n properties: ['string'],\n propertiesWithHistory: ['string'],\n archived: true,\n idProperty: 'idProperty',\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "430001"\n }\n ],\n "properties": [\n "string"\n ],\n "propertiesWithHistory": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/objects/2026-03/users/batch/update', - httpMethod: 'post', - summary: 'Update a batch of users by internal ID, or unique property values', - description: - 'Update multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles.', - stainlessPath: '(resource) crm.objects.users.batch > (method) update', - qualified: 'client.crm.objects.users.batch.update', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.crm.objects.users.batch.update(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/update`\n\nUpdate multiple user records in a single request by specifying their internal IDs or unique property values. This operation allows for batch processing of user data, ensuring efficient updates across multiple user profiles.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n A public object batch response object\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicObject = await client.crm.objects.users.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicObject.completedAt);", - }, - python: { - method: 'crm.objects.users.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_object = client.crm.objects.users.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_object.completed_at)', - }, - java: { - method: 'crm().objects().users().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInput;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInput params = BatchInputSimplePublicObjectBatchInput.builder()\n .addInput(SimplePublicObjectBatchInput.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicObject batchResponseSimplePublicObject = client.crm().objects().users().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicObject, err := client.Crm.Objects.Users.Batch.Update(context.TODO(), crm.ObjectUserBatchUpdateParams{\n\t\tBatchInputSimplePublicObjectBatchInput: crm.BatchInputSimplePublicObjectBatchInputParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.users.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_object = hubspot.crm.objects.users.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_object)', - }, - php: { - method: 'crm->objects->users->batch->update', - example: - "crm->objects->users->batch->update(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'my_unique_property_name',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert', - endpoint: '/crm/objects/2026-03/users/batch/upsert', - httpMethod: 'post', - summary: 'Create or update a batch of users by unique property values', - description: - 'Create or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.', - stainlessPath: '(resource) crm.objects.users.batch > (method) upsert', - qualified: 'client.crm.objects.users.batch.upsert', - params: [ - 'inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## upsert\n\n`client.crm.objects.users.batch.upsert(inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]): { completedAt: string; results: simple_public_upsert_object[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/objects/2026-03/users/batch/upsert`\n\nCreate or update records identified by a unique property value as specified by the `idProperty` query param. `idProperty` query param refers to a property whose values are unique for the object.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; idProperty?: string; objectWriteTraceId?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.\n\n - `completedAt: string`\n - `results: { id: string; archived: boolean; createdAt: string; new: boolean; properties: object; updatedAt: string; archivedAt?: string; objectWriteTraceId?: string; propertiesWithHistory?: object; url?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.users.batch.upsert({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSimplePublicUpsertObject);\n```", - perLanguage: { - typescript: { - method: 'client.crm.objects.users.batch.upsert', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSimplePublicUpsertObject = await client.crm.objects.users.batch.upsert({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseSimplePublicUpsertObject.completedAt);", - }, - python: { - method: 'crm.objects.users.batch.upsert', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_simple_public_upsert_object = client.crm.objects.users.batch.upsert(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_simple_public_upsert_object.completed_at)', - }, - java: { - method: 'crm().objects().users().batch().upsert', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.BatchInputSimplePublicObjectBatchInputUpsert;\nimport com.hubspot.sdk.models.crm.objects.BatchResponseSimplePublicUpsertObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectBatchInputUpsert;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputSimplePublicObjectBatchInputUpsert params = BatchInputSimplePublicObjectBatchInputUpsert.builder()\n .addInput(SimplePublicObjectBatchInputUpsert.builder()\n .id("id")\n .properties(SimplePublicObjectBatchInputUpsert.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseSimplePublicUpsertObject batchResponseSimplePublicUpsertObject = client.crm().objects().users().batch().upsert(params);\n }\n}', - }, - go: { - method: 'client.Crm.Objects.Users.Batch.Upsert', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSimplePublicUpsertObject, err := client.Crm.Objects.Users.Batch.Upsert(context.TODO(), crm.ObjectUserBatchUpsertParams{\n\t\tBatchInputSimplePublicObjectBatchInputUpsert: crm.BatchInputSimplePublicObjectBatchInputUpsertParam{\n\t\t\tInputs: []crm.SimplePublicObjectBatchInputUpsertParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSimplePublicUpsertObject.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.objects.users.batch.upsert', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_simple_public_upsert_object = hubspot.crm.objects.users.batch.upsert(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_simple_public_upsert_object)', - }, - php: { - method: 'crm->objects->users->batch->upsert', - example: - "crm\n ->objects\n ->users\n ->batch\n ->upsert(\n inputs: [\n [\n 'id' => 'id',\n 'properties' => ['foo' => 'string'],\n 'idProperty' => 'idProperty',\n 'objectWriteTraceID' => 'objectWriteTraceId',\n ],\n ],\n);\n\nvar_dump($batchResponseSimplePublicUpsertObject);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/objects/2026-03/users/batch/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/owners/2026-03/{ownerId}', - httpMethod: 'get', - summary: 'Retrieve a specific owner by ID', - description: "Retrieve details of a specific owner using either their 'id' or 'userId'.", - stainlessPath: '(resource) crm.owners > (method) get', - qualified: 'client.crm.owners.get', - params: ['ownerId: number;', 'archived?: boolean;', "idProperty?: 'id' | 'userId';"], - response: - "{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }", - markdown: - "## get\n\n`client.crm.owners.get(ownerId: number, archived?: boolean, idProperty?: 'id' | 'userId'): { id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: public_team[]; userId?: number; userIdIncludingInactive?: number; }`\n\n**get** `/crm/owners/2026-03/{ownerId}`\n\nRetrieve details of a specific owner using either their 'id' or 'userId'.\n\n### Parameters\n\n- `ownerId: number`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `idProperty?: 'id' | 'userId'`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `type: 'PERSON' | 'QUEUE'`\n - `updatedAt: string`\n - `email?: string`\n - `firstName?: string`\n - `lastName?: string`\n - `teams?: { id: string; name: string; primary: boolean; }[]`\n - `userId?: number`\n - `userIdIncludingInactive?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicOwner = await client.crm.owners.get(0);\n\nconsole.log(publicOwner);\n```", - perLanguage: { - typescript: { - method: 'client.crm.owners.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicOwner = await client.crm.owners.get(0);\n\nconsole.log(publicOwner.id);", - }, - python: { - method: 'crm.owners.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_owner = client.crm.owners.get(\n owner_id=0,\n)\nprint(public_owner.id)', - }, - java: { - method: 'crm().owners().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.owners.OwnerGetParams;\nimport com.hubspot.sdk.models.crm.owners.PublicOwner;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicOwner publicOwner = client.crm().owners().get(0);\n }\n}', - }, - go: { - method: 'client.Crm.Owners.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicOwner, err := client.Crm.Owners.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tcrm.OwnerGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicOwner.ID)\n}\n', - }, - ruby: { - method: 'crm.owners.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_owner = hubspot.crm.owners.get(0)\n\nputs(public_owner)', - }, - php: { - method: 'crm->owners->get', - example: - "crm->owners->get(0, archived: true, idProperty: 'id');\n\nvar_dump($publicOwner);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/owners/2026-03/$OWNER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/owners/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) crm.owners > (method) list', - qualified: 'client.crm.owners.list', - params: ['after?: string;', 'archived?: boolean;', 'email?: string;', 'limit?: number;'], - response: - "{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }", - markdown: - "## list\n\n`client.crm.owners.list(after?: string, archived?: boolean, email?: string, limit?: number): { id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: public_team[]; userId?: number; userIdIncludingInactive?: number; }`\n\n**get** `/crm/owners/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `email?: string`\n Filter by email address (optional)\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; type: 'PERSON' | 'QUEUE'; updatedAt: string; email?: string; firstName?: string; lastName?: string; teams?: { id: string; name: string; primary: boolean; }[]; userId?: number; userIdIncludingInactive?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `type: 'PERSON' | 'QUEUE'`\n - `updatedAt: string`\n - `email?: string`\n - `firstName?: string`\n - `lastName?: string`\n - `teams?: { id: string; name: string; primary: boolean; }[]`\n - `userId?: number`\n - `userIdIncludingInactive?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicOwner of client.crm.owners.list()) {\n console.log(publicOwner);\n}\n```", - perLanguage: { - typescript: { - method: 'client.crm.owners.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicOwner of client.crm.owners.list()) {\n console.log(publicOwner.id);\n}", - }, - python: { - method: 'crm.owners.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.crm.owners.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'crm().owners().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.owners.OwnerListPage;\nimport com.hubspot.sdk.models.crm.owners.OwnerListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OwnerListPage page = client.crm().owners().list();\n }\n}', - }, - go: { - method: 'client.Crm.Owners.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Crm.Owners.List(context.TODO(), crm.OwnerListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'crm.owners.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.crm.owners.list\n\nputs(page)', - }, - php: { - method: 'crm->owners->list', - example: - "crm->owners->list(\n after: 'after', archived: true, email: 'email', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/owners/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/pipelines/2026-03/{objectType}', - httpMethod: 'post', - summary: 'Create a pipeline', - description: - 'Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.', - stainlessPath: '(resource) crm.pipelines > (method) create', - qualified: 'client.crm.pipelines.create', - params: [ - 'objectType: string;', - 'displayOrder: number;', - 'label: string;', - 'stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[];', - 'pipelineId?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", - markdown: - "## create\n\n`client.crm.pipelines.create(objectType: string, displayOrder: number, label: string, stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[], pipelineId?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**post** `/crm/pipelines/2026-03/{objectType}`\n\nCreate a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A unique label used to organize pipelines in HubSpot's UI\n\n- `stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[]`\n Pipeline stage inputs used to create the new or replacement pipeline.\n\n- `pipelineId?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.create('objectType', {\n displayOrder: 0,\n label: 'label',\n stages: [{\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n}],\n});\n\nconsole.log(pipeline);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.create('objectType', {\n displayOrder: 0,\n label: 'label',\n stages: [\n {\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(pipeline.id);", - }, - python: { - method: 'crm.pipelines.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.create(\n object_type="objectType",\n display_order=0,\n label="label",\n stages=[{\n "display_order": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n },\n }],\n)\nprint(pipeline.id)', - }, - java: { - method: 'crm().pipelines().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineCreateParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineCreateParams params = PipelineCreateParams.builder()\n .objectType("objectType")\n .pipelineInput(PipelineInput.builder()\n .displayOrder(0)\n .label("label")\n .addStage(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n Pipeline pipeline = client.crm().pipelines().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PipelineNewParams{\n\t\t\tPipelineInput: crm.PipelineInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tStages: []crm.PipelineStageInputParam{{\n\t\t\t\t\tDisplayOrder: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.create(\n "objectType",\n display_order: 0,\n label: "label",\n stages: [{displayOrder: 0, label: "label", metadata: {foo: "string"}}]\n)\n\nputs(pipeline)', - }, - php: { - method: 'crm->pipelines->create', - example: - "crm->pipelines->create(\n 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n [\n 'displayOrder' => 0,\n 'label' => 'label',\n 'metadata' => ['foo' => 'string'],\n 'stageID' => 'stageId',\n ],\n ],\n pipelineID: 'pipelineId',\n);\n\nvar_dump($pipeline);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "stages": [\n {\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_stage', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', - httpMethod: 'post', - summary: 'Create a pipeline stage', - description: 'Create a pipeline stage', - stainlessPath: '(resource) crm.pipelines > (method) create_stage', - qualified: 'client.crm.pipelines.createStage', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'displayOrder: number;', - 'label: string;', - 'metadata: object;', - 'stageId?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", - markdown: - "## create_stage\n\n`client.crm.pipelines.createStage(objectType: string, pipelineId: string, displayOrder: number, label: string, metadata: object, stageId?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**post** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`\n\nCreate a pipeline stage\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n- `stageId?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.createStage('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.createStage', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.createStage('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", - }, - python: { - method: 'crm.pipelines.create_stage', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.create_stage(\n pipeline_id="pipelineId",\n object_type="objectType",\n display_order=0,\n label="label",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', - }, - java: { - method: 'crm().pipelines().createStage', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineCreateStageParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineCreateStageParams params = PipelineCreateStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelineStageInput(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().createStage(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.NewStage', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.NewStage(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineNewStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineStageInput: crm.PipelineStageInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.create_stage', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.create_stage(\n "pipelineId",\n object_type: "objectType",\n display_order: 0,\n label: "label",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', - }, - php: { - method: 'crm->pipelines->createStage', - example: - "crm->pipelines->createStage(\n 'pipelineId',\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n metadata: ['foo' => 'string'],\n stageID: 'stageId',\n);\n\nvar_dump($pipelineStage);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - httpMethod: 'delete', - summary: 'Delete a pipeline', - description: 'Delete a pipeline', - stainlessPath: '(resource) crm.pipelines > (method) delete', - qualified: 'client.crm.pipelines.delete', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'validateDealStageUsagesBeforeDelete?: boolean;', - 'validateReferencesBeforeDelete?: boolean;', - ], - markdown: - "## delete\n\n`client.crm.pipelines.delete(objectType: string, pipelineId: string, validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean): void`\n\n**delete** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nDelete a pipeline\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.pipelines.delete('pipelineId', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.pipelines.delete('pipelineId', { objectType: 'objectType' });", - }, - python: { - method: 'crm.pipelines.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.pipelines.delete(\n pipeline_id="pipelineId",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().pipelines().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineDeleteParams params = PipelineDeleteParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n client.crm().pipelines().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Pipelines.Delete(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.pipelines.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.pipelines.delete("pipelineId", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->pipelines->delete', - example: - "crm->pipelines->delete(\n 'pipelineId',\n objectType: 'objectType',\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_stage', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - httpMethod: 'delete', - summary: 'Delete a pipeline stage', - description: 'Delete a pipeline stage', - stainlessPath: '(resource) crm.pipelines > (method) delete_stage', - qualified: 'client.crm.pipelines.deleteStage', - params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], - markdown: - "## delete_stage\n\n`client.crm.pipelines.deleteStage(objectType: string, pipelineId: string, stageId: string): void`\n\n**delete** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nDelete a pipeline stage\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.pipelines.deleteStage('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.deleteStage', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.pipelines.deleteStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n});", - }, - python: { - method: 'crm.pipelines.delete_stage', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.pipelines.delete_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)', - }, - java: { - method: 'crm().pipelines().deleteStage', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineDeleteStageParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineDeleteStageParams params = PipelineDeleteStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n client.crm().pipelines().deleteStage(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.DeleteStage', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Pipelines.DeleteStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineDeleteStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.pipelines.delete_stage', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.pipelines.delete_stage("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(result)', - }, - php: { - method: 'crm->pipelines->deleteStage', - example: - "crm->pipelines->deleteStage(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - httpMethod: 'get', - summary: 'Return a pipeline by ID', - description: 'Return a single pipeline object identified by its unique `{pipelineId}`.', - stainlessPath: '(resource) crm.pipelines > (method) get', - qualified: 'client.crm.pipelines.get', - params: ['objectType: string;', 'pipelineId: string;'], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", - markdown: - "## get\n\n`client.crm.pipelines.get(objectType: string, pipelineId: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nReturn a single pipeline object identified by its unique `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.get('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.get('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline.id);", - }, - python: { - method: 'crm.pipelines.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.get(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(pipeline.id)', - }, - java: { - method: 'crm().pipelines().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineGetParams params = PipelineGetParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n Pipeline pipeline = client.crm().pipelines().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.Get(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.get("pipelineId", object_type: "objectType")\n\nputs(pipeline)', - }, - php: { - method: 'crm->pipelines->get', - example: - "crm->pipelines->get(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($pipeline);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_stage', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - httpMethod: 'get', - summary: 'Return a pipeline stage by ID', - description: 'Return a pipeline stage by ID', - stainlessPath: '(resource) crm.pipelines > (method) get_stage', - qualified: 'client.crm.pipelines.getStage', - params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", - markdown: - "## get_stage\n\n`client.crm.pipelines.getStage(objectType: string, pipelineId: string, stageId: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nReturn a pipeline stage by ID\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.getStage('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' });\n\nconsole.log(pipelineStage);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.getStage', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.getStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n});\n\nconsole.log(pipelineStage.id);", - }, - python: { - method: 'crm.pipelines.get_stage', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.get_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)\nprint(pipeline_stage.id)', - }, - java: { - method: 'crm().pipelines().getStage', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineGetStageParams;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineGetStageParams params = PipelineGetStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().getStage(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.GetStage', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.GetStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineGetStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.get_stage', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.get_stage("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(pipeline_stage)', - }, - php: { - method: 'crm->pipelines->getStage', - example: - "crm->pipelines->getStage(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($pipelineStage);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/pipelines/2026-03/{objectType}', - httpMethod: 'get', - summary: 'Retrieve all pipelines', - description: 'Return all pipelines for the object type specified by `{objectType}`.', - stainlessPath: '(resource) crm.pipelines > (method) list', - qualified: 'client.crm.pipelines.list', - params: ['objectType: string;'], - response: - '{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }[]; }', - markdown: - "## list\n\n`client.crm.pipelines.list(objectType: string): { results: pipeline[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}`\n\nReturn all pipelines for the object type specified by `{objectType}`.\n\n### Parameters\n\n- `objectType: string`\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }[]; }`\n\n - `results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePipelineNoPaging = await client.crm.pipelines.list('objectType');\n\nconsole.log(collectionResponsePipelineNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePipelineNoPaging = await client.crm.pipelines.list('objectType');\n\nconsole.log(collectionResponsePipelineNoPaging.results);", - }, - python: { - method: 'crm.pipelines.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_pipeline_no_paging = client.crm.pipelines.list(\n "objectType",\n)\nprint(collection_response_pipeline_no_paging.results)', - }, - java: { - method: 'crm().pipelines().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePipelineNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePipelineNoPaging collectionResponsePipelineNoPaging = client.crm().pipelines().list("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePipelineNoPaging, err := client.Crm.Pipelines.List(context.TODO(), "objectType")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePipelineNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.pipelines.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_pipeline_no_paging = hubspot.crm.pipelines.list("objectType")\n\nputs(collection_response_pipeline_no_paging)', - }, - php: { - method: 'crm->pipelines->list', - example: - "crm->pipelines->list(\n 'objectType'\n);\n\nvar_dump($collectionResponsePipelineNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_audit', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit', - httpMethod: 'get', - summary: 'Return an audit of all changes to the pipeline', - description: - 'Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.', - stainlessPath: '(resource) crm.pipelines > (method) list_audit', - qualified: 'client.crm.pipelines.listAudit', - params: ['objectType: string;', 'pipelineId: string;'], - response: - '{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }', - markdown: - "## list_audit\n\n`client.crm.pipelines.listAudit(objectType: string, pipelineId: string): { results: public_audit_info[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit`\n\nReturn a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }`\n\n - `results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listAudit('pipelineId', { objectType: 'objectType' });\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.listAudit', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listAudit(\n 'pipelineId',\n { objectType: 'objectType' },\n);\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging.results);", - }, - python: { - method: 'crm.pipelines.list_audit', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_audit_info_no_paging = client.crm.pipelines.list_audit(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(collection_response_public_audit_info_no_paging.results)', - }, - java: { - method: 'crm().pipelines().listAudit', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePublicAuditInfoNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListAuditParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListAuditParams params = PipelineListAuditParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n CollectionResponsePublicAuditInfoNoPaging collectionResponsePublicAuditInfoNoPaging = client.crm().pipelines().listAudit(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.ListAudit', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAuditInfoNoPaging, err := client.Crm.Pipelines.ListAudit(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineListAuditParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAuditInfoNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.pipelines.list_audit', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_audit_info_no_paging = hubspot.crm.pipelines.list_audit("pipelineId", object_type: "objectType")\n\nputs(collection_response_public_audit_info_no_paging)', - }, - php: { - method: 'crm->pipelines->listAudit', - example: - "crm->pipelines->listAudit(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($collectionResponsePublicAuditInfoNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/audit \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_stage_audit', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit', - httpMethod: 'get', - summary: '', - description: - 'Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.', - stainlessPath: '(resource) crm.pipelines > (method) list_stage_audit', - qualified: 'client.crm.pipelines.listStageAudit', - params: ['objectType: string;', 'pipelineId: string;', 'stageId: string;'], - response: - '{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }', - markdown: - "## list_stage_audit\n\n`client.crm.pipelines.listStageAudit(objectType: string, pipelineId: string, stageId: string): { results: public_audit_info[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit`\n\nReturn a reverse chronological list of all mutations that have occurred on the pipeline stage identified by `{stageId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n### Returns\n\n- `{ results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]; }`\n\n - `results: { action: string; identifier: string; portalId: number; fromUserId?: number; message?: string; rawObject?: object; timestamp?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listStageAudit('stageId', { objectType: 'objectType', pipelineId: 'pipelineId' });\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.listStageAudit', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicAuditInfoNoPaging = await client.crm.pipelines.listStageAudit(\n 'stageId',\n { objectType: 'objectType', pipelineId: 'pipelineId' },\n);\n\nconsole.log(collectionResponsePublicAuditInfoNoPaging.results);", - }, - python: { - method: 'crm.pipelines.list_stage_audit', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_audit_info_no_paging = client.crm.pipelines.list_stage_audit(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n)\nprint(collection_response_public_audit_info_no_paging.results)', - }, - java: { - method: 'crm().pipelines().listStageAudit', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePublicAuditInfoNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListStageAuditParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListStageAuditParams params = PipelineListStageAuditParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .build();\n CollectionResponsePublicAuditInfoNoPaging collectionResponsePublicAuditInfoNoPaging = client.crm().pipelines().listStageAudit(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.ListStageAudit', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicAuditInfoNoPaging, err := client.Crm.Pipelines.ListStageAudit(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineListStageAuditParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicAuditInfoNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.pipelines.list_stage_audit', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_audit_info_no_paging = hubspot.crm.pipelines.list_stage_audit("stageId", object_type: "objectType", pipeline_id: "pipelineId")\n\nputs(collection_response_public_audit_info_no_paging)', - }, - php: { - method: 'crm->pipelines->listStageAudit', - example: - "crm\n ->pipelines\n ->listStageAudit(\n 'stageId', objectType: 'objectType', pipelineID: 'pipelineId'\n);\n\nvar_dump($collectionResponsePublicAuditInfoNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID/audit \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_stages', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', - httpMethod: 'get', - summary: 'Return all stages of a pipeline', - description: 'Return all the stages associated with the pipeline identified by `{pipelineId}`.', - stainlessPath: '(resource) crm.pipelines > (method) list_stages', - qualified: 'client.crm.pipelines.listStages', - params: ['objectType: string;', 'pipelineId: string;'], - response: - "{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; }", - markdown: - "## list_stages\n\n`client.crm.pipelines.listStages(objectType: string, pipelineId: string): { results: pipeline_stage[]; }`\n\n**get** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages`\n\nReturn all the stages associated with the pipeline identified by `{pipelineId}`.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n### Returns\n\n- `{ results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; }`\n\n - `results: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePipelineStageNoPaging = await client.crm.pipelines.listStages('pipelineId', { objectType: 'objectType' });\n\nconsole.log(collectionResponsePipelineStageNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.listStages', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePipelineStageNoPaging = await client.crm.pipelines.listStages(\n 'pipelineId',\n { objectType: 'objectType' },\n);\n\nconsole.log(collectionResponsePipelineStageNoPaging.results);", - }, - python: { - method: 'crm.pipelines.list_stages', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_pipeline_stage_no_paging = client.crm.pipelines.list_stages(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(collection_response_pipeline_stage_no_paging.results)', - }, - java: { - method: 'crm().pipelines().listStages', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.CollectionResponsePipelineStageNoPaging;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineListStagesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineListStagesParams params = PipelineListStagesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .build();\n CollectionResponsePipelineStageNoPaging collectionResponsePipelineStageNoPaging = client.crm().pipelines().listStages(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.ListStages', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePipelineStageNoPaging, err := client.Crm.Pipelines.ListStages(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineListStagesParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePipelineStageNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.pipelines.list_stages', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_pipeline_stage_no_paging = hubspot.crm.pipelines.list_stages("pipelineId", object_type: "objectType")\n\nputs(collection_response_pipeline_stage_no_paging)', - }, - php: { - method: 'crm->pipelines->listStages', - example: - "crm->pipelines->listStages(\n 'pipelineId', objectType: 'objectType'\n);\n\nvar_dump($collectionResponsePipelineStageNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - httpMethod: 'patch', - summary: '', - description: - 'Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.', - stainlessPath: '(resource) crm.pipelines > (method) update', - qualified: 'client.crm.pipelines.update', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'validateDealStageUsagesBeforeDelete?: boolean;', - 'validateReferencesBeforeDelete?: boolean;', - 'archived?: boolean;', - 'displayOrder?: number;', - 'label?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", - markdown: - "## update\n\n`client.crm.pipelines.update(objectType: string, pipelineId: string, validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean, archived?: boolean, displayOrder?: number, label?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**patch** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nPerform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n- `archived?: boolean`\n Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a `400 Bad Request` will be returned.\n\n- `displayOrder?: number`\n The order for displaying this pipeline. If two pipelines have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label?: string`\n A unique label used to organize pipelines in HubSpot's UI\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.update('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.update('pipelineId', { objectType: 'objectType' });\n\nconsole.log(pipeline.id);", - }, - python: { - method: 'crm.pipelines.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.update(\n pipeline_id="pipelineId",\n object_type="objectType",\n)\nprint(pipeline.id)', - }, - java: { - method: 'crm().pipelines().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelinePatchInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateParams params = PipelineUpdateParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelinePatchInput(PipelinePatchInput.builder().build())\n .build();\n Pipeline pipeline = client.crm().pipelines().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.Update(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelinePatchInput: crm.PipelinePatchInputParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.update("pipelineId", object_type: "objectType")\n\nputs(pipeline)', - }, - php: { - method: 'crm->pipelines->update', - example: - "crm->pipelines->update(\n 'pipelineId',\n objectType: 'objectType',\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n archived: true,\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($pipeline);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_all_properties', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - httpMethod: 'put', - summary: 'Replace a pipeline', - description: 'Replace a pipeline', - stainlessPath: '(resource) crm.pipelines > (method) update_all_properties', - qualified: 'client.crm.pipelines.updateAllProperties', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'displayOrder: number;', - 'label: string;', - 'stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[];', - 'validateDealStageUsagesBeforeDelete?: boolean;', - 'validateReferencesBeforeDelete?: boolean;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }", - markdown: - "## update_all_properties\n\n`client.crm.pipelines.updateAllProperties(objectType: string, pipelineId: string, displayOrder: number, label: string, stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[], validateDealStageUsagesBeforeDelete?: boolean, validateReferencesBeforeDelete?: boolean): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: pipeline_stage[]; updatedAt: string; archivedAt?: string; }`\n\n**put** `/crm/pipelines/2026-03/{objectType}/{pipelineId}`\n\nReplace a pipeline\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `stages: { displayOrder: number; label: string; metadata: object; stageId?: string; }[]`\n The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.\n\n- `validateDealStageUsagesBeforeDelete?: boolean`\n\n- `validateReferencesBeforeDelete?: boolean`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]; updatedAt: string; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `stages: { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }[]`\n - `updatedAt: string`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipeline = await client.crm.pipelines.updateAllProperties('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [{\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n}],\n});\n\nconsole.log(pipeline);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.updateAllProperties', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipeline = await client.crm.pipelines.updateAllProperties('pipelineId', {\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n {\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(pipeline.id);", - }, - python: { - method: 'crm.pipelines.update_all_properties', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline = client.crm.pipelines.update_all_properties(\n pipeline_id="pipelineId",\n object_type="objectType",\n display_order=0,\n label="label",\n stages=[{\n "display_order": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n },\n }],\n)\nprint(pipeline.id)', - }, - java: { - method: 'crm().pipelines().updateAllProperties', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.Pipeline;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineReplaceInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateAllPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateAllPropertiesParams params = PipelineUpdateAllPropertiesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .pipelineReplaceInput(PipelineReplaceInput.builder()\n .displayOrder(0)\n .label("label")\n .addStage(PipelineStageInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n Pipeline pipeline = client.crm().pipelines().updateAllProperties(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.UpdateAllProperties', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipeline, err := client.Crm.Pipelines.UpdateAllProperties(\n\t\tcontext.TODO(),\n\t\t"pipelineId",\n\t\tcrm.PipelineUpdateAllPropertiesParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineReplaceInput: crm.PipelineReplaceInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tStages: []crm.PipelineStageInputParam{{\n\t\t\t\t\tDisplayOrder: 0,\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipeline.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.update_all_properties', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline = hubspot.crm.pipelines.update_all_properties(\n "pipelineId",\n object_type: "objectType",\n display_order: 0,\n label: "label",\n stages: [{displayOrder: 0, label: "label", metadata: {foo: "string"}}]\n)\n\nputs(pipeline)', - }, - php: { - method: 'crm->pipelines->updateAllProperties', - example: - "crm->pipelines->updateAllProperties(\n 'pipelineId',\n objectType: 'objectType',\n displayOrder: 0,\n label: 'label',\n stages: [\n [\n 'displayOrder' => 0,\n 'label' => 'label',\n 'metadata' => ['foo' => 'string'],\n 'stageID' => 'stageId',\n ],\n ],\n validateDealStageUsagesBeforeDelete: true,\n validateReferencesBeforeDelete: true,\n);\n\nvar_dump($pipeline);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "stages": [\n {\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update_stage', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - httpMethod: 'patch', - summary: '', - description: '', - stainlessPath: '(resource) crm.pipelines > (method) update_stage', - qualified: 'client.crm.pipelines.updateStage', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'stageId: string;', - 'metadata: object;', - 'archived?: boolean;', - 'displayOrder?: number;', - 'label?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", - markdown: - "## update_stage\n\n`client.crm.pipelines.updateStage(objectType: string, pipelineId: string, stageId: string, metadata: object, archived?: boolean, displayOrder?: number, label?: string): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**patch** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n- `archived?: boolean`\n Whether the pipeline is archived.\n\n- `displayOrder?: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label?: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.updateStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.updateStage', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.updateStage('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", - }, - python: { - method: 'crm.pipelines.update_stage', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.update_stage(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', - }, - java: { - method: 'crm().pipelines().updateStage', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStagePatchInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateStageParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateStageParams params = PipelineUpdateStageParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .pipelineStagePatchInput(PipelineStagePatchInput.builder()\n .metadata(PipelineStagePatchInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().updateStage(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.UpdateStage', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.UpdateStage(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineUpdateStageParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t\tPipelineStagePatchInput: crm.PipelineStagePatchInputParam{\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.update_stage', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.update_stage(\n "stageId",\n object_type: "objectType",\n pipeline_id: "pipelineId",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', - }, - php: { - method: 'crm->pipelines->updateStage', - example: - "crm->pipelines->updateStage(\n 'stageId',\n objectType: 'objectType',\n pipelineID: 'pipelineId',\n metadata: ['foo' => 'string'],\n archived: true,\n displayOrder: 0,\n label: 'label',\n);\n\nvar_dump($pipelineStage);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "metadata": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'update_stage_all_properties', - endpoint: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - httpMethod: 'put', - summary: 'Replace a pipeline stage', - description: - 'Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.', - stainlessPath: '(resource) crm.pipelines > (method) update_stage_all_properties', - qualified: 'client.crm.pipelines.updateStageAllProperties', - params: [ - 'objectType: string;', - 'pipelineId: string;', - 'stageId: string;', - 'displayOrder: number;', - 'label: string;', - 'metadata: object;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }", - markdown: - "## update_stage_all_properties\n\n`client.crm.pipelines.updateStageAllProperties(objectType: string, pipelineId: string, stageId: string, displayOrder: number, label: string, metadata: object): { id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n**put** `/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}`\n\nReplace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.\n\n### Parameters\n\n- `objectType: string`\n\n- `pipelineId: string`\n\n- `stageId: string`\n\n- `displayOrder: number`\n The order for displaying this pipeline stage. If two pipeline stages have a matching `displayOrder`, they will be sorted alphabetically by label.\n\n- `label: string`\n A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.\n\n- `metadata: object`\n A JSON object containing properties that are not present on all object pipelines.\n\nFor `deals` pipelines, the `probability` field is required (`{ \"probability\": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.\n\nFor `tickets` pipelines, the `ticketState` field is optional (`{ \"ticketState\": \"OPEN\" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; displayOrder: number; label: string; metadata: object; updatedAt: string; writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'; archivedAt?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `displayOrder: number`\n - `label: string`\n - `metadata: object`\n - `updatedAt: string`\n - `writePermissions: 'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY'`\n - `archivedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst pipelineStage = await client.crm.pipelines.updateStageAllProperties('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage);\n```", - perLanguage: { - typescript: { - method: 'client.crm.pipelines.updateStageAllProperties', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst pipelineStage = await client.crm.pipelines.updateStageAllProperties('stageId', {\n objectType: 'objectType',\n pipelineId: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: { foo: 'string' },\n});\n\nconsole.log(pipelineStage.id);", - }, - python: { - method: 'crm.pipelines.update_stage_all_properties', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npipeline_stage = client.crm.pipelines.update_stage_all_properties(\n stage_id="stageId",\n object_type="objectType",\n pipeline_id="pipelineId",\n display_order=0,\n label="label",\n metadata={\n "foo": "string"\n },\n)\nprint(pipeline_stage.id)', - }, - java: { - method: 'crm().pipelines().updateStageAllProperties', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStage;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineStageReplaceInput;\nimport com.hubspot.sdk.models.crm.pipelines.PipelineUpdateStageAllPropertiesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PipelineUpdateStageAllPropertiesParams params = PipelineUpdateStageAllPropertiesParams.builder()\n .objectType("objectType")\n .pipelineId("pipelineId")\n .stageId("stageId")\n .pipelineStageReplaceInput(PipelineStageReplaceInput.builder()\n .displayOrder(0)\n .label("label")\n .metadata(PipelineStageReplaceInput.Metadata.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PipelineStage pipelineStage = client.crm().pipelines().updateStageAllProperties(params);\n }\n}', - }, - go: { - method: 'client.Crm.Pipelines.UpdateStageAllProperties', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpipelineStage, err := client.Crm.Pipelines.UpdateStageAllProperties(\n\t\tcontext.TODO(),\n\t\t"stageId",\n\t\tcrm.PipelineUpdateStageAllPropertiesParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPipelineID: "pipelineId",\n\t\t\tPipelineStageReplaceInput: crm.PipelineStageReplaceInputParam{\n\t\t\t\tDisplayOrder: 0,\n\t\t\t\tLabel: "label",\n\t\t\t\tMetadata: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", pipelineStage.ID)\n}\n', - }, - ruby: { - method: 'crm.pipelines.update_stage_all_properties', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npipeline_stage = hubspot.crm.pipelines.update_stage_all_properties(\n "stageId",\n object_type: "objectType",\n pipeline_id: "pipelineId",\n display_order: 0,\n label: "label",\n metadata: {foo: "string"}\n)\n\nputs(pipeline_stage)', - }, - php: { - method: 'crm->pipelines->updateStageAllProperties', - example: - "crm->pipelines->updateStageAllProperties(\n 'stageId',\n objectType: 'objectType',\n pipelineID: 'pipelineId',\n displayOrder: 0,\n label: 'label',\n metadata: ['foo' => 'string'],\n);\n\nvar_dump($pipelineStage);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/pipelines/2026-03/$OBJECT_TYPE/$PIPELINE_ID/stages/$STAGE_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "displayOrder": 0,\n "label": "label",\n "metadata": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/properties/2026-03/{objectType}', - httpMethod: 'post', - summary: 'Create a property', - description: 'Create and return a copy of a new property for the specified object type.', - stainlessPath: '(resource) crm.properties > (method) create', - qualified: 'client.crm.properties.create', - params: [ - 'objectType: string;', - 'fieldType: string;', - 'groupName: string;', - 'label: string;', - 'name: string;', - "type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", - 'calculationFormula?: string;', - 'currencyPropertyName?: string;', - "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'description?: string;', - 'displayOrder?: number;', - 'externalOptions?: boolean;', - 'formField?: boolean;', - 'hasUniqueValue?: boolean;', - 'hidden?: boolean;', - "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - 'referencedObjectType?: string;', - 'showCurrencySymbol?: boolean;', - ], - response: - "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", - markdown: - "## create\n\n`client.crm.properties.create(objectType: string, fieldType: string, groupName: string, label: string, name: string, type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string', calculationFormula?: string, currencyPropertyName?: string, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', description?: string, displayOrder?: number, externalOptions?: boolean, formField?: boolean, hasUniqueValue?: boolean, hidden?: boolean, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], referencedObjectType?: string, showCurrencySymbol?: boolean): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}`\n\nCreate and return a copy of a new property for the specified object type.\n\n### Parameters\n\n- `objectType: string`\n\n- `fieldType: string`\n\n- `groupName: string`\n\n- `label: string`\n\n- `name: string`\n\n- `type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n\n- `calculationFormula?: string`\n\n- `currencyPropertyName?: string`\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `description?: string`\n\n- `displayOrder?: number`\n\n- `externalOptions?: boolean`\n\n- `formField?: boolean`\n\n- `hasUniqueValue?: boolean`\n\n- `hidden?: boolean`\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n\n- `referencedObjectType?: string`\n\n- `showCurrencySymbol?: boolean`\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.create('objectType', {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(property);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.create('objectType', {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n});\n\nconsole.log(property.hidden);", - }, - python: { - method: 'crm.properties.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.create(\n object_type="objectType",\n field_type="booleancheckbox",\n group_name="groupName",\n label="label",\n name="name",\n type="bool",\n)\nprint(property.hidden)', - }, - java: { - method: 'crm().properties().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.crm.properties.PropertyCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyCreateParams params = PropertyCreateParams.builder()\n .objectType("objectType")\n .propertyCreate(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build();\n Property property = client.crm().properties().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyNewParams{\n\t\t\tPropertyCreate: shared.PropertyCreateParam{\n\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\tGroupName: "groupName",\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', - }, - ruby: { - method: 'crm.properties.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.create(\n "objectType",\n field_type: :booleancheckbox,\n group_name: "groupName",\n label: "label",\n name: "name",\n type: :bool\n)\n\nputs(property)', - }, - php: { - method: 'crm->properties->create', - example: - "crm->properties->create(\n 'objectType',\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n dataSensitivity: 'highly_sensitive',\n description: 'description',\n displayOrder: 0,\n externalOptions: true,\n formField: true,\n hasUniqueValue: true,\n hidden: true,\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n referencedObjectType: 'referencedObjectType',\n showCurrencySymbol: true,\n);\n\nvar_dump($property);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', - httpMethod: 'delete', - summary: 'Archive a property', - description: 'Move a property identified by {propertyName} to the recycling bin.', - stainlessPath: '(resource) crm.properties > (method) delete', - qualified: 'client.crm.properties.delete', - params: ['objectType: string;', 'propertyName: string;'], - markdown: - "## delete\n\n`client.crm.properties.delete(objectType: string, propertyName: string): void`\n\n**delete** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nMove a property identified by {propertyName} to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.delete('propertyName', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.delete('propertyName', { objectType: 'objectType' });", - }, - python: { - method: 'crm.properties.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.delete(\n property_name="propertyName",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().properties().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.PropertyDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyDeleteParams params = PropertyDeleteParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n client.crm().properties().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Delete(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.properties.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.delete("propertyName", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->properties->delete', - example: - "crm->properties->delete(\n 'propertyName', objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', - httpMethod: 'get', - summary: 'Read a property', - description: 'Read a property identified by {propertyName}.', - stainlessPath: '(resource) crm.properties > (method) get', - qualified: 'client.crm.properties.get', - params: [ - 'objectType: string;', - 'propertyName: string;', - 'archived?: boolean;', - "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'locale?: string;', - 'properties?: string;', - ], - response: - "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", - markdown: - "## get\n\n`client.crm.properties.get(objectType: string, propertyName: string, archived?: boolean, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', locale?: string, properties?: string): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**get** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nRead a property identified by {propertyName}.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `locale?: string`\n\n- `properties?: string`\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.get('propertyName', { objectType: 'objectType' });\n\nconsole.log(property);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.get('propertyName', { objectType: 'objectType' });\n\nconsole.log(property.hidden);", - }, - python: { - method: 'crm.properties.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.get(\n property_name="propertyName",\n object_type="objectType",\n)\nprint(property.hidden)', - }, - java: { - method: 'crm().properties().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.crm.properties.PropertyGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyGetParams params = PropertyGetParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .build();\n Property property = client.crm().properties().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.Get(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', - }, - ruby: { - method: 'crm.properties.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.get("propertyName", object_type: "objectType")\n\nputs(property)', - }, - php: { - method: 'crm->properties->get', - example: - "crm->properties->get(\n 'propertyName',\n objectType: 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n locale: 'locale',\n properties: 'properties',\n);\n\nvar_dump($property);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/properties/2026-03/{objectType}', - httpMethod: 'get', - summary: 'Read all properties', - description: 'Read all existing properties for the specified object type and HubSpot account.', - stainlessPath: '(resource) crm.properties > (method) list', - qualified: 'client.crm.properties.list', - params: [ - 'objectType: string;', - 'archived?: boolean;', - "dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'locale?: string;', - 'properties?: string;', - ], - response: - "{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }", - markdown: - "## list\n\n`client.crm.properties.list(objectType: string, archived?: boolean, dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive', locale?: string, properties?: string): { results: property[]; }`\n\n**get** `/crm/properties/2026-03/{objectType}`\n\nRead all existing properties for the specified object type and HubSpot account.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `locale?: string`\n\n- `properties?: string`\n\n### Returns\n\n- `{ results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; }`\n\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyNoPaging = await client.crm.properties.list('objectType');\n\nconsole.log(collectionResponsePropertyNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyNoPaging = await client.crm.properties.list('objectType');\n\nconsole.log(collectionResponsePropertyNoPaging.results);", - }, - python: { - method: 'crm.properties.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_no_paging = client.crm.properties.list(\n object_type="objectType",\n)\nprint(collection_response_property_no_paging.results)', - }, - java: { - method: 'crm().properties().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.CollectionResponsePropertyNoPaging;\nimport com.hubspot.sdk.models.crm.properties.PropertyListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePropertyNoPaging collectionResponsePropertyNoPaging = client.crm().properties().list("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.Properties.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyNoPaging, err := client.Crm.Properties.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.properties.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_no_paging = hubspot.crm.properties.list("objectType")\n\nputs(collection_response_property_no_paging)', - }, - php: { - method: 'crm->properties->list', - example: - "crm->properties->list(\n 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n locale: 'locale',\n properties: 'properties',\n);\n\nvar_dump($collectionResponsePropertyNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/properties/2026-03/{objectType}/{propertyName}', - httpMethod: 'patch', - summary: 'Update a property', - description: - 'Perform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.', - stainlessPath: '(resource) crm.properties > (method) update', - qualified: 'client.crm.properties.update', - params: [ - 'objectType: string;', - 'propertyName: string;', - 'calculationFormula?: string;', - 'currencyPropertyName?: string;', - 'description?: string;', - 'displayOrder?: number;', - 'fieldType?: string;', - 'formField?: boolean;', - 'groupName?: string;', - 'hidden?: boolean;', - 'label?: string;', - "numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted';", - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - 'showCurrencySymbol?: boolean;', - "type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string';", - ], - response: - "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", - markdown: - "## update\n\n`client.crm.properties.update(objectType: string, propertyName: string, calculationFormula?: string, currencyPropertyName?: string, description?: string, displayOrder?: number, fieldType?: string, formField?: boolean, groupName?: string, hidden?: boolean, label?: string, numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted', options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[], showCurrencySymbol?: boolean, type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**patch** `/crm/properties/2026-03/{objectType}/{propertyName}`\n\nPerform a partial update of a property identified by { propertyName }. Provided fields will be overwritten.\n\n### Parameters\n\n- `objectType: string`\n\n- `propertyName: string`\n\n- `calculationFormula?: string`\n Represents a formula that is used to compute a calculated property.\n\n- `currencyPropertyName?: string`\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `displayOrder?: number`\n Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the Property to be displayed after any positive values.\n\n- `fieldType?: string`\n Controls how the property appears in HubSpot.\n\n- `formField?: boolean`\n Whether or not the property can be used in a HubSpot form.\n\n- `groupName?: string`\n The name of the property group the property belongs to.\n\n- `hidden?: boolean`\n If true, the property won't be visible and can't be used in HubSpot.\n\n- `label?: string`\n A human-readable property label that will be shown in HubSpot.\n\n- `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of valid options for the property.\n\n- `showCurrencySymbol?: boolean`\n\n- `type?: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'`\n The data type of the property.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.crm.properties.update('propertyName', { objectType: 'objectType' });\n\nconsole.log(property);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.crm.properties.update('propertyName', { objectType: 'objectType' });\n\nconsole.log(property.hidden);", - }, - python: { - method: 'crm.properties.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.crm.properties.update(\n property_name="propertyName",\n object_type="objectType",\n)\nprint(property.hidden)', - }, - java: { - method: 'crm().properties().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.crm.properties.PropertyUpdate;\nimport com.hubspot.sdk.models.crm.properties.PropertyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertyUpdateParams params = PropertyUpdateParams.builder()\n .objectType("objectType")\n .propertyName("propertyName")\n .propertyUpdate(PropertyUpdate.builder().build())\n .build();\n Property property = client.crm().properties().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Crm.Properties.Update(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertyUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyUpdate: crm.PropertyUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', - }, - ruby: { - method: 'crm.properties.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.crm.properties.update("propertyName", object_type: "objectType")\n\nputs(property)', - }, - php: { - method: 'crm->properties->update', - example: - "crm->properties->update(\n 'propertyName',\n objectType: 'objectType',\n calculationFormula: 'calculationFormula',\n currencyPropertyName: 'currencyPropertyName',\n description: 'description',\n displayOrder: 0,\n fieldType: 'booleancheckbox',\n formField: true,\n groupName: 'groupName',\n hidden: true,\n label: 'label',\n numberDisplayHint: 'currency',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n showCurrencySymbol: true,\n type: 'bool',\n);\n\nvar_dump($property);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create', - endpoint: '/crm/properties/2026-03/{objectType}/batch/create', - httpMethod: 'post', - summary: 'Create a batch of properties', - description: 'Create a batch of properties using the same rules as when creating an individual property.', - stainlessPath: '(resource) crm.properties.batch > (method) create', - qualified: 'client.crm.properties.batch.create', - params: [ - 'objectType: string;', - "inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[];", - ], - response: - "{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.properties.batch.create(objectType: string, inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: option_input[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]): { completedAt: string; results: property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/create`\n\nCreate a batch of properties using the same rules as when creating an individual property.\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { fieldType: string; groupName: string; label: string; name: string; type: 'bool' | 'date' | 'datetime' | 'enumeration' | 'number' | 'phone_number' | 'string'; calculationFormula?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; description?: string; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; referencedObjectType?: string; showCurrencySymbol?: boolean; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.crm.properties.batch.create('objectType', { inputs: [{\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n}] });\n\nconsole.log(batchResponseProperty);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.crm.properties.batch.create('objectType', {\n inputs: [\n {\n fieldType: 'booleancheckbox',\n groupName: 'groupName',\n label: 'label',\n name: 'name',\n type: 'bool',\n },\n ],\n});\n\nconsole.log(batchResponseProperty.completedAt);", - }, - python: { - method: 'crm.properties.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.crm.properties.batch.create(\n object_type="objectType",\n inputs=[{\n "field_type": "booleancheckbox",\n "group_name": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool",\n }],\n)\nprint(batch_response_property.completed_at)', - }, - java: { - method: 'crm().properties().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyCreate;\nimport com.hubspot.sdk.models.PropertyCreate;\nimport com.hubspot.sdk.models.crm.properties.BatchResponseProperty;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchCreateParams params = BatchCreateParams.builder()\n .objectType("objectType")\n .batchInputPropertyCreate(BatchInputPropertyCreate.builder()\n .addInput(PropertyCreate.builder()\n .fieldType(PropertyCreate.FieldType.BOOLEANCHECKBOX)\n .groupName("groupName")\n .label("label")\n .name("name")\n .type(PropertyCreate.Type.BOOL)\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.crm().properties().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Crm.Properties.Batch.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchNewParams{\n\t\t\tBatchInputPropertyCreate: shared.BatchInputPropertyCreateParam{\n\t\t\t\tInputs: []shared.PropertyCreateParam{{\n\t\t\t\t\tFieldType: shared.PropertyCreateFieldTypeBooleancheckbox,\n\t\t\t\t\tGroupName: "groupName",\n\t\t\t\t\tLabel: "label",\n\t\t\t\t\tName: "name",\n\t\t\t\t\tType: shared.PropertyCreateTypeBool,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.properties.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.crm.properties.batch.create(\n "objectType",\n inputs: [{fieldType: :booleancheckbox, groupName: "groupName", label: "label", name: "name", type: :bool}]\n)\n\nputs(batch_response_property)', - }, - php: { - method: 'crm->properties->batch->create', - example: - "crm->properties->batch->create(\n 'objectType',\n inputs: [\n [\n 'fieldType' => 'booleancheckbox',\n 'groupName' => 'groupName',\n 'label' => 'label',\n 'name' => 'name',\n 'type' => 'bool',\n 'calculationFormula' => 'calculationFormula',\n 'currencyPropertyName' => 'currencyPropertyName',\n 'dataSensitivity' => 'highly_sensitive',\n 'description' => 'description',\n 'displayOrder' => 0,\n 'externalOptions' => true,\n 'formField' => true,\n 'hasUniqueValue' => true,\n 'hidden' => true,\n 'numberDisplayHint' => 'currency',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n 'referencedObjectType' => 'referencedObjectType',\n 'showCurrencySymbol' => true,\n ],\n ],\n);\n\nvar_dump($batchResponseProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "fieldType": "booleancheckbox",\n "groupName": "groupName",\n "label": "label",\n "name": "name",\n "type": "bool"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/properties/2026-03/{objectType}/batch/archive', - httpMethod: 'post', - summary: 'Archive a batch of properties', - description: - 'Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).', - stainlessPath: '(resource) crm.properties.batch > (method) delete', - qualified: 'client.crm.properties.batch.delete', - params: ['objectType: string;', 'inputs: { name: string; }[];'], - markdown: - "## delete\n\n`client.crm.properties.batch.delete(objectType: string, inputs: { name: string; }[]): void`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/archive`\n\nArchive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent).\n\n### Parameters\n\n- `objectType: string`\n\n- `inputs: { name: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.batch.delete('objectType', { inputs: [{ name: 'name' }] })\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.batch.delete('objectType', { inputs: [{ name: 'name' }] });", - }, - python: { - method: 'crm.properties.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.batch.delete(\n object_type="objectType",\n inputs=[{\n "name": "name"\n }],\n)', - }, - java: { - method: 'crm().properties().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchDeleteParams params = BatchDeleteParams.builder()\n .objectType("objectType")\n .batchInputPropertyName(BatchInputPropertyName.builder()\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n client.crm().properties().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Batch.Delete(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchDeleteParams{\n\t\t\tBatchInputPropertyName: shared.BatchInputPropertyNameParam{\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.properties.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.batch.delete("objectType", inputs: [{name: "name"}])\n\nputs(result)', - }, - php: { - method: 'crm->properties->batch->delete', - example: - "crm->properties->batch->delete(\n 'objectType', inputs: [['name' => 'name']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/properties/2026-03/{objectType}/batch/read', - httpMethod: 'post', - summary: 'Read a batch of properties', - description: 'Read a provided list of properties.', - stainlessPath: '(resource) crm.properties.batch > (method) get', - qualified: 'client.crm.properties.batch.get', - params: [ - 'objectType: string;', - 'archived: boolean;', - "dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive';", - 'inputs: { name: string; }[];', - 'locale?: string;', - ], - response: - "{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.crm.properties.batch.get(objectType: string, archived: boolean, dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive', inputs: { name: string; }[], locale?: string): { completedAt: string; results: property[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/crm/properties/2026-03/{objectType}/batch/read`\n\nRead a provided list of properties.\n\n### Parameters\n\n- `objectType: string`\n\n- `archived: boolean`\n\n- `dataSensitivity: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n\n- `inputs: { name: string; }[]`\n\n- `locale?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseProperty = await client.crm.properties.batch.get('objectType', {\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseProperty = await client.crm.properties.batch.get('objectType', {\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [{ name: 'name' }],\n});\n\nconsole.log(batchResponseProperty.completedAt);", - }, - python: { - method: 'crm.properties.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_property = client.crm.properties.batch.get(\n object_type="objectType",\n archived=True,\n data_sensitivity="highly_sensitive",\n inputs=[{\n "name": "name"\n }],\n)\nprint(batch_response_property.completed_at)', - }, - java: { - method: 'crm().properties().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchReadInputPropertyName;\nimport com.hubspot.sdk.models.PropertyName;\nimport com.hubspot.sdk.models.crm.properties.BatchResponseProperty;\nimport com.hubspot.sdk.models.crm.properties.batch.BatchGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchGetParams params = BatchGetParams.builder()\n .objectType("objectType")\n .batchReadInputPropertyName(BatchReadInputPropertyName.builder()\n .archived(true)\n .dataSensitivity(BatchReadInputPropertyName.DataSensitivity.HIGHLY_SENSITIVE)\n .addInput(PropertyName.builder()\n .name("name")\n .build())\n .build())\n .build();\n BatchResponseProperty batchResponseProperty = client.crm().properties().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseProperty, err := client.Crm.Properties.Batch.Get(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyBatchGetParams{\n\t\t\tBatchReadInputPropertyName: shared.BatchReadInputPropertyNameParam{\n\t\t\t\tArchived: true,\n\t\t\t\tDataSensitivity: shared.BatchReadInputPropertyNameDataSensitivityHighlySensitive,\n\t\t\t\tInputs: []shared.PropertyNameParam{{\n\t\t\t\t\tName: "name",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseProperty.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.properties.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_property = hubspot.crm.properties.batch.get(\n "objectType",\n archived: true,\n data_sensitivity: :highly_sensitive,\n inputs: [{name: "name"}]\n)\n\nputs(batch_response_property)', - }, - php: { - method: 'crm->properties->batch->get', - example: - "crm->properties->batch->get(\n 'objectType',\n archived: true,\n dataSensitivity: 'highly_sensitive',\n inputs: [['name' => 'name']],\n locale: 'locale',\n);\n\nvar_dump($batchResponseProperty);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "archived": true,\n "dataSensitivity": "highly_sensitive",\n "inputs": [\n {\n "name": "name"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/crm/properties/2026-03/{objectType}/groups', - httpMethod: 'post', - summary: 'Create a property group', - description: 'Create and return a copy of a new property group.', - stainlessPath: '(resource) crm.properties.groups > (method) create', - qualified: 'client.crm.properties.groups.create', - params: ['objectType: string;', 'label: string;', 'name: string;', 'displayOrder?: number;'], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## create\n\n`client.crm.properties.groups.create(objectType: string, label: string, name: string, displayOrder?: number): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**post** `/crm/properties/2026-03/{objectType}/groups`\n\nCreate and return a copy of a new property group.\n\n### Parameters\n\n- `objectType: string`\n\n- `label: string`\n\n- `name: string`\n\n- `displayOrder?: number`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.create('objectType', { label: 'label', name: 'name' });\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.groups.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.create('objectType', {\n label: 'label',\n name: 'name',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'crm.properties.groups.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.create(\n object_type="objectType",\n label="label",\n name="name",\n)\nprint(property_group.archived)', - }, - java: { - method: 'crm().properties().groups().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupCreate;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupCreateParams params = GroupCreateParams.builder()\n .objectType("objectType")\n .propertyGroupCreate(PropertyGroupCreate.builder()\n .label("label")\n .name("name")\n .build())\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Groups.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.New(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyGroupNewParams{\n\t\t\tPropertyGroupCreate: shared.PropertyGroupCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tName: "name",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'crm.properties.groups.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.create("objectType", label: "label", name: "name")\n\nputs(property_group)', - }, - php: { - method: 'crm->properties->groups->create', - example: - "crm->properties->groups->create(\n 'objectType', label: 'label', name: 'name', displayOrder: 0\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - httpMethod: 'delete', - summary: 'Archive a property group', - description: 'Move a property group identified by {groupName} to the recycling bin.', - stainlessPath: '(resource) crm.properties.groups > (method) delete', - qualified: 'client.crm.properties.groups.delete', - params: ['objectType: string;', 'groupName: string;'], - markdown: - "## delete\n\n`client.crm.properties.groups.delete(objectType: string, groupName: string): void`\n\n**delete** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nMove a property group identified by {groupName} to the recycling bin.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.properties.groups.delete('groupName', { objectType: 'objectType' })\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.groups.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.properties.groups.delete('groupName', { objectType: 'objectType' });", - }, - python: { - method: 'crm.properties.groups.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties.groups.delete(\n group_name="groupName",\n object_type="objectType",\n)', - }, - java: { - method: 'crm().properties().groups().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupDeleteParams params = GroupDeleteParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .build();\n client.crm().properties().groups().delete(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Groups.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Properties.Groups.Delete(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupDeleteParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.properties.groups.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties.groups.delete("groupName", object_type: "objectType")\n\nputs(result)', - }, - php: { - method: 'crm->properties->groups->delete', - example: - "crm->properties->groups->delete(\n 'groupName', objectType: 'objectType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - httpMethod: 'get', - summary: 'Read a property group', - description: 'Read a property group identified by {groupName}.', - stainlessPath: '(resource) crm.properties.groups > (method) get', - qualified: 'client.crm.properties.groups.get', - params: ['objectType: string;', 'groupName: string;', 'locale?: string;'], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## get\n\n`client.crm.properties.groups.get(objectType: string, groupName: string, locale?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**get** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nRead a property group identified by {groupName}.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `locale?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.get('groupName', { objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.groups.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.get('groupName', {\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'crm.properties.groups.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.get(\n group_name="groupName",\n object_type="objectType",\n)\nprint(property_group.archived)', - }, - java: { - method: 'crm().properties().groups().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupGetParams params = GroupGetParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().get(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Groups.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.Get(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupGetParams{\n\t\t\tObjectType: "objectType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'crm.properties.groups.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.get("groupName", object_type: "objectType")\n\nputs(property_group)', - }, - php: { - method: 'crm->properties->groups->get', - example: - "crm->properties->groups->get(\n 'groupName', objectType: 'objectType', locale: 'locale'\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/crm/properties/2026-03/{objectType}/groups', - httpMethod: 'get', - summary: 'Read all property groups', - description: 'Read all existing property groups for the specified object type and HubSpot account.', - stainlessPath: '(resource) crm.properties.groups > (method) list', - qualified: 'client.crm.properties.groups.list', - params: ['objectType: string;', 'locale?: string;'], - response: '{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }', - markdown: - "## list\n\n`client.crm.properties.groups.list(objectType: string, locale?: string): { results: property_group[]; }`\n\n**get** `/crm/properties/2026-03/{objectType}/groups`\n\nRead all existing property groups for the specified object type and HubSpot account.\n\n### Parameters\n\n- `objectType: string`\n\n- `locale?: string`\n\n### Returns\n\n- `{ results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]; }`\n\n - `results: { archived: boolean; label: string; name: string; displayOrder?: number; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePropertyGroupNoPaging = await client.crm.properties.groups.list('objectType');\n\nconsole.log(collectionResponsePropertyGroupNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.groups.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePropertyGroupNoPaging = await client.crm.properties.groups.list(\n 'objectType',\n);\n\nconsole.log(collectionResponsePropertyGroupNoPaging.results);", - }, - python: { - method: 'crm.properties.groups.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_property_group_no_paging = client.crm.properties.groups.list(\n object_type="objectType",\n)\nprint(collection_response_property_group_no_paging.results)', - }, - java: { - method: 'crm().properties().groups().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.CollectionResponsePropertyGroupNoPaging;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePropertyGroupNoPaging collectionResponsePropertyGroupNoPaging = client.crm().properties().groups().list("objectType");\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Groups.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePropertyGroupNoPaging, err := client.Crm.Properties.Groups.List(\n\t\tcontext.TODO(),\n\t\t"objectType",\n\t\tcrm.PropertyGroupListParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePropertyGroupNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.properties.groups.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_property_group_no_paging = hubspot.crm.properties.groups.list("objectType")\n\nputs(collection_response_property_group_no_paging)', - }, - php: { - method: 'crm->properties->groups->list', - example: - "crm\n ->properties\n ->groups\n ->list('objectType', locale: 'locale');\n\nvar_dump($collectionResponsePropertyGroupNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - httpMethod: 'patch', - summary: 'Update a property group', - description: - 'Perform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.', - stainlessPath: '(resource) crm.properties.groups > (method) update', - qualified: 'client.crm.properties.groups.update', - params: ['objectType: string;', 'groupName: string;', 'displayOrder?: number;', 'label?: string;'], - response: '{ archived: boolean; label: string; name: string; displayOrder?: number; }', - markdown: - "## update\n\n`client.crm.properties.groups.update(objectType: string, groupName: string, displayOrder?: number, label?: string): { archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n**patch** `/crm/properties/2026-03/{objectType}/groups/{groupName}`\n\nPerform a partial update of a property group identified by {groupName}. Provided fields will be overwritten.\n\n### Parameters\n\n- `objectType: string`\n\n- `groupName: string`\n\n- `displayOrder?: number`\n\n- `label?: string`\n\n### Returns\n\n- `{ archived: boolean; label: string; name: string; displayOrder?: number; }`\n\n - `archived: boolean`\n - `label: string`\n - `name: string`\n - `displayOrder?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst propertyGroup = await client.crm.properties.groups.update('groupName', { objectType: 'objectType' });\n\nconsole.log(propertyGroup);\n```", - perLanguage: { - typescript: { - method: 'client.crm.properties.groups.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst propertyGroup = await client.crm.properties.groups.update('groupName', {\n objectType: 'objectType',\n});\n\nconsole.log(propertyGroup.archived);", - }, - python: { - method: 'crm.properties.groups.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty_group = client.crm.properties.groups.update(\n group_name="groupName",\n object_type="objectType",\n)\nprint(property_group.archived)', - }, - java: { - method: 'crm().properties().groups().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyGroup;\nimport com.hubspot.sdk.models.PropertyGroupUpdate;\nimport com.hubspot.sdk.models.crm.properties.groups.GroupUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n GroupUpdateParams params = GroupUpdateParams.builder()\n .objectType("objectType")\n .groupName("groupName")\n .propertyGroupUpdate(PropertyGroupUpdate.builder().build())\n .build();\n PropertyGroup propertyGroup = client.crm().properties().groups().update(params);\n }\n}', - }, - go: { - method: 'client.Crm.Properties.Groups.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpropertyGroup, err := client.Crm.Properties.Groups.Update(\n\t\tcontext.TODO(),\n\t\t"groupName",\n\t\tcrm.PropertyGroupUpdateParams{\n\t\t\tObjectType: "objectType",\n\t\t\tPropertyGroupUpdate: shared.PropertyGroupUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", propertyGroup.Archived)\n}\n', - }, - ruby: { - method: 'crm.properties.groups.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty_group = hubspot.crm.properties.groups.update("groupName", object_type: "objectType")\n\nputs(property_group)', - }, - php: { - method: 'crm->properties->groups->update', - example: - "crm->properties->groups->update(\n 'groupName', objectType: 'objectType', displayOrder: 0, label: 'label'\n);\n\nvar_dump($propertyGroup);", - }, - http: { - example: - "curl https://api.hubapi.com/crm/properties/2026-03/$OBJECT_TYPE/groups/$GROUP_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'get_by_object_type_id', - endpoint: '/crm/property-validations/2026-03/{objectTypeId}', - httpMethod: 'get', - summary: 'Read all property validation rules for an object', - description: 'Read all properties with validation rules for a given object.', - stainlessPath: '(resource) crm.properties_validations > (method) get_by_object_type_id', - qualified: 'client.crm.propertiesValidations.getByObjectTypeID', - params: ['objectTypeId: string;'], - response: - '{ results: { propertyName: string; propertyValidationRules: public_property_validation_rule[]; }[]; }', - markdown: - "## get_by_object_type_id\n\n`client.crm.propertiesValidations.getByObjectTypeID(objectTypeId: string): { results: public_property_validation_rule_map[]; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}`\n\nRead all properties with validation rules for a given object.\n\n### Parameters\n\n- `objectTypeId: string`\n\n### Returns\n\n- `{ results: { propertyName: string; propertyValidationRules: public_property_validation_rule[]; }[]; }`\n\n - `results: { propertyName: string; propertyValidationRules: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPropertyValidationRuleMapNoPaging = await client.crm.propertiesValidations.getByObjectTypeID('objectTypeId');\n\nconsole.log(collectionResponsePublicPropertyValidationRuleMapNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.propertiesValidations.getByObjectTypeID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPropertyValidationRuleMapNoPaging =\n await client.crm.propertiesValidations.getByObjectTypeID('objectTypeId');\n\nconsole.log(collectionResponsePublicPropertyValidationRuleMapNoPaging.results);", - }, - python: { - method: 'crm.properties_validations.get_by_object_type_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_property_validation_rule_map_no_paging = client.crm.properties_validations.get_by_object_type_id(\n "objectTypeId",\n)\nprint(collection_response_public_property_validation_rule_map_no_paging.results)', - }, - java: { - method: 'crm().propertiesValidations().getByObjectTypeId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.CollectionResponsePublicPropertyValidationRuleMapNoPaging;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicPropertyValidationRuleMapNoPaging collectionResponsePublicPropertyValidationRuleMapNoPaging = client.crm().propertiesValidations().getByObjectTypeId("objectTypeId");\n }\n}', - }, - go: { - method: 'client.Crm.PropertiesValidations.GetByObjectTypeID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPropertyValidationRuleMapNoPaging, err := client.Crm.PropertiesValidations.GetByObjectTypeID(context.TODO(), "objectTypeId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPropertyValidationRuleMapNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.properties_validations.get_by_object_type_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_property_validation_rule_map_no_paging = hubspot.crm.properties_validations.get_by_object_type_id("objectTypeId")\n\nputs(collection_response_public_property_validation_rule_map_no_paging)', - }, - php: { - method: 'crm->propertiesValidations->getByObjectTypeID', - example: - "crm\n ->propertiesValidations\n ->getByObjectTypeID('objectTypeId');\n\nvar_dump($collectionResponsePublicPropertyValidationRuleMapNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_object_type_id_and_property_name', - endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}', - httpMethod: 'get', - summary: 'Read validation rules for a property', - description: "Read a property's validation rules identified by {propertyName}.", - stainlessPath: '(resource) crm.properties_validations > (method) get_by_object_type_id_and_property_name', - qualified: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', - params: ['objectTypeId: string;', 'propertyName: string;'], - response: - '{ results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }', - markdown: - "## get_by_object_type_id_and_property_name\n\n`client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName(objectTypeId: string, propertyName: string): { results: public_property_validation_rule[]; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}`\n\nRead a property's validation rules identified by {propertyName}.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n### Returns\n\n- `{ results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]; }`\n\n - `results: { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPropertyValidationRuleNoPaging = await client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName('propertyName', { objectTypeId: 'objectTypeId' });\n\nconsole.log(collectionResponsePublicPropertyValidationRuleNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPropertyValidationRuleNoPaging =\n await client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName('propertyName', {\n objectTypeId: 'objectTypeId',\n });\n\nconsole.log(collectionResponsePublicPropertyValidationRuleNoPaging.results);", - }, - python: { - method: 'crm.properties_validations.get_by_object_type_id_and_property_name', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_property_validation_rule_no_paging = client.crm.properties_validations.get_by_object_type_id_and_property_name(\n property_name="propertyName",\n object_type_id="objectTypeId",\n)\nprint(collection_response_public_property_validation_rule_no_paging.results)', - }, - java: { - method: 'crm().propertiesValidations().getByObjectTypeIdAndPropertyName', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.CollectionResponsePublicPropertyValidationRuleNoPaging;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdAndPropertyNameParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationGetByObjectTypeIdAndPropertyNameParams params = PropertiesValidationGetByObjectTypeIdAndPropertyNameParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .build();\n CollectionResponsePublicPropertyValidationRuleNoPaging collectionResponsePublicPropertyValidationRuleNoPaging = client.crm().propertiesValidations().getByObjectTypeIdAndPropertyName(params);\n }\n}', - }, - go: { - method: 'client.Crm.PropertiesValidations.GetByObjectTypeIDAndPropertyName', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPropertyValidationRuleNoPaging, err := client.Crm.PropertiesValidations.GetByObjectTypeIDAndPropertyName(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tcrm.PropertiesValidationGetByObjectTypeIDAndPropertyNameParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPropertyValidationRuleNoPaging.Results)\n}\n', - }, - ruby: { - method: 'crm.properties_validations.get_by_object_type_id_and_property_name', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_property_validation_rule_no_paging = hubspot.crm.properties_validations.get_by_object_type_id_and_property_name(\n "propertyName",\n object_type_id: "objectTypeId"\n)\n\nputs(collection_response_public_property_validation_rule_no_paging)', - }, - php: { - method: 'crm->propertiesValidations->getByObjectTypeIDAndPropertyName', - example: - "crm\n ->propertiesValidations\n ->getByObjectTypeIDAndPropertyName(\n 'propertyName', objectTypeID: 'objectTypeId'\n);\n\nvar_dump($collectionResponsePublicPropertyValidationRuleNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_object_type_id_property_name_and_rule_type', - endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', - httpMethod: 'get', - summary: - 'Retrieve a validation rule for a specific property and rule type, providing details on how property values should be formatted.', - description: 'Retrieve a specific validation rule for a property identified by its name and rule type.', - stainlessPath: - '(resource) crm.properties_validations > (method) get_by_object_type_id_property_name_and_rule_type', - qualified: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', - params: ['objectTypeId: string;', 'propertyName: string;', 'ruleType: string;'], - response: '{ ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }', - markdown: - "## get_by_object_type_id_property_name_and_rule_type\n\n`client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType(objectTypeId: string, propertyName: string, ruleType: string): { ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }`\n\n**get** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}`\n\nRetrieve a specific validation rule for a property identified by its name and rule type.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n- `ruleType: string`\n\n### Returns\n\n- `{ ruleArguments: string[]; ruleType: string; shouldApplyNormalization?: boolean; }`\n\n - `ruleArguments: string[]`\n - `ruleType: string`\n - `shouldApplyNormalization?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicPropertyValidationRule = await client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType('AFTER_DATETIME_DURATION', { objectTypeId: 'objectTypeId', propertyName: 'propertyName' });\n\nconsole.log(publicPropertyValidationRule);\n```", - perLanguage: { - typescript: { - method: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicPropertyValidationRule =\n await client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n { objectTypeId: 'objectTypeId', propertyName: 'propertyName' },\n );\n\nconsole.log(publicPropertyValidationRule.ruleArguments);", - }, - python: { - method: 'crm.properties_validations.get_by_object_type_id_property_name_and_rule_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_property_validation_rule = client.crm.properties_validations.get_by_object_type_id_property_name_and_rule_type(\n rule_type="AFTER_DATETIME_DURATION",\n object_type_id="objectTypeId",\n property_name="propertyName",\n)\nprint(public_property_validation_rule.rule_arguments)', - }, - java: { - method: 'crm().propertiesValidations().getByObjectTypeIdPropertyNameAndRuleType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PublicPropertyValidationRule;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams params = PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .ruleType(PropertiesValidationGetByObjectTypeIdPropertyNameAndRuleTypeParams.RuleType.AFTER_DATETIME_DURATION)\n .build();\n PublicPropertyValidationRule publicPropertyValidationRule = client.crm().propertiesValidations().getByObjectTypeIdPropertyNameAndRuleType(params);\n }\n}', - }, - go: { - method: 'client.Crm.PropertiesValidations.GetByObjectTypeIDPropertyNameAndRuleType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicPropertyValidationRule, err := client.Crm.PropertiesValidations.GetByObjectTypeIDPropertyNameAndRuleType(\n\t\tcontext.TODO(),\n\t\tcrm.PropertiesValidationGetByObjectTypeIDPropertyNameAndRuleTypeParamsRuleTypeAfterDatetimeDuration,\n\t\tcrm.PropertiesValidationGetByObjectTypeIDPropertyNameAndRuleTypeParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tPropertyName: "propertyName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicPropertyValidationRule.RuleArguments)\n}\n', - }, - ruby: { - method: 'crm.properties_validations.get_by_object_type_id_property_name_and_rule_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_property_validation_rule = hubspot.crm.properties_validations.get_by_object_type_id_property_name_and_rule_type(\n :AFTER_DATETIME_DURATION,\n object_type_id: "objectTypeId",\n property_name: "propertyName"\n)\n\nputs(public_property_validation_rule)', - }, - php: { - method: 'crm->propertiesValidations->getByObjectTypeIDPropertyNameAndRuleType', - example: - "crm\n ->propertiesValidations\n ->getByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n);\n\nvar_dump($publicPropertyValidationRule);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME/rule-type/$RULE_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_by_object_type_id_property_name_and_rule_type', - endpoint: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', - httpMethod: 'put', - summary: - 'Update a validation rule for a specific property and rule type, allowing customization of property value constraints.', - description: 'Update a specific validation rule for a property identified by its name and rule type.', - stainlessPath: - '(resource) crm.properties_validations > (method) update_by_object_type_id_property_name_and_rule_type', - qualified: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', - params: [ - 'objectTypeId: string;', - 'propertyName: string;', - 'ruleType: string;', - 'ruleArguments: string[];', - 'shouldApplyNormalization?: boolean;', - ], - markdown: - "## update_by_object_type_id_property_name_and_rule_type\n\n`client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType(objectTypeId: string, propertyName: string, ruleType: string, ruleArguments: string[], shouldApplyNormalization?: boolean): void`\n\n**put** `/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}`\n\nUpdate a specific validation rule for a property identified by its name and rule type.\n\n### Parameters\n\n- `objectTypeId: string`\n\n- `propertyName: string`\n\n- `ruleType: string`\n\n- `ruleArguments: string[]`\n A list of arguments that define the constraints for the validation rule.\n\n- `shouldApplyNormalization?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType('AFTER_DATETIME_DURATION', {\n objectTypeId: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n})\n```", - perLanguage: { - typescript: { - method: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n {\n objectTypeId: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n },\n);", - }, - python: { - method: 'crm.properties_validations.update_by_object_type_id_property_name_and_rule_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.properties_validations.update_by_object_type_id_property_name_and_rule_type(\n rule_type="AFTER_DATETIME_DURATION",\n object_type_id="objectTypeId",\n property_name="propertyName",\n rule_arguments=["string"],\n)', - }, - java: { - method: 'crm().propertiesValidations().updateByObjectTypeIdPropertyNameAndRuleType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams;\nimport com.hubspot.sdk.models.crm.propertiesvalidations.PublicPropertyValidationRuleUpdate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams params = PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams.builder()\n .objectTypeId("objectTypeId")\n .propertyName("propertyName")\n .ruleType(PropertiesValidationUpdateByObjectTypeIdPropertyNameAndRuleTypeParams.RuleType.AFTER_DATETIME_DURATION)\n .publicPropertyValidationRuleUpdate(PublicPropertyValidationRuleUpdate.builder()\n .addRuleArgument("string")\n .build())\n .build();\n client.crm().propertiesValidations().updateByObjectTypeIdPropertyNameAndRuleType(params);\n }\n}', - }, - go: { - method: 'client.Crm.PropertiesValidations.UpdateByObjectTypeIDPropertyNameAndRuleType', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.PropertiesValidations.UpdateByObjectTypeIDPropertyNameAndRuleType(\n\t\tcontext.TODO(),\n\t\tcrm.PropertiesValidationUpdateByObjectTypeIDPropertyNameAndRuleTypeParamsRuleTypeAfterDatetimeDuration,\n\t\tcrm.PropertiesValidationUpdateByObjectTypeIDPropertyNameAndRuleTypeParams{\n\t\t\tObjectTypeID: "objectTypeId",\n\t\t\tPropertyName: "propertyName",\n\t\t\tPublicPropertyValidationRuleUpdate: crm.PublicPropertyValidationRuleUpdateParam{\n\t\t\t\tRuleArguments: []string{"string"},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.properties_validations.update_by_object_type_id_property_name_and_rule_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.properties_validations.update_by_object_type_id_property_name_and_rule_type(\n :AFTER_DATETIME_DURATION,\n object_type_id: "objectTypeId",\n property_name: "propertyName",\n rule_arguments: ["string"]\n)\n\nputs(result)', - }, - php: { - method: 'crm->propertiesValidations->updateByObjectTypeIDPropertyNameAndRuleType', - example: - "crm\n ->propertiesValidations\n ->updateByObjectTypeIDPropertyNameAndRuleType(\n 'AFTER_DATETIME_DURATION',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n ruleArguments: ['string'],\n shouldApplyNormalization: true,\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/crm/property-validations/2026-03/$OBJECT_TYPE_ID/$PROPERTY_NAME/rule-type/$RULE_TYPE \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "ruleArguments": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'create_event', - endpoint: '/integrators/timeline/2026-03/events', - httpMethod: 'post', - summary: 'Send event data (single)', - description: 'Send a single instance of event data to a specified event type.', - stainlessPath: '(resource) crm.timeline > (method) create_event', - qualified: 'client.crm.timeline.createEvent', - params: [ - 'id: string;', - 'eventTypeName: string;', - 'properties: object;', - 'domain?: string;', - 'email?: string;', - 'extraData?: object;', - 'objectId?: string;', - 'objectTypeFullyQualifiedName?: string;', - 'timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; };', - 'timestamp?: string;', - 'utk?: string;', - ], - markdown: - "## create_event\n\n`client.crm.timeline.createEvent(id: string, eventTypeName: string, properties: object, domain?: string, email?: string, extraData?: object, objectId?: string, objectTypeFullyQualifiedName?: string, timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }, timestamp?: string, utk?: string): void`\n\n**post** `/integrators/timeline/2026-03/events`\n\nSend a single instance of event data to a specified event type.\n\n### Parameters\n\n- `id: string`\n\n- `eventTypeName: string`\n\n- `properties: object`\n\n- `domain?: string`\n\n- `email?: string`\n\n- `extraData?: object`\n\n- `objectId?: string`\n\n- `objectTypeFullyQualifiedName?: string`\n\n- `timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }`\n - `headerLabel: string`\n The label of the modal window that displays the iframe contents.\n - `height: number`\n The height of the modal window in pixels.\n - `linkLabel: string`\n The text displaying the link that will display the iframe.\n - `url: string`\n The URI of the iframe contents.\n - `width: number`\n The width of the modal window in pixels.\n\n- `timestamp?: string`\n\n- `utk?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.crm.timeline.createEvent({\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n})\n```", - perLanguage: { - typescript: { - method: 'client.crm.timeline.createEvent', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.crm.timeline.createEvent({\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n});", - }, - python: { - method: 'crm.timeline.create_event', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.crm.timeline.create_event(\n id="id",\n event_type_name="eventTypeName",\n properties={\n "foo": "string"\n },\n)', - }, - java: { - method: 'crm().timeline().createEvent', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.timeline.AppEventOccurrence;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AppEventOccurrence params = AppEventOccurrence.builder()\n .id("id")\n .eventTypeName("eventTypeName")\n .properties(AppEventOccurrence.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n client.crm().timeline().createEvent(params);\n }\n}', - }, - go: { - method: 'client.Crm.Timeline.NewEvent', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Crm.Timeline.NewEvent(context.TODO(), crm.TimelineNewEventParams{\n\t\tAppEventOccurrence: crm.AppEventOccurrenceParam{\n\t\t\tID: "id",\n\t\t\tEventTypeName: "eventTypeName",\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'crm.timeline.create_event', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.crm.timeline.create_event(id: "id", event_type_name: "eventTypeName", properties: {foo: "string"})\n\nputs(result)', - }, - php: { - method: 'crm->timeline->createEvent', - example: - "crm->timeline->createEvent(\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: ['foo' => 'string'],\n domain: 'domain',\n email: 'email',\n extraData: (object) [],\n objectID: 'objectId',\n objectTypeFullyQualifiedName: 'objectTypeFullyQualifiedName',\n timelineIFrame: [\n 'headerLabel' => 'headerLabel',\n 'height' => 0,\n 'linkLabel' => 'linkLabel',\n 'url' => 'url',\n 'width' => 0,\n ],\n timestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n utk: 'utk',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/integrators/timeline/2026-03/events \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id",\n "eventTypeName": "eventTypeName",\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create_project_type', - endpoint: '/integrators/timeline/2026-03/types/projects', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.timeline > (method) create_project_type', - qualified: 'client.crm.timeline.createProjectType', - params: ['developerSymbol: string;', 'projectName: string;'], - response: - '{ developerQualifiedSymbol: { developerSymbol: string; projectName: string; }; fullyQualifiedName: string; }', - markdown: - "## create_project_type\n\n`client.crm.timeline.createProjectType(developerSymbol: string, projectName: string): { developerQualifiedSymbol: developer_qualified_symbol; fullyQualifiedName: string; }`\n\n**post** `/integrators/timeline/2026-03/types/projects`\n\n### Parameters\n\n- `developerSymbol: string`\n\n- `projectName: string`\n\n### Returns\n\n- `{ developerQualifiedSymbol: { developerSymbol: string; projectName: string; }; fullyQualifiedName: string; }`\n\n - `developerQualifiedSymbol: { developerSymbol: string; projectName: string; }`\n - `fullyQualifiedName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst appEventResolutionResponse = await client.crm.timeline.createProjectType({ developerSymbol: 'developerSymbol', projectName: 'projectName' });\n\nconsole.log(appEventResolutionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.crm.timeline.createProjectType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst appEventResolutionResponse = await client.crm.timeline.createProjectType({\n developerSymbol: 'developerSymbol',\n projectName: 'projectName',\n});\n\nconsole.log(appEventResolutionResponse.developerQualifiedSymbol);", - }, - python: { - method: 'crm.timeline.create_project_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\napp_event_resolution_response = client.crm.timeline.create_project_type(\n developer_symbol="developerSymbol",\n project_name="projectName",\n)\nprint(app_event_resolution_response.developer_qualified_symbol)', - }, - java: { - method: 'crm().timeline().createProjectType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.timeline.AppEventResolutionResponse;\nimport com.hubspot.sdk.models.crm.timeline.ExternalAppEventResolutionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalAppEventResolutionRequest params = ExternalAppEventResolutionRequest.builder()\n .developerSymbol("developerSymbol")\n .projectName("projectName")\n .build();\n AppEventResolutionResponse appEventResolutionResponse = client.crm().timeline().createProjectType(params);\n }\n}', - }, - go: { - method: 'client.Crm.Timeline.NewProjectType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tappEventResolutionResponse, err := client.Crm.Timeline.NewProjectType(context.TODO(), crm.TimelineNewProjectTypeParams{\n\t\tExternalAppEventResolutionRequest: crm.ExternalAppEventResolutionRequestParam{\n\t\t\tDeveloperSymbol: "developerSymbol",\n\t\t\tProjectName: "projectName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", appEventResolutionResponse.DeveloperQualifiedSymbol)\n}\n', - }, - ruby: { - method: 'crm.timeline.create_project_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\napp_event_resolution_response = hubspot.crm.timeline.create_project_type(developer_symbol: "developerSymbol", project_name: "projectName")\n\nputs(app_event_resolution_response)', - }, - php: { - method: 'crm->timeline->createProjectType', - example: - "crm->timeline->createProjectType(\n developerSymbol: 'developerSymbol', projectName: 'projectName'\n);\n\nvar_dump($appEventResolutionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/integrators/timeline/2026-03/types/projects \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "developerSymbol": "developerSymbol",\n "projectName": "projectName"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/integrators/timeline/2026-03/events/batch', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) crm.timeline.batch > (method) create', - qualified: 'client.crm.timeline.batch.create', - params: [ - 'inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[];', - ], - response: - "{ completedAt: string; results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create\n\n`client.crm.timeline.batch.create(inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]): { completedAt: string; results: app_event_occurrence[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/integrators/timeline/2026-03/events/batch`\n\n### Parameters\n\n- `inputs: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: timeline_event_i_frame; timestamp?: string; utk?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; eventTypeName: string; properties: object; domain?: string; email?: string; extraData?: object; objectId?: string; objectTypeFullyQualifiedName?: string; timelineIFrame?: { headerLabel: string; height: number; linkLabel: string; url: string; width: number; }; timestamp?: string; utk?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseAppEventOccurrence = await client.crm.timeline.batch.create({ inputs: [{\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseAppEventOccurrence);\n```", - perLanguage: { - typescript: { - method: 'client.crm.timeline.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseAppEventOccurrence = await client.crm.timeline.batch.create({\n inputs: [\n {\n id: 'id',\n eventTypeName: 'eventTypeName',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponseAppEventOccurrence.completedAt);", - }, - python: { - method: 'crm.timeline.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_app_event_occurrence = client.crm.timeline.batch.create(\n inputs=[{\n "id": "id",\n "event_type_name": "eventTypeName",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_app_event_occurrence.completed_at)', - }, - java: { - method: 'crm().timeline().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.timeline.AppEventOccurrence;\nimport com.hubspot.sdk.models.crm.timeline.BatchInputAppEventOccurrence;\nimport com.hubspot.sdk.models.crm.timeline.BatchResponseAppEventOccurrence;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputAppEventOccurrence params = BatchInputAppEventOccurrence.builder()\n .addInput(AppEventOccurrence.builder()\n .id("id")\n .eventTypeName("eventTypeName")\n .properties(AppEventOccurrence.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponseAppEventOccurrence batchResponseAppEventOccurrence = client.crm().timeline().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Crm.Timeline.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseAppEventOccurrence, err := client.Crm.Timeline.Batch.New(context.TODO(), crm.TimelineBatchNewParams{\n\t\tBatchInputAppEventOccurrence: crm.BatchInputAppEventOccurrenceParam{\n\t\t\tInputs: []crm.AppEventOccurrenceParam{{\n\t\t\t\tID: "id",\n\t\t\t\tEventTypeName: "eventTypeName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseAppEventOccurrence.CompletedAt)\n}\n', - }, - ruby: { - method: 'crm.timeline.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_app_event_occurrence = hubspot.crm.timeline.batch.create(\n inputs: [{id: "id", eventTypeName: "eventTypeName", properties: {foo: "string"}}]\n)\n\nputs(batch_response_app_event_occurrence)', - }, - php: { - method: 'crm->timeline->batch->create', - example: - "crm->timeline->batch->create(\n inputs: [\n [\n 'id' => 'id',\n 'eventTypeName' => 'eventTypeName',\n 'properties' => ['foo' => 'string'],\n 'domain' => 'domain',\n 'email' => 'email',\n 'extraData' => (object) [],\n 'objectID' => 'objectId',\n 'objectTypeFullyQualifiedName' => 'objectTypeFullyQualifiedName',\n 'timelineIFrame' => [\n 'headerLabel' => 'headerLabel',\n 'height' => 0,\n 'linkLabel' => 'linkLabel',\n 'url' => 'url',\n 'width' => 0,\n ],\n 'timestamp' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n ],\n ],\n);\n\nvar_dump($batchResponseAppEventOccurrence);", - }, - http: { - example: - 'curl https://api.hubapi.com/integrators/timeline/2026-03/events/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "eventTypeName": "eventTypeName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/events/2026-03/event-definitions', - httpMethod: 'post', - summary: 'Create custom event definition', - description: 'Create a custom event definition.', - stainlessPath: '(resource) events.definitions > (method) create', - qualified: 'client.events.definitions.create', - params: [ - 'includeDefaultProperties: boolean;', - 'label: string;', - 'propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; }[];', - 'customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; };', - 'description?: string;', - 'name?: string;', - 'primaryObject?: string;', - ], - response: - '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', - markdown: - "## create\n\n`client.events.definitions.create(includeDefaultProperties: boolean, label: string, propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: option_input[]; }[], customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }, description?: string, name?: string, primaryObject?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**post** `/events/2026-03/event-definitions`\n\nCreate a custom event definition.\n\n### Parameters\n\n- `includeDefaultProperties: boolean`\n\n- `label: string`\n Human readable label for the event. Used in HubSpot UI\n\n- `propertyDefinitions: { label: string; type: string; description?: string; name?: string; options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]; }[]`\n List of custom properties on event\n\n- `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }`\n\n- `description?: string`\n A description of the event that will be shown as help text in HubSpot.\n\n- `name?: string`\n Internal event name, which must be used when referencing the event from this event definitions API. If a name is not supplied, one will be generated based on the label. The `name` value will also be used to automatically generate a `fullyQualifiedName` for the event definition, which you'll use when sending event completions to this event. \n\n- `primaryObject?: string`\n The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects.\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.create({\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [{ label: 'label', type: 'type' }],\n});\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.create({\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [{ label: 'label', type: 'type' }],\n});\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", - }, - python: { - method: 'events.definitions.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.create(\n include_default_properties=True,\n label="label",\n property_definitions=[{\n "label": "label",\n "type": "type",\n }],\n)\nprint(external_behavioral_event_type_definition.id)', - }, - java: { - method: 'events().definitions().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyCreate;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinitionEgg;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalBehavioralEventTypeDefinitionEgg params = ExternalBehavioralEventTypeDefinitionEgg.builder()\n .includeDefaultProperties(true)\n .label("label")\n .addPropertyDefinition(ExternalBehavioralEventPropertyCreate.builder()\n .label("label")\n .type("type")\n .build())\n .build();\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().create(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.New(context.TODO(), events.DefinitionNewParams{\n\t\tExternalBehavioralEventTypeDefinitionEgg: events.ExternalBehavioralEventTypeDefinitionEggParam{\n\t\t\tIncludeDefaultProperties: true,\n\t\t\tLabel: "label",\n\t\t\tPropertyDefinitions: []events.ExternalBehavioralEventPropertyCreateParam{{\n\t\t\t\tLabel: "label",\n\t\t\t\tType: "type",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', - }, - ruby: { - method: 'events.definitions.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.create(\n include_default_properties: true,\n label: "label",\n property_definitions: [{label: "label", type: "type"}]\n)\n\nputs(external_behavioral_event_type_definition)', - }, - php: { - method: 'events->definitions->create', - example: - "events->definitions->create(\n includeDefaultProperties: true,\n label: 'label',\n propertyDefinitions: [\n [\n 'label' => 'label',\n 'type' => 'type',\n 'description' => 'description',\n 'name' => 'name',\n 'options' => [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n ],\n ],\n customMatchingID: [\n 'primaryObjectRule' => [\n 'eventPropertyName' => 'eventPropertyName',\n 'targetObjectPropertyName' => 'targetObjectPropertyName',\n ],\n ],\n description: 'description',\n name: 'name',\n primaryObject: 'primaryObject',\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "includeDefaultProperties": true,\n "label": "label",\n "propertyDefinitions": [\n {\n "label": "label",\n "type": "type"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_property', - endpoint: '/events/2026-03/event-definitions/{eventName}/property', - httpMethod: 'post', - summary: 'Create a property for an event definition', - description: 'Create a new property for an existing event definition.', - stainlessPath: '(resource) events.definitions > (method) create_property', - qualified: 'client.events.definitions.createProperty', - params: [ - 'eventName: string;', - 'label: string;', - 'type: string;', - 'description?: string;', - 'name?: string;', - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - ], - response: - "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", - markdown: - "## create_property\n\n`client.events.definitions.createProperty(eventName: string, label: string, type: string, description?: string, name?: string, options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**post** `/events/2026-03/event-definitions/{eventName}/property`\n\nCreate a new property for an existing event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `label: string`\n Human readable label for the property. Used in HubSpot UI\n\n- `type: string`\n The data type of the property. Can be one of the following: [string, number, enumeration, datetime]\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `name?: string`\n Internal property name, which must be used when referencing the property from the API\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.events.definitions.createProperty('eventName', { label: 'label', type: 'type' });\n\nconsole.log(property);\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.createProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.events.definitions.createProperty('eventName', {\n label: 'label',\n type: 'type',\n});\n\nconsole.log(property.hidden);", - }, - python: { - method: 'events.definitions.create_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.events.definitions.create_property(\n event_name="eventName",\n label="label",\n type="type",\n)\nprint(property.hidden)', - }, - java: { - method: 'events().definitions().createProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.events.definitions.DefinitionCreatePropertyParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyCreate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionCreatePropertyParams params = DefinitionCreatePropertyParams.builder()\n .eventName("eventName")\n .externalBehavioralEventPropertyCreate(ExternalBehavioralEventPropertyCreate.builder()\n .label("label")\n .type("type")\n .build())\n .build();\n Property property = client.events().definitions().createProperty(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.NewProperty', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Events.Definitions.NewProperty(\n\t\tcontext.TODO(),\n\t\t"eventName",\n\t\tevents.DefinitionNewPropertyParams{\n\t\t\tExternalBehavioralEventPropertyCreate: events.ExternalBehavioralEventPropertyCreateParam{\n\t\t\t\tLabel: "label",\n\t\t\t\tType: "type",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', - }, - ruby: { - method: 'events.definitions.create_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.events.definitions.create_property("eventName", label: "label", type: "type")\n\nputs(property)', - }, - php: { - method: 'events->definitions->createProperty', - example: - "events->definitions->createProperty(\n 'eventName',\n label: 'label',\n type: 'type',\n description: 'description',\n name: 'name',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n);\n\nvar_dump($property);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "label": "label",\n "type": "type"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/events/2026-03/event-definitions/{eventName}', - httpMethod: 'delete', - summary: 'Delete an event definition', - description: 'Delete a custom event definition by name.', - stainlessPath: '(resource) events.definitions > (method) delete', - qualified: 'client.events.definitions.delete', - params: ['eventName: string;'], - markdown: - "## delete\n\n`client.events.definitions.delete(eventName: string): void`\n\n**delete** `/events/2026-03/event-definitions/{eventName}`\n\nDelete a custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.delete('eventName')\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.delete('eventName');", - }, - python: { - method: 'events.definitions.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.delete(\n "eventName",\n)', - }, - java: { - method: 'events().definitions().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.events().definitions().delete("eventName");\n }\n}', - }, - go: { - method: 'client.Events.Definitions.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.Delete(context.TODO(), "eventName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'events.definitions.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.delete("eventName")\n\nputs(result)', - }, - php: { - method: 'events->definitions->delete', - example: - "events->definitions->delete('eventName');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_property', - endpoint: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', - httpMethod: 'delete', - summary: 'Delete a property from a custom event definition', - description: 'Delete an existing property from a custom event definition.', - stainlessPath: '(resource) events.definitions > (method) delete_property', - qualified: 'client.events.definitions.deleteProperty', - params: ['eventName: string;', 'propertyName: string;'], - markdown: - "## delete_property\n\n`client.events.definitions.deleteProperty(eventName: string, propertyName: string): void`\n\n**delete** `/events/2026-03/event-definitions/{eventName}/property/{propertyName}`\n\nDelete an existing property from a custom event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `propertyName: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.deleteProperty('propertyName', { eventName: 'eventName' })\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.deleteProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.deleteProperty('propertyName', { eventName: 'eventName' });", - }, - python: { - method: 'events.definitions.delete_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.delete_property(\n property_name="propertyName",\n event_name="eventName",\n)', - }, - java: { - method: 'events().definitions().deleteProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionDeletePropertyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionDeletePropertyParams params = DefinitionDeletePropertyParams.builder()\n .eventName("eventName")\n .propertyName("propertyName")\n .build();\n client.events().definitions().deleteProperty(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.DeleteProperty', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.DeleteProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tevents.DefinitionDeletePropertyParams{\n\t\t\tEventName: "eventName",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'events.definitions.delete_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.delete_property("propertyName", event_name: "eventName")\n\nputs(result)', - }, - php: { - method: 'events->definitions->deleteProperty', - example: - "events->definitions->deleteProperty(\n 'propertyName', eventName: 'eventName'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property/$PROPERTY_NAME \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/events/2026-03/event-definitions/{eventName}', - httpMethod: 'get', - summary: 'Retrieve a custom event definition', - description: 'Fetch a single custom event definition by name.', - stainlessPath: '(resource) events.definitions > (method) get', - qualified: 'client.events.definitions.get', - params: ['eventName: string;'], - response: - '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', - markdown: - "## get\n\n`client.events.definitions.get(eventName: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**get** `/events/2026-03/event-definitions/{eventName}`\n\nFetch a single custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.get('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.get('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", - }, - python: { - method: 'events.definitions.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.get(\n "eventName",\n)\nprint(external_behavioral_event_type_definition.id)', - }, - java: { - method: 'events().definitions().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionGetParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().get("eventName");\n }\n}', - }, - go: { - method: 'client.Events.Definitions.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.Get(context.TODO(), "eventName")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', - }, - ruby: { - method: 'events.definitions.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.get("eventName")\n\nputs(external_behavioral_event_type_definition)', - }, - php: { - method: 'events->definitions->get', - example: - "events->definitions->get(\n 'eventName'\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/events/2026-03/event-definitions', - httpMethod: 'get', - summary: 'Retrieve event definitions', - description: 'Retrieve existing custom event definitions.', - stainlessPath: '(resource) events.definitions > (method) list', - qualified: 'client.events.definitions.list', - params: [ - 'after?: string;', - 'includeProperties?: boolean;', - 'limit?: number;', - 'searchString?: string;', - 'sortOrder?: string;', - ], - response: - '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', - markdown: - "## list\n\n`client.events.definitions.list(after?: string, includeProperties?: boolean, limit?: number, searchString?: string, sortOrder?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**get** `/events/2026-03/event-definitions`\n\nRetrieve existing custom event definitions.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `includeProperties?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `searchString?: string`\n\n- `sortOrder?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalBehavioralEventTypeDefinition of client.events.definitions.list()) {\n console.log(externalBehavioralEventTypeDefinition);\n}\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalBehavioralEventTypeDefinition of client.events.definitions.list()) {\n console.log(externalBehavioralEventTypeDefinition.id);\n}", - }, - python: { - method: 'events.definitions.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.events.definitions.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'events().definitions().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionListPage;\nimport com.hubspot.sdk.models.events.definitions.DefinitionListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionListPage page = client.events().definitions().list();\n }\n}', - }, - go: { - method: 'client.Events.Definitions.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Events.Definitions.List(context.TODO(), events.DefinitionListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'events.definitions.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.events.definitions.list\n\nputs(page)', - }, - php: { - method: 'events->definitions->list', - example: - "events->definitions->list(\n after: 'after',\n includeProperties: true,\n limit: 0,\n searchString: 'searchString',\n sortOrder: 'sortOrder',\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/event-definitions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'send_batch', - endpoint: '/events/2026-03/send/batch', - httpMethod: 'post', - summary: 'Send a batch of event occurrences', - description: 'Send multiple event occurrences at once.', - stainlessPath: '(resource) events.definitions > (method) send_batch', - qualified: 'client.events.definitions.sendBatch', - params: [ - 'inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[];', - ], - markdown: - "## send_batch\n\n`client.events.definitions.sendBatch(inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]): void`\n\n**post** `/events/2026-03/send/batch`\n\nSend multiple event occurrences at once.\n\n### Parameters\n\n- `inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.definitions.sendBatch({ inputs: [{\n eventName: 'eventName',\n properties: { foo: 'string' },\n}] })\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.sendBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.definitions.sendBatch({\n inputs: [\n {\n eventName: 'eventName',\n properties: { foo: 'string' },\n },\n ],\n});", - }, - python: { - method: 'events.definitions.send_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.definitions.send_batch(\n inputs=[{\n "event_name": "eventName",\n "properties": {\n "foo": "string"\n },\n }],\n)', - }, - java: { - method: 'events().definitions().sendBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BatchedBehavioralEventHttpCompletionRequest;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchedBehavioralEventHttpCompletionRequest params = BatchedBehavioralEventHttpCompletionRequest.builder()\n .addInput(BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n client.events().definitions().sendBatch(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.SendBatch', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Definitions.SendBatch(context.TODO(), events.DefinitionSendBatchParams{\n\t\tBatchedBehavioralEventHTTPCompletionRequest: events.BatchedBehavioralEventHTTPCompletionRequestParam{\n\t\t\tInputs: []events.BehavioralEventHTTPCompletionRequestParam{{\n\t\t\t\tEventName: "eventName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'events.definitions.send_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.definitions.send_batch(inputs: [{eventName: "eventName", properties: {foo: "string"}}])\n\nputs(result)', - }, - php: { - method: 'events->definitions->sendBatch', - example: - "events->definitions->sendBatch(\n inputs: [\n [\n 'eventName' => 'eventName',\n 'properties' => ['foo' => 'string'],\n 'email' => 'email',\n 'objectID' => 'objectId',\n 'occurredAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n 'uuid' => 'uuid',\n ],\n ],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/send/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/events/2026-03/event-definitions/{eventName}', - httpMethod: 'patch', - summary: 'Update a custom event definition', - description: 'Update a specific custom event definition by name.', - stainlessPath: '(resource) events.definitions > (method) update', - qualified: 'client.events.definitions.update', - params: ['eventName: string;', 'description?: string;', 'label?: string;'], - response: - '{ id: string; archived: boolean; associations: object[]; fullyQualifiedName: string; labels: object; name: string; objectTypeId: string; properties: object[]; comboEventRules?: object; createdAt?: string; createdUserId?: number; customMatchingId?: object; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }', - markdown: - "## update\n\n`client.events.definitions.update(eventName: string, description?: string, label?: string): { id: string; archived: boolean; associations: definitions_association_definition[]; fullyQualifiedName: string; labels: behavioral_event_type_definition_labels; name: string; objectTypeId: string; properties: property[]; comboEventRules?: combo_event_rule_branch; createdAt?: string; createdUserId?: number; customMatchingId?: external_object_resolution_mapping_response; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n**patch** `/events/2026-03/event-definitions/{eventName}`\n\nUpdate a specific custom event definition by name.\n\n### Parameters\n\n- `eventName: string`\n\n- `description?: string`\n A description of the event that will be shown as help text in HubSpot.\n\n- `label?: string`\n Human readable label for the event. Used in HubSpot UI\n\n### Returns\n\n- `{ id: string; archived: boolean; associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]; fullyQualifiedName: string; labels: { singular: string; plural?: string; }; name: string; objectTypeId: string; properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]; comboEventRules?: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }; createdAt?: string; createdUserId?: number; customMatchingId?: { primaryObjectRule: external_primary_object_resolution_rule; }; description?: string; detailTemplate?: string; headerTemplate?: string; primaryObject?: string; primaryObjectId?: string; trackingType?: string; updatedAt?: string; updatedUserId?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `associations: { id: number; allowsCustomLabels: boolean; cardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; fromObjectTypeId: string; hasAllAssociatedObjects: boolean; hasCascadingDeletes: boolean; hasUserEnforcedMaxFromObjectIds: boolean; hasUserEnforcedMaxToObjectIds: boolean; hidden: boolean; inverseAllowsCustomLabels: boolean; inverseCardinality: 'ONE_TO_MANY' | 'ONE_TO_ONE'; inverseHasAllAssociatedObjects: boolean; inverseId: number; inverseName: string; isDefault: boolean; isInversePrimary: boolean; isPrimary: boolean; maxFromObjectIds: number; maxToObjectIds: number; name: string; portalUniqueIdentifier: string; readOnly: boolean; toObjectTypeId: string; fromObjectType?: string; hiddenReason?: 'DEFAULT' | 'INTERNAL' | 'USER_CONFIGURED'; inverseLabel?: string; label?: string; toObjectType?: string; }[]`\n - `fullyQualifiedName: string`\n - `labels: { singular: string; plural?: string; }`\n - `name: string`\n - `objectTypeId: string`\n - `properties: { description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }[]`\n - `comboEventRules?: { composingRules: { count: number; eventTypeId: string; propertyFilters: property_filter[]; lookbackWindowDays?: number; }[]; operationType: 'AND' | 'OR'; ruleBranches: { composingRules: combo_event_rule[]; operationType: 'AND' | 'OR'; ruleBranches: combo_event_rule_branch[]; }[]; }`\n - `createdAt?: string`\n - `createdUserId?: number`\n - `customMatchingId?: { primaryObjectRule: { eventPropertyName: string; targetObjectPropertyName: string; }; }`\n - `description?: string`\n - `detailTemplate?: string`\n - `headerTemplate?: string`\n - `primaryObject?: string`\n - `primaryObjectId?: string`\n - `trackingType?: string`\n - `updatedAt?: string`\n - `updatedUserId?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.update('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition);\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBehavioralEventTypeDefinition = await client.events.definitions.update('eventName');\n\nconsole.log(externalBehavioralEventTypeDefinition.id);", - }, - python: { - method: 'events.definitions.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_behavioral_event_type_definition = client.events.definitions.update(\n event_name="eventName",\n)\nprint(external_behavioral_event_type_definition.id)', - }, - java: { - method: 'events().definitions().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.definitions.DefinitionUpdateParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinition;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventTypeDefinitionPatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdateParams params = DefinitionUpdateParams.builder()\n .eventName("eventName")\n .externalBehavioralEventTypeDefinitionPatch(ExternalBehavioralEventTypeDefinitionPatch.builder().build())\n .build();\n ExternalBehavioralEventTypeDefinition externalBehavioralEventTypeDefinition = client.events().definitions().update(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBehavioralEventTypeDefinition, err := client.Events.Definitions.Update(\n\t\tcontext.TODO(),\n\t\t"eventName",\n\t\tevents.DefinitionUpdateParams{\n\t\t\tExternalBehavioralEventTypeDefinitionPatch: events.ExternalBehavioralEventTypeDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBehavioralEventTypeDefinition.ID)\n}\n', - }, - ruby: { - method: 'events.definitions.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_behavioral_event_type_definition = hubspot.events.definitions.update("eventName")\n\nputs(external_behavioral_event_type_definition)', - }, - php: { - method: 'events->definitions->update', - example: - "events->definitions->update(\n 'eventName', description: 'description', label: 'label'\n);\n\nvar_dump($externalBehavioralEventTypeDefinition);", - }, - http: { - example: - "curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_property', - endpoint: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', - httpMethod: 'patch', - summary: 'Update an existing custom event property', - description: 'Update an existing property in a custom event definition.', - stainlessPath: '(resource) events.definitions > (method) update_property', - qualified: 'client.events.definitions.updateProperty', - params: [ - 'eventName: string;', - 'propertyName: string;', - 'description?: string;', - 'label?: string;', - 'options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[];', - ], - response: - "{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }", - markdown: - "## update_property\n\n`client.events.definitions.updateProperty(eventName: string, propertyName: string, description?: string, label?: string, options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]): { description: string; fieldType: string; groupName: string; label: string; name: string; options: option[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: property_modification_metadata; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n\n**patch** `/events/2026-03/event-definitions/{eventName}/property/{propertyName}`\n\nUpdate an existing property in a custom event definition.\n\n### Parameters\n\n- `eventName: string`\n\n- `propertyName: string`\n\n- `description?: string`\n A description of the property that will be shown as help text in HubSpot.\n\n- `label?: string`\n Human readable label for the property. Used in HubSpot UI\n\n- `options?: { displayOrder: number; hidden: boolean; label: string; value: string; description?: string; }[]`\n A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties.\n\n### Returns\n\n- `{ description: string; fieldType: string; groupName: string; label: string; name: string; options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]; type: string; archived?: boolean; archivedAt?: string; calculated?: boolean; calculationFormula?: string; createdAt?: string; createdUserId?: string; currencyPropertyName?: string; dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'; dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'; displayOrder?: number; externalOptions?: boolean; formField?: boolean; hasUniqueValue?: boolean; hidden?: boolean; hubspotDefined?: boolean; modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }; numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'; referencedObjectType?: string; sensitiveDataCategories?: string[]; showCurrencySymbol?: boolean; updatedAt?: string; updatedUserId?: string; }`\n A HubSpot property\n\n - `description: string`\n - `fieldType: string`\n - `groupName: string`\n - `label: string`\n - `name: string`\n - `options: { hidden: boolean; label: string; value: string; description?: string; displayOrder?: number; }[]`\n - `type: string`\n - `archived?: boolean`\n - `archivedAt?: string`\n - `calculated?: boolean`\n - `calculationFormula?: string`\n - `createdAt?: string`\n - `createdUserId?: string`\n - `currencyPropertyName?: string`\n - `dataSensitivity?: 'highly_sensitive' | 'non_sensitive' | 'sensitive'`\n - `dateDisplayHint?: 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until'`\n - `displayOrder?: number`\n - `externalOptions?: boolean`\n - `formField?: boolean`\n - `hasUniqueValue?: boolean`\n - `hidden?: boolean`\n - `hubspotDefined?: boolean`\n - `modificationMetadata?: { archivable: boolean; readOnlyDefinition: boolean; readOnlyValue: boolean; readOnlyOptions?: boolean; }`\n - `numberDisplayHint?: 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted'`\n - `referencedObjectType?: string`\n - `sensitiveDataCategories?: string[]`\n - `showCurrencySymbol?: boolean`\n - `updatedAt?: string`\n - `updatedUserId?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst property = await client.events.definitions.updateProperty('propertyName', { eventName: 'eventName' });\n\nconsole.log(property);\n```", - perLanguage: { - typescript: { - method: 'client.events.definitions.updateProperty', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst property = await client.events.definitions.updateProperty('propertyName', {\n eventName: 'eventName',\n});\n\nconsole.log(property.hidden);", - }, - python: { - method: 'events.definitions.update_property', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nproperty = client.events.definitions.update_property(\n property_name="propertyName",\n event_name="eventName",\n)\nprint(property.hidden)', - }, - java: { - method: 'events().definitions().updateProperty', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.Property;\nimport com.hubspot.sdk.models.events.definitions.DefinitionUpdatePropertyParams;\nimport com.hubspot.sdk.models.events.definitions.ExternalBehavioralEventPropertyDefinitionPatch;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DefinitionUpdatePropertyParams params = DefinitionUpdatePropertyParams.builder()\n .eventName("eventName")\n .propertyName("propertyName")\n .externalBehavioralEventPropertyDefinitionPatch(ExternalBehavioralEventPropertyDefinitionPatch.builder().build())\n .build();\n Property property = client.events().definitions().updateProperty(params);\n }\n}', - }, - go: { - method: 'client.Events.Definitions.UpdateProperty', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tproperty, err := client.Events.Definitions.UpdateProperty(\n\t\tcontext.TODO(),\n\t\t"propertyName",\n\t\tevents.DefinitionUpdatePropertyParams{\n\t\t\tEventName: "eventName",\n\t\t\tExternalBehavioralEventPropertyDefinitionPatch: events.ExternalBehavioralEventPropertyDefinitionPatchParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", property.Hidden)\n}\n', - }, - ruby: { - method: 'events.definitions.update_property', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nproperty = hubspot.events.definitions.update_property("propertyName", event_name: "eventName")\n\nputs(property)', - }, - php: { - method: 'events->definitions->updateProperty', - example: - "events->definitions->updateProperty(\n 'propertyName',\n eventName: 'eventName',\n description: 'description',\n label: 'label',\n options: [\n [\n 'displayOrder' => 0,\n 'hidden' => true,\n 'label' => 'label',\n 'value' => 'value',\n 'description' => 'description',\n ],\n ],\n);\n\nvar_dump($property);", - }, - http: { - example: - "curl https://api.hubapi.com/events/2026-03/event-definitions/$EVENT_NAME/property/$PROPERTY_NAME \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'list', - endpoint: '/events/event-occurrences/2026-03', - httpMethod: 'get', - summary: 'Retrieve event occurrences', - description: - 'Retrieve event occurrences for the specified time frame. This endpoint allows filtering by various parameters such as object type, event type, and occurrence time. It supports pagination and sorting of results.', - stainlessPath: '(resource) events.occurrences > (method) list', - qualified: 'client.events.occurrences.list', - params: [ - 'id?: string[];', - 'after?: string;', - 'before?: string;', - 'eventType?: string;', - 'limit?: number;', - 'objectId?: number;', - 'objectProperty?: { {propname}?: object; };', - 'objectType?: string;', - 'occurredAfter?: string;', - 'occurredBefore?: string;', - 'properties?: string[];', - 'property?: { {propname}?: object; };', - 'sort?: string[];', - ], - response: - '{ id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }', - markdown: - "## list\n\n`client.events.occurrences.list(id?: string[], after?: string, before?: string, eventType?: string, limit?: number, objectId?: number, objectProperty?: { {propname}?: object; }, objectType?: string, occurredAfter?: string, occurredBefore?: string, properties?: string[], property?: { {propname}?: object; }, sort?: string[]): { id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }`\n\n**get** `/events/event-occurrences/2026-03`\n\nRetrieve event occurrences for the specified time frame. This endpoint allows filtering by various parameters such as object type, event type, and occurrence time. It supports pagination and sorting of results.\n\n### Parameters\n\n- `id?: string[]`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `eventType?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `objectId?: number`\n\n- `objectProperty?: { {propname}?: object; }`\n - `{propname}?: object`\n\n- `objectType?: string`\n\n- `occurredAfter?: string`\n\n- `occurredBefore?: string`\n\n- `properties?: string[]`\n\n- `property?: { {propname}?: object; }`\n - `{propname}?: object`\n\n- `sort?: string[]`\n\n### Returns\n\n- `{ id: string; eventType: string; objectId: string; objectType: string; occurredAt: string; properties: object; }`\n\n - `id: string`\n - `eventType: string`\n - `objectId: string`\n - `objectType: string`\n - `occurredAt: string`\n - `properties: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalUnifiedEvent of client.events.occurrences.list()) {\n console.log(externalUnifiedEvent);\n}\n```", - perLanguage: { - typescript: { - method: 'client.events.occurrences.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalUnifiedEvent of client.events.occurrences.list()) {\n console.log(externalUnifiedEvent.id);\n}", - }, - python: { - method: 'events.occurrences.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.events.occurrences.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'events().occurrences().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListPage;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n OccurrenceListPage page = client.events().occurrences().list();\n }\n}', - }, - go: { - method: 'client.Events.Occurrences.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Events.Occurrences.List(context.TODO(), events.OccurrenceListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'events.occurrences.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.events.occurrences.list\n\nputs(page)', - }, - php: { - method: 'events->occurrences->list', - example: - "events->occurrences->list(\n id: ['string'],\n after: 'after',\n before: 'before',\n eventType: 'eventType',\n limit: 0,\n objectID: 0,\n objectProperty: ['_propname' => (object) []],\n objectType: 'objectType',\n occurredAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n occurredBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n properties: ['string'],\n property: ['_propname' => (object) []],\n sort: ['string'],\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/event-occurrences/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_event_types', - endpoint: '/events/event-occurrences/2026-03/event-types', - httpMethod: 'get', - summary: 'Retrieve event types', - description: - 'Retrieve a list of event type names. You may use these event types to query the API for event occurrences of a desired type.\n\nNote: the `get_types` method is only supported in the Python SDK version `12.0.0-beta.1` or later. ', - stainlessPath: '(resource) events.occurrences > (method) list_event_types', - qualified: 'client.events.occurrences.listEventTypes', - response: '{ eventTypes: string[]; }', - markdown: - "## list_event_types\n\n`client.events.occurrences.listEventTypes(): { eventTypes: string[]; }`\n\n**get** `/events/event-occurrences/2026-03/event-types`\n\nRetrieve a list of event type names. You may use these event types to query the API for event occurrences of a desired type.\n\nNote: the `get_types` method is only supported in the Python SDK version `12.0.0-beta.1` or later. \n\n### Returns\n\n- `{ eventTypes: string[]; }`\n\n - `eventTypes: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst visibleExternalEventTypeNames = await client.events.occurrences.listEventTypes();\n\nconsole.log(visibleExternalEventTypeNames);\n```", - perLanguage: { - typescript: { - method: 'client.events.occurrences.listEventTypes', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst visibleExternalEventTypeNames = await client.events.occurrences.listEventTypes();\n\nconsole.log(visibleExternalEventTypeNames.eventTypes);", - }, - python: { - method: 'events.occurrences.list_event_types', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nvisible_external_event_type_names = client.events.occurrences.list_event_types()\nprint(visible_external_event_type_names.event_types)', - }, - java: { - method: 'events().occurrences().listEventTypes', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.events.occurrences.OccurrenceListEventTypesParams;\nimport com.hubspot.sdk.models.events.occurrences.VisibleExternalEventTypeNames;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n VisibleExternalEventTypeNames visibleExternalEventTypeNames = client.events().occurrences().listEventTypes();\n }\n}', - }, - go: { - method: 'client.Events.Occurrences.ListEventTypes', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tvisibleExternalEventTypeNames, err := client.Events.Occurrences.ListEventTypes(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", visibleExternalEventTypeNames.EventTypes)\n}\n', - }, - ruby: { - method: 'events.occurrences.list_event_types', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nvisible_external_event_type_names = hubspot.events.occurrences.list_event_types\n\nputs(visible_external_event_type_names)', - }, - php: { - method: 'events->occurrences->listEventTypes', - example: - "events->occurrences->listEventTypes();\n\nvar_dump($visibleExternalEventTypeNames);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/event-occurrences/2026-03/event-types \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'batch_send', - endpoint: '/events/2026-03/send/batch', - httpMethod: 'post', - summary: 'Send a batch of event occurrences', - description: 'Send multiple event occurrences at once.', - stainlessPath: '(resource) events.send > (method) batch_send', - qualified: 'client.events.send.batchSend', - params: [ - 'inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[];', - ], - markdown: - "## batch_send\n\n`client.events.send.batchSend(inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]): void`\n\n**post** `/events/2026-03/send/batch`\n\nSend multiple event occurrences at once.\n\n### Parameters\n\n- `inputs: { eventName: string; properties: object; email?: string; objectId?: string; occurredAt?: string; utk?: string; uuid?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.send.batchSend({ inputs: [{\n eventName: 'eventName',\n properties: { foo: 'string' },\n}] })\n```", - perLanguage: { - typescript: { - method: 'client.events.send.batchSend', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.send.batchSend({\n inputs: [\n {\n eventName: 'eventName',\n properties: { foo: 'string' },\n },\n ],\n});", - }, - python: { - method: 'events.send.batch_send', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.send.batch_send(\n inputs=[{\n "event_name": "eventName",\n "properties": {\n "foo": "string"\n },\n }],\n)', - }, - java: { - method: 'events().send().batchSend', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BatchedBehavioralEventHttpCompletionRequest;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchedBehavioralEventHttpCompletionRequest params = BatchedBehavioralEventHttpCompletionRequest.builder()\n .addInput(BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n client.events().send().batchSend(params);\n }\n}', - }, - go: { - method: 'client.Events.Send.BatchSend', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Send.BatchSend(context.TODO(), events.SendBatchSendParams{\n\t\tBatchedBehavioralEventHTTPCompletionRequest: events.BatchedBehavioralEventHTTPCompletionRequestParam{\n\t\t\tInputs: []events.BehavioralEventHTTPCompletionRequestParam{{\n\t\t\t\tEventName: "eventName",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'events.send_.batch_send', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.send_.batch_send(inputs: [{eventName: "eventName", properties: {foo: "string"}}])\n\nputs(result)', - }, - php: { - method: 'events->send->batchSend', - example: - "events->send->batchSend(\n inputs: [\n [\n 'eventName' => 'eventName',\n 'properties' => ['foo' => 'string'],\n 'email' => 'email',\n 'objectID' => 'objectId',\n 'occurredAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'utk' => 'utk',\n 'uuid' => 'uuid',\n ],\n ],\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/send/batch \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'send', - endpoint: '/events/2026-03/send', - httpMethod: 'post', - summary: 'Send a custom event occurrence', - description: 'Send data for a single custom event occurrence.', - stainlessPath: '(resource) events.send > (method) send', - qualified: 'client.events.send.send', - params: [ - 'eventName: string;', - 'properties: object;', - 'email?: string;', - 'objectId?: string;', - 'occurredAt?: string;', - 'utk?: string;', - 'uuid?: string;', - ], - markdown: - "## send\n\n`client.events.send.send(eventName: string, properties: object, email?: string, objectId?: string, occurredAt?: string, utk?: string, uuid?: string): void`\n\n**post** `/events/2026-03/send`\n\nSend data for a single custom event occurrence.\n\n### Parameters\n\n- `eventName: string`\n Internal name of the event-type to trigger\n\n- `properties: object`\n Map of properties for the event in the format property internal name - property value\n\n- `email?: string`\n Email of visitor\n\n- `objectId?: string`\n The object id that this event occurred on. Could be a contact id or a visitor id.\n\n- `occurredAt?: string`\n The time when this event occurred (if any). If this isn't set, the current time will be used\n\n- `utk?: string`\n User token\n\n- `uuid?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.events.send.send({\n eventName: 'eventName',\n properties: { foo: 'string' },\n})\n```", - perLanguage: { - typescript: { - method: 'client.events.send.send', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.events.send.send({\n eventName: 'eventName',\n properties: { foo: 'string' },\n});", - }, - python: { - method: 'events.send.send', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.events.send.send(\n event_name="eventName",\n properties={\n "foo": "string"\n },\n)', - }, - java: { - method: 'events().send().send', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.events.BehavioralEventHttpCompletionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BehavioralEventHttpCompletionRequest params = BehavioralEventHttpCompletionRequest.builder()\n .eventName("eventName")\n .properties(BehavioralEventHttpCompletionRequest.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n client.events().send().send(params);\n }\n}', - }, - go: { - method: 'client.Events.Send.Send', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/events"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Events.Send.Send(context.TODO(), events.SendSendParams{\n\t\tBehavioralEventHTTPCompletionRequest: events.BehavioralEventHTTPCompletionRequestParam{\n\t\t\tEventName: "eventName",\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'events.send_.send_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.events.send_.send_(event_name: "eventName", properties: {foo: "string"})\n\nputs(result)', - }, - php: { - method: 'events->send->send', - example: - "events->send->send(\n eventName: 'eventName',\n properties: ['foo' => 'string'],\n email: 'email',\n objectID: 'objectId',\n occurredAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n utk: 'utk',\n uuid: 'uuid',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/events/2026-03/send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventName": "eventName",\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/files/2026-03/folders', - httpMethod: 'post', - summary: 'Create folder', - description: 'Creates a folder.', - stainlessPath: '(resource) files.file_assets > (method) create', - qualified: 'client.files.fileAssets.create', - params: ['name: string;', 'parentFolderId?: string;', 'parentPath?: string;'], - response: - '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', - markdown: - "## create\n\n`client.files.fileAssets.create(name: string, parentFolderId?: string, parentPath?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**post** `/files/2026-03/folders`\n\nCreates a folder.\n\n### Parameters\n\n- `name: string`\n Desired name for the folder.\n\n- `parentFolderId?: string`\n FolderId of the parent of the created folder. If not specified, the folder will be created at the root level. parentFolderId and parentFolderPath cannot be set at the same time.\n\n- `parentPath?: string`\n Path of the parent of the created folder. If not specified the folder will be created at the root level. parentFolderPath and parentFolderId cannot be set at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.fileAssets.create({ name: 'name' });\n\nconsole.log(folder);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.fileAssets.create({ name: 'name' });\n\nconsole.log(folder.id);", - }, - python: { - method: 'files.file_assets.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.file_assets.create(\n name="name",\n)\nprint(folder.id)', - }, - java: { - method: 'files().fileAssets().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.FolderInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderInput params = FolderInput.builder()\n .name("name")\n .build();\n Folder folder = client.files().fileAssets().create(params);\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.FileAssets.New(context.TODO(), files.FileAssetNewParams{\n\t\tFolderInput: files.FolderInputParam{\n\t\t\tName: "name",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.file_assets.create(name: "name")\n\nputs(folder)', - }, - php: { - method: 'files->fileAssets->create', - example: - "files->fileAssets->create(\n name: 'name', parentFolderID: 'parentFolderId', parentPath: 'parentPath'\n);\n\nvar_dump($folder);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "name": "name"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/files/2026-03/files/{fileId}', - httpMethod: 'delete', - summary: 'Delete file by ID', - description: 'Delete a file by ID', - stainlessPath: '(resource) files.file_assets > (method) delete', - qualified: 'client.files.fileAssets.delete', - params: ['fileId: string;'], - markdown: - "## delete\n\n`client.files.fileAssets.delete(fileId: string): void`\n\n**delete** `/files/2026-03/files/{fileId}`\n\nDelete a file by ID\n\n### Parameters\n\n- `fileId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.fileAssets.delete('321669910225')\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.fileAssets.delete('321669910225');", - }, - python: { - method: 'files.file_assets.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.file_assets.delete(\n "321669910225",\n)', - }, - java: { - method: 'files().fileAssets().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().fileAssets().delete("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.FileAssets.Delete(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'files.file_assets.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.file_assets.delete("321669910225")\n\nputs(result)', - }, - php: { - method: 'files->fileAssets->delete', - example: - "files->fileAssets->delete('321669910225');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'gdpr_delete', - endpoint: '/files/2026-03/files/{fileId}/gdpr-delete', - httpMethod: 'delete', - summary: 'GDPR-delete file', - description: 'Delete a file in accordance with GDPR regulations.', - stainlessPath: '(resource) files.file_assets > (method) gdpr_delete', - qualified: 'client.files.fileAssets.gdprDelete', - params: ['fileId: string;'], - markdown: - "## gdpr_delete\n\n`client.files.fileAssets.gdprDelete(fileId: string): void`\n\n**delete** `/files/2026-03/files/{fileId}/gdpr-delete`\n\nDelete a file in accordance with GDPR regulations.\n\n### Parameters\n\n- `fileId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.fileAssets.gdprDelete('321669910225')\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.gdprDelete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.fileAssets.gdprDelete('321669910225');", - }, - python: { - method: 'files.file_assets.gdpr_delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.file_assets.gdpr_delete(\n "321669910225",\n)', - }, - java: { - method: 'files().fileAssets().gdprDelete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGdprDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().fileAssets().gdprDelete("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.GdprDelete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.FileAssets.GdprDelete(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'files.file_assets.gdpr_delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.file_assets.gdpr_delete("321669910225")\n\nputs(result)', - }, - php: { - method: 'files->fileAssets->gdprDelete', - example: - "files->fileAssets->gdprDelete('321669910225');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID/gdpr-delete \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/files/2026-03/files/{fileId}', - httpMethod: 'get', - summary: 'Retrieve file by ID', - description: 'Retrieve a file by its ID.', - stainlessPath: '(resource) files.file_assets > (method) get', - qualified: 'client.files.fileAssets.get', - params: ['fileId: string;', 'properties?: string[];'], - response: - "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", - markdown: - "## get\n\n`client.files.fileAssets.get(fileId: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**get** `/files/2026-03/files/{fileId}`\n\nRetrieve a file by its ID.\n\n### Parameters\n\n- `fileId: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.get('321669910225');\n\nconsole.log(file);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.get('321669910225');\n\nconsole.log(file.id);", - }, - python: { - method: 'files.file_assets.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.get(\n file_id="321669910225",\n)\nprint(file.id)', - }, - java: { - method: 'files().fileAssets().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().get("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Get(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.get("321669910225")\n\nputs(file)', - }, - php: { - method: 'files->fileAssets->get', - example: - "files->fileAssets->get('321669910225', properties: ['string']);\n\nvar_dump($file);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_import_task_status', - endpoint: '/files/2026-03/files/import-from-url/async/tasks/{taskId}/status', - httpMethod: 'get', - summary: 'Check import status', - description: 'Check the status of requested import.', - stainlessPath: '(resource) files.file_assets > (method) get_import_task_status', - qualified: 'client.files.fileAssets.getImportTaskStatus', - params: ['taskId: string;'], - response: - "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }; }", - markdown: - "## get_import_task_status\n\n`client.files.fileAssets.getImportTaskStatus(taskId: string): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: file; }`\n\n**get** `/files/2026-03/files/import-from-url/async/tasks/{taskId}/status`\n\nCheck the status of requested import.\n\n### Parameters\n\n- `taskId: string`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `taskId: string`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst fileActionResponse = await client.files.fileAssets.getImportTaskStatus('taskId');\n\nconsole.log(fileActionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.getImportTaskStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst fileActionResponse = await client.files.fileAssets.getImportTaskStatus('taskId');\n\nconsole.log(fileActionResponse.completedAt);", - }, - python: { - method: 'files.file_assets.get_import_task_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile_action_response = client.files.file_assets.get_import_task_status(\n "taskId",\n)\nprint(file_action_response.completed_at)', - }, - java: { - method: 'files().fileAssets().getImportTaskStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FileActionResponse;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetImportTaskStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileActionResponse fileActionResponse = client.files().fileAssets().getImportTaskStatus("taskId");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.GetImportTaskStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfileActionResponse, err := client.Files.FileAssets.GetImportTaskStatus(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", fileActionResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'files.file_assets.get_import_task_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile_action_response = hubspot.files.file_assets.get_import_task_status("taskId")\n\nputs(file_action_response)', - }, - php: { - method: 'files->fileAssets->getImportTaskStatus', - example: - "files->fileAssets->getImportTaskStatus('taskId');\n\nvar_dump($fileActionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/import-from-url/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_signed_url', - endpoint: '/files/2026-03/files/{fileId}/signed-url', - httpMethod: 'get', - summary: 'Get signed URL to access private file', - description: 'Generates signed URL that allows temporary access to a private file.', - stainlessPath: '(resource) files.file_assets > (method) get_signed_url', - qualified: 'client.files.fileAssets.getSignedURL', - params: [ - 'fileId: string;', - 'expirationSeconds?: number;', - "size?: 'icon' | 'medium' | 'preview' | 'thumb';", - 'upscale?: boolean;', - ], - response: - '{ expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }', - markdown: - "## get_signed_url\n\n`client.files.fileAssets.getSignedURL(fileId: string, expirationSeconds?: number, size?: 'icon' | 'medium' | 'preview' | 'thumb', upscale?: boolean): { expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }`\n\n**get** `/files/2026-03/files/{fileId}/signed-url`\n\nGenerates signed URL that allows temporary access to a private file.\n\n### Parameters\n\n- `fileId: string`\n\n- `expirationSeconds?: number`\n\n- `size?: 'icon' | 'medium' | 'preview' | 'thumb'`\n\n- `upscale?: boolean`\n\n### Returns\n\n- `{ expiresAt: string; url: string; extension?: string; height?: number; name?: string; size?: number; type?: string; width?: number; }`\n\n - `expiresAt: string`\n - `url: string`\n - `extension?: string`\n - `height?: number`\n - `name?: string`\n - `size?: number`\n - `type?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst signedURL = await client.files.fileAssets.getSignedURL('321669910225');\n\nconsole.log(signedURL);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.getSignedURL', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst signedURL = await client.files.fileAssets.getSignedURL('321669910225');\n\nconsole.log(signedURL.width);", - }, - python: { - method: 'files.file_assets.get_signed_url', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsigned_url = client.files.file_assets.get_signed_url(\n file_id="321669910225",\n)\nprint(signed_url.width)', - }, - java: { - method: 'files().fileAssets().getSignedUrl', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.SignedUrl;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetGetSignedUrlParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SignedUrl signedUrl = client.files().fileAssets().getSignedUrl("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.GetSignedURL', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsignedURL, err := client.Files.FileAssets.GetSignedURL(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetGetSignedURLParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", signedURL.Width)\n}\n', - }, - ruby: { - method: 'files.file_assets.get_signed_url', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsigned_url = hubspot.files.file_assets.get_signed_url("321669910225")\n\nputs(signed_url)', - }, - php: { - method: 'files->fileAssets->getSignedURL', - example: - "files->fileAssets->getSignedURL(\n '321669910225', expirationSeconds: 0, size: 'icon', upscale: true\n);\n\nvar_dump($signedURL);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID/signed-url \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'import_from_url_async', - endpoint: '/files/2026-03/files/import-from-url/async', - httpMethod: 'post', - summary: 'Import file from URL', - description: 'Asynchronously imports the file at the given URL into the file manager.', - stainlessPath: '(resource) files.file_assets > (method) import_from_url_async', - qualified: 'client.files.fileAssets.importFromURLAsync', - params: [ - 'access: string;', - "duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER';", - "duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING';", - 'overwrite: boolean;', - 'expiresAt?: string;', - 'folderId?: string;', - 'folderPath?: string;', - 'name?: string;', - 'ttl?: string;', - 'url?: string;', - ], - response: '{ id: string; links?: object; }', - markdown: - "## import_from_url_async\n\n`client.files.fileAssets.importFromURLAsync(access: string, duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER', duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING', overwrite: boolean, expiresAt?: string, folderId?: string, folderPath?: string, name?: string, ttl?: string, url?: string): { id: string; links?: object; }`\n\n**post** `/files/2026-03/files/import-from-url/async`\n\nAsynchronously imports the file at the given URL into the file manager.\n\n### Parameters\n\n- `access: string`\n PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines can index the file. PUBLIC_NOT_INDEXABLE: File is publicly accessible by anyone who has the URL. Search engines *can't* index the file. PRIVATE: File is NOT publicly accessible. Requires a signed URL to see content. Search engines *can't* index the file.\n\n- `duplicateValidationScope: 'ENTIRE_PORTAL' | 'EXACT_FOLDER'`\n ENTIRE_PORTAL: Look for a duplicate file in the entire account. EXACT_FOLDER: Look for a duplicate file in the provided folder.\n\n- `duplicateValidationStrategy: 'NONE' | 'REJECT' | 'RETURN_EXISTING'`\n NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.\n\n- `overwrite: boolean`\n If true, will overwrite existing file if one with the same name and extension exists in the given folder. The overwritten file will be deleted and the uploaded file will take its place with a new ID. If unset or set as false, the new file's name will be updated to prevent colliding with existing file if one exists with the same path, name, and extension\n\n- `expiresAt?: string`\n Specifies the date and time when the file will expire.\n\n- `folderId?: string`\n One of folderId or folderPath is required. Destination folderId for the uploaded file.\n\n- `folderPath?: string`\n One of folderPath or folderId is required. Destination folder path for the uploaded file. If the folder path does not exist, there will be an attempt to create the folder path.\n\n- `name?: string`\n Name to give the resulting file in the file manager.\n\n- `ttl?: string`\n Time to live. If specified the file will be deleted after the given time frame. If left unset, the file will exist indefinitely\n\n- `url?: string`\n URL to download the new file from.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst importFromURLTaskLocator = await client.files.fileAssets.importFromURLAsync({\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n});\n\nconsole.log(importFromURLTaskLocator);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.importFromURLAsync', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst importFromURLTaskLocator = await client.files.fileAssets.importFromURLAsync({\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n});\n\nconsole.log(importFromURLTaskLocator.id);", - }, - python: { - method: 'files.file_assets.import_from_url_async', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nimport_from_url_task_locator = client.files.file_assets.import_from_url_async(\n access="HIDDEN_INDEXABLE",\n duplicate_validation_scope="ENTIRE_PORTAL",\n duplicate_validation_strategy="NONE",\n overwrite=True,\n)\nprint(import_from_url_task_locator.id)', - }, - java: { - method: 'files().fileAssets().importFromUrlAsync', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.ImportFromUrlInput;\nimport com.hubspot.sdk.models.files.ImportFromUrlTaskLocator;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ImportFromUrlInput params = ImportFromUrlInput.builder()\n .access(ImportFromUrlInput.Access.HIDDEN_INDEXABLE)\n .duplicateValidationScope(ImportFromUrlInput.DuplicateValidationScope.ENTIRE_PORTAL)\n .duplicateValidationStrategy(ImportFromUrlInput.DuplicateValidationStrategy.NONE)\n .overwrite(true)\n .build();\n ImportFromUrlTaskLocator importFromUrlTaskLocator = client.files().fileAssets().importFromUrlAsync(params);\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.ImportFromURLAsync', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\timportFromURLTaskLocator, err := client.Files.FileAssets.ImportFromURLAsync(context.TODO(), files.FileAssetImportFromURLAsyncParams{\n\t\tImportFromURLInput: files.ImportFromURLInputParam{\n\t\t\tAccess: files.ImportFromURLInputAccessHiddenIndexable,\n\t\t\tDuplicateValidationScope: files.ImportFromURLInputDuplicateValidationScopeEntirePortal,\n\t\t\tDuplicateValidationStrategy: files.ImportFromURLInputDuplicateValidationStrategyNone,\n\t\t\tOverwrite: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", importFromURLTaskLocator.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.import_from_url_async', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nimport_from_url_task_locator = hubspot.files.file_assets.import_from_url_async(\n access: :HIDDEN_INDEXABLE,\n duplicate_validation_scope: :ENTIRE_PORTAL,\n duplicate_validation_strategy: :NONE,\n overwrite: true\n)\n\nputs(import_from_url_task_locator)', - }, - php: { - method: 'files->fileAssets->importFromURLAsync', - example: - "files->fileAssets->importFromURLAsync(\n access: 'HIDDEN_INDEXABLE',\n duplicateValidationScope: 'ENTIRE_PORTAL',\n duplicateValidationStrategy: 'NONE',\n overwrite: true,\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n folderID: 'folderId',\n folderPath: 'folderPath',\n name: 'name',\n ttl: 'ttl',\n url: 'url',\n);\n\nvar_dump($importFromURLTaskLocator);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/import-from-url/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "access": "HIDDEN_INDEXABLE",\n "duplicateValidationScope": "ENTIRE_PORTAL",\n "duplicateValidationStrategy": "NONE",\n "overwrite": true\n }\'', - }, - }, - }, - { - name: 'replace', - endpoint: '/files/2026-03/files/{fileId}', - httpMethod: 'put', - summary: 'Replace file', - description: - 'Replace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.', - stainlessPath: '(resource) files.file_assets > (method) replace', - qualified: 'client.files.fileAssets.replace', - params: ['fileId: string;', 'charsetHunch?: string;', 'file?: string;', 'options?: string;'], - response: - "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", - markdown: - "## replace\n\n`client.files.fileAssets.replace(fileId: string, charsetHunch?: string, file?: string, options?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**put** `/files/2026-03/files/{fileId}`\n\nReplace existing file data with new file data. Can be used to change image content without having to upload a new file and update all references.\n\n### Parameters\n\n- `fileId: string`\n\n- `charsetHunch?: string`\n\n- `file?: string`\n\n- `options?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.replace('321669910225');\n\nconsole.log(file);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.replace', - example: - "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.replace('321669910225');\n\nconsole.log(file.id);", - }, - python: { - method: 'files.file_assets.replace', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.replace(\n file_id="321669910225",\n)\nprint(file.id)', - }, - java: { - method: 'files().fileAssets().replace', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetReplaceParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().replace("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Replace', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Replace(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetReplaceParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.replace', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.replace("321669910225")\n\nputs(file)', - }, - php: { - method: 'files->fileAssets->replace', - example: - "files->fileAssets->replace(\n '321669910225',\n charsetHunch: 'charsetHunch',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n options: 'options',\n);\n\nvar_dump($file);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/files/2026-03/files/search', - httpMethod: 'get', - summary: 'Search files', - description: 'Search through files in the file manager. Does not display hidden or archived files.', - stainlessPath: '(resource) files.file_assets > (method) search', - qualified: 'client.files.fileAssets.search', - params: [ - 'after?: string;', - 'allowsAnonymousAccess?: boolean;', - 'before?: string;', - 'createdAt?: string;', - 'createdAtGte?: string;', - 'createdAtLte?: string;', - 'encoding?: string;', - 'expiresAt?: string;', - 'expiresAtGte?: string;', - 'expiresAtLte?: string;', - 'extension?: string;', - 'fileMd5?: string;', - 'height?: number;', - 'heightGte?: number;', - 'heightLte?: number;', - 'idGte?: number;', - 'idLte?: number;', - 'ids?: number[];', - 'isUsableInContent?: boolean;', - 'limit?: number;', - 'name?: string;', - 'parentFolderIds?: number[];', - 'path?: string;', - 'properties?: string[];', - 'size?: number;', - 'sizeGte?: number;', - 'sizeLte?: number;', - 'sort?: string[];', - 'type?: string;', - 'updatedAt?: string;', - 'updatedAtGte?: string;', - 'updatedAtLte?: string;', - 'url?: string;', - 'width?: number;', - 'widthGte?: number;', - 'widthLte?: number;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", - markdown: - "## search\n\n`client.files.fileAssets.search(after?: string, allowsAnonymousAccess?: boolean, before?: string, createdAt?: string, createdAtGte?: string, createdAtLte?: string, encoding?: string, expiresAt?: string, expiresAtGte?: string, expiresAtLte?: string, extension?: string, fileMd5?: string, height?: number, heightGte?: number, heightLte?: number, idGte?: number, idLte?: number, ids?: number[], isUsableInContent?: boolean, limit?: number, name?: string, parentFolderIds?: number[], path?: string, properties?: string[], size?: number, sizeGte?: number, sizeLte?: number, sort?: string[], type?: string, updatedAt?: string, updatedAtGte?: string, updatedAtLte?: string, url?: string, width?: number, widthGte?: number, widthLte?: number): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**get** `/files/2026-03/files/search`\n\nSearch through files in the file manager. Does not display hidden or archived files.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `allowsAnonymousAccess?: boolean`\n\n- `before?: string`\n\n- `createdAt?: string`\n\n- `createdAtGte?: string`\n\n- `createdAtLte?: string`\n\n- `encoding?: string`\n\n- `expiresAt?: string`\n\n- `expiresAtGte?: string`\n\n- `expiresAtLte?: string`\n\n- `extension?: string`\n\n- `fileMd5?: string`\n\n- `height?: number`\n\n- `heightGte?: number`\n\n- `heightLte?: number`\n\n- `idGte?: number`\n\n- `idLte?: number`\n\n- `ids?: number[]`\n\n- `isUsableInContent?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `parentFolderIds?: number[]`\n\n- `path?: string`\n\n- `properties?: string[]`\n\n- `size?: number`\n\n- `sizeGte?: number`\n\n- `sizeLte?: number`\n\n- `sort?: string[]`\n\n- `type?: string`\n\n- `updatedAt?: string`\n\n- `updatedAtGte?: string`\n\n- `updatedAtLte?: string`\n\n- `url?: string`\n\n- `width?: number`\n\n- `widthGte?: number`\n\n- `widthLte?: number`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const file of client.files.fileAssets.search()) {\n console.log(file);\n}\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const file of client.files.fileAssets.search()) {\n console.log(file.id);\n}", - }, - python: { - method: 'files.file_assets.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.files.file_assets.search()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'files().fileAssets().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetSearchPage;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileAssetSearchPage page = client.files().fileAssets().search();\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Files.FileAssets.Search(context.TODO(), files.FileAssetSearchParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'files.file_assets.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.files.file_assets.search\n\nputs(page)', - }, - php: { - method: 'files->fileAssets->search', - example: - "files->fileAssets->search(\n after: 'after',\n allowsAnonymousAccess: true,\n before: 'before',\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n encoding: 'encoding',\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n expiresAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n expiresAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n extension: 'extension',\n fileMd5: 'fileMd5',\n height: 0,\n heightGte: 0,\n heightLte: 0,\n idGte: 0,\n idLte: 0,\n ids: [0],\n isUsableInContent: true,\n limit: 0,\n name: 'name',\n parentFolderIDs: [0],\n path: 'path',\n properties: ['string'],\n size: 0,\n sizeGte: 0,\n sizeLte: 0,\n sort: ['string'],\n type: 'type',\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n url: 'url',\n width: 0,\n widthGte: 0,\n widthLte: 0,\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/files/2026-03/files/{fileId}', - httpMethod: 'patch', - summary: 'Update file properties', - description: 'Update properties of file by ID.', - stainlessPath: '(resource) files.file_assets > (method) update', - qualified: 'client.files.fileAssets.update', - params: [ - 'fileId: string;', - 'clearExpires: boolean;', - 'access?: string;', - 'expiresAt?: string;', - 'isUsableInContent?: boolean;', - 'name?: string;', - 'parentFolderId?: string;', - 'parentFolderPath?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", - markdown: - "## update\n\n`client.files.fileAssets.update(fileId: string, clearExpires: boolean, access?: string, expiresAt?: string, isUsableInContent?: boolean, name?: string, parentFolderId?: string, parentFolderPath?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**patch** `/files/2026-03/files/{fileId}`\n\nUpdate properties of file by ID.\n\n### Parameters\n\n- `fileId: string`\n\n- `clearExpires: boolean`\n\n- `access?: string`\n NONE: Do not run any duplicate validation. REJECT: Reject the upload if a duplicate is found. RETURN_EXISTING: If a duplicate file is found, do not upload a new file and return the found duplicate instead.\n\n- `expiresAt?: string`\n\n- `isUsableInContent?: boolean`\n Mark whether the file should be used in new content or not.\n\n- `name?: string`\n New name for the file.\n\n- `parentFolderId?: string`\n FolderId where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.\n\n- `parentFolderPath?: string`\n Folder path where the file should be moved to. folderId and folderPath parameters cannot be set at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.update('321669910225', { clearExpires: true });\n\nconsole.log(file);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.update('321669910225', { clearExpires: true });\n\nconsole.log(file.id);", - }, - python: { - method: 'files.file_assets.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.update(\n file_id="321669910225",\n clear_expires=True,\n)\nprint(file.id)', - }, - java: { - method: 'files().fileAssets().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.FileUpdateInput;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FileAssetUpdateParams params = FileAssetUpdateParams.builder()\n .fileId("321669910225")\n .fileUpdateInput(FileUpdateInput.builder()\n .clearExpires(true)\n .build())\n .build();\n File file = client.files().fileAssets().update(params);\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Update(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FileAssetUpdateParams{\n\t\t\tFileUpdateInput: files.FileUpdateInputParam{\n\t\t\t\tClearExpires: true,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.update("321669910225", clear_expires: true)\n\nputs(file)', - }, - php: { - method: 'files->fileAssets->update', - example: - "files->fileAssets->update(\n '321669910225',\n clearExpires: true,\n access: 'HIDDEN_INDEXABLE',\n expiresAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n isUsableInContent: true,\n name: 'name',\n parentFolderID: 'parentFolderId',\n parentFolderPath: 'parentFolderPath',\n);\n\nvar_dump($file);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files/$FILE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "clearExpires": true\n }\'', - }, - }, - }, - { - name: 'upload', - endpoint: '/files/2026-03/files', - httpMethod: 'post', - summary: 'Upload file', - description: 'Upload a single file with content specified in request body.', - stainlessPath: '(resource) files.file_assets > (method) upload', - qualified: 'client.files.fileAssets.upload', - params: [ - 'charsetHunch?: string;', - 'file?: string;', - 'fileName?: string;', - 'folderId?: string;', - 'folderPath?: string;', - 'options?: string;', - ], - response: - "{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }", - markdown: - "## upload\n\n`client.files.fileAssets.upload(charsetHunch?: string, file?: string, fileName?: string, folderId?: string, folderPath?: string, options?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n**post** `/files/2026-03/files`\n\nUpload a single file with content specified in request body.\n\n### Parameters\n\n- `charsetHunch?: string`\n\n- `file?: string`\n\n- `fileName?: string`\n\n- `folderId?: string`\n\n- `folderPath?: string`\n\n- `options?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; access?: string; archivedAt?: string; defaultHostingUrl?: string; encoding?: string; expiresAt?: number; extension?: string; fileMd5?: string; height?: number; isUsableInContent?: boolean; name?: string; parentFolderId?: string; path?: string; size?: number; sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'; type?: string; url?: string; width?: number; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `access?: string`\n - `archivedAt?: string`\n - `defaultHostingUrl?: string`\n - `encoding?: string`\n - `expiresAt?: number`\n - `extension?: string`\n - `fileMd5?: string`\n - `height?: number`\n - `isUsableInContent?: boolean`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n - `size?: number`\n - `sourceGroup?: 'CONTENT' | 'CONVERSATIONS' | 'FORMS' | 'UI_EXTENSIONS' | 'UNKNOWN'`\n - `type?: string`\n - `url?: string`\n - `width?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst file = await client.files.fileAssets.upload();\n\nconsole.log(file);\n```", - perLanguage: { - typescript: { - method: 'client.files.fileAssets.upload', - example: - "import fs from 'fs';\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst file = await client.files.fileAssets.upload();\n\nconsole.log(file.id);", - }, - python: { - method: 'files.file_assets.upload', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfile = client.files.file_assets.upload()\nprint(file.id)', - }, - java: { - method: 'files().fileAssets().upload', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.File;\nimport com.hubspot.sdk.models.files.fileassets.FileAssetUploadParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n File file = client.files().fileAssets().upload();\n }\n}', - }, - go: { - method: 'client.Files.FileAssets.Upload', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfile, err := client.Files.FileAssets.Upload(context.TODO(), files.FileAssetUploadParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", file.ID)\n}\n', - }, - ruby: { - method: 'files.file_assets.upload', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfile = hubspot.files.file_assets.upload\n\nputs(file)', - }, - php: { - method: 'files->fileAssets->upload', - example: - "files->fileAssets->upload(\n charsetHunch: 'charsetHunch',\n file: FileParam::fromString('Example data', filename: uniqid('file-upload-', true)),\n fileName: 'fileName',\n folderID: 'folderId',\n folderPath: 'folderPath',\n options: 'options',\n);\n\nvar_dump($file);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/files \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_by_id', - endpoint: '/files/2026-03/folders/{folderId}', - httpMethod: 'delete', - summary: 'Delete folder by ID', - description: 'Delete folder by ID.', - stainlessPath: '(resource) files.folders > (method) delete_by_id', - qualified: 'client.files.folders.deleteByID', - params: ['folderId: string;'], - markdown: - "## delete_by_id\n\n`client.files.folders.deleteByID(folderId: string): void`\n\n**delete** `/files/2026-03/folders/{folderId}`\n\nDelete folder by ID.\n\n### Parameters\n\n- `folderId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.folders.deleteByID('321669910225')\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.deleteByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.folders.deleteByID('321669910225');", - }, - python: { - method: 'files.folders.delete_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.folders.delete_by_id(\n "321669910225",\n)', - }, - java: { - method: 'files().folders().deleteById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderDeleteByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().folders().deleteById("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.Folders.DeleteByID', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.Folders.DeleteByID(context.TODO(), "321669910225")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'files.folders.delete_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.folders.delete_by_id("321669910225")\n\nputs(result)', - }, - php: { - method: 'files->folders->deleteByID', - example: - "files->folders->deleteByID('321669910225');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_by_path', - endpoint: '/files/2026-03/folders/{folderPath}', - httpMethod: 'delete', - summary: 'Delete folder by path', - description: 'Delete a folder, identified by its path.', - stainlessPath: '(resource) files.folders > (method) delete_by_path', - qualified: 'client.files.folders.deleteByPath', - params: ['folderPath: string;'], - markdown: - "## delete_by_path\n\n`client.files.folders.deleteByPath(folderPath: string): void`\n\n**delete** `/files/2026-03/folders/{folderPath}`\n\nDelete a folder, identified by its path.\n\n### Parameters\n\n- `folderPath: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.files.folders.deleteByPath('folderPath')\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.deleteByPath', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.files.folders.deleteByPath('folderPath');", - }, - python: { - method: 'files.folders.delete_by_path', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.files.folders.delete_by_path(\n "folderPath",\n)', - }, - java: { - method: 'files().folders().deleteByPath', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderDeleteByPathParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.files().folders().deleteByPath("folderPath");\n }\n}', - }, - go: { - method: 'client.Files.Folders.DeleteByPath', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Files.Folders.DeleteByPath(context.TODO(), "folderPath")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'files.folders.delete_by_path', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.files.folders.delete_by_path("folderPath")\n\nputs(result)', - }, - php: { - method: 'files->folders->deleteByPath', - example: - "files->folders->deleteByPath('folderPath');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_PATH \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_id', - endpoint: '/files/2026-03/folders/{folderId}', - httpMethod: 'get', - summary: 'Retrieve folder by ID', - description: 'Retrieve a folder by its ID.', - stainlessPath: '(resource) files.folders > (method) get_by_id', - qualified: 'client.files.folders.getByID', - params: ['folderId: string;', 'properties?: string[];'], - response: - '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', - markdown: - "## get_by_id\n\n`client.files.folders.getByID(folderId: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/{folderId}`\n\nRetrieve a folder by its ID.\n\n### Parameters\n\n- `folderId: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.getByID('321669910225');\n\nconsole.log(folder);\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.getByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.getByID('321669910225');\n\nconsole.log(folder.id);", - }, - python: { - method: 'files.folders.get_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.get_by_id(\n folder_id="321669910225",\n)\nprint(folder.id)', - }, - java: { - method: 'files().folders().getById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.folders.FolderGetByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Folder folder = client.files().folders().getById("321669910225");\n }\n}', - }, - go: { - method: 'client.Files.Folders.GetByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.GetByID(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FolderGetByIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', - }, - ruby: { - method: 'files.folders.get_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.get_by_id("321669910225")\n\nputs(folder)', - }, - php: { - method: 'files->folders->getByID', - example: - "files->folders->getByID(\n '321669910225', properties: ['string']\n);\n\nvar_dump($folder);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_path', - endpoint: '/files/2026-03/folders/{folderPath}', - httpMethod: 'get', - summary: 'Retrieve folder by path', - description: 'Retrieve a folder, identified by its path.', - stainlessPath: '(resource) files.folders > (method) get_by_path', - qualified: 'client.files.folders.getByPath', - params: ['folderPath: string;', 'properties?: string[];'], - response: - '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', - markdown: - "## get_by_path\n\n`client.files.folders.getByPath(folderPath: string, properties?: string[]): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/{folderPath}`\n\nRetrieve a folder, identified by its path.\n\n### Parameters\n\n- `folderPath: string`\n\n- `properties?: string[]`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.getByPath('folderPath');\n\nconsole.log(folder);\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.getByPath', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.getByPath('folderPath');\n\nconsole.log(folder.id);", - }, - python: { - method: 'files.folders.get_by_path', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.get_by_path(\n folder_path="folderPath",\n)\nprint(folder.id)', - }, - java: { - method: 'files().folders().getByPath', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.folders.FolderGetByPathParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Folder folder = client.files().folders().getByPath("folderPath");\n }\n}', - }, - go: { - method: 'client.Files.Folders.GetByPath', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.GetByPath(\n\t\tcontext.TODO(),\n\t\t"folderPath",\n\t\tfiles.FolderGetByPathParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', - }, - ruby: { - method: 'files.folders.get_by_path', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.get_by_path("folderPath")\n\nputs(folder)', - }, - php: { - method: 'files->folders->getByPath', - example: - "files->folders->getByPath(\n 'folderPath', properties: ['string']\n);\n\nvar_dump($folder);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_PATH \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_update_async_status', - endpoint: '/files/2026-03/folders/update/async/tasks/{taskId}/status', - httpMethod: 'get', - summary: 'Check folder update status', - description: 'Check status of folder update. Folder updates happen asynchronously.', - stainlessPath: '(resource) files.folders > (method) get_update_async_status', - qualified: 'client.files.folders.getUpdateAsyncStatus', - params: ['taskId: string;'], - response: - "{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }; }", - markdown: - "## get_update_async_status\n\n`client.files.folders.getUpdateAsyncStatus(taskId: string): { completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; result?: folder; }`\n\n**get** `/files/2026-03/folders/update/async/tasks/{taskId}/status`\n\nCheck status of folder update. Folder updates happen asynchronously.\n\n### Parameters\n\n- `taskId: string`\n\n### Returns\n\n- `{ completedAt: string; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; taskId: string; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }; }`\n\n - `completedAt: string`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `taskId: string`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n - `result?: { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folderActionResponse = await client.files.folders.getUpdateAsyncStatus('taskId');\n\nconsole.log(folderActionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.getUpdateAsyncStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folderActionResponse = await client.files.folders.getUpdateAsyncStatus('taskId');\n\nconsole.log(folderActionResponse.completedAt);", - }, - python: { - method: 'files.folders.get_update_async_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder_action_response = client.files.folders.get_update_async_status(\n "taskId",\n)\nprint(folder_action_response.completed_at)', - }, - java: { - method: 'files().folders().getUpdateAsyncStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FolderActionResponse;\nimport com.hubspot.sdk.models.files.folders.FolderGetUpdateAsyncStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderActionResponse folderActionResponse = client.files().folders().getUpdateAsyncStatus("taskId");\n }\n}', - }, - go: { - method: 'client.Files.Folders.GetUpdateAsyncStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolderActionResponse, err := client.Files.Folders.GetUpdateAsyncStatus(context.TODO(), "taskId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folderActionResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'files.folders.get_update_async_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder_action_response = hubspot.files.folders.get_update_async_status("taskId")\n\nputs(folder_action_response)', - }, - php: { - method: 'files->folders->getUpdateAsyncStatus', - example: - "files->folders->getUpdateAsyncStatus('taskId');\n\nvar_dump($folderActionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/update/async/tasks/$TASK_ID/status \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search', - endpoint: '/files/2026-03/folders/search', - httpMethod: 'get', - summary: 'Search folders', - description: 'Search for folders. Does not contain hidden or archived folders.', - stainlessPath: '(resource) files.folders > (method) search', - qualified: 'client.files.folders.search', - params: [ - 'after?: string;', - 'before?: string;', - 'createdAt?: string;', - 'createdAtGte?: string;', - 'createdAtLte?: string;', - 'idGte?: number;', - 'idLte?: number;', - 'ids?: number[];', - 'limit?: number;', - 'name?: string;', - 'parentFolderIds?: number[];', - 'path?: string;', - 'properties?: string[];', - 'sort?: string[];', - 'updatedAt?: string;', - 'updatedAtGte?: string;', - 'updatedAtLte?: string;', - ], - response: - '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', - markdown: - "## search\n\n`client.files.folders.search(after?: string, before?: string, createdAt?: string, createdAtGte?: string, createdAtLte?: string, idGte?: number, idLte?: number, ids?: number[], limit?: number, name?: string, parentFolderIds?: number[], path?: string, properties?: string[], sort?: string[], updatedAt?: string, updatedAtGte?: string, updatedAtLte?: string): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**get** `/files/2026-03/folders/search`\n\nSearch for folders. Does not contain hidden or archived folders.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `createdAt?: string`\n\n- `createdAtGte?: string`\n\n- `createdAtLte?: string`\n\n- `idGte?: number`\n\n- `idLte?: number`\n\n- `ids?: number[]`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `parentFolderIds?: number[]`\n\n- `path?: string`\n\n- `properties?: string[]`\n\n- `sort?: string[]`\n\n- `updatedAt?: string`\n\n- `updatedAtGte?: string`\n\n- `updatedAtLte?: string`\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const folder of client.files.folders.search()) {\n console.log(folder);\n}\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.search', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const folder of client.files.folders.search()) {\n console.log(folder.id);\n}", - }, - python: { - method: 'files.folders.search', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.files.folders.search()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'files().folders().search', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.folders.FolderSearchPage;\nimport com.hubspot.sdk.models.files.folders.FolderSearchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderSearchPage page = client.files().folders().search();\n }\n}', - }, - go: { - method: 'client.Files.Folders.Search', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Files.Folders.Search(context.TODO(), files.FolderSearchParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'files.folders.search', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.files.folders.search\n\nputs(page)', - }, - php: { - method: 'files->folders->search', - example: - "files->folders->search(\n after: 'after',\n before: 'before',\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n idGte: 0,\n idLte: 0,\n ids: [0],\n limit: 0,\n name: 'name',\n parentFolderIDs: [0],\n path: 'path',\n properties: ['string'],\n sort: ['string'],\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtGte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAtLte: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_async_by_id', - endpoint: '/files/2026-03/folders/update/async', - httpMethod: 'post', - summary: 'Update folder properties', - description: - "Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.", - stainlessPath: '(resource) files.folders > (method) update_async_by_id', - qualified: 'client.files.folders.updateAsyncByID', - params: ['id: string;', 'name?: string;', 'parentFolderId?: number;'], - response: '{ id: string; links?: object; }', - markdown: - "## update_async_by_id\n\n`client.files.folders.updateAsyncByID(id: string, name?: string, parentFolderId?: number): { id: string; links?: object; }`\n\n**post** `/files/2026-03/folders/update/async`\n\nUpdate properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.\n\n### Parameters\n\n- `id: string`\n The unique identifier of the folder to be updated.\n\n- `name?: string`\n New name. If specified the folder's name and fullPath will change. All children of the folder will be updated accordingly.\n\n- `parentFolderId?: number`\n New parent folderId. If changed, the folder and all it's children will be moved into the specified folder. parentFolderId and parentFolderPath cannot be specified at the same time.\n\n### Returns\n\n- `{ id: string; links?: object; }`\n\n - `id: string`\n - `links?: object`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folderUpdateTaskLocator = await client.files.folders.updateAsyncByID({ id: 'id' });\n\nconsole.log(folderUpdateTaskLocator);\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.updateAsyncByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folderUpdateTaskLocator = await client.files.folders.updateAsyncByID({ id: 'id' });\n\nconsole.log(folderUpdateTaskLocator.id);", - }, - python: { - method: 'files.folders.update_async_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder_update_task_locator = client.files.folders.update_async_by_id(\n id="id",\n)\nprint(folder_update_task_locator.id)', - }, - java: { - method: 'files().folders().updateAsyncById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.FolderUpdateInputWithId;\nimport com.hubspot.sdk.models.files.FolderUpdateTaskLocator;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateInputWithId params = FolderUpdateInputWithId.builder()\n .id("id")\n .build();\n FolderUpdateTaskLocator folderUpdateTaskLocator = client.files().folders().updateAsyncById(params);\n }\n}', - }, - go: { - method: 'client.Files.Folders.UpdateAsyncByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolderUpdateTaskLocator, err := client.Files.Folders.UpdateAsyncByID(context.TODO(), files.FolderUpdateAsyncByIDParams{\n\t\tFolderUpdateInputWithID: files.FolderUpdateInputWithIDParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folderUpdateTaskLocator.ID)\n}\n', - }, - ruby: { - method: 'files.folders.update_async_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder_update_task_locator = hubspot.files.folders.update_async_by_id(id: "id")\n\nputs(folder_update_task_locator)', - }, - php: { - method: 'files->folders->updateAsyncByID', - example: - "files->folders->updateAsyncByID(\n id: 'id', name: 'name', parentFolderID: 0\n);\n\nvar_dump($folderUpdateTaskLocator);", - }, - http: { - example: - 'curl https://api.hubapi.com/files/2026-03/folders/update/async \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'update_by_id', - endpoint: '/files/2026-03/folders/{folderId}', - httpMethod: 'patch', - summary: 'Update folder properties by folder ID', - description: "Update a folder's properties, identified by folder ID.", - stainlessPath: '(resource) files.folders > (method) update_by_id', - qualified: 'client.files.folders.updateByID', - params: ['folderId: string;', 'name?: string;', 'parentFolderId?: number;'], - response: - '{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }', - markdown: - "## update_by_id\n\n`client.files.folders.updateByID(folderId: string, name?: string, parentFolderId?: number): { id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n**patch** `/files/2026-03/folders/{folderId}`\n\nUpdate a folder's properties, identified by folder ID.\n\n### Parameters\n\n- `folderId: string`\n\n- `name?: string`\n New name. If specified the folder's name and fullPath will change. All children of the folder will be updated accordingly.\n\n- `parentFolderId?: number`\n New parent folderId. If changed, the folder and all it's children will be moved into the specified folder. parentFolderId and parentFolderPath cannot be specified at the same time.\n\n### Returns\n\n- `{ id: string; archived: boolean; createdAt: string; updatedAt: string; archivedAt?: string; name?: string; parentFolderId?: string; path?: string; }`\n\n - `id: string`\n - `archived: boolean`\n - `createdAt: string`\n - `updatedAt: string`\n - `archivedAt?: string`\n - `name?: string`\n - `parentFolderId?: string`\n - `path?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst folder = await client.files.folders.updateByID('321669910225');\n\nconsole.log(folder);\n```", - perLanguage: { - typescript: { - method: 'client.files.folders.updateByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst folder = await client.files.folders.updateByID('321669910225');\n\nconsole.log(folder.id);", - }, - python: { - method: 'files.folders.update_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfolder = client.files.folders.update_by_id(\n folder_id="321669910225",\n)\nprint(folder.id)', - }, - java: { - method: 'files().folders().updateById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.files.Folder;\nimport com.hubspot.sdk.models.files.FolderUpdateInput;\nimport com.hubspot.sdk.models.files.folders.FolderUpdateByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FolderUpdateByIdParams params = FolderUpdateByIdParams.builder()\n .folderId("321669910225")\n .folderUpdateInput(FolderUpdateInput.builder().build())\n .build();\n Folder folder = client.files().folders().updateById(params);\n }\n}', - }, - go: { - method: 'client.Files.Folders.UpdateByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/files"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfolder, err := client.Files.Folders.UpdateByID(\n\t\tcontext.TODO(),\n\t\t"321669910225",\n\t\tfiles.FolderUpdateByIDParams{\n\t\t\tFolderUpdateInput: files.FolderUpdateInputParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", folder.ID)\n}\n', - }, - ruby: { - method: 'files.folders.update_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfolder = hubspot.files.folders.update_by_id("321669910225")\n\nputs(folder)', - }, - php: { - method: 'files->folders->updateByID', - example: - "files->folders->updateByID(\n '321669910225', name: 'name', parentFolderID: 0\n);\n\nvar_dump($folder);", - }, - http: { - example: - "curl https://api.hubapi.com/files/2026-03/folders/$FOLDER_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/campaigns/2026-03', - httpMethod: 'post', - summary: 'Create a campaign', - description: - "Create a campaign with the specified properties and receive a copy of the campaign object, including its ID. Note that the 'hs_goal' property is deprecated and will be ignored if provided.", - stainlessPath: '(resource) marketing.campaigns > (method) create', - qualified: 'client.marketing.campaigns.create', - params: ['properties: object;'], - response: - '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', - markdown: - "## create\n\n`client.marketing.campaigns.create(properties: object): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**post** `/marketing/campaigns/2026-03`\n\nCreate a campaign with the specified properties and receive a copy of the campaign object, including its ID. Note that the 'hs_goal' property is deprecated and will be ignored if provided.\n\n### Parameters\n\n- `properties: object`\n A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.\n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaign = await client.marketing.campaigns.create({ properties: { foo: 'string' } });\n\nconsole.log(publicCampaign);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaign = await client.marketing.campaigns.create({ properties: { foo: 'string' } });\n\nconsole.log(publicCampaign.id);", - }, - python: { - method: 'marketing.campaigns.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign = client.marketing.campaigns.create(\n properties={\n "foo": "string"\n },\n)\nprint(public_campaign.id)', - }, - java: { - method: 'marketing().campaigns().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCampaignInput params = PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\n PublicCampaign publicCampaign = client.marketing().campaigns().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaign, err := client.Marketing.Campaigns.New(context.TODO(), marketing.CampaignNewParams{\n\t\tPublicCampaignInput: marketing.PublicCampaignInputParam{\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaign.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign = hubspot.marketing.campaigns.create(properties: {foo: "string"})\n\nputs(public_campaign)', - }, - php: { - method: 'marketing->campaigns->create', - example: - "marketing->campaigns->create(\n properties: ['foo' => 'string']\n);\n\nvar_dump($publicCampaign);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', - httpMethod: 'delete', - summary: 'Delete campaign ', - description: - 'Delete a specified campaign from the system.\nThis call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.', - stainlessPath: '(resource) marketing.campaigns > (method) delete', - qualified: 'client.marketing.campaigns.delete', - params: ['campaignGuid: string;'], - markdown: - "## delete\n\n`client.marketing.campaigns.delete(campaignGuid: string): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nDelete a specified campaign from the system.\nThis call will return a 204 No Content response regardless of whether the campaignGuid provided corresponds to an existing campaign or not.\n\n### Parameters\n\n- `campaignGuid: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.delete('campaignGuid')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.delete('campaignGuid');", - }, - python: { - method: 'marketing.campaigns.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.delete(\n "campaignGuid",\n)', - }, - java: { - method: 'marketing().campaigns().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().campaigns().delete("campaignGuid");\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Delete(context.TODO(), "campaignGuid")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.delete("campaignGuid")\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->delete', - example: - "marketing->campaigns->delete('campaignGuid');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', - httpMethod: 'get', - summary: 'Read a campaign', - description: - "Get a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.", - stainlessPath: '(resource) marketing.campaigns > (method) get', - qualified: 'client.marketing.campaigns.get', - params: ['campaignGuid: string;', 'endDate?: string;', 'properties?: string[];', 'startDate?: string;'], - response: - '{ id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', - markdown: - "## get\n\n`client.marketing.campaigns.get(campaignGuid: string, endDate?: string, properties?: string[], startDate?: string): { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nGet a campaign identified by a specific campaignGuid with the given properties. Along with the campaign information, it also returns information about assets. Depending on the query parameters used, this can also be used to return information about the corresponding assets' metrics. Metrics are available only if startDate and endDate are provided.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `endDate?: string`\n The end date for fetching asset metrics, in YYYY-MM-DD format.\nOptional. Example: 2000-01-27\n\n- `properties?: string[]`\n A comma-separated list of properties to include in the response. \n Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes\n\n- `startDate?: string`\n The start date for fetching asset metrics, in YYYY-MM-DD format. \nOptional. Example: 2000-01-20 \n\n### Returns\n\n- `{ id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `assets: object`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaignWithAssets = await client.marketing.campaigns.get('campaignGuid');\n\nconsole.log(publicCampaignWithAssets);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaignWithAssets = await client.marketing.campaigns.get('campaignGuid');\n\nconsole.log(publicCampaignWithAssets.id);", - }, - python: { - method: 'marketing.campaigns.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign_with_assets = client.marketing.campaigns.get(\n campaign_guid="campaignGuid",\n)\nprint(public_campaign_with_assets.id)', - }, - java: { - method: 'marketing().campaigns().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignGetParams;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignWithAssets;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicCampaignWithAssets publicCampaignWithAssets = client.marketing().campaigns().get("campaignGuid");\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaignWithAssets, err := client.Marketing.Campaigns.Get(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaignWithAssets.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign_with_assets = hubspot.marketing.campaigns.get("campaignGuid")\n\nputs(public_campaign_with_assets)', - }, - php: { - method: 'marketing->campaigns->get', - example: - "marketing->campaigns->get(\n 'campaignGuid',\n endDate: 'endDate',\n properties: ['string'],\n startDate: 'startDate',\n);\n\nvar_dump($publicCampaignWithAssets);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/campaigns/2026-03', - httpMethod: 'get', - summary: 'Retrieve campaigns', - description: - 'Retrieve a paginated list of campaigns from your HubSpot account. This endpoint allows you to specify sorting, pagination, and filtering options to tailor the results to your needs.', - stainlessPath: '(resource) marketing.campaigns > (method) list', - qualified: 'client.marketing.campaigns.list', - params: [ - 'after?: string;', - 'limit?: number;', - 'name?: string;', - 'properties?: string[];', - 'sort?: string;', - ], - response: - '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', - markdown: - "## list\n\n`client.marketing.campaigns.list(after?: string, limit?: number, name?: string, properties?: string[], sort?: string): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**get** `/marketing/campaigns/2026-03`\n\nRetrieve a paginated list of campaigns from your HubSpot account. This endpoint allows you to specify sorting, pagination, and filtering options to tailor the results to your needs.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n Filter campaigns by name. Optional. \n\n- `properties?: string[]`\n A comma-separated list of properties to include in the response. \n Unrecognized properties are ignored. Optional. Example: \n hs_name, hs_budget,hs_notes\n\n- `sort?: string`\n The property to sort results by. Optional. \n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicCampaign of client.marketing.campaigns.list()) {\n console.log(publicCampaign);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicCampaign of client.marketing.campaigns.list()) {\n console.log(publicCampaign.id);\n}", - }, - python: { - method: 'marketing.campaigns.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.campaigns.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().campaigns().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignListPage;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CampaignListPage page = client.marketing().campaigns().list();\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Campaigns.List(context.TODO(), marketing.CampaignListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.campaigns.list\n\nputs(page)', - }, - php: { - method: 'marketing->campaigns->list', - example: - "marketing->campaigns->list(\n after: 'after', limit: 0, name: 'name', properties: ['string'], sort: 'sort'\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}', - httpMethod: 'patch', - summary: 'Update campaign', - description: - "Perform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error.\nIf an empty string is passed for any property in the Batch Update, it will reset that property's value.\n", - stainlessPath: '(resource) marketing.campaigns > (method) update', - qualified: 'client.marketing.campaigns.update', - params: ['campaignGuid: string;', 'properties: object;'], - response: - '{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }', - markdown: - "## update\n\n`client.marketing.campaigns.update(campaignGuid: string, properties: object): { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }`\n\n**patch** `/marketing/campaigns/2026-03/{campaignGuid}`\n\nPerform a partial update of a campaign identified by the specified campaignGuid. Provided property values will be overwritten. Read-only and non-existent properties will cause 400 error.\nIf an empty string is passed for any property in the Batch Update, it will reset that property's value.\n\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `properties: object`\n A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.\n\n### Returns\n\n- `{ id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }`\n\n - `id: string`\n - `businessUnits: { id: number; }[]`\n - `createdAt: string`\n - `properties: object`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicCampaign = await client.marketing.campaigns.update('campaignGuid', { properties: { foo: 'string' } });\n\nconsole.log(publicCampaign);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicCampaign = await client.marketing.campaigns.update('campaignGuid', {\n properties: { foo: 'string' },\n});\n\nconsole.log(publicCampaign.id);", - }, - python: { - method: 'marketing.campaigns.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_campaign = client.marketing.campaigns.update(\n campaign_guid="campaignGuid",\n properties={\n "foo": "string"\n },\n)\nprint(public_campaign.id)', - }, - java: { - method: 'marketing().campaigns().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.CampaignUpdateParams;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CampaignUpdateParams params = CampaignUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .publicCampaignInput(PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n PublicCampaign publicCampaign = client.marketing().campaigns().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicCampaign, err := client.Marketing.Campaigns.Update(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignUpdateParams{\n\t\t\tPublicCampaignInput: marketing.PublicCampaignInputParam{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicCampaign.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_campaign = hubspot.marketing.campaigns.update("campaignGuid", properties: {foo: "string"})\n\nputs(public_campaign)', - }, - php: { - method: 'marketing->campaigns->update', - example: - "marketing->campaigns->update(\n 'campaignGuid', properties: ['foo' => 'string']\n);\n\nvar_dump($publicCampaign);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "properties": {\n "foo": "string"\n }\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', - httpMethod: 'delete', - summary: 'Remove asset association', - description: - 'Disassociate a specified asset from a campaign. Using the API, you can remove associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.', - stainlessPath: '(resource) marketing.campaigns.assets > (method) delete', - qualified: 'client.marketing.campaigns.assets.delete', - params: ['campaignGuid: string;', 'assetType: string;', 'assetId: string;'], - markdown: - "## delete\n\n`client.marketing.campaigns.assets.delete(campaignGuid: string, assetType: string, assetId: string): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}`\n\nDisassociate a specified asset from a campaign. Using the API, you can remove associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `assetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.assets.delete('assetId', { campaignGuid: 'campaignGuid', assetType: 'assetType' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.assets.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.assets.delete('assetId', {\n campaignGuid: 'campaignGuid',\n assetType: 'assetType',\n});", - }, - python: { - method: 'marketing.campaigns.assets.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.assets.delete(\n asset_id="assetId",\n campaign_guid="campaignGuid",\n asset_type="assetType",\n)', - }, - java: { - method: 'marketing().campaigns().assets().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetDeleteParams params = AssetDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .assetId("assetId")\n .build();\n client.marketing().campaigns().assets().delete(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Assets.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Assets.Delete(\n\t\tcontext.TODO(),\n\t\t"assetId",\n\t\tmarketing.CampaignAssetDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tAssetType: "assetType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.assets.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.assets.delete(\n "assetId",\n campaign_guid: "campaignGuid",\n asset_type: "assetType"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->assets->delete', - example: - "marketing->campaigns->assets->delete(\n 'assetId', campaignGuid: 'campaignGuid', assetType: 'assetType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE/$ASSET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}', - httpMethod: 'get', - summary: 'List assets', - description: - 'This endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type.\nAsset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.', - stainlessPath: '(resource) marketing.campaigns.assets > (method) list', - qualified: 'client.marketing.campaigns.assets.list', - params: [ - 'campaignGuid: string;', - 'assetType: string;', - 'after?: string;', - 'endDate?: string;', - 'limit?: string;', - 'startDate?: string;', - ], - response: - '{ results: { id: string; metrics?: object; name?: string; }[]; paging?: { next?: next_page; }; }', - markdown: - "## list\n\n`client.marketing.campaigns.assets.list(campaignGuid: string, assetType: string, after?: string, endDate?: string, limit?: string, startDate?: string): { results: public_campaign_asset[]; paging?: forward_paging; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}`\n\nThis endpoint lists all assets of the campaign by asset type. The assetType parameter is required, and each request can only fetch assets of a single type.\nAsset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `endDate?: string`\n End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2024-01-27\n\n- `limit?: string`\n The maximum number of results to display per page.\n\n- `startDate?: string`\n Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2023-01-20\n\n### Returns\n\n- `{ results: { id: string; metrics?: object; name?: string; }[]; paging?: { next?: next_page; }; }`\n\n - `results: { id: string; metrics?: object; name?: string; }[]`\n - `paging?: { next?: { after: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicCampaignAssetForwardPaging = await client.marketing.campaigns.assets.list('assetType', { campaignGuid: 'campaignGuid' });\n\nconsole.log(collectionResponsePublicCampaignAssetForwardPaging);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.assets.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicCampaignAssetForwardPaging =\n await client.marketing.campaigns.assets.list('assetType', { campaignGuid: 'campaignGuid' });\n\nconsole.log(collectionResponsePublicCampaignAssetForwardPaging.results);", - }, - python: { - method: 'marketing.campaigns.assets.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_campaign_asset_forward_paging = client.marketing.campaigns.assets.list(\n asset_type="assetType",\n campaign_guid="campaignGuid",\n)\nprint(collection_response_public_campaign_asset_forward_paging.results)', - }, - java: { - method: 'marketing().campaigns().assets().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.CollectionResponsePublicCampaignAssetForwardPaging;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetListParams params = AssetListParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .build();\n CollectionResponsePublicCampaignAssetForwardPaging collectionResponsePublicCampaignAssetForwardPaging = client.marketing().campaigns().assets().list(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Assets.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicCampaignAssetForwardPaging, err := client.Marketing.Campaigns.Assets.List(\n\t\tcontext.TODO(),\n\t\t"assetType",\n\t\tmarketing.CampaignAssetListParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicCampaignAssetForwardPaging.Results)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.assets.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_campaign_asset_forward_paging = hubspot.marketing.campaigns.assets.list("assetType", campaign_guid: "campaignGuid")\n\nputs(collection_response_public_campaign_asset_forward_paging)', - }, - php: { - method: 'marketing->campaigns->assets->list', - example: - "marketing\n ->campaigns\n ->assets\n ->list(\n 'assetType',\n campaignGuid: 'campaignGuid',\n after: 'after',\n endDate: 'endDate',\n limit: 'limit',\n startDate: 'startDate',\n);\n\nvar_dump($collectionResponsePublicCampaignAssetForwardPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', - httpMethod: 'put', - summary: 'Add asset association', - description: - 'Associate a specified asset with a campaign. Using the API, you can create associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.', - stainlessPath: '(resource) marketing.campaigns.assets > (method) update', - qualified: 'client.marketing.campaigns.assets.update', - params: ['campaignGuid: string;', 'assetType: string;', 'assetId: string;'], - markdown: - "## update\n\n`client.marketing.campaigns.assets.update(campaignGuid: string, assetType: string, assetId: string): void`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}`\n\nAssociate a specified asset with a campaign. Using the API, you can create associations for the following asset types: ads, blog posts, calls, case studies, CTAs, CTAs (legacy), external website pages, feedback surveys, forms, files, knowledge base articles, landing pages, marketing email, marketing events, meetings, playbooks, podcast episodes, sales documents, sales emails, sequences, SMS, social posts, static lists, videos, website pages, and workflows.\n\nFor other asset types, it is recommended to manage your associations directly in the campaign tool in HubSpot.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `assetType: string`\n\n- `assetId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.assets.update('assetId', { campaignGuid: 'campaignGuid', assetType: 'assetType' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.assets.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.assets.update('assetId', {\n campaignGuid: 'campaignGuid',\n assetType: 'assetType',\n});", - }, - python: { - method: 'marketing.campaigns.assets.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.assets.update(\n asset_id="assetId",\n campaign_guid="campaignGuid",\n asset_type="assetType",\n)', - }, - java: { - method: 'marketing().campaigns().assets().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.assets.AssetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AssetUpdateParams params = AssetUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .assetType("assetType")\n .assetId("assetId")\n .build();\n client.marketing().campaigns().assets().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Assets.Update', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Assets.Update(\n\t\tcontext.TODO(),\n\t\t"assetId",\n\t\tmarketing.CampaignAssetUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tAssetType: "assetType",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.assets.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.assets.update(\n "assetId",\n campaign_guid: "campaignGuid",\n asset_type: "assetType"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->assets->update', - example: - "marketing->campaigns->assets->update(\n 'assetId', campaignGuid: 'campaignGuid', assetType: 'assetType'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/assets/$ASSET_TYPE/$ASSET_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/campaigns/2026-03/batch/create', - httpMethod: 'post', - summary: 'Create a batch of campaigns', - description: - 'This endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.', - stainlessPath: '(resource) marketing.campaigns.batch > (method) create', - qualified: 'client.marketing.campaigns.batch.create', - params: ['inputs: { properties: object; }[];'], - response: - "{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.marketing.campaigns.batch.create(inputs: { properties: object; }[]): { completedAt: string; results: public_campaign[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/create`\n\nThis endpoint creates a batch of campaigns. The maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\n\n### Parameters\n\n- `inputs: { properties: object; }[]`\n An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.create({ inputs: [{ properties: { foo: 'string' } }] });\n\nconsole.log(batchResponsePublicCampaign);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.create({\n inputs: [{ properties: { foo: 'string' } }],\n});\n\nconsole.log(batchResponsePublicCampaign.completedAt);", - }, - python: { - method: 'marketing.campaigns.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign = client.marketing.campaigns.batch.create(\n inputs=[{\n "properties": {\n "foo": "string"\n }\n }],\n)\nprint(batch_response_public_campaign.completed_at)', - }, - java: { - method: 'marketing().campaigns().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignInput;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignInput params = BatchInputPublicCampaignInput.builder()\n .addInput(PublicCampaignInput.builder()\n .properties(PublicCampaignInput.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponsePublicCampaign batchResponsePublicCampaign = client.marketing().campaigns().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaign, err := client.Marketing.Campaigns.Batch.New(context.TODO(), marketing.CampaignBatchNewParams{\n\t\tBatchInputPublicCampaignInput: marketing.BatchInputPublicCampaignInputParam{\n\t\t\tInputs: []marketing.PublicCampaignInputParam{{\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaign.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign = hubspot.marketing.campaigns.batch.create(inputs: [{properties: {foo: "string"}}])\n\nputs(batch_response_public_campaign)', - }, - php: { - method: 'marketing->campaigns->batch->create', - example: - "marketing->campaigns->batch->create(\n inputs: [['properties' => ['foo' => 'string']]]\n);\n\nvar_dump($batchResponsePublicCampaign);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/campaigns/2026-03/batch/archive', - httpMethod: 'post', - summary: 'Delete a batch of campaigns', - description: - 'This endpoint deletes a batch of campaigns. \nThe maximum number of items in a batch request is 50.\nThe response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.', - stainlessPath: '(resource) marketing.campaigns.batch > (method) delete', - qualified: 'client.marketing.campaigns.batch.delete', - params: ['inputs: { id: string; }[];'], - markdown: - "## delete\n\n`client.marketing.campaigns.batch.delete(inputs: { id: string; }[]): void`\n\n**post** `/marketing/campaigns/2026-03/batch/archive`\n\nThis endpoint deletes a batch of campaigns. \nThe maximum number of items in a batch request is 50.\nThe response will always be 204 No Content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.batch.delete({ inputs: [{ id: 'id' }] })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.batch.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.batch.delete({ inputs: [{ id: 'id' }] });", - }, - python: { - method: 'marketing.campaigns.batch.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.batch.delete(\n inputs=[{\n "id": "id"\n }],\n)', - }, - java: { - method: 'marketing().campaigns().batch().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignDeleteInput;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignDeleteInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignDeleteInput params = BatchInputPublicCampaignDeleteInput.builder()\n .addInput(PublicCampaignDeleteInput.builder()\n .id("id")\n .build())\n .build();\n client.marketing().campaigns().batch().delete(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Batch.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Batch.Delete(context.TODO(), marketing.CampaignBatchDeleteParams{\n\t\tBatchInputPublicCampaignDeleteInput: marketing.BatchInputPublicCampaignDeleteInputParam{\n\t\t\tInputs: []marketing.PublicCampaignDeleteInputParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.batch.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.batch.delete(inputs: [{id: "id"}])\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->batch->delete', - example: - "marketing->campaigns->batch->delete(\n inputs: [['id' => 'id']]\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/campaigns/2026-03/batch/read', - httpMethod: 'post', - summary: 'Read a batch of campaigns', - description: - 'This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. \nThe maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\nIf duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.\n', - stainlessPath: '(resource) marketing.campaigns.batch > (method) get', - qualified: 'client.marketing.campaigns.batch.get', - params: [ - 'inputs: { id: string; }[];', - 'endDate?: string;', - 'properties?: string[];', - 'startDate?: string;', - ], - response: - "{ completedAt: string; results: { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.marketing.campaigns.batch.get(inputs: { id: string; }[], endDate?: string, properties?: string[], startDate?: string): { completedAt: string; results: public_campaign_with_assets[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/read`\n\nThis endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. \nThe maximum number of items in a batch request is 50.\nThe campaigns in the response are not guaranteed to be in the same order as they were provided in the request.\nIf duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.\n\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.\n\n- `endDate?: string`\n End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2024-01-27\n\n- `properties?: string[]`\n A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map.\nExample: hs_name, hs_campaign_status, hs_notes\n\n- `startDate?: string`\n Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched.\nExample: 2023-01-20\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; assets: object; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; assets: object; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaignWithAssets = await client.marketing.campaigns.batch.get({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponsePublicCampaignWithAssets);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaignWithAssets = await client.marketing.campaigns.batch.get({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponsePublicCampaignWithAssets.completedAt);", - }, - python: { - method: 'marketing.campaigns.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign_with_assets = client.marketing.campaigns.batch.get(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_public_campaign_with_assets.completed_at)', - }, - java: { - method: 'marketing().campaigns().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignReadInput;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaignWithAssets;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignReadInput;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignReadInput params = BatchInputPublicCampaignReadInput.builder()\n .addInput(PublicCampaignReadInput.builder()\n .id("id")\n .build())\n .build();\n BatchResponsePublicCampaignWithAssets batchResponsePublicCampaignWithAssets = client.marketing().campaigns().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaignWithAssets, err := client.Marketing.Campaigns.Batch.Get(context.TODO(), marketing.CampaignBatchGetParams{\n\t\tBatchInputPublicCampaignReadInput: marketing.BatchInputPublicCampaignReadInputParam{\n\t\t\tInputs: []marketing.PublicCampaignReadInputParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaignWithAssets.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign_with_assets = hubspot.marketing.campaigns.batch.get(inputs: [{id: "id"}])\n\nputs(batch_response_public_campaign_with_assets)', - }, - php: { - method: 'marketing->campaigns->batch->get', - example: - "marketing\n ->campaigns\n ->batch\n ->get(\n inputs: [['id' => 'id']],\n endDate: 'endDate',\n properties: ['string'],\n startDate: 'startDate',\n);\n\nvar_dump($batchResponsePublicCampaignWithAssets);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/campaigns/2026-03/batch/update', - httpMethod: 'post', - summary: 'Update a batch of campaigns', - description: - 'This endpoint updates a batch of campaigns based on the provided input data.\nThe maximum number of items in a batch request is 50.\nIf an empty string ("") is passed for any property in the Batch Update, it will reset that property\'s value.', - stainlessPath: '(resource) marketing.campaigns.batch > (method) update', - qualified: 'client.marketing.campaigns.batch.update', - params: ['inputs: { id: string; properties: object; }[];'], - response: - "{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.marketing.campaigns.batch.update(inputs: { id: string; properties: object; }[]): { completedAt: string; results: public_campaign[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/campaigns/2026-03/batch/update`\n\nThis endpoint updates a batch of campaigns based on the provided input data.\nThe maximum number of items in a batch request is 50.\nIf an empty string (\"\") is passed for any property in the Batch Update, it will reset that property's value.\n\n### Parameters\n\n- `inputs: { id: string; properties: object; }[]`\n An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; businessUnits: public_business_unit[]; createdAt: string; properties: object; updatedAt: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; businessUnits: { id: number; }[]; createdAt: string; properties: object; updatedAt: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.update({ inputs: [{\n id: 'id',\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponsePublicCampaign);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponsePublicCampaign = await client.marketing.campaigns.batch.update({\n inputs: [\n {\n id: 'id',\n properties: { foo: 'string' },\n },\n ],\n});\n\nconsole.log(batchResponsePublicCampaign.completedAt);", - }, - python: { - method: 'marketing.campaigns.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_public_campaign = client.marketing.campaigns.batch.update(\n inputs=[{\n "id": "id",\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_public_campaign.completed_at)', - }, - java: { - method: 'marketing().campaigns().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchInputPublicCampaignBatchUpdateItem;\nimport com.hubspot.sdk.models.marketing.campaigns.BatchResponsePublicCampaign;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicCampaignBatchUpdateItem;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicCampaignBatchUpdateItem params = BatchInputPublicCampaignBatchUpdateItem.builder()\n .addInput(PublicCampaignBatchUpdateItem.builder()\n .id("id")\n .properties(PublicCampaignBatchUpdateItem.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build();\n BatchResponsePublicCampaign batchResponsePublicCampaign = client.marketing().campaigns().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponsePublicCampaign, err := client.Marketing.Campaigns.Batch.Update(context.TODO(), marketing.CampaignBatchUpdateParams{\n\t\tBatchInputPublicCampaignBatchUpdateItem: marketing.BatchInputPublicCampaignBatchUpdateItemParam{\n\t\t\tInputs: []marketing.PublicCampaignBatchUpdateItemParam{{\n\t\t\t\tID: "id",\n\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t"foo": "string",\n\t\t\t\t},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponsePublicCampaign.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_public_campaign = hubspot.marketing.campaigns.batch.update(inputs: [{id: "id", properties: {foo: "string"}}])\n\nputs(batch_response_public_campaign)', - }, - php: { - method: 'marketing->campaigns->batch->update', - example: - "marketing->campaigns->batch->update(\n inputs: [['id' => 'id', 'properties' => ['foo' => 'string']]]\n);\n\nvar_dump($batchResponsePublicCampaign);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget', - httpMethod: 'post', - summary: 'Add budget item', - description: 'Add a new budget item to the campaign', - stainlessPath: '(resource) marketing.campaigns.budget > (method) create', - qualified: 'client.marketing.campaigns.budget.create', - params: [ - 'campaignGuid: string;', - 'amount: number;', - 'name: string;', - 'order: number;', - 'description?: string;', - ], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## create\n\n`client.marketing.campaigns.budget.create(campaignGuid: string, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**post** `/marketing/campaigns/2026-03/{campaignGuid}/budget`\n\nAdd a new budget item to the campaign\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `amount: number`\n The monetary value assigned to the budget item.\n\n- `name: string`\n The name of the budget item.\n\n- `order: number`\n The sequence number indicating the order of the budget item.\n\n- `description?: string`\n A detailed explanation or notes about the budget item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.budget.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem.id);", - }, - python: { - method: 'marketing.campaigns.budget.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.create(\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_budget_item.id)', - }, - java: { - method: 'marketing().campaigns().budget().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetCreateParams params = BudgetCreateParams.builder()\n .campaignGuid("campaignGuid")\n .publicBudgetItemInput(PublicBudgetItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Budget.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.New(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignBudgetNewParams{\n\t\t\tPublicBudgetItemInput: marketing.PublicBudgetItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.budget.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.create("campaignGuid", amount: 0, name: "name", order: 0)\n\nputs(public_budget_item)', - }, - php: { - method: 'marketing->campaigns->budget->create', - example: - "marketing->campaigns->budget->create(\n 'campaignGuid', amount: 0, name: 'name', order: 0, description: 'description'\n);\n\nvar_dump($publicBudgetItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - httpMethod: 'delete', - summary: 'Delete budget item', - description: 'Delete a specific budget item by ID', - stainlessPath: '(resource) marketing.campaigns.budget > (method) delete', - qualified: 'client.marketing.campaigns.budget.delete', - params: ['campaignGuid: string;', 'budgetId: number;'], - markdown: - "## delete\n\n`client.marketing.campaigns.budget.delete(campaignGuid: string, budgetId: number): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nDelete a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.budget.delete(0, { campaignGuid: 'campaignGuid' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.budget.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.budget.delete(0, { campaignGuid: 'campaignGuid' });", - }, - python: { - method: 'marketing.campaigns.budget.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.budget.delete(\n budget_id=0,\n campaign_guid="campaignGuid",\n)', - }, - java: { - method: 'marketing().campaigns().budget().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetDeleteParams params = BudgetDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .build();\n client.marketing().campaigns().budget().delete(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Budget.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Budget.Delete(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.budget.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.budget.delete(0, campaign_guid: "campaignGuid")\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->budget->delete', - example: - "marketing->campaigns->budget->delete(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - httpMethod: 'get', - summary: 'Get budget item', - description: 'Get a specific budget item by ID', - stainlessPath: '(resource) marketing.campaigns.budget > (method) get', - qualified: 'client.marketing.campaigns.budget.get', - params: ['campaignGuid: string;', 'budgetId: number;'], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## get\n\n`client.marketing.campaigns.budget.get(campaignGuid: string, budgetId: number): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nGet a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.get(0, { campaignGuid: 'campaignGuid' });\n\nconsole.log(publicBudgetItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.budget.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.get(0, {\n campaignGuid: 'campaignGuid',\n});\n\nconsole.log(publicBudgetItem.id);", - }, - python: { - method: 'marketing.campaigns.budget.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.get(\n budget_id=0,\n campaign_guid="campaignGuid",\n)\nprint(public_budget_item.id)', - }, - java: { - method: 'marketing().campaigns().budget().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetGetParams params = BudgetGetParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().get(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Budget.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetGetParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.budget.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.get(0, campaign_guid: "campaignGuid")\n\nputs(public_budget_item)', - }, - php: { - method: 'marketing->campaigns->budget->get', - example: - "marketing->campaigns->budget->get(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($publicBudgetItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_totals', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/totals', - httpMethod: 'get', - summary: 'Read budget', - description: - 'Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.\nBudget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer', - stainlessPath: '(resource) marketing.campaigns.budget > (method) get_totals', - qualified: 'client.marketing.campaigns.budget.getTotals', - params: ['campaignGuid: string;'], - response: - '{ budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; currencyCode: string; spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }', - markdown: - "## get_totals\n\n`client.marketing.campaigns.budget.getTotals(campaignGuid: string): { budgetItems: public_budget_item[]; currencyCode: string; spendItems: public_spend_item[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/budget/totals`\n\nRetrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget.\nBudget and Spend items may be returned in any order, but the order field specifies their sequence based on the creation date. The item with order 0 is the oldest, and items with higher order values are newer\n\n### Parameters\n\n- `campaignGuid: string`\n\n### Returns\n\n- `{ budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; currencyCode: string; spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]; budgetTotal?: number; remainingBudget?: number; spendTotal?: number; }`\n\n - `budgetItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]`\n - `currencyCode: string`\n - `spendItems: { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }[]`\n - `budgetTotal?: number`\n - `remainingBudget?: number`\n - `spendTotal?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetTotals = await client.marketing.campaigns.budget.getTotals('campaignGuid');\n\nconsole.log(publicBudgetTotals);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.budget.getTotals', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetTotals = await client.marketing.campaigns.budget.getTotals('campaignGuid');\n\nconsole.log(publicBudgetTotals.budgetItems);", - }, - python: { - method: 'marketing.campaigns.budget.get_totals', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_totals = client.marketing.campaigns.budget.get_totals(\n "campaignGuid",\n)\nprint(public_budget_totals.budget_items)', - }, - java: { - method: 'marketing().campaigns().budget().getTotals', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetTotals;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetGetTotalsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicBudgetTotals publicBudgetTotals = client.marketing().campaigns().budget().getTotals("campaignGuid");\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Budget.GetTotals', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetTotals, err := client.Marketing.Campaigns.Budget.GetTotals(context.TODO(), "campaignGuid")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetTotals.BudgetItems)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.budget.get_totals', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_totals = hubspot.marketing.campaigns.budget.get_totals("campaignGuid")\n\nputs(public_budget_totals)', - }, - php: { - method: 'marketing->campaigns->budget->getTotals', - example: - "marketing->campaigns->budget->getTotals(\n 'campaignGuid'\n);\n\nvar_dump($publicBudgetTotals);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/totals \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - httpMethod: 'put', - summary: 'Update budget item', - description: 'Update a specific budget item by ID', - stainlessPath: '(resource) marketing.campaigns.budget > (method) update', - qualified: 'client.marketing.campaigns.budget.update', - params: [ - 'campaignGuid: string;', - 'budgetId: number;', - 'amount: number;', - 'name: string;', - 'order: number;', - 'description?: string;', - ], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## update\n\n`client.marketing.campaigns.budget.update(campaignGuid: string, budgetId: number, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}`\n\nUpdate a specific budget item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `budgetId: number`\n\n- `amount: number`\n The monetary value assigned to the budget item.\n\n- `name: string`\n The name of the budget item.\n\n- `order: number`\n The sequence number indicating the order of the budget item.\n\n- `description?: string`\n A detailed explanation or notes about the budget item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.budget.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicBudgetItem = await client.marketing.campaigns.budget.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicBudgetItem.id);", - }, - python: { - method: 'marketing.campaigns.budget.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_budget_item = client.marketing.campaigns.budget.update(\n budget_id=0,\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_budget_item.id)', - }, - java: { - method: 'marketing().campaigns().budget().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicBudgetItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.budget.BudgetUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BudgetUpdateParams params = BudgetUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .budgetId(0L)\n .publicBudgetItemInput(PublicBudgetItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicBudgetItem publicBudgetItem = client.marketing().campaigns().budget().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Budget.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicBudgetItem, err := client.Marketing.Campaigns.Budget.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignBudgetUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tPublicBudgetItemInput: marketing.PublicBudgetItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicBudgetItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.budget.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_budget_item = hubspot.marketing.campaigns.budget.update(\n 0,\n campaign_guid: "campaignGuid",\n amount: 0,\n name: "name",\n order: 0\n)\n\nputs(public_budget_item)', - }, - php: { - method: 'marketing->campaigns->budget->update', - example: - "marketing->campaigns->budget->update(\n 0,\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n description: 'description',\n);\n\nvar_dump($publicBudgetItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/budget/$BUDGET_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', - }, - }, - }, - { - name: 'get_attribution_metrics', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics', - httpMethod: 'get', - summary: 'Get Campaign Metrics\n', - description: - 'This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.', - stainlessPath: '(resource) marketing.campaigns.metrics > (method) get_attribution_metrics', - qualified: 'client.marketing.campaigns.metrics.getAttributionMetrics', - params: ['campaignGuid: string;', 'endDate?: string;', 'startDate?: string;'], - response: - '{ influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }', - markdown: - "## get_attribution_metrics\n\n`client.marketing.campaigns.metrics.getAttributionMetrics(campaignGuid: string, endDate?: string, startDate?: string): { influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics`\n\nThis endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `endDate?: string`\n The end date for fetching attribution data, in YYYY-MM-DD format.\nOptional. Example: 2000-01-27 \n\n- `startDate?: string`\n The start date for fetching attribution data, in YYYY-MM-DD format.\nOptional. Example: 2000-01-20\n\n### Returns\n\n- `{ influencedContacts: number; newContactsFirstTouch: number; newContactsLastTouch: number; sessions: number; }`\n\n - `influencedContacts: number`\n - `newContactsFirstTouch: number`\n - `newContactsLastTouch: number`\n - `sessions: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst metricsCounters = await client.marketing.campaigns.metrics.getAttributionMetrics('campaignGuid');\n\nconsole.log(metricsCounters);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.metrics.getAttributionMetrics', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst metricsCounters = await client.marketing.campaigns.metrics.getAttributionMetrics(\n 'campaignGuid',\n);\n\nconsole.log(metricsCounters.influencedContacts);", - }, - python: { - method: 'marketing.campaigns.metrics.get_attribution_metrics', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmetrics_counters = client.marketing.campaigns.metrics.get_attribution_metrics(\n campaign_guid="campaignGuid",\n)\nprint(metrics_counters.influenced_contacts)', - }, - java: { - method: 'marketing().campaigns().metrics().getAttributionMetrics', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.MetricsCounters;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricGetAttributionMetricsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MetricsCounters metricsCounters = client.marketing().campaigns().metrics().getAttributionMetrics("campaignGuid");\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Metrics.GetAttributionMetrics', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmetricsCounters, err := client.Marketing.Campaigns.Metrics.GetAttributionMetrics(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignMetricGetAttributionMetricsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", metricsCounters.InfluencedContacts)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.metrics.get_attribution_metrics', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmetrics_counters = hubspot.marketing.campaigns.metrics.get_attribution_metrics("campaignGuid")\n\nputs(metrics_counters)', - }, - php: { - method: 'marketing->campaigns->metrics->getAttributionMetrics', - example: - "marketing\n ->campaigns\n ->metrics\n ->getAttributionMetrics(\n 'campaignGuid', endDate: 'endDate', startDate: 'startDate'\n);\n\nvar_dump($metricsCounters);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/metrics \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_revenue_attribution', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue', - httpMethod: 'get', - summary: 'Fetch revenue', - description: 'Fetch revenue attribution report data for a specified campaign\n', - stainlessPath: '(resource) marketing.campaigns.metrics > (method) get_revenue_attribution', - qualified: 'client.marketing.campaigns.metrics.getRevenueAttribution', - params: [ - 'campaignGuid: string;', - 'attributionModel?: string;', - 'endDate?: string;', - 'startDate?: string;', - ], - response: - '{ contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }', - markdown: - "## get_revenue_attribution\n\n`client.marketing.campaigns.metrics.getRevenueAttribution(campaignGuid: string, attributionModel?: string, endDate?: string, startDate?: string): { contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue`\n\nFetch revenue attribution report data for a specified campaign\n\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `attributionModel?: string`\n The revenue attribution model used to calculate deal revenue credit. Defaults to LINEAR if not specified. Enum values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED\n\n- `endDate?: string`\n End date to fetch attribution data, YYYY-MM-DD\n\n- `startDate?: string`\n Start date to fetch attribution data, YYYY-MM-DD\n\n### Returns\n\n- `{ contactsNumber?: number; currencyCode?: string; dealAmount?: number; dealsNumber?: number; revenueAmount?: number; }`\n\n - `contactsNumber?: number`\n - `currencyCode?: string`\n - `dealAmount?: number`\n - `dealsNumber?: number`\n - `revenueAmount?: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst revenueAttributionAggregate = await client.marketing.campaigns.metrics.getRevenueAttribution('campaignGuid');\n\nconsole.log(revenueAttributionAggregate);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.metrics.getRevenueAttribution', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst revenueAttributionAggregate = await client.marketing.campaigns.metrics.getRevenueAttribution(\n 'campaignGuid',\n);\n\nconsole.log(revenueAttributionAggregate.contactsNumber);", - }, - python: { - method: 'marketing.campaigns.metrics.get_revenue_attribution', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nrevenue_attribution_aggregate = client.marketing.campaigns.metrics.get_revenue_attribution(\n campaign_guid="campaignGuid",\n)\nprint(revenue_attribution_aggregate.contacts_number)', - }, - java: { - method: 'marketing().campaigns().metrics().getRevenueAttribution', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.RevenueAttributionAggregate;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricGetRevenueAttributionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RevenueAttributionAggregate revenueAttributionAggregate = client.marketing().campaigns().metrics().getRevenueAttribution("campaignGuid");\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Metrics.GetRevenueAttribution', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trevenueAttributionAggregate, err := client.Marketing.Campaigns.Metrics.GetRevenueAttribution(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignMetricGetRevenueAttributionParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", revenueAttributionAggregate.ContactsNumber)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.metrics.get_revenue_attribution', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nrevenue_attribution_aggregate = hubspot.marketing.campaigns.metrics.get_revenue_attribution("campaignGuid")\n\nputs(revenue_attribution_aggregate)', - }, - php: { - method: 'marketing->campaigns->metrics->getRevenueAttribution', - example: - "marketing\n ->campaigns\n ->metrics\n ->getRevenueAttribution(\n 'campaignGuid',\n attributionModel: 'attributionModel',\n endDate: 'endDate',\n startDate: 'startDate',\n);\n\nvar_dump($revenueAttributionAggregate);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/revenue \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_contact_ids_by_type', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}', - httpMethod: 'get', - summary: 'Fetch contact IDs', - description: 'Fetch the list of contact IDs for the specified campaign and contact type', - stainlessPath: '(resource) marketing.campaigns.metrics > (method) list_contact_ids_by_type', - qualified: 'client.marketing.campaigns.metrics.listContactIDsByType', - params: [ - 'campaignGuid: string;', - 'contactType: string;', - 'after?: string;', - 'endDate?: string;', - 'limit?: number;', - 'startDate?: string;', - ], - response: '{ id: string; }', - markdown: - "## list_contact_ids_by_type\n\n`client.marketing.campaigns.metrics.listContactIDsByType(campaignGuid: string, contactType: string, after?: string, endDate?: string, limit?: number, startDate?: string): { id: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}`\n\nFetch the list of contact IDs for the specified campaign and contact type\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `contactType: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `endDate?: string`\n The end date for fetching contact data, in YYYY-MM-DD format. \nOptional. Example: 2000-01-27 \n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `startDate?: string`\n The start date for fetching contact data, in YYYY-MM-DD format. \nOptional. Example: 2000-01-20\n\n### Returns\n\n- `{ id: string; }`\n\n - `id: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const contactReference of client.marketing.campaigns.metrics.listContactIDsByType('contactType', { campaignGuid: 'campaignGuid' })) {\n console.log(contactReference);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.metrics.listContactIDsByType', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const contactReference of client.marketing.campaigns.metrics.listContactIDsByType(\n 'contactType',\n { campaignGuid: 'campaignGuid' },\n)) {\n console.log(contactReference.id);\n}", - }, - python: { - method: 'marketing.campaigns.metrics.list_contact_ids_by_type', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.campaigns.metrics.list_contact_ids_by_type(\n contact_type="contactType",\n campaign_guid="campaignGuid",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().campaigns().metrics().listContactIdsByType', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricListContactIdsByTypePage;\nimport com.hubspot.sdk.models.marketing.campaigns.metrics.MetricListContactIdsByTypeParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MetricListContactIdsByTypeParams params = MetricListContactIdsByTypeParams.builder()\n .campaignGuid("campaignGuid")\n .contactType("contactType")\n .build();\n MetricListContactIdsByTypePage page = client.marketing().campaigns().metrics().listContactIdsByType(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Metrics.ListContactIDsByType', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Campaigns.Metrics.ListContactIDsByType(\n\t\tcontext.TODO(),\n\t\t"contactType",\n\t\tmarketing.CampaignMetricListContactIDsByTypeParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.metrics.list_contact_ids_by_type', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.campaigns.metrics.list_contact_ids_by_type("contactType", campaign_guid: "campaignGuid")\n\nputs(page)', - }, - php: { - method: 'marketing->campaigns->metrics->listContactIDsByType', - example: - "marketing->campaigns->metrics->listContactIDsByType(\n 'contactType',\n campaignGuid: 'campaignGuid',\n after: 'after',\n endDate: 'endDate',\n limit: 0,\n startDate: 'startDate',\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/reports/contacts/$CONTACT_TYPE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend', - httpMethod: 'post', - summary: 'Create campaign spend item', - description: 'Create a new campaign spend item', - stainlessPath: '(resource) marketing.campaigns.spend > (method) create', - qualified: 'client.marketing.campaigns.spend.create', - params: [ - 'campaignGuid: string;', - 'amount: number;', - 'name: string;', - 'order: number;', - 'description?: string;', - ], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## create\n\n`client.marketing.campaigns.spend.create(campaignGuid: string, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**post** `/marketing/campaigns/2026-03/{campaignGuid}/spend`\n\nCreate a new campaign spend item\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `amount: number`\n The monetary value of the spend item.\n\n- `name: string`\n The name of the spend item.\n\n- `order: number`\n The sequence number indicating the order of the spend item.\n\n- `description?: string`\n A brief description of the spend item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.spend.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.create('campaignGuid', {\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem.id);", - }, - python: { - method: 'marketing.campaigns.spend.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.create(\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_spend_item.id)', - }, - java: { - method: 'marketing().campaigns().spend().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendCreateParams params = SpendCreateParams.builder()\n .campaignGuid("campaignGuid")\n .publicSpendItemInput(PublicSpendItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Spend.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.New(\n\t\tcontext.TODO(),\n\t\t"campaignGuid",\n\t\tmarketing.CampaignSpendNewParams{\n\t\t\tPublicSpendItemInput: marketing.PublicSpendItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.spend.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.create("campaignGuid", amount: 0, name: "name", order: 0)\n\nputs(public_spend_item)', - }, - php: { - method: 'marketing->campaigns->spend->create', - example: - "marketing->campaigns->spend->create(\n 'campaignGuid', amount: 0, name: 'name', order: 0, description: 'description'\n);\n\nvar_dump($publicSpendItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - httpMethod: 'delete', - summary: 'Delete campaign spend item', - description: 'Delete a specific campaign spend item by ID', - stainlessPath: '(resource) marketing.campaigns.spend > (method) delete', - qualified: 'client.marketing.campaigns.spend.delete', - params: ['campaignGuid: string;', 'spendId: number;'], - markdown: - "## delete\n\n`client.marketing.campaigns.spend.delete(campaignGuid: string, spendId: number): void`\n\n**delete** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nDelete a specific campaign spend item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.campaigns.spend.delete(0, { campaignGuid: 'campaignGuid' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.spend.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.campaigns.spend.delete(0, { campaignGuid: 'campaignGuid' });", - }, - python: { - method: 'marketing.campaigns.spend.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.campaigns.spend.delete(\n spend_id=0,\n campaign_guid="campaignGuid",\n)', - }, - java: { - method: 'marketing().campaigns().spend().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendDeleteParams params = SpendDeleteParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .build();\n client.marketing().campaigns().spend().delete(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Spend.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Campaigns.Spend.Delete(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendDeleteParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.campaigns.spend.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.campaigns.spend.delete(0, campaign_guid: "campaignGuid")\n\nputs(result)', - }, - php: { - method: 'marketing->campaigns->spend->delete', - example: - "marketing->campaigns->spend->delete(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - httpMethod: 'get', - summary: 'Read campaign spend item', - description: 'Read a campaign spend item by its spendId', - stainlessPath: '(resource) marketing.campaigns.spend > (method) get', - qualified: 'client.marketing.campaigns.spend.get', - params: ['campaignGuid: string;', 'spendId: number;'], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## get\n\n`client.marketing.campaigns.spend.get(campaignGuid: string, spendId: number): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**get** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nRead a campaign spend item by its spendId\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.get(0, { campaignGuid: 'campaignGuid' });\n\nconsole.log(publicSpendItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.spend.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.get(0, {\n campaignGuid: 'campaignGuid',\n});\n\nconsole.log(publicSpendItem.id);", - }, - python: { - method: 'marketing.campaigns.spend.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.get(\n spend_id=0,\n campaign_guid="campaignGuid",\n)\nprint(public_spend_item.id)', - }, - java: { - method: 'marketing().campaigns().spend().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendGetParams params = SpendGetParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().get(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Spend.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.Get(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendGetParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.spend.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.get(0, campaign_guid: "campaignGuid")\n\nputs(public_spend_item)', - }, - php: { - method: 'marketing->campaigns->spend->get', - example: - "marketing->campaigns->spend->get(\n 0, campaignGuid: 'campaignGuid'\n);\n\nvar_dump($publicSpendItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - httpMethod: 'put', - summary: 'Update campaign spend item', - description: 'Update a specific campaign spend item by ID', - stainlessPath: '(resource) marketing.campaigns.spend > (method) update', - qualified: 'client.marketing.campaigns.spend.update', - params: [ - 'campaignGuid: string;', - 'spendId: number;', - 'amount: number;', - 'name: string;', - 'order: number;', - 'description?: string;', - ], - response: - '{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }', - markdown: - "## update\n\n`client.marketing.campaigns.spend.update(campaignGuid: string, spendId: number, amount: number, name: string, order: number, description?: string): { id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n**put** `/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}`\n\nUpdate a specific campaign spend item by ID\n\n### Parameters\n\n- `campaignGuid: string`\n\n- `spendId: number`\n\n- `amount: number`\n The monetary value of the spend item.\n\n- `name: string`\n The name of the spend item.\n\n- `order: number`\n The sequence number indicating the order of the spend item.\n\n- `description?: string`\n A brief description of the spend item.\n\n### Returns\n\n- `{ id: string; amount: number; createdAt: number; name: string; order: number; updatedAt: number; description?: string; }`\n\n - `id: string`\n - `amount: number`\n - `createdAt: number`\n - `name: string`\n - `order: number`\n - `updatedAt: number`\n - `description?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicSpendItem = await client.marketing.campaigns.spend.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.campaigns.spend.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicSpendItem = await client.marketing.campaigns.spend.update(0, {\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n});\n\nconsole.log(publicSpendItem.id);", - }, - python: { - method: 'marketing.campaigns.spend.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_spend_item = client.marketing.campaigns.spend.update(\n spend_id=0,\n campaign_guid="campaignGuid",\n amount=0,\n name="name",\n order=0,\n)\nprint(public_spend_item.id)', - }, - java: { - method: 'marketing().campaigns().spend().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItem;\nimport com.hubspot.sdk.models.marketing.campaigns.PublicSpendItemInput;\nimport com.hubspot.sdk.models.marketing.campaigns.spend.SpendUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SpendUpdateParams params = SpendUpdateParams.builder()\n .campaignGuid("campaignGuid")\n .spendId(0L)\n .publicSpendItemInput(PublicSpendItemInput.builder()\n .amount(0.0)\n .name("name")\n .order(0)\n .build())\n .build();\n PublicSpendItem publicSpendItem = client.marketing().campaigns().spend().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Campaigns.Spend.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicSpendItem, err := client.Marketing.Campaigns.Spend.Update(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.CampaignSpendUpdateParams{\n\t\t\tCampaignGuid: "campaignGuid",\n\t\t\tPublicSpendItemInput: marketing.PublicSpendItemInputParam{\n\t\t\t\tAmount: 0,\n\t\t\t\tName: "name",\n\t\t\t\tOrder: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicSpendItem.ID)\n}\n', - }, - ruby: { - method: 'marketing.campaigns.spend.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_spend_item = hubspot.marketing.campaigns.spend.update(\n 0,\n campaign_guid: "campaignGuid",\n amount: 0,\n name: "name",\n order: 0\n)\n\nputs(public_spend_item)', - }, - php: { - method: 'marketing->campaigns->spend->update', - example: - "marketing->campaigns->spend->update(\n 0,\n campaignGuid: 'campaignGuid',\n amount: 0,\n name: 'name',\n order: 0,\n description: 'description',\n);\n\nvar_dump($publicSpendItem);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/campaigns/2026-03/$CAMPAIGN_GUID/spend/$SPEND_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "amount": 0,\n "name": "name",\n "order": 0\n }\'', - }, - }, - }, - { - name: 'clone', - endpoint: '/marketing/emails/2026-03/clone', - httpMethod: 'post', - summary: 'Clone a marketing email', - description: - 'This will create a duplicate email with the same properties as the original, with the exception of a unique ID.', - stainlessPath: '(resource) marketing.emails > (method) clone', - qualified: 'client.marketing.emails.clone', - params: ['id: string;', 'cloneName?: string;', 'language?: string;'], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## clone\n\n`client.marketing.emails.clone(id: string, cloneName?: string, language?: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/clone`\n\nThis will create a duplicate email with the same properties as the original, with the exception of a unique ID.\n\n### Parameters\n\n- `id: string`\n The email ID.\n\n- `cloneName?: string`\n The name to assign to the cloned email.\n\n- `language?: string`\n The language code for the cloned email, such as 'en' for English.\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.clone({ id: 'id' });\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.clone', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.clone({ id: 'id' });\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.clone', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.clone(\n id="id",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().clone', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailCloneRequestVNext;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailCloneRequestVNext params = EmailCloneRequestVNext.builder()\n .id("id")\n .build();\n PublicEmail publicEmail = client.marketing().emails().clone(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Clone', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.Clone(context.TODO(), marketing.EmailCloneParams{\n\t\tEmailCloneRequestVNext: marketing.EmailCloneRequestVNextParam{\n\t\t\tID: "id",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.clone_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.clone_(id: "id")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->clone', - example: - "marketing->emails->clone(\n id: 'id', cloneName: 'cloneName', language: 'language'\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/clone \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "id": "id"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/emails/2026-03', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) marketing.emails > (method) create', - qualified: 'client.marketing.emails.create', - params: [ - 'activeDomain?: string;', - 'archived?: boolean;', - 'businessUnitId?: number;', - 'campaign?: string;', - "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", - 'feedbackSurveyId?: string;', - 'folderIdV2?: number;', - 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', - 'jitterSendTime?: boolean;', - 'language?: string;', - 'name?: string;', - 'publishDate?: string;', - "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", - 'sendOnPublish?: boolean;', - 'state?: string;', - 'subcategory?: string;', - 'subject?: string;', - 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', - "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", - 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', - 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', - ], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## create\n\n`client.marketing.emails.create(activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, feedbackSurveyId?: string, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03`\n\n### Parameters\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `feedbackSurveyId?: string`\n The ID of the feedback survey linked to the email.\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.create();\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.create();\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.create()\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailCreateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailCreateRequest params = EmailCreateRequest.builder().build();\n PublicEmail publicEmail = client.marketing().emails().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.New(context.TODO(), marketing.EmailNewParams{\n\t\tEmailCreateRequest: marketing.EmailCreateRequestParam{},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.create\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->create', - example: - "marketing->emails->create(\n activeDomain: 'activeDomain',\n archived: true,\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n feedbackSurveyID: 'feedbackSurveyId',\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - "curl https://api.hubapi.com/marketing/emails/2026-03 \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create_ab_test_variation', - endpoint: '/marketing/emails/2026-03/ab-test/create-variation', - httpMethod: 'post', - summary: 'Create an A/B test variation of a marketing email', - description: - "Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.", - stainlessPath: '(resource) marketing.emails > (method) create_ab_test_variation', - qualified: 'client.marketing.emails.createAbTestVariation', - params: ['contentId: string;', 'variationName: string;'], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## create_ab_test_variation\n\n`client.marketing.emails.createAbTestVariation(contentId: string, variationName: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/ab-test/create-variation`\n\nCreate a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created.\n\n### Parameters\n\n- `contentId: string`\n ID of the object to test.\n\n- `variationName: string`\n Name of A/B test variation.\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.createAbTestVariation({ contentId: 'contentId', variationName: 'variationName' });\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.createAbTestVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.createAbTestVariation({\n contentId: 'contentId',\n variationName: 'variationName',\n});\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.create_ab_test_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.create_ab_test_variation(\n content_id="contentId",\n variation_name="variationName",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().createAbTestVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AbTestCreateRequestVNext;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AbTestCreateRequestVNext params = AbTestCreateRequestVNext.builder()\n .contentId("contentId")\n .variationName("variationName")\n .build();\n PublicEmail publicEmail = client.marketing().emails().createAbTestVariation(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.NewAbTestVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.NewAbTestVariation(context.TODO(), marketing.EmailNewAbTestVariationParams{\n\t\tAbTestCreateRequestVNext: shared.AbTestCreateRequestVNextParam{\n\t\t\tContentID: "contentId",\n\t\t\tVariationName: "variationName",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.create_ab_test_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.create_ab_test_variation(\n content_id: "contentId",\n variation_name: "variationName"\n)\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->createAbTestVariation', - example: - "marketing->emails->createAbTestVariation(\n contentID: 'contentId', variationName: 'variationName'\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/ab-test/create-variation \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contentId": "contentId",\n "variationName": "variationName"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/emails/2026-03/{emailId}', - httpMethod: 'delete', - summary: 'Delete a marketing email', - description: 'Delete a marketing email by its ID', - stainlessPath: '(resource) marketing.emails > (method) delete', - qualified: 'client.marketing.emails.delete', - params: ['emailId: string;', 'archived?: boolean;'], - markdown: - "## delete\n\n`client.marketing.emails.delete(emailId: string, archived?: boolean): void`\n\n**delete** `/marketing/emails/2026-03/{emailId}`\n\nDelete a marketing email by its ID\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.delete('emailId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.delete('emailId');", - }, - python: { - method: 'marketing.emails.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.delete(\n email_id="emailId",\n)', - }, - java: { - method: 'marketing().emails().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().delete("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Delete(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.emails.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.delete("emailId")\n\nputs(result)', - }, - php: { - method: 'marketing->emails->delete', - example: - "marketing->emails->delete('emailId', archived: true);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/emails/2026-03/statistics/list', - httpMethod: 'get', - summary: 'Get aggregated statistics', - description: - 'Use this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.', - stainlessPath: '(resource) marketing.emails > (method) get', - qualified: 'client.marketing.emails.get', - params: [ - 'emailIds?: number[];', - 'endTimestamp?: string;', - 'property?: string;', - 'startTimestamp?: string;', - ], - response: - '{ aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; campaignAggregations: object; emails: number[]; }', - markdown: - "## get\n\n`client.marketing.emails.get(emailIds?: number[], endTimestamp?: string, property?: string, startTimestamp?: string): { aggregate: email_statistics_data; campaignAggregations: object; emails: number[]; }`\n\n**get** `/marketing/emails/2026-03/statistics/list`\n\nUse this endpoint to get aggregated statistics of emails sent in a specified time span. It also returns the list of emails that were sent during the time span.\n\n### Parameters\n\n- `emailIds?: number[]`\n\n- `endTimestamp?: string`\n\n- `property?: string`\n\n- `startTimestamp?: string`\n\n### Returns\n\n- `{ aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; campaignAggregations: object; emails: number[]; }`\n\n - `aggregate: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `campaignAggregations: object`\n - `emails: number[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst aggregateEmailStatistics = await client.marketing.emails.get();\n\nconsole.log(aggregateEmailStatistics);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst aggregateEmailStatistics = await client.marketing.emails.get();\n\nconsole.log(aggregateEmailStatistics.aggregate);", - }, - python: { - method: 'marketing.emails.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\naggregate_email_statistics = client.marketing.emails.get()\nprint(aggregate_email_statistics.aggregate)', - }, - java: { - method: 'marketing().emails().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.AggregateEmailStatistics;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AggregateEmailStatistics aggregateEmailStatistics = client.marketing().emails().get();\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taggregateEmailStatistics, err := client.Marketing.Emails.Get(context.TODO(), marketing.EmailGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", aggregateEmailStatistics.Aggregate)\n}\n', - }, - ruby: { - method: 'marketing.emails.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\naggregate_email_statistics = hubspot.marketing.emails.get\n\nputs(aggregate_email_statistics)', - }, - php: { - method: 'marketing->emails->get', - example: - "marketing->emails->get(\n emailIDs: [0],\n endTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n property: 'property',\n startTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($aggregateEmailStatistics);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/statistics/list \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_ab_test_variation', - endpoint: '/marketing/emails/2026-03/{emailId}/ab-test/get-variation', - httpMethod: 'get', - summary: 'Get the variation of a an A/B marketing email', - description: - 'This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa.', - stainlessPath: '(resource) marketing.emails > (method) get_ab_test_variation', - qualified: 'client.marketing.emails.getAbTestVariation', - params: [ - 'emailId: string;', - 'archived?: boolean;', - 'includedProperties?: string[];', - 'includeStats?: boolean;', - 'marketingCampaignNames?: boolean;', - 'variantStats?: boolean;', - 'workflowNames?: boolean;', - ], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## get_ab_test_variation\n\n`client.marketing.emails.getAbTestVariation(emailId: string, archived?: boolean, includedProperties?: string[], includeStats?: boolean, marketingCampaignNames?: boolean, variantStats?: boolean, workflowNames?: boolean): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/ab-test/get-variation`\n\nThis endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `includedProperties?: string[]`\n\n- `includeStats?: boolean`\n\n- `marketingCampaignNames?: boolean`\n\n- `variantStats?: boolean`\n\n- `workflowNames?: boolean`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.getAbTestVariation('emailId');\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.getAbTestVariation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.getAbTestVariation('emailId');\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.get_ab_test_variation', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.get_ab_test_variation(\n email_id="emailId",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().getAbTestVariation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetAbTestVariationParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicEmail publicEmail = client.marketing().emails().getAbTestVariation("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.GetAbTestVariation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.GetAbTestVariation(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailGetAbTestVariationParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.get_ab_test_variation', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.get_ab_test_variation("emailId")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->getAbTestVariation', - example: - "marketing->emails->getAbTestVariation(\n 'emailId',\n archived: true,\n includedProperties: ['string'],\n includeStats: true,\n marketingCampaignNames: true,\n variantStats: true,\n workflowNames: true,\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/ab-test/get-variation \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_draft', - endpoint: '/marketing/emails/2026-03/{emailId}/draft', - httpMethod: 'get', - summary: 'Get draft version of a marketing email', - description: - 'Get the draft version of an email (if it exists). If no draft version exists, the published email is returned.', - stainlessPath: '(resource) marketing.emails > (method) get_draft', - qualified: 'client.marketing.emails.getDraft', - params: ['emailId: string;'], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## get_draft\n\n`client.marketing.emails.getDraft(emailId: string): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/draft`\n\nGet the draft version of an email (if it exists). If no draft version exists, the published email is returned.\n\n### Parameters\n\n- `emailId: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.getDraft('emailId');\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.getDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.getDraft('emailId');\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.get_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.get_draft(\n "emailId",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().getDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicEmail publicEmail = client.marketing().emails().getDraft("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.GetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.GetDraft(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.get_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.get_draft("emailId")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->getDraft', - example: - "marketing->emails->getDraft('emailId');\n\nvar_dump($publicEmail);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_histogram', - endpoint: '/marketing/emails/2026-03/statistics/histogram', - httpMethod: 'get', - summary: 'Get aggregated statistic intervals', - description: - 'Get aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.', - stainlessPath: '(resource) marketing.emails > (method) get_histogram', - qualified: 'client.marketing.emails.getHistogram', - params: [ - 'emailIds?: number[];', - 'endTimestamp?: string;', - "interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR';", - 'startTimestamp?: string;', - ], - response: - '{ results: { aggregations: email_statistics_data; interval: interval; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## get_histogram\n\n`client.marketing.emails.getHistogram(emailIds?: number[], endTimestamp?: string, interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR', startTimestamp?: string): { results: email_statistic_interval[]; total: number; paging?: paging; }`\n\n**get** `/marketing/emails/2026-03/statistics/histogram`\n\nGet aggregated statistics in intervals for a specified time span. Each interval contains aggregated statistics of the emails that were sent in that time.\n\n### Parameters\n\n- `emailIds?: number[]`\n\n- `endTimestamp?: string`\n\n- `interval?: 'DAY' | 'HOUR' | 'MINUTE' | 'MONTH' | 'QUARTER' | 'QUARTER_HOUR' | 'SECOND' | 'WEEK' | 'YEAR'`\n\n- `startTimestamp?: string`\n\n### Returns\n\n- `{ results: { aggregations: email_statistics_data; interval: interval; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { aggregations: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; interval: { end: string; start: string; }; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalEmailStatisticInterval = await client.marketing.emails.getHistogram();\n\nconsole.log(collectionResponseWithTotalEmailStatisticInterval);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.getHistogram', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalEmailStatisticInterval =\n await client.marketing.emails.getHistogram();\n\nconsole.log(collectionResponseWithTotalEmailStatisticInterval.results);", - }, - python: { - method: 'marketing.emails.get_histogram', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_email_statistic_interval = client.marketing.emails.get_histogram()\nprint(collection_response_with_total_email_statistic_interval.results)', - }, - java: { - method: 'marketing().emails().getHistogram', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.CollectionResponseWithTotalEmailStatisticInterval;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetHistogramParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalEmailStatisticInterval collectionResponseWithTotalEmailStatisticInterval = client.marketing().emails().getHistogram();\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.GetHistogram', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalEmailStatisticInterval, err := client.Marketing.Emails.GetHistogram(context.TODO(), marketing.EmailGetHistogramParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalEmailStatisticInterval.Results)\n}\n', - }, - ruby: { - method: 'marketing.emails.get_histogram', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_email_statistic_interval = hubspot.marketing.emails.get_histogram\n\nputs(collection_response_with_total_email_statistic_interval)', - }, - php: { - method: 'marketing->emails->getHistogram', - example: - "marketing\n ->emails\n ->getHistogram(\n emailIDs: [0],\n endTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n interval: 'DAY',\n startTimestamp: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($collectionResponseWithTotalEmailStatisticInterval);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/statistics/histogram \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_revision', - endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}', - httpMethod: 'get', - summary: 'Get a revision of a marketing email', - description: 'Get a specific revision of a marketing email.', - stainlessPath: '(resource) marketing.emails > (method) get_revision', - qualified: 'client.marketing.emails.getRevision', - params: ['emailId: string;', 'revisionId: string;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## get_revision\n\n`client.marketing.emails.getRevision(emailId: string, revisionId: string): { id: string; object: public_email; updatedAt: string; user: version_user; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}`\n\nGet a specific revision of a marketing email.\n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: string`\n\n### Returns\n\n- `{ id: string; object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmailVersion = await client.marketing.emails.getRevision('revisionId', { emailId: 'emailId' });\n\nconsole.log(publicEmailVersion);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.getRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmailVersion = await client.marketing.emails.getRevision('revisionId', {\n emailId: 'emailId',\n});\n\nconsole.log(publicEmailVersion.id);", - }, - python: { - method: 'marketing.emails.get_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email_version = client.marketing.emails.get_revision(\n revision_id="revisionId",\n email_id="emailId",\n)\nprint(public_email_version.id)', - }, - java: { - method: 'marketing().emails().getRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailGetRevisionParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmailVersion;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailGetRevisionParams params = EmailGetRevisionParams.builder()\n .emailId("emailId")\n .revisionId("revisionId")\n .build();\n PublicEmailVersion publicEmailVersion = client.marketing().emails().getRevision(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.GetRevision', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmailVersion, err := client.Marketing.Emails.GetRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tmarketing.EmailGetRevisionParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmailVersion.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.get_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email_version = hubspot.marketing.emails.get_revision("revisionId", email_id: "emailId")\n\nputs(public_email_version)', - }, - php: { - method: 'marketing->emails->getRevision', - example: - "marketing->emails->getRevision(\n 'revisionId', emailID: 'emailId'\n);\n\nvar_dump($publicEmailVersion);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/emails/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) marketing.emails > (method) list', - qualified: 'client.marketing.emails.list', - params: [ - 'after?: string;', - 'archived?: boolean;', - 'campaign?: string;', - 'createdAfter?: string;', - 'createdAt?: string;', - 'createdBefore?: string;', - 'includedProperties?: string[];', - 'includeStats?: boolean;', - 'isPublished?: boolean;', - 'limit?: number;', - 'marketingCampaignNames?: boolean;', - 'publishedAfter?: string;', - 'publishedAt?: string;', - 'publishedBefore?: string;', - 'sort?: string[];', - 'type?: string;', - 'updatedAfter?: string;', - 'updatedAt?: string;', - 'updatedBefore?: string;', - 'variantStats?: boolean;', - 'workflowNames?: boolean;', - ], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## list\n\n`client.marketing.emails.list(after?: string, archived?: boolean, campaign?: string, createdAfter?: string, createdAt?: string, createdBefore?: string, includedProperties?: string[], includeStats?: boolean, isPublished?: boolean, limit?: number, marketingCampaignNames?: boolean, publishedAfter?: string, publishedAt?: string, publishedBefore?: string, sort?: string[], type?: string, updatedAfter?: string, updatedAt?: string, updatedBefore?: string, variantStats?: boolean, workflowNames?: boolean): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**get** `/marketing/emails/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `campaign?: string`\n\n- `createdAfter?: string`\n\n- `createdAt?: string`\n\n- `createdBefore?: string`\n\n- `includedProperties?: string[]`\n\n- `includeStats?: boolean`\n\n- `isPublished?: boolean`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `marketingCampaignNames?: boolean`\n\n- `publishedAfter?: string`\n\n- `publishedAt?: string`\n\n- `publishedBefore?: string`\n\n- `sort?: string[]`\n\n- `type?: string`\n\n- `updatedAfter?: string`\n\n- `updatedAt?: string`\n\n- `updatedBefore?: string`\n\n- `variantStats?: boolean`\n\n- `workflowNames?: boolean`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicEmail of client.marketing.emails.list()) {\n console.log(publicEmail);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicEmail of client.marketing.emails.list()) {\n console.log(publicEmail.id);\n}", - }, - python: { - method: 'marketing.emails.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.emails.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().emails().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailListPage;\nimport com.hubspot.sdk.models.marketing.emails.EmailListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListPage page = client.marketing().emails().list();\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Emails.List(context.TODO(), marketing.EmailListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.emails.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.emails.list\n\nputs(page)', - }, - php: { - method: 'marketing->emails->list', - example: - "marketing->emails->list(\n after: 'after',\n archived: true,\n campaign: 'campaign',\n createdAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n createdBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n includedProperties: ['string'],\n includeStats: true,\n isPublished: true,\n limit: 0,\n marketingCampaignNames: true,\n publishedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n publishedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n sort: ['string'],\n type: 'AB_EMAIL',\n updatedAfter: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n updatedBefore: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n variantStats: true,\n workflowNames: true,\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_revisions', - endpoint: '/marketing/emails/2026-03/{emailId}/revisions', - httpMethod: 'get', - summary: 'Get revisions of a marketing email', - description: - 'Get a list of all versions of a marketing email, with each entry including the full state of that particular version. To view the most recent version, sort by the updatedAt parameter. ', - stainlessPath: '(resource) marketing.emails > (method) list_revisions', - qualified: 'client.marketing.emails.listRevisions', - params: ['emailId: string;', 'after?: string;', 'before?: string;', 'limit?: number;'], - response: '{ id: string; object: object; updatedAt: string; user: object; }', - markdown: - "## list_revisions\n\n`client.marketing.emails.listRevisions(emailId: string, after?: string, before?: string, limit?: number): { id: string; object: public_email; updatedAt: string; user: version_user; }`\n\n**get** `/marketing/emails/2026-03/{emailId}/revisions`\n\nGet a list of all versions of a marketing email, with each entry including the full state of that particular version. To view the most recent version, sort by the updatedAt parameter. \n\n### Parameters\n\n- `emailId: string`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `before?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }; updatedAt: string; user: { id: string; email: string; fullName: string; }; }`\n\n - `id: string`\n - `object: { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n - `updatedAt: string`\n - `user: { id: string; email: string; fullName: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const versionPublicEmail of client.marketing.emails.listRevisions('emailId')) {\n console.log(versionPublicEmail);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.listRevisions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const versionPublicEmail of client.marketing.emails.listRevisions('emailId')) {\n console.log(versionPublicEmail.id);\n}", - }, - python: { - method: 'marketing.emails.list_revisions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.emails.list_revisions(\n email_id="emailId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().emails().listRevisions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailListRevisionsPage;\nimport com.hubspot.sdk.models.marketing.emails.EmailListRevisionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailListRevisionsPage page = client.marketing().emails().listRevisions("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.ListRevisions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Emails.ListRevisions(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailListRevisionsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.emails.list_revisions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.emails.list_revisions("emailId")\n\nputs(page)', - }, - php: { - method: 'marketing->emails->listRevisions', - example: - "marketing->emails->listRevisions(\n 'emailId', after: 'after', before: 'before', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'publish', - endpoint: '/marketing/emails/2026-03/{emailId}/publish', - httpMethod: 'post', - summary: 'Publish or send a marketing email', - description: - 'If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.', - stainlessPath: '(resource) marketing.emails > (method) publish', - qualified: 'client.marketing.emails.publish', - params: ['emailId: string;'], - markdown: - "## publish\n\n`client.marketing.emails.publish(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/publish`\n\nIf you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.publish('emailId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.publish', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.publish('emailId');", - }, - python: { - method: 'marketing.emails.publish', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.publish(\n "emailId",\n)', - }, - java: { - method: 'marketing().emails().publish', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailPublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().publish("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Publish', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Publish(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.emails.publish', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.publish("emailId")\n\nputs(result)', - }, - php: { - method: 'marketing->emails->publish', - example: - "marketing->emails->publish('emailId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/publish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset_draft', - endpoint: '/marketing/emails/2026-03/{emailId}/draft/reset', - httpMethod: 'post', - summary: 'Reset the draft version', - description: 'Resets the draft back to a copy of the live object.', - stainlessPath: '(resource) marketing.emails > (method) reset_draft', - qualified: 'client.marketing.emails.resetDraft', - params: ['emailId: string;'], - markdown: - "## reset_draft\n\n`client.marketing.emails.resetDraft(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/draft/reset`\n\nResets the draft back to a copy of the live object.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.resetDraft('emailId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.resetDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.resetDraft('emailId');", - }, - python: { - method: 'marketing.emails.reset_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.reset_draft(\n "emailId",\n)', - }, - java: { - method: 'marketing().emails().resetDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailResetDraftParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().resetDraft("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.ResetDraft', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.ResetDraft(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.emails.reset_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.reset_draft("emailId")\n\nputs(result)', - }, - php: { - method: 'marketing->emails->resetDraft', - example: - "marketing->emails->resetDraft('emailId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft/reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_revision', - endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore', - httpMethod: 'post', - summary: 'Restore a revision of a marketing email', - description: - 'Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.', - stainlessPath: '(resource) marketing.emails > (method) restore_revision', - qualified: 'client.marketing.emails.restoreRevision', - params: ['emailId: string;', 'revisionId: string;'], - markdown: - "## restore_revision\n\n`client.marketing.emails.restoreRevision(emailId: string, revisionId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore`\n\nRestores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number.\n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.restoreRevision('revisionId', { emailId: 'emailId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.restoreRevision', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.restoreRevision('revisionId', { emailId: 'emailId' });", - }, - python: { - method: 'marketing.emails.restore_revision', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.restore_revision(\n revision_id="revisionId",\n email_id="emailId",\n)', - }, - java: { - method: 'marketing().emails().restoreRevision', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailRestoreRevisionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailRestoreRevisionParams params = EmailRestoreRevisionParams.builder()\n .emailId("emailId")\n .revisionId("revisionId")\n .build();\n client.marketing().emails().restoreRevision(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.RestoreRevision', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.RestoreRevision(\n\t\tcontext.TODO(),\n\t\t"revisionId",\n\t\tmarketing.EmailRestoreRevisionParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.emails.restore_revision', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.restore_revision("revisionId", email_id: "emailId")\n\nputs(result)', - }, - php: { - method: 'marketing->emails->restoreRevision', - example: - "marketing->emails->restoreRevision(\n 'revisionId', emailID: 'emailId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID/restore \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'restore_revision_to_draft', - endpoint: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft', - httpMethod: 'post', - summary: 'Restore a revision of a marketing email to DRAFT state', - description: - 'Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. ', - stainlessPath: '(resource) marketing.emails > (method) restore_revision_to_draft', - qualified: 'client.marketing.emails.restoreRevisionToDraft', - params: ['emailId: string;', 'revisionId: number;'], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## restore_revision_to_draft\n\n`client.marketing.emails.restoreRevisionToDraft(emailId: string, revisionId: number): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**post** `/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft`\n\nRestores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. \n\n### Parameters\n\n- `emailId: string`\n\n- `revisionId: number`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.restoreRevisionToDraft(0, { emailId: 'emailId' });\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.restoreRevisionToDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.restoreRevisionToDraft(0, { emailId: 'emailId' });\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.restore_revision_to_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.restore_revision_to_draft(\n revision_id=0,\n email_id="emailId",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().restoreRevisionToDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailRestoreRevisionToDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailRestoreRevisionToDraftParams params = EmailRestoreRevisionToDraftParams.builder()\n .emailId("emailId")\n .revisionId(0L)\n .build();\n PublicEmail publicEmail = client.marketing().emails().restoreRevisionToDraft(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.RestoreRevisionToDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.RestoreRevisionToDraft(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.EmailRestoreRevisionToDraftParams{\n\t\t\tEmailID: "emailId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.restore_revision_to_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.restore_revision_to_draft(0, email_id: "emailId")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->restoreRevisionToDraft', - example: - "marketing->emails->restoreRevisionToDraft(\n 0, emailID: 'emailId'\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/revisions/$REVISION_ID/restore-to-draft \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'unpublish', - endpoint: '/marketing/emails/2026-03/{emailId}/unpublish', - httpMethod: 'post', - summary: 'Unpublish or cancel a marketing email', - description: - 'If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.', - stainlessPath: '(resource) marketing.emails > (method) unpublish', - qualified: 'client.marketing.emails.unpublish', - params: ['emailId: string;'], - markdown: - "## unpublish\n\n`client.marketing.emails.unpublish(emailId: string): void`\n\n**post** `/marketing/emails/2026-03/{emailId}/unpublish`\n\nIf you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible.\n\n### Parameters\n\n- `emailId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.emails.unpublish('emailId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.unpublish', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.emails.unpublish('emailId');", - }, - python: { - method: 'marketing.emails.unpublish', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.emails.unpublish(\n "emailId",\n)', - }, - java: { - method: 'marketing().emails().unpublish', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUnpublishParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().emails().unpublish("emailId");\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Unpublish', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Emails.Unpublish(context.TODO(), "emailId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.emails.unpublish', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.emails.unpublish("emailId")\n\nputs(result)', - }, - php: { - method: 'marketing->emails->unpublish', - example: - "marketing->emails->unpublish('emailId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/unpublish \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/emails/2026-03/{emailId}', - httpMethod: 'patch', - summary: 'Update a marketing email', - description: 'Change properties of a marketing email.', - stainlessPath: '(resource) marketing.emails > (method) update', - qualified: 'client.marketing.emails.update', - params: [ - 'emailId: string;', - 'archived?: boolean;', - 'activeDomain?: string;', - 'archived?: boolean;', - 'businessUnitId?: number;', - 'campaign?: string;', - "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", - 'folderIdV2?: number;', - 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', - 'jitterSendTime?: boolean;', - 'language?: string;', - 'name?: string;', - 'publishDate?: string;', - "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", - 'sendOnPublish?: boolean;', - 'state?: string;', - 'subcategory?: string;', - 'subject?: string;', - 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', - "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", - 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', - 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', - ], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## update\n\n`client.marketing.emails.update(emailId: string, archived?: boolean, activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**patch** `/marketing/emails/2026-03/{emailId}`\n\nChange properties of a marketing email.\n\n### Parameters\n\n- `emailId: string`\n\n- `archived?: boolean`\n Whether to return only results that have been archived.\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.update('emailId');\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.update('emailId');\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.update(\n email_id="emailId",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateParams;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateParams params = EmailUpdateParams.builder()\n .emailId("emailId")\n .emailUpdateRequest(EmailUpdateRequest.builder().build())\n .build();\n PublicEmail publicEmail = client.marketing().emails().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.Update(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailUpdateParams{\n\t\t\tEmailUpdateRequest: marketing.EmailUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.update("emailId")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->update', - example: - "marketing->emails->update(\n 'emailId',\n archived: true,\n activeDomain: 'activeDomain',\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - "curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_draft', - endpoint: '/marketing/emails/2026-03/{emailId}/draft', - httpMethod: 'patch', - summary: 'Create or update draft version', - description: - 'Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.', - stainlessPath: '(resource) marketing.emails > (method) update_draft', - qualified: 'client.marketing.emails.updateDraft', - params: [ - 'emailId: string;', - 'activeDomain?: string;', - 'archived?: boolean;', - 'businessUnitId?: number;', - 'campaign?: string;', - "content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; };", - 'folderIdV2?: number;', - 'from?: { customReplyTo?: string; fromName?: string; replyTo?: string; };', - 'jitterSendTime?: boolean;', - 'language?: string;', - 'name?: string;', - 'publishDate?: string;', - "rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; };", - 'sendOnPublish?: boolean;', - 'state?: string;', - 'subcategory?: string;', - 'subject?: string;', - 'subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; };', - "testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; };", - 'to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; };', - 'webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; };', - ], - response: - "{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: object; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: object; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: object; sendOnPublish?: boolean; state?: string; stats?: object; subcategory?: string; subject?: string; subscriptionDetails?: object; teamsWithAccess?: string[]; testing?: object; to?: object; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: object; workflowNames?: string[]; }", - markdown: - "## update_draft\n\n`client.marketing.emails.updateDraft(emailId: string, activeDomain?: string, archived?: boolean, businessUnitId?: number, campaign?: string, content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }, folderIdV2?: number, from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }, jitterSendTime?: boolean, language?: string, name?: string, publishDate?: string, rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }, sendOnPublish?: boolean, state?: string, subcategory?: string, subject?: string, subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }, testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }, to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }, webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }): { isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: public_email_content; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: public_email_from_details; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: public_rss_email_details; sendOnPublish?: boolean; state?: string; stats?: email_statistics_data; subcategory?: string; subject?: string; subscriptionDetails?: public_email_subscription_details; teamsWithAccess?: string[]; testing?: public_email_testing_details; to?: public_email_to_details; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: public_webversion_details; workflowNames?: string[]; }`\n\n**patch** `/marketing/emails/2026-03/{emailId}/draft`\n\nCreate or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned.\n\n### Parameters\n\n- `emailId: string`\n\n- `activeDomain?: string`\n The active domain of the email.\n\n- `archived?: boolean`\n Determines if the email is archived or not.\n\n- `businessUnitId?: number`\n The ID of the business unit associated with the email.\n\n- `campaign?: string`\n The ID of the campaign this email is associated to.\n\n- `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `flexAreas?: object`\n - `plainTextVersion?: string`\n - `smartFields?: object`\n - `styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: { backgroundColor?: object; cornerRadius?: number; fontStyle?: public_font_style; }; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: { color?: object; height?: number; lineType?: string; }; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; headingTwoFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; linksFont?: { bold?: boolean; color?: string; font?: string; italic?: boolean; size?: number; underline?: boolean; }; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }`\n - `templatePath?: string`\n - `themeSettingsValues?: object`\n - `widgetContainers?: object`\n - `widgets?: object`\n\n- `folderIdV2?: number`\n The ID of the folder where the email will be stored.\n\n- `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `customReplyTo?: string`\n The reply to recipients will see.\n - `fromName?: string`\n The name recipients will see.\n - `replyTo?: string`\n The from address and reply to email address (if no customReplyTo defined) recipients will see.\n\n- `jitterSendTime?: boolean`\n Determines whether the email send time should be randomized to avoid sending all emails at the exact same time.\n\n- `language?: string`\n The language code for the email, such as 'en' for English.\n\n- `name?: string`\n The name of the email, as displayed on the email dashboard.\n\n- `publishDate?: string`\n The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.\n\n- `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `blogEmailType?: string`\n - `blogImageMaxWidth?: number`\n - `blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'`\n - `hubspotBlogId?: string`\n - `maxEntries?: number`\n - `rssEntryTemplate?: string`\n - `timing?: object`\n - `url?: string`\n - `useHeadlineAsSubject?: boolean`\n\n- `sendOnPublish?: boolean`\n Determines whether the email will be sent immediately on publish.\n\n- `state?: string`\n The email state.\n\n- `subcategory?: string`\n The email subcategory.\n\n- `subject?: string`\n The subject of the email.\n\n- `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `officeLocationId?: string`\n ID of the selected office location.\n - `preferencesGroupId?: string`\n - `subscriptionId?: string`\n ID of the subscription.\n - `subscriptionName?: string`\n\n- `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `isAbVariation: boolean`\n - `abSampleSizeDefault?: string`\n Version of the email that should be sent if there are too few recipients to conduct an AB test.\n - `abSamplingDefault?: string`\n Version of the email that should be sent if the results are inconclusive after the test period, master or variant.\n - `abStatus?: string`\n Status of the AB test.\n - `abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'`\n Metric to determine the version that will be sent to the remaining contacts.\n - `abTestPercentage?: number`\n The size of your test group.\n - `hoursToWait?: number`\n Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.\n - `testId?: string`\n The ID of the AB test.\n\n- `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `contactIds?: { exclude?: string[]; include?: string[]; }`\n - `contactIlsLists?: { exclude?: string[]; include?: string[]; }`\n - `contactLists?: { exclude?: string[]; include?: string[]; }`\n - `limitSendFrequency?: boolean`\n - `suppressGraymail?: boolean`\n Whether to send to unengaged contacts (false) or not (true).\n\n- `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `domain?: string`\n - `enabled?: boolean`\n - `expiresAt?: string`\n - `isPageRedirected?: boolean`\n - `metaDescription?: string`\n - `pageExpiryEnabled?: boolean`\n - `redirectToPageId?: string`\n - `redirectToUrl?: string`\n - `slug?: string`\n - `title?: string`\n - `url?: string`\n\n### Returns\n\n- `{ isAb: boolean; id?: string; activeDomain?: string; allEmailCampaignIds?: string[]; archived?: boolean; businessUnitId?: string; campaign?: string; campaignName?: string; campaignUtm?: string; clonedFrom?: string; content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: public_email_style_settings; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }; createdAt?: string; createdById?: string; deletedAt?: string; emailCampaignGroupId?: string; emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'; feedbackSurveyId?: string; folderId?: number; folderIdV2?: number; from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }; isPublished?: boolean; isTransactional?: boolean; jitterSendTime?: boolean; language?: string; name?: string; previewKey?: string; primaryEmailCampaignId?: string; publishDate?: string; publishedAt?: string; publishedByEmail?: string; publishedById?: string; publishedByName?: string; rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }; sendOnPublish?: boolean; state?: string; stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }; subcategory?: string; subject?: string; subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }; teamsWithAccess?: string[]; testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }; to?: { contactIds?: public_email_recipients; contactIlsLists?: public_email_recipients; contactLists?: public_email_recipients; limitSendFrequency?: boolean; suppressGraymail?: boolean; }; type?: string; unpublishedAt?: string; updatedAt?: string; updatedById?: string; usersWithAccess?: string[]; webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }; workflowNames?: string[]; }`\n\n - `isAb: boolean`\n - `id?: string`\n - `activeDomain?: string`\n - `allEmailCampaignIds?: string[]`\n - `archived?: boolean`\n - `businessUnitId?: string`\n - `campaign?: string`\n - `campaignName?: string`\n - `campaignUtm?: string`\n - `clonedFrom?: string`\n - `content?: { flexAreas?: object; plainTextVersion?: string; smartFields?: object; styleSettings?: { backgroundColor?: string; backgroundImage?: string; backgroundImageType?: 'REPEAT' | 'SINGLE' | 'STRETCH'; bodyBorderColor?: string; bodyBorderColorChoice?: string; bodyBorderWidth?: number; bodyColor?: string; buttonStyleSettings?: public_button_style_settings; colorPickerFavorite1?: string; colorPickerFavorite2?: string; colorPickerFavorite3?: string; colorPickerFavorite4?: string; colorPickerFavorite5?: string; colorPickerFavorite6?: string; dividerStyleSettings?: public_divider_style_settings; emailBodyPadding?: string; emailBodyWidth?: string; headingOneFont?: public_font_style; headingTwoFont?: public_font_style; linksFont?: public_font_style; primaryAccentColor?: string; primaryFont?: string; primaryFontColor?: string; primaryFontLineHeight?: string; primaryFontSize?: number; secondaryAccentColor?: string; secondaryFont?: string; secondaryFontColor?: string; secondaryFontLineHeight?: string; secondaryFontSize?: number; }; templatePath?: string; themeSettingsValues?: object; widgetContainers?: object; widgets?: object; }`\n - `createdAt?: string`\n - `createdById?: string`\n - `deletedAt?: string`\n - `emailCampaignGroupId?: string`\n - `emailTemplateMode?: 'DESIGN_MANAGER' | 'DRAG_AND_DROP'`\n - `feedbackSurveyId?: string`\n - `folderId?: number`\n - `folderIdV2?: number`\n - `from?: { customReplyTo?: string; fromName?: string; replyTo?: string; }`\n - `isPublished?: boolean`\n - `isTransactional?: boolean`\n - `jitterSendTime?: boolean`\n - `language?: string`\n - `name?: string`\n - `previewKey?: string`\n - `primaryEmailCampaignId?: string`\n - `publishDate?: string`\n - `publishedAt?: string`\n - `publishedByEmail?: string`\n - `publishedById?: string`\n - `publishedByName?: string`\n - `rssData?: { blogEmailType?: string; blogImageMaxWidth?: number; blogLayout?: 'FULL_POST' | 'SUMMARY_NO_FEATURED_IMAGE' | 'SUMMARY_WITH_FEATURED_IMAGE'; hubspotBlogId?: string; maxEntries?: number; rssEntryTemplate?: string; timing?: object; url?: string; useHeadlineAsSubject?: boolean; }`\n - `sendOnPublish?: boolean`\n - `state?: string`\n - `stats?: { counters: object; deviceBreakdown: object; qualifierStats: object; ratios: object; }`\n - `subcategory?: string`\n - `subject?: string`\n - `subscriptionDetails?: { officeLocationId?: string; preferencesGroupId?: string; subscriptionId?: string; subscriptionName?: string; }`\n - `teamsWithAccess?: string[]`\n - `testing?: { isAbVariation: boolean; abSampleSizeDefault?: string; abSamplingDefault?: string; abStatus?: string; abSuccessMetric?: 'CLICKS_BY_DELIVERED' | 'CLICKS_BY_OPENS' | 'OPENS_BY_DELIVERED'; abTestPercentage?: number; hoursToWait?: number; testId?: string; }`\n - `to?: { contactIds?: { exclude?: string[]; include?: string[]; }; contactIlsLists?: { exclude?: string[]; include?: string[]; }; contactLists?: { exclude?: string[]; include?: string[]; }; limitSendFrequency?: boolean; suppressGraymail?: boolean; }`\n - `type?: string`\n - `unpublishedAt?: string`\n - `updatedAt?: string`\n - `updatedById?: string`\n - `usersWithAccess?: string[]`\n - `webversion?: { domain?: string; enabled?: boolean; expiresAt?: string; isPageRedirected?: boolean; metaDescription?: string; pageExpiryEnabled?: boolean; redirectToPageId?: string; redirectToUrl?: string; slug?: string; title?: string; url?: string; }`\n - `workflowNames?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicEmail = await client.marketing.emails.updateDraft('emailId');\n\nconsole.log(publicEmail);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.emails.updateDraft', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicEmail = await client.marketing.emails.updateDraft('emailId');\n\nconsole.log(publicEmail.id);", - }, - python: { - method: 'marketing.emails.update_draft', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_email = client.marketing.emails.update_draft(\n email_id="emailId",\n)\nprint(public_email.id)', - }, - java: { - method: 'marketing().emails().updateDraft', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateDraftParams;\nimport com.hubspot.sdk.models.marketing.emails.EmailUpdateRequest;\nimport com.hubspot.sdk.models.marketing.emails.PublicEmail;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmailUpdateDraftParams params = EmailUpdateDraftParams.builder()\n .emailId("emailId")\n .emailUpdateRequest(EmailUpdateRequest.builder().build())\n .build();\n PublicEmail publicEmail = client.marketing().emails().updateDraft(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Emails.UpdateDraft', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicEmail, err := client.Marketing.Emails.UpdateDraft(\n\t\tcontext.TODO(),\n\t\t"emailId",\n\t\tmarketing.EmailUpdateDraftParams{\n\t\t\tEmailUpdateRequest: marketing.EmailUpdateRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicEmail.ID)\n}\n', - }, - ruby: { - method: 'marketing.emails.update_draft', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_email = hubspot.marketing.emails.update_draft("emailId")\n\nputs(public_email)', - }, - php: { - method: 'marketing->emails->updateDraft', - example: - "marketing->emails->updateDraft(\n 'emailId',\n activeDomain: 'activeDomain',\n archived: true,\n businessUnitID: 0,\n campaign: 'campaign',\n content: [\n 'flexAreas' => ['foo' => (object) []],\n 'plainTextVersion' => 'plainTextVersion',\n 'smartFields' => ['foo' => (object) []],\n 'styleSettings' => [\n 'backgroundColor' => 'backgroundColor',\n 'backgroundImage' => 'backgroundImage',\n 'backgroundImageType' => 'REPEAT',\n 'bodyBorderColor' => 'bodyBorderColor',\n 'bodyBorderColorChoice' => 'bodyBorderColorChoice',\n 'bodyBorderWidth' => 0,\n 'bodyColor' => 'bodyColor',\n 'buttonStyleSettings' => [\n 'backgroundColor' => (object) [],\n 'cornerRadius' => 0,\n 'fontStyle' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n ],\n 'colorPickerFavorite1' => 'colorPickerFavorite1',\n 'colorPickerFavorite2' => 'colorPickerFavorite2',\n 'colorPickerFavorite3' => 'colorPickerFavorite3',\n 'colorPickerFavorite4' => 'colorPickerFavorite4',\n 'colorPickerFavorite5' => 'colorPickerFavorite5',\n 'colorPickerFavorite6' => 'colorPickerFavorite6',\n 'dividerStyleSettings' => [\n 'color' => (object) [], 'height' => 0, 'lineType' => 'lineType'\n ],\n 'emailBodyPadding' => 'emailBodyPadding',\n 'emailBodyWidth' => 'emailBodyWidth',\n 'headingOneFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'headingTwoFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'linksFont' => [\n 'bold' => true,\n 'color' => 'color',\n 'font' => 'font',\n 'italic' => true,\n 'size' => 0,\n 'underline' => true,\n ],\n 'primaryAccentColor' => 'primaryAccentColor',\n 'primaryFont' => 'primaryFont',\n 'primaryFontColor' => 'primaryFontColor',\n 'primaryFontLineHeight' => 'primaryFontLineHeight',\n 'primaryFontSize' => 0,\n 'secondaryAccentColor' => 'secondaryAccentColor',\n 'secondaryFont' => 'secondaryFont',\n 'secondaryFontColor' => 'secondaryFontColor',\n 'secondaryFontLineHeight' => 'secondaryFontLineHeight',\n 'secondaryFontSize' => 0,\n ],\n 'templatePath' => 'templatePath',\n 'themeSettingsValues' => ['foo' => (object) []],\n 'widgetContainers' => ['foo' => (object) []],\n 'widgets' => ['foo' => (object) []],\n ],\n folderIDV2: 0,\n from: [\n 'customReplyTo' => 'customReplyTo',\n 'fromName' => 'fromName',\n 'replyTo' => 'replyTo',\n ],\n jitterSendTime: true,\n language: 'aa',\n name: 'name',\n publishDate: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n rssData: [\n 'blogEmailType' => 'blogEmailType',\n 'blogImageMaxWidth' => 0,\n 'blogLayout' => 'FULL_POST',\n 'hubSpotBlogID' => 'hubspotBlogId',\n 'maxEntries' => 0,\n 'rssEntryTemplate' => 'rssEntryTemplate',\n 'timing' => ['foo' => (object) []],\n 'url' => 'url',\n 'useHeadlineAsSubject' => true,\n ],\n sendOnPublish: true,\n state: 'AGENT_GENERATED',\n subcategory: 'ab_loser_variant',\n subject: 'subject',\n subscriptionDetails: [\n 'officeLocationID' => 'officeLocationId',\n 'preferencesGroupID' => 'preferencesGroupId',\n 'subscriptionID' => 'subscriptionId',\n 'subscriptionName' => 'subscriptionName',\n ],\n testing: [\n 'isAbVariation' => true,\n 'abSampleSizeDefault' => 'automated_loser_variant',\n 'abSamplingDefault' => 'automated_loser_variant',\n 'abStatus' => 'automated_loser_variant',\n 'abSuccessMetric' => 'CLICKS_BY_DELIVERED',\n 'abTestPercentage' => 0,\n 'hoursToWait' => 0,\n 'testID' => 'testId',\n ],\n to: [\n 'contactIDs' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactIlsLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'contactLists' => ['exclude' => ['string'], 'include' => ['string']],\n 'limitSendFrequency' => true,\n 'suppressGraymail' => true,\n ],\n webversion: [\n 'domain' => 'domain',\n 'enabled' => true,\n 'expiresAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'isPageRedirected' => true,\n 'metaDescription' => 'metaDescription',\n 'pageExpiryEnabled' => true,\n 'redirectToPageID' => 'redirectToPageId',\n 'redirectToURL' => 'redirectToUrl',\n 'slug' => 'slug',\n 'title' => 'title',\n 'url' => 'url',\n ],\n);\n\nvar_dump($publicEmail);", - }, - http: { - example: - "curl https://api.hubapi.com/marketing/emails/2026-03/$EMAIL_ID/draft \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/marketing-events/2026-03/events', - httpMethod: 'post', - summary: 'Create a marketing event', - description: 'Creates a new marketing event in HubSpot', - stainlessPath: '(resource) marketing.marketing_events > (method) create', - qualified: 'client.marketing.marketingEvents.create', - params: [ - "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", - 'eventName: string;', - 'eventOrganizer: string;', - 'externalAccountId: string;', - 'externalEventId: string;', - 'endDateTime?: string;', - 'eventCancelled?: boolean;', - 'eventCompleted?: boolean;', - 'eventDescription?: string;', - 'eventType?: string;', - 'eventUrl?: string;', - 'startDateTime?: string;', - ], - response: - "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## create\n\n`client.marketing.marketingEvents.create(customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], eventName: string, eventOrganizer: string, externalAccountId: string, externalEventId: string, endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events`\n\nCreates a new marketing event in HubSpot\n\n### Parameters\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `eventName: string`\n The name of the marketing event.\n\n- `eventOrganizer: string`\n The name of the organizer of the marketing event.\n\n- `externalAccountId: string`\n The accountId that is associated with this marketing event in the external event application.\n\n- `externalEventId: string`\n The id of the marketing event in the external event application.\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.create({\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.create({\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventDefaultResponse.customProperties);", - }, - python: { - method: 'marketing.marketing_events.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.create(\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n event_name="eventName",\n event_organizer="eventOrganizer",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)\nprint(marketing_event_default_response.custom_properties)', - }, - java: { - method: 'marketing().marketingEvents().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventCreateRequestParams params = MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.New(context.TODO(), marketing.MarketingEventNewParams{\n\t\tMarketingEventCreateRequestParams: marketing.MarketingEventCreateRequestParams{\n\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\tIsEncrypted: true,\n\t\t\t\tIsLargeValue: true,\n\t\t\t\tName: "name",\n\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\tRequestID: "requestId",\n\t\t\t\tSelectedByUser: true,\n\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\tSourceID: "sourceId",\n\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\tSourceVid: []int64{0},\n\t\t\t\tTimestamp: 0,\n\t\t\t\tUnit: "unit",\n\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\tValue: "value",\n\t\t\t}},\n\t\t\tEventName: "eventName",\n\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.create(\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n event_name: "eventName",\n event_organizer: "eventOrganizer",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(marketing_event_default_response)', - }, - php: { - method: 'marketing->marketingEvents->create', - example: - "marketing->marketingEvents->create(\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/marketing-events/2026-03/{objectId}', - httpMethod: 'delete', - summary: 'Delete Marketing Event by objectId', - description: 'Deletes the existing Marketing Event with the specified objectId, if it exists.', - stainlessPath: '(resource) marketing.marketing_events > (method) delete', - qualified: 'client.marketing.marketingEvents.delete', - params: ['objectId: string;'], - markdown: - "## delete\n\n`client.marketing.marketingEvents.delete(objectId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/{objectId}`\n\nDeletes the existing Marketing Event with the specified objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.delete('objectId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.delete('objectId');", - }, - python: { - method: 'marketing.marketing_events.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.delete(\n "objectId",\n)', - }, - java: { - method: 'marketing().marketingEvents().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().marketingEvents().delete("objectId");\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.Delete(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.delete("objectId")\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->delete', - example: - "marketing->marketingEvents->delete('objectId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_batch', - endpoint: '/marketing/marketing-events/2026-03/batch/archive', - httpMethod: 'post', - summary: 'Delete Multiple Marketing Events by ObjectId', - description: - 'Deletes multiple Marketing Events from the portal based on their objectId, if they exist.\n\nResponses:\n204: Returned if all specified Marketing Events were successfully deleted.\n207: Returned if some objectIds did not correspond to any existing Marketing Events.', - stainlessPath: '(resource) marketing.marketing_events > (method) delete_batch', - qualified: 'client.marketing.marketingEvents.deleteBatch', - params: ['inputs: { objectId: string; }[];'], - response: 'string', - markdown: - "## delete_batch\n\n`client.marketing.marketingEvents.deleteBatch(inputs: { objectId: string; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/batch/archive`\n\nDeletes multiple Marketing Events from the portal based on their objectId, if they exist.\n\nResponses:\n204: Returned if all specified Marketing Events were successfully deleted.\n207: Returned if some objectIds did not correspond to any existing Marketing Events.\n\n### Parameters\n\n- `inputs: { objectId: string; }[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.deleteBatch({ inputs: [{ objectId: 'objectId' }] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.deleteBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.deleteBatch({\n inputs: [{ objectId: 'objectId' }],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'marketing.marketing_events.delete_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.delete_batch(\n inputs=[{\n "object_id": "objectId"\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'marketing().marketingEvents().deleteBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventPublicObjectIdDeleteRequest;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicObjectIdDeleteRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventPublicObjectIdDeleteRequest params = BatchInputMarketingEventPublicObjectIdDeleteRequest.builder()\n .addInput(MarketingEventPublicObjectIdDeleteRequest.builder()\n .objectId("objectId")\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().deleteBatch(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.DeleteBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.DeleteBatch(context.TODO(), marketing.MarketingEventDeleteBatchParams{\n\t\tBatchInputMarketingEventPublicObjectIDDeleteRequest: marketing.BatchInputMarketingEventPublicObjectIDDeleteRequestParam{\n\t\t\tInputs: []marketing.MarketingEventPublicObjectIDDeleteRequestParam{{\n\t\t\t\tObjectID: "objectId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.delete_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.delete_batch(inputs: [{objectId: "objectId"}])\n\nputs(response)', - }, - php: { - method: 'marketing->marketingEvents->deleteBatch', - example: - "marketing->marketingEvents->deleteBatch(\n inputs: [['objectID' => 'objectId']]\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/batch/archive \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "objectId": "objectId"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_batch_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/delete', - httpMethod: 'post', - summary: 'Delete Multiple Marketing Events by External Ids', - description: - 'Deletes multiple Marketing Events based on externalAccountId, externalEventId, and appId.\n\nOnly Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. ', - stainlessPath: '(resource) marketing.marketing_events > (method) delete_batch_by_external_event_id', - qualified: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', - params: ['inputs: { appId: number; externalAccountId: string; externalEventId: string; }[];'], - response: 'string', - markdown: - "## delete_batch_by_external_event_id\n\n`client.marketing.marketingEvents.deleteBatchByExternalEventID(inputs: { appId: number; externalAccountId: string; externalEventId: string; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/delete`\n\nDeletes multiple Marketing Events based on externalAccountId, externalEventId, and appId.\n\nOnly Marketing Events created by the same apps will be deleted; events from other apps cannot be removed by this endpoint. \n\n### Parameters\n\n- `inputs: { appId: number; externalAccountId: string; externalEventId: string; }[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.deleteBatchByExternalEventID({ inputs: [{\n appId: 0,\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n}] });\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.deleteBatchByExternalEventID({\n inputs: [\n {\n appId: 0,\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n },\n ],\n});\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'marketing.marketing_events.delete_batch_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.delete_batch_by_external_event_id(\n inputs=[{\n "app_id": 0,\n "external_account_id": "externalAccountId",\n "external_event_id": "externalEventId",\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'marketing().marketingEvents().deleteBatchByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventExternalUniqueIdentifier;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventExternalUniqueIdentifier;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventExternalUniqueIdentifier params = BatchInputMarketingEventExternalUniqueIdentifier.builder()\n .addInput(MarketingEventExternalUniqueIdentifier.builder()\n .appId(0)\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().deleteBatchByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.DeleteBatchByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.DeleteBatchByExternalEventID(context.TODO(), marketing.MarketingEventDeleteBatchByExternalEventIDParams{\n\t\tBatchInputMarketingEventExternalUniqueIdentifier: marketing.BatchInputMarketingEventExternalUniqueIdentifierParam{\n\t\t\tInputs: []marketing.MarketingEventExternalUniqueIdentifierParam{{\n\t\t\t\tAppID: 0,\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.delete_batch_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.delete_batch_by_external_event_id(\n inputs: [{appId: 0, externalAccountId: "externalAccountId", externalEventId: "externalEventId"}]\n)\n\nputs(response)', - }, - php: { - method: 'marketing->marketingEvents->deleteBatchByExternalEventID', - example: - "marketing->marketingEvents->deleteBatchByExternalEventID(\n inputs: [\n [\n 'appID' => 0,\n 'externalAccountID' => 'externalAccountId',\n 'externalEventID' => 'externalEventId',\n ],\n ],\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/delete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "appId": 0,\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'delete_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', - httpMethod: 'delete', - summary: 'Delete Marketing Event by External Ids', - description: - 'Deletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app can be deleted.', - stainlessPath: '(resource) marketing.marketing_events > (method) delete_by_external_event_id', - qualified: 'client.marketing.marketingEvents.deleteByExternalEventID', - params: ['externalEventId: string;', 'externalAccountId: string;'], - markdown: - "## delete_by_external_event_id\n\n`client.marketing.marketingEvents.deleteByExternalEventID(externalEventId: string, externalAccountId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nDeletes the existing Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app can be deleted.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.deleteByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.deleteByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.deleteByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n});", - }, - python: { - method: 'marketing.marketing_events.delete_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.delete_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)', - }, - java: { - method: 'marketing().marketingEvents().deleteByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDeleteByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventDeleteByExternalEventIdParams params = MarketingEventDeleteByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n client.marketing().marketingEvents().deleteByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.DeleteByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.DeleteByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventDeleteByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.delete_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.delete_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->deleteByExternalEventID', - example: - "marketing->marketingEvents->deleteByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/marketing-events/2026-03/{objectId}', - httpMethod: 'get', - summary: 'Get Marketing Event by objectId', - description: 'Returns the details of a Marketing Event with the specified objectId, if it exists.', - stainlessPath: '(resource) marketing.marketing_events > (method) get', - qualified: 'client.marketing.marketingEvents.get', - params: ['objectId: string;'], - response: - '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }', - markdown: - "## get\n\n`client.marketing.marketingEvents.get(objectId: string): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03/{objectId}`\n\nReturns the details of a Marketing Event with the specified objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `attendees?: number`\n - `cancellations?: number`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventStatus?: string`\n - `eventStatusV2?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `externalEventId?: string`\n - `noShows?: number`\n - `registrants?: number`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicReadResponseV2 = await client.marketing.marketingEvents.get('objectId');\n\nconsole.log(marketingEventPublicReadResponseV2);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicReadResponseV2 = await client.marketing.marketingEvents.get('objectId');\n\nconsole.log(marketingEventPublicReadResponseV2.createdAt);", - }, - python: { - method: 'marketing.marketing_events.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_read_response_v2 = client.marketing.marketing_events.get(\n "objectId",\n)\nprint(marketing_event_public_read_response_v2.created_at)', - }, - java: { - method: 'marketing().marketingEvents().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventGetParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicReadResponseV2;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventPublicReadResponseV2 marketingEventPublicReadResponseV2 = client.marketing().marketingEvents().get("objectId");\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicReadResponseV2, err := client.Marketing.MarketingEvents.Get(context.TODO(), "objectId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicReadResponseV2.CreatedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_read_response_v2 = hubspot.marketing.marketing_events.get("objectId")\n\nputs(marketing_event_public_read_response_v2)', - }, - php: { - method: 'marketing->marketingEvents->get', - example: - "marketing->marketingEvents->get(\n 'objectId'\n);\n\nvar_dump($marketingEventPublicReadResponseV2);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', - httpMethod: 'get', - summary: 'Get Marketing Event by External IDs', - description: - 'Returns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app making the request can be retrieved.', - stainlessPath: '(resource) marketing.marketing_events > (method) get_by_external_event_id', - qualified: 'client.marketing.marketingEvents.getByExternalEventID', - params: ['externalEventId: string;', 'externalAccountId: string;'], - response: - "{ id: string; attendees: number; cancellations: number; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## get_by_external_event_id\n\n`client.marketing.marketingEvents.getByExternalEventID(externalEventId: string, externalAccountId: string): { id: string; attendees: number; cancellations: number; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nReturns the details of a Marketing Event with the specified externalAccountId, externalEventId, if it exists.\n\nOnly Marketing Events created by the same app making the request can be retrieved.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Returns\n\n- `{ id: string; attendees: number; cancellations: number; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalEventId: string; noShows: number; registrants: number; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `attendees: number`\n - `cancellations: number`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `externalEventId: string`\n - `noShows: number`\n - `registrants: number`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicReadResponse = await client.marketing.marketingEvents.getByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(marketingEventPublicReadResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.getByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicReadResponse =\n await client.marketing.marketingEvents.getByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(marketingEventPublicReadResponse.id);", - }, - python: { - method: 'marketing.marketing_events.get_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_read_response = client.marketing.marketing_events.get_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(marketing_event_public_read_response.id)', - }, - java: { - method: 'marketing().marketingEvents().getByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventGetByExternalEventIdParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicReadResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventGetByExternalEventIdParams params = MarketingEventGetByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n MarketingEventPublicReadResponse marketingEventPublicReadResponse = client.marketing().marketingEvents().getByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.GetByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicReadResponse, err := client.Marketing.MarketingEvents.GetByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventGetByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicReadResponse.ID)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.get_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_read_response = hubspot.marketing.marketing_events.get_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(marketing_event_public_read_response)', - }, - php: { - method: 'marketing->marketingEvents->getByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->getByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($marketingEventPublicReadResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/marketing-events/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) marketing.marketing_events > (method) list', - qualified: 'client.marketing.marketingEvents.list', - params: ['after?: string;', 'limit?: number;'], - response: - '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }', - markdown: - "## list\n\n`client.marketing.marketingEvents.list(after?: string, limit?: number): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n**get** `/marketing/marketing-events/2026-03`\n\n### Parameters\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; attendees?: number; cancellations?: number; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventStatus?: string; eventStatusV2?: string; eventType?: string; eventUrl?: string; externalEventId?: string; noShows?: number; registrants?: number; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `attendees?: number`\n - `cancellations?: number`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventStatus?: string`\n - `eventStatusV2?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `externalEventId?: string`\n - `noShows?: number`\n - `registrants?: number`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const marketingEventPublicReadResponseV2 of client.marketing.marketingEvents.list()) {\n console.log(marketingEventPublicReadResponseV2);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const marketingEventPublicReadResponseV2 of client.marketing.marketingEvents.list()) {\n console.log(marketingEventPublicReadResponseV2.createdAt);\n}", - }, - python: { - method: 'marketing.marketing_events.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.list()\npage = page.results[0]\nprint(page.created_at)', - }, - java: { - method: 'marketing().marketingEvents().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventListPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventListPage page = client.marketing().marketingEvents().list();\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.List(context.TODO(), marketing.MarketingEventListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.list\n\nputs(page)', - }, - php: { - method: 'marketing->marketingEvents->list', - example: - "marketing->marketingEvents->list(after: 'after', limit: 0);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/search', - httpMethod: 'get', - summary: 'Find App-Specific Marketing Events by External Event Id', - description: - 'Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.\n\nMarketing Events created by other apps will not be included in the results.', - stainlessPath: '(resource) marketing.marketing_events > (method) search_by_external_event_id', - qualified: 'client.marketing.marketingEvents.searchByExternalEventID', - params: ['q: string;'], - response: - '{ results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]; }', - markdown: - "## search_by_external_event_id\n\n`client.marketing.marketingEvents.searchByExternalEventID(q: string): { results: search_public_response_wrapper[]; }`\n\n**get** `/marketing/marketing-events/2026-03/events/search`\n\nRetrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request.\n\nMarketing Events created by other apps will not be included in the results.\n\n### Parameters\n\n- `q: string`\n\n### Returns\n\n- `{ results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]; }`\n\n - `results: { appId: number; externalAccountId: string; externalEventId: string; objectId: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseSearchPublicResponseWrapperNoPaging = await client.marketing.marketingEvents.searchByExternalEventID({ q: 'q' });\n\nconsole.log(collectionResponseSearchPublicResponseWrapperNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.searchByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseSearchPublicResponseWrapperNoPaging =\n await client.marketing.marketingEvents.searchByExternalEventID({ q: 'q' });\n\nconsole.log(collectionResponseSearchPublicResponseWrapperNoPaging.results);", - }, - python: { - method: 'marketing.marketing_events.search_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_search_public_response_wrapper_no_paging = client.marketing.marketing_events.search_by_external_event_id(\n q="q",\n)\nprint(collection_response_search_public_response_wrapper_no_paging.results)', - }, - java: { - method: 'marketing().marketingEvents().searchByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseSearchPublicResponseWrapperNoPaging;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSearchByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventSearchByExternalEventIdParams params = MarketingEventSearchByExternalEventIdParams.builder()\n .q("q")\n .build();\n CollectionResponseSearchPublicResponseWrapperNoPaging collectionResponseSearchPublicResponseWrapperNoPaging = client.marketing().marketingEvents().searchByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.SearchByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseSearchPublicResponseWrapperNoPaging, err := client.Marketing.MarketingEvents.SearchByExternalEventID(context.TODO(), marketing.MarketingEventSearchByExternalEventIDParams{\n\t\tQ: "q",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseSearchPublicResponseWrapperNoPaging.Results)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.search_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_search_public_response_wrapper_no_paging = hubspot.marketing.marketing_events.search_by_external_event_id(q: "q")\n\nputs(collection_response_search_public_response_wrapper_no_paging)', - }, - php: { - method: 'marketing->marketingEvents->searchByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->searchByExternalEventID(q: 'q');\n\nvar_dump($collectionResponseSearchPublicResponseWrapperNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/search \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'search_identifiers_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/{externalEventId}/identifiers', - httpMethod: 'get', - summary: 'Find Marketing Events by External Event Id', - description: - 'This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request.\n\nIt retrieves the objectId and additional event details for each matching Marketing Event.\n\nSince multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results.\n\nNote: Marketing Events become searchable by externalEventId a few minutes after creation.', - stainlessPath: '(resource) marketing.marketing_events > (method) search_identifiers_by_external_event_id', - qualified: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', - params: ['externalEventId: string;'], - response: - '{ results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: app_info; externalAccountId?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## search_identifiers_by_external_event_id\n\n`client.marketing.marketingEvents.searchIdentifiersByExternalEventID(externalEventId: string): { results: marketing_event_identifiers_response[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/{externalEventId}/identifiers`\n\nThis endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request.\n\nIt retrieves the objectId and additional event details for each matching Marketing Event.\n\nSince multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results.\n\nNote: Marketing Events become searchable by externalEventId a few minutes after creation.\n\n### Parameters\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: app_info; externalAccountId?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { externalEventId: string; marketingEventName: string; objectId: string; appInfo?: { id: string; name: string; }; externalAccountId?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalMarketingEventIdentifiersResponse = await client.marketing.marketingEvents.searchIdentifiersByExternalEventID('externalEventId');\n\nconsole.log(collectionResponseWithTotalMarketingEventIdentifiersResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalMarketingEventIdentifiersResponse =\n await client.marketing.marketingEvents.searchIdentifiersByExternalEventID('externalEventId');\n\nconsole.log(collectionResponseWithTotalMarketingEventIdentifiersResponse.results);", - }, - python: { - method: 'marketing.marketing_events.search_identifiers_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_marketing_event_identifiers_response = client.marketing.marketing_events.search_identifiers_by_external_event_id(\n "externalEventId",\n)\nprint(collection_response_with_total_marketing_event_identifiers_response.results)', - }, - java: { - method: 'marketing().marketingEvents().searchIdentifiersByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalMarketingEventIdentifiersResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSearchIdentifiersByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalMarketingEventIdentifiersResponse collectionResponseWithTotalMarketingEventIdentifiersResponse = client.marketing().marketingEvents().searchIdentifiersByExternalEventId("externalEventId");\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.SearchIdentifiersByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalMarketingEventIdentifiersResponse, err := client.Marketing.MarketingEvents.SearchIdentifiersByExternalEventID(context.TODO(), "externalEventId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalMarketingEventIdentifiersResponse.Results)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.search_identifiers_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_marketing_event_identifiers_response = hubspot.marketing.marketing_events.search_identifiers_by_external_event_id("externalEventId")\n\nputs(collection_response_with_total_marketing_event_identifiers_response)', - }, - php: { - method: 'marketing->marketingEvents->searchIdentifiersByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->searchIdentifiersByExternalEventID('externalEventId');\n\nvar_dump($collectionResponseWithTotalMarketingEventIdentifiersResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$EXTERNAL_EVENT_ID/identifiers \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/marketing/marketing-events/2026-03/{objectId}', - httpMethod: 'patch', - summary: 'Update Marketing Event by objectId', - description: - 'Updates the details of an existing Marketing Event identified by its objectId, if it exists.', - stainlessPath: '(resource) marketing.marketing_events > (method) update', - qualified: 'client.marketing.marketingEvents.update', - params: [ - 'objectId: string;', - "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", - 'endDateTime?: string;', - 'eventCancelled?: boolean;', - 'eventDescription?: string;', - 'eventName?: string;', - 'eventOrganizer?: string;', - 'eventType?: string;', - 'eventUrl?: string;', - 'startDateTime?: string;', - ], - response: - '{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }', - markdown: - "## update\n\n`client.marketing.marketingEvents.update(objectId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], endDateTime?: string, eventCancelled?: boolean, eventDescription?: string, eventName?: string, eventOrganizer?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }`\n\n**patch** `/marketing/marketing-events/2026-03/{objectId}`\n\nUpdates the details of an existing Marketing Event identified by its objectId, if it exists.\n\n### Parameters\n\n- `objectId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n\n- `endDateTime?: string`\n The end date and time of the marketing event\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled\n\n- `eventDescription?: string`\n The description of the marketing event\n\n- `eventName?: string`\n The name of the marketing event\n\n- `eventOrganizer?: string`\n The name of the organizer of the marketing event\n\n- `eventType?: string`\n The type of the marketing event\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed\n\n- `startDateTime?: string`\n The start date and time of the marketing event\n\n### Returns\n\n- `{ createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }`\n\n - `createdAt: string`\n - `customProperties: { name: string; value: string; }[]`\n - `eventName: string`\n - `objectId: string`\n - `updatedAt: string`\n - `appInfo?: { id: string; name: string; }`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventOrganizer?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.update('objectId', { customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}] });\n\nconsole.log(marketingEventPublicDefaultResponseV2);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.update(\n 'objectId',\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n },\n);\n\nconsole.log(marketingEventPublicDefaultResponseV2.createdAt);", - }, - python: { - method: 'marketing.marketing_events.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response_v2 = client.marketing.marketing_events.update(\n object_id="objectId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n)\nprint(marketing_event_public_default_response_v2.created_at)', - }, - java: { - method: 'marketing().marketingEvents().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponseV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicUpdateRequestV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpdateParams params = MarketingEventUpdateParams.builder()\n .objectId("objectId")\n .marketingEventPublicUpdateRequestV2(MarketingEventPublicUpdateRequestV2.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .build())\n .build();\n MarketingEventPublicDefaultResponseV2 marketingEventPublicDefaultResponseV2 = client.marketing().marketingEvents().update(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponseV2, err := client.Marketing.MarketingEvents.Update(\n\t\tcontext.TODO(),\n\t\t"objectId",\n\t\tmarketing.MarketingEventUpdateParams{\n\t\t\tMarketingEventPublicUpdateRequestV2: marketing.MarketingEventPublicUpdateRequestV2Param{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponseV2.CreatedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response_v2 = hubspot.marketing.marketing_events.update(\n "objectId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ]\n)\n\nputs(marketing_event_public_default_response_v2)', - }, - php: { - method: 'marketing->marketingEvents->update', - example: - "marketing\n ->marketingEvents\n ->update(\n 'objectId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventDescription: 'eventDescription',\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponseV2);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update_batch', - endpoint: '/marketing/marketing-events/2026-03/batch/update', - httpMethod: 'post', - summary: 'Update Multiple Marketing Events by ObjectId', - description: 'Updates multiple Marketing Events on the portal based on their objectId, if they exist.', - stainlessPath: '(resource) marketing.marketing_events > (method) update_batch', - qualified: 'client.marketing.marketingEvents.updateBatch', - params: [ - "inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[];", - ], - response: - "{ completedAt: string; results: { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update_batch\n\n`client.marketing.marketingEvents.updateBatch(inputs: { customProperties: property_value[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]): { completedAt: string; results: marketing_event_public_default_response_v2[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/batch/update`\n\nUpdates multiple Marketing Events on the portal based on their objectId, if they exist.\n\n### Parameters\n\n- `inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; objectId: string; endDateTime?: string; eventCancelled?: boolean; eventDescription?: string; eventName?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { createdAt: string; customProperties: crm_property_wrapper[]; eventName: string; objectId: string; updatedAt: string; appInfo?: app_info; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { createdAt: string; customProperties: { name: string; value: string; }[]; eventName: string; objectId: string; updatedAt: string; appInfo?: { id: string; name: string; }; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventOrganizer?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseMarketingEventPublicDefaultResponseV2 = await client.marketing.marketingEvents.updateBatch({ inputs: [{ customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}], objectId: 'objectId' }] });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponseV2);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.updateBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseMarketingEventPublicDefaultResponseV2 =\n await client.marketing.marketingEvents.updateBatch({\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n objectId: 'objectId',\n },\n ],\n });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponseV2.completedAt);", - }, - python: { - method: 'marketing.marketing_events.update_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_marketing_event_public_default_response_v2 = client.marketing.marketing_events.update_batch(\n inputs=[{\n "custom_properties": [{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n "object_id": "objectId",\n }],\n)\nprint(batch_response_marketing_event_public_default_response_v2.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().updateBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventPublicUpdateRequestFullV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseMarketingEventPublicDefaultResponseV2;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicUpdateRequestFullV2;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventPublicUpdateRequestFullV2 params = BatchInputMarketingEventPublicUpdateRequestFullV2.builder()\n .addInput(MarketingEventPublicUpdateRequestFullV2.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .objectId("objectId")\n .build())\n .build();\n BatchResponseMarketingEventPublicDefaultResponseV2 batchResponseMarketingEventPublicDefaultResponseV2 = client.marketing().marketingEvents().updateBatch(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.UpdateBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseMarketingEventPublicDefaultResponseV2, err := client.Marketing.MarketingEvents.UpdateBatch(context.TODO(), marketing.MarketingEventUpdateBatchParams{\n\t\tBatchInputMarketingEventPublicUpdateRequestFullV2: marketing.BatchInputMarketingEventPublicUpdateRequestFullV2Param{\n\t\t\tInputs: []marketing.MarketingEventPublicUpdateRequestFullV2Param{{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tObjectID: "objectId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseMarketingEventPublicDefaultResponseV2.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.update_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_marketing_event_public_default_response_v2 = hubspot.marketing.marketing_events.update_batch(\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n objectId: "objectId"\n }\n ]\n)\n\nputs(batch_response_marketing_event_public_default_response_v2)', - }, - php: { - method: 'marketing->marketingEvents->updateBatch', - example: - "marketing\n ->marketingEvents\n ->updateBatch(\n inputs: [\n [\n 'customProperties' => [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n 'objectID' => 'objectId',\n 'endDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'eventCancelled' => true,\n 'eventDescription' => 'eventDescription',\n 'eventName' => 'eventName',\n 'eventOrganizer' => 'eventOrganizer',\n 'eventType' => 'eventType',\n 'eventURL' => 'eventUrl',\n 'startDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseMarketingEventPublicDefaultResponseV2);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "objectId": "objectId"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', - httpMethod: 'patch', - summary: 'Update Marketing Event by External IDs', - description: - 'Updates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists.\n\nOnly Marketing Events created by the same app can be updated.', - stainlessPath: '(resource) marketing.marketing_events > (method) update_by_external_event_id', - qualified: 'client.marketing.marketingEvents.updateByExternalEventID', - params: [ - 'externalEventId: string;', - 'externalAccountId: string;', - "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", - 'endDateTime?: string;', - 'eventCancelled?: boolean;', - 'eventCompleted?: boolean;', - 'eventDescription?: string;', - 'eventName?: string;', - 'eventOrganizer?: string;', - 'eventType?: string;', - 'eventUrl?: string;', - 'startDateTime?: string;', - ], - response: - "{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## update_by_external_event_id\n\n`client.marketing.marketingEvents.updateByExternalEventID(externalEventId: string, externalAccountId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventName?: string, eventOrganizer?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**patch** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nUpdates the details of an existing Marketing Event identified by its externalAccountId, externalEventId if it exists.\n\nOnly Marketing Events created by the same app can be updated.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventName?: string`\n The name of the marketing event.\n\n- `eventOrganizer?: string`\n The name of the organizer of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponse = await client.marketing.marketingEvents.updateByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId', customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}] });\n\nconsole.log(marketingEventPublicDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.updateByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.updateByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n });\n\nconsole.log(marketingEventPublicDefaultResponse.id);", - }, - python: { - method: 'marketing.marketing_events.update_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response = client.marketing.marketing_events.update_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n)\nprint(marketing_event_public_default_response.id)', - }, - java: { - method: 'marketing().marketingEvents().updateByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateByExternalEventIdParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpdateRequestParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpdateByExternalEventIdParams params = MarketingEventUpdateByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .marketingEventUpdateRequestParams(MarketingEventUpdateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .build())\n .build();\n MarketingEventPublicDefaultResponse marketingEventPublicDefaultResponse = client.marketing().marketingEvents().updateByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.UpdateByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpdateByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventUpdateByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tMarketingEventUpdateRequestParams: marketing.MarketingEventUpdateRequestParams{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponse.ID)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.update_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response = hubspot.marketing.marketing_events.update_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ]\n)\n\nputs(marketing_event_public_default_response)', - }, - php: { - method: 'marketing->marketingEvents->updateByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->updateByExternalEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert_batch', - endpoint: '/marketing/marketing-events/2026-03/events/upsert', - httpMethod: 'post', - summary: 'Create or Update Multiple Marketing Events', - description: - 'Upserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.\n\nOnly Marketing Events originally created by the same app can be updated.', - stainlessPath: '(resource) marketing.marketing_events > (method) upsert_batch', - qualified: 'client.marketing.marketingEvents.upsertBatch', - params: [ - "inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[];", - ], - response: - "{ completedAt: string; results: { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## upsert_batch\n\n`client.marketing.marketingEvents.upsertBatch(inputs: { customProperties: property_value[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]): { completedAt: string; results: marketing_event_public_default_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/upsert`\n\nUpserts multiple Marketing Events. If a Marketing Event with the specified ID already exists, it will be updated; otherwise, a new event will be created.\n\nOnly Marketing Events originally created by the same app can be updated.\n\n### Parameters\n\n- `inputs: { customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; externalAccountId: string; externalEventId: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; startDateTime?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseMarketingEventPublicDefaultResponse = await client.marketing.marketingEvents.upsertBatch({ inputs: [{\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n}] });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.upsertBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseMarketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.upsertBatch({\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n },\n ],\n });\n\nconsole.log(batchResponseMarketingEventPublicDefaultResponse.completedAt);", - }, - python: { - method: 'marketing.marketing_events.upsert_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_marketing_event_public_default_response = client.marketing.marketing_events.upsert_batch(\n inputs=[{\n "custom_properties": [{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n "event_name": "eventName",\n "event_organizer": "eventOrganizer",\n "external_account_id": "externalAccountId",\n "external_event_id": "externalEventId",\n }],\n)\nprint(batch_response_marketing_event_public_default_response.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().upsertBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseMarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputMarketingEventCreateRequestParams params = BatchInputMarketingEventCreateRequestParams.builder()\n .addInput(MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n BatchResponseMarketingEventPublicDefaultResponse batchResponseMarketingEventPublicDefaultResponse = client.marketing().marketingEvents().upsertBatch(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.UpsertBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseMarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpsertBatch(context.TODO(), marketing.MarketingEventUpsertBatchParams{\n\t\tBatchInputMarketingEventCreateRequestParams: marketing.BatchInputMarketingEventCreateRequestParams{\n\t\t\tInputs: []marketing.MarketingEventCreateRequestParams{{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tEventName: "eventName",\n\t\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseMarketingEventPublicDefaultResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.upsert_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_marketing_event_public_default_response = hubspot.marketing.marketing_events.upsert_batch(\n inputs: [\n {\n customProperties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n eventName: "eventName",\n eventOrganizer: "eventOrganizer",\n externalAccountId: "externalAccountId",\n externalEventId: "externalEventId"\n }\n ]\n)\n\nputs(batch_response_marketing_event_public_default_response)', - }, - php: { - method: 'marketing->marketingEvents->upsertBatch', - example: - "marketing\n ->marketingEvents\n ->upsertBatch(\n inputs: [\n [\n 'customProperties' => [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n 'eventName' => 'eventName',\n 'eventOrganizer' => 'eventOrganizer',\n 'externalAccountID' => 'externalAccountId',\n 'externalEventID' => 'externalEventId',\n 'endDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'eventCancelled' => true,\n 'eventCompleted' => true,\n 'eventDescription' => 'eventDescription',\n 'eventType' => 'eventType',\n 'eventURL' => 'eventUrl',\n 'startDateTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseMarketingEventPublicDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'upsert_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}', - httpMethod: 'put', - summary: 'Create or update a marketing event', - description: - 'Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.', - stainlessPath: '(resource) marketing.marketing_events > (method) upsert_by_external_event_id', - qualified: 'client.marketing.marketingEvents.upsertByExternalEventID', - params: [ - 'externalEventId: string;', - "customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[];", - 'eventName: string;', - 'eventOrganizer: string;', - 'externalAccountId: string;', - 'externalEventId: string;', - 'endDateTime?: string;', - 'eventCancelled?: boolean;', - 'eventCompleted?: boolean;', - 'eventDescription?: string;', - 'eventType?: string;', - 'eventUrl?: string;', - 'startDateTime?: string;', - ], - response: - "{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## upsert_by_external_event_id\n\n`client.marketing.marketingEvents.upsertByExternalEventID(externalEventId: string, customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[], eventName: string, eventOrganizer: string, externalAccountId: string, externalEventId: string, endDateTime?: string, eventCancelled?: boolean, eventCompleted?: boolean, eventDescription?: string, eventType?: string, eventUrl?: string, startDateTime?: string): { id: string; createdAt: string; customProperties: property_value[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**put** `/marketing/marketing-events/2026-03/events/{externalEventId}`\n\nUpserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account's definition of the MarketingEvent Object. If they don't they will be filtered out and not set.\nIn order to do this you'll need to create a new PropertyGroup on the HubSpot account's MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n\n\n- `eventName: string`\n The name of the marketing event.\n\n- `eventOrganizer: string`\n The name of the organizer of the marketing event.\n\n- `externalAccountId: string`\n The accountId that is associated with this marketing event in the external event application.\n\n- `externalEventId: string`\n The id of the marketing event in the external event application.\n\n- `endDateTime?: string`\n The end date and time of the marketing event.\n\n- `eventCancelled?: boolean`\n Indicates if the marketing event has been cancelled. Defaults to `false`\n\n- `eventCompleted?: boolean`\n Indicates if the marketing event has been completed. Defaults to `false`\n\n- `eventDescription?: string`\n The description of the marketing event.\n\n- `eventType?: string`\n Describes what type of event this is. For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`\n\n- `eventUrl?: string`\n A URL in the external event application where the marketing event can be managed.\n\n- `startDateTime?: string`\n The start date and time of the marketing event.\n\n### Returns\n\n- `{ id: string; createdAt: string; customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; updatedAt: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `updatedAt: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventPublicDefaultResponse = await client.marketing.marketingEvents.upsertByExternalEventID('externalEventId', {\n customProperties: [{\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n}],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});\n\nconsole.log(marketingEventPublicDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.upsertByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventPublicDefaultResponse =\n await client.marketing.marketingEvents.upsertByExternalEventID('externalEventId', {\n customProperties: [\n {\n dataSensitivity: 'high',\n isEncrypted: true,\n isLargeValue: true,\n name: 'name',\n persistenceTimestamp: 0,\n requestId: 'requestId',\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: 'ACADEMY',\n sourceId: 'sourceId',\n sourceLabel: 'sourceLabel',\n sourceMetadata: 'sourceMetadata',\n sourceUpstreamDeployable: 'sourceUpstreamDeployable',\n sourceVid: [0],\n timestamp: 0,\n unit: 'unit',\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: 'value',\n },\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n });\n\nconsole.log(marketingEventPublicDefaultResponse.id);", - }, - python: { - method: 'marketing.marketing_events.upsert_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_public_default_response = client.marketing.marketing_events.upsert_by_external_event_id(\n path_external_event_id="externalEventId",\n custom_properties=[{\n "data_sensitivity": "high",\n "is_encrypted": True,\n "is_large_value": True,\n "name": "name",\n "persistence_timestamp": 0,\n "request_id": "requestId",\n "selected_by_user": True,\n "selected_by_user_timestamp": 0,\n "source": "ACADEMY",\n "source_id": "sourceId",\n "source_label": "sourceLabel",\n "source_metadata": "sourceMetadata",\n "source_upstream_deployable": "sourceUpstreamDeployable",\n "source_vid": [0],\n "timestamp": 0,\n "unit": "unit",\n "updated_by_user_id": 0,\n "use_timestamp_as_persistence_timestamp": True,\n "value": "value",\n }],\n event_name="eventName",\n event_organizer="eventOrganizer",\n external_account_id="externalAccountId",\n body_external_event_id="externalEventId",\n)\nprint(marketing_event_public_default_response.id)', - }, - java: { - method: 'marketing().marketingEvents().upsertByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.PropertyValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCreateRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventPublicDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventUpsertByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n MarketingEventUpsertByExternalEventIdParams params = MarketingEventUpsertByExternalEventIdParams.builder()\n .pathExternalEventId("externalEventId")\n .marketingEventCreateRequestParams(MarketingEventCreateRequestParams.builder()\n .addCustomProperty(PropertyValue.builder()\n .dataSensitivity(PropertyValue.DataSensitivity.HIGH)\n .isEncrypted(true)\n .isLargeValue(true)\n .name("name")\n .persistenceTimestamp(0L)\n .requestId("requestId")\n .selectedByUser(true)\n .selectedByUserTimestamp(0L)\n .source(PropertyValue.Source.ACADEMY)\n .sourceId("sourceId")\n .sourceLabel("sourceLabel")\n .sourceMetadata("sourceMetadata")\n .sourceUpstreamDeployable("sourceUpstreamDeployable")\n .addSourceVid(0L)\n .timestamp(0L)\n .unit("unit")\n .updatedByUserId(0)\n .useTimestampAsPersistenceTimestamp(true)\n .value("value")\n .build())\n .eventName("eventName")\n .eventOrganizer("eventOrganizer")\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build())\n .build();\n MarketingEventPublicDefaultResponse marketingEventPublicDefaultResponse = client.marketing().marketingEvents().upsertByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.UpsertByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventPublicDefaultResponse, err := client.Marketing.MarketingEvents.UpsertByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventUpsertByExternalEventIDParams{\n\t\t\tMarketingEventCreateRequestParams: marketing.MarketingEventCreateRequestParams{\n\t\t\t\tCustomProperties: []shared.PropertyValueParam{{\n\t\t\t\t\tDataSensitivity: shared.PropertyValueDataSensitivityHigh,\n\t\t\t\t\tIsEncrypted: true,\n\t\t\t\t\tIsLargeValue: true,\n\t\t\t\t\tName: "name",\n\t\t\t\t\tPersistenceTimestamp: 0,\n\t\t\t\t\tRequestID: "requestId",\n\t\t\t\t\tSelectedByUser: true,\n\t\t\t\t\tSelectedByUserTimestamp: 0,\n\t\t\t\t\tSource: shared.PropertyValueSourceAcademy,\n\t\t\t\t\tSourceID: "sourceId",\n\t\t\t\t\tSourceLabel: "sourceLabel",\n\t\t\t\t\tSourceMetadata: "sourceMetadata",\n\t\t\t\t\tSourceUpstreamDeployable: "sourceUpstreamDeployable",\n\t\t\t\t\tSourceVid: []int64{0},\n\t\t\t\t\tTimestamp: 0,\n\t\t\t\t\tUnit: "unit",\n\t\t\t\t\tUpdatedByUserID: 0,\n\t\t\t\t\tUseTimestampAsPersistenceTimestamp: true,\n\t\t\t\t\tValue: "value",\n\t\t\t\t}},\n\t\t\t\tEventName: "eventName",\n\t\t\t\tEventOrganizer: "eventOrganizer",\n\t\t\t\tExternalAccountID: "externalAccountId",\n\t\t\t\tExternalEventID: "externalEventId",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventPublicDefaultResponse.ID)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.upsert_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_public_default_response = hubspot.marketing.marketing_events.upsert_by_external_event_id(\n "externalEventId",\n custom_properties: [\n {\n dataSensitivity: :high,\n isEncrypted: true,\n isLargeValue: true,\n name: "name",\n persistenceTimestamp: 0,\n requestId: "requestId",\n selectedByUser: true,\n selectedByUserTimestamp: 0,\n source: :ACADEMY,\n sourceId: "sourceId",\n sourceLabel: "sourceLabel",\n sourceMetadata: "sourceMetadata",\n sourceUpstreamDeployable: "sourceUpstreamDeployable",\n sourceVid: [0],\n timestamp: 0,\n unit: "unit",\n updatedByUserId: 0,\n useTimestampAsPersistenceTimestamp: true,\n value: "value"\n }\n ],\n event_name: "eventName",\n event_organizer: "eventOrganizer",\n external_account_id: "externalAccountId",\n body_external_event_id: "externalEventId"\n)\n\nputs(marketing_event_public_default_response)', - }, - php: { - method: 'marketing->marketingEvents->upsertByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->upsertByExternalEventID(\n 'externalEventId',\n customProperties: [\n [\n 'dataSensitivity' => 'high',\n 'isEncrypted' => true,\n 'isLargeValue' => true,\n 'name' => 'name',\n 'persistenceTimestamp' => 0,\n 'requestID' => 'requestId',\n 'selectedByUser' => true,\n 'selectedByUserTimestamp' => 0,\n 'source' => 'ACADEMY',\n 'sourceID' => 'sourceId',\n 'sourceLabel' => 'sourceLabel',\n 'sourceMetadata' => 'sourceMetadata',\n 'sourceUpstreamDeployable' => 'sourceUpstreamDeployable',\n 'sourceVid' => [0],\n 'timestamp' => 0,\n 'unit' => 'unit',\n 'updatedByUserID' => 0,\n 'useTimestampAsPersistenceTimestamp' => true,\n 'value' => 'value',\n ],\n ],\n eventName: 'eventName',\n eventOrganizer: 'eventOrganizer',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n eventCancelled: true,\n eventCompleted: true,\n eventDescription: 'eventDescription',\n eventType: 'eventType',\n eventURL: 'eventUrl',\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventPublicDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "customProperties": [\n {\n "dataSensitivity": "high",\n "isEncrypted": true,\n "isLargeValue": true,\n "name": "name",\n "persistenceTimestamp": 0,\n "requestId": "requestId",\n "selectedByUser": true,\n "selectedByUserTimestamp": 0,\n "source": "ACADEMY",\n "sourceId": "sourceId",\n "sourceLabel": "sourceLabel",\n "sourceMetadata": "sourceMetadata",\n "sourceUpstreamDeployable": "sourceUpstreamDeployable",\n "sourceVid": [\n 0\n ],\n "timestamp": 0,\n "unit": "unit",\n "updatedByUserId": 0,\n "useTimestampAsPersistenceTimestamp": true,\n "value": "value"\n }\n ],\n "eventName": "eventName",\n "eventOrganizer": "eventOrganizer",\n "externalAccountId": "externalAccountId",\n "externalEventId": "externalEventId"\n }\'', - }, - }, - }, - { - name: 'create_by_event_id_and_contact_id', - endpoint: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create', - httpMethod: 'post', - summary: 'Record Participants by ContactId with Marketing Event Object Id', - description: - 'Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', - stainlessPath: - '(resource) marketing.marketing_events.attendance > (method) create_by_event_id_and_contact_id', - qualified: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', - params: [ - 'objectId: string;', - 'subscriberState: string;', - 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', - ], - response: - "{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create_by_event_id_and_contact_id\n\n`client.marketing.marketingEvents.attendance.createByEventIDAndContactID(objectId: string, subscriberState: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[]): { completedAt: string; results: subscriber_vid_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `objectId: string`\n\n- `subscriberState: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n### Returns\n\n- `{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberVidResponse = await client.marketing.marketingEvents.attendance.createByEventIDAndContactID('subscriberState', { objectId: 'objectId', inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}] });\n\nconsole.log(batchResponseSubscriberVidResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberVidResponse =\n await client.marketing.marketingEvents.attendance.createByEventIDAndContactID('subscriberState', {\n objectId: 'objectId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n });\n\nconsole.log(batchResponseSubscriberVidResponse.completedAt);", - }, - python: { - method: 'marketing.marketing_events.attendance.create_by_event_id_and_contact_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_vid_response = client.marketing.marketing_events.attendance.create_by_event_id_and_contact_id(\n subscriber_state="subscriberState",\n object_id="objectId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(batch_response_subscriber_vid_response.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().attendance().createByEventIdAndContactId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberVidResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByEventIdAndContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByEventIdAndContactIdParams params = AttendanceCreateByEventIdAndContactIdParams.builder()\n .objectId("objectId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n BatchResponseSubscriberVidResponse batchResponseSubscriberVidResponse = client.marketing().marketingEvents().attendance().createByEventIdAndContactId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Attendance.NewByEventIDAndContactID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberVidResponse, err := client.Marketing.MarketingEvents.Attendance.NewByEventIDAndContactID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByEventIDAndContactIDParams{\n\t\t\tObjectID: "objectId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberVidResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.attendance.create_by_event_id_and_contact_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_vid_response = hubspot.marketing.marketing_events.attendance.create_by_event_id_and_contact_id(\n "subscriberState",\n object_id_: "objectId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(batch_response_subscriber_vid_response)', - }, - php: { - method: 'marketing->marketingEvents->attendance->createByEventIDAndContactID', - example: - "marketing\n ->marketingEvents\n ->attendance\n ->createByEventIDAndContactID(\n 'subscriberState',\n objectID: 'objectId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n);\n\nvar_dump($batchResponseSubscriberVidResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID/attendance/$SUBSCRIBER_STATE/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_by_event_id_and_email', - endpoint: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create', - httpMethod: 'post', - summary: 'Record Participants by Email with Marketing Event Object Id', - description: - 'Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', - stainlessPath: '(resource) marketing.marketing_events.attendance > (method) create_by_event_id_and_email', - qualified: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', - params: [ - 'objectId: string;', - 'subscriberState: string;', - 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', - ], - response: - "{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create_by_event_id_and_email\n\n`client.marketing.marketingEvents.attendance.createByEventIDAndEmail(objectId: string, subscriberState: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]): { completedAt: string; results: subscriber_email_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `objectId: string`\n\n- `subscriberState: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n### Returns\n\n- `{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { email: string; vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberEmailResponse = await client.marketing.marketingEvents.attendance.createByEventIDAndEmail('subscriberState', { objectId: 'objectId', inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSubscriberEmailResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberEmailResponse =\n await client.marketing.marketingEvents.attendance.createByEventIDAndEmail('subscriberState', {\n objectId: 'objectId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n });\n\nconsole.log(batchResponseSubscriberEmailResponse.completedAt);", - }, - python: { - method: 'marketing.marketing_events.attendance.create_by_event_id_and_email', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_email_response = client.marketing.marketing_events.attendance.create_by_event_id_and_email(\n subscriber_state="subscriberState",\n object_id="objectId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_subscriber_email_response.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().attendance().createByEventIdAndEmail', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberEmailResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByEventIdAndEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByEventIdAndEmailParams params = AttendanceCreateByEventIdAndEmailParams.builder()\n .objectId("objectId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSubscriberEmailResponse batchResponseSubscriberEmailResponse = client.marketing().marketingEvents().attendance().createByEventIdAndEmail(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Attendance.NewByEventIDAndEmail', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberEmailResponse, err := client.Marketing.MarketingEvents.Attendance.NewByEventIDAndEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByEventIDAndEmailParams{\n\t\t\tObjectID: "objectId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberEmailResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.attendance.create_by_event_id_and_email', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_email_response = hubspot.marketing.marketing_events.attendance.create_by_event_id_and_email(\n "subscriberState",\n object_id_: "objectId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(batch_response_subscriber_email_response)', - }, - php: { - method: 'marketing->marketingEvents->attendance->createByEventIDAndEmail', - example: - "marketing\n ->marketingEvents\n ->attendance\n ->createByEventIDAndEmail(\n 'subscriberState',\n objectID: 'objectId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n);\n\nvar_dump($batchResponseSubscriberEmailResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$OBJECT_ID/attendance/$SUBSCRIBER_STATE/email-create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_by_external_event_id_and_contact_id', - endpoint: '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create', - httpMethod: 'post', - summary: 'Record Participants by ContactId with Marketing Event External Ids', - description: - 'Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', - stainlessPath: - '(resource) marketing.marketing_events.attendance > (method) create_by_external_event_id_and_contact_id', - qualified: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', - params: [ - 'externalEventId: string;', - 'subscriberState: string;', - 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', - 'externalAccountId?: string;', - ], - response: - "{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create_by_external_event_id_and_contact_id\n\n`client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID(externalEventId: string, subscriberState: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[], externalAccountId?: string): { completedAt: string; results: subscriber_vid_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n- `externalAccountId?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberVidResponse = await client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID('subscriberState', { externalEventId: 'externalEventId', inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}] });\n\nconsole.log(batchResponseSubscriberVidResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberVidResponse =\n await client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n },\n );\n\nconsole.log(batchResponseSubscriberVidResponse.completedAt);", - }, - python: { - method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_vid_response = client.marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(batch_response_subscriber_vid_response.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().attendance().createByExternalEventIdAndContactId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberVidResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByExternalEventIdAndContactIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByExternalEventIdAndContactIdParams params = AttendanceCreateByExternalEventIdAndContactIdParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n BatchResponseSubscriberVidResponse batchResponseSubscriberVidResponse = client.marketing().marketingEvents().attendance().createByExternalEventIdAndContactId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndContactID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberVidResponse, err := client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndContactID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByExternalEventIDAndContactIDParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberVidResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_vid_response = hubspot.marketing.marketing_events.attendance.create_by_external_event_id_and_contact_id(\n "subscriberState",\n external_event_id: "externalEventId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(batch_response_subscriber_vid_response)', - }, - php: { - method: 'marketing->marketingEvents->attendance->createByExternalEventIDAndContactID', - example: - "marketing\n ->marketingEvents\n ->attendance\n ->createByExternalEventIDAndContactID(\n 'subscriberState',\n externalEventID: 'externalEventId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n externalAccountID: 'externalAccountId',\n);\n\nvar_dump($batchResponseSubscriberVidResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/attendance/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_by_external_event_id_and_email', - endpoint: - '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create', - httpMethod: 'post', - summary: 'Record Participants by Email with Marketing Event External Ids', - description: - 'Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state "attend":\n- joinedAt\n- leftAt', - stainlessPath: - '(resource) marketing.marketing_events.attendance > (method) create_by_external_event_id_and_email', - qualified: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', - params: [ - 'externalEventId: string;', - 'subscriberState: string;', - 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', - 'externalAccountId?: string;', - ], - response: - "{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }", - markdown: - "## create_by_external_event_id_and_email\n\n`client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail(externalEventId: string, subscriberState: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[], externalAccountId?: string): { completedAt: string; results: subscriber_email_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: standard_error[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create`\n\nRecords the participation of multiple HubSpot contacts in a Marketing Event using their email addresses.\n\nIf a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts.\n\nAdditional Functionality:\n- Adds a timeline event to the contacts.\n\nAllowed Properties:\nFor the state \"attend\":\n- joinedAt\n- leftAt\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n- `externalAccountId?: string`\n\n### Returns\n\n- `{ completedAt: string; results: { email: string; vid: number; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; errors?: { category: string; context: object; errors: error_detail[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]; links?: object; numErrors?: number; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { email: string; vid: number; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `errors?: { category: string; context: object; errors: { message: string; code?: string; context?: object; in?: string; subCategory?: string; }[]; links: object; message: string; status: string; id?: string; subCategory?: object; }[]`\n - `links?: object`\n - `numErrors?: number`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriberEmailResponse = await client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail('subscriberState', { externalEventId: 'externalEventId', inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}] });\n\nconsole.log(batchResponseSubscriberEmailResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriberEmailResponse =\n await client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n },\n );\n\nconsole.log(batchResponseSubscriberEmailResponse.completedAt);", - }, - python: { - method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_email', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscriber_email_response = client.marketing.marketing_events.attendance.create_by_external_event_id_and_email(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(batch_response_subscriber_email_response.completed_at)', - }, - java: { - method: 'marketing().marketingEvents().attendance().createByExternalEventIdAndEmail', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchResponseSubscriberEmailResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.attendance.AttendanceCreateByExternalEventIdAndEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCreateByExternalEventIdAndEmailParams params = AttendanceCreateByExternalEventIdAndEmailParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n BatchResponseSubscriberEmailResponse batchResponseSubscriberEmailResponse = client.marketing().marketingEvents().attendance().createByExternalEventIdAndEmail(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndEmail', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriberEmailResponse, err := client.Marketing.MarketingEvents.Attendance.NewByExternalEventIDAndEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventAttendanceNewByExternalEventIDAndEmailParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriberEmailResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.attendance.create_by_external_event_id_and_email', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscriber_email_response = hubspot.marketing.marketing_events.attendance.create_by_external_event_id_and_email(\n "subscriberState",\n external_event_id: "externalEventId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(batch_response_subscriber_email_response)', - }, - php: { - method: 'marketing->marketingEvents->attendance->createByExternalEventIDAndEmail', - example: - "marketing\n ->marketingEvents\n ->attendance\n ->createByExternalEventIDAndEmail(\n 'subscriberState',\n externalEventID: 'externalEventId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n externalAccountID: 'externalAccountId',\n);\n\nvar_dump($batchResponseSubscriberEmailResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/attendance/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/email-create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'cancel_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/cancel', - httpMethod: 'post', - summary: 'Mark a marketing event as cancelled', - description: 'Mark a marketing event as cancelled.', - stainlessPath: '(resource) marketing.marketing_events.events > (method) cancel_by_external_event_id', - qualified: 'client.marketing.marketingEvents.events.cancelByExternalEventID', - params: ['externalEventId: string;', 'externalAccountId: string;'], - response: - "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## cancel_by_external_event_id\n\n`client.marketing.marketingEvents.events.cancelByExternalEventID(externalEventId: string, externalAccountId: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/cancel`\n\nMark a marketing event as cancelled.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.events.cancelByExternalEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(marketingEventDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.events.cancelByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse =\n await client.marketing.marketingEvents.events.cancelByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(marketingEventDefaultResponse.customProperties);", - }, - python: { - method: 'marketing.marketing_events.events.cancel_by_external_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.events.cancel_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(marketing_event_default_response.custom_properties)', - }, - java: { - method: 'marketing().marketingEvents().events().cancelByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.events.EventCancelByExternalEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventCancelByExternalEventIdParams params = EventCancelByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().events().cancelByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Events.CancelByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.Events.CancelByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventEventCancelByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.events.cancel_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.events.cancel_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(marketing_event_default_response)', - }, - php: { - method: 'marketing->marketingEvents->events->cancelByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->events\n ->cancelByExternalEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($marketingEventDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/cancel \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'complete_by_external_event_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/complete', - httpMethod: 'post', - summary: 'Mark a marketing event as completed', - description: 'Mark a marketing event as completed', - stainlessPath: '(resource) marketing.marketing_events.events > (method) complete_by_external_event_id', - qualified: 'client.marketing.marketingEvents.events.completeByExternalEventID', - params: [ - 'externalEventId: string;', - 'externalAccountId: string;', - 'endDateTime: string;', - 'startDateTime: string;', - ], - response: - "{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }", - markdown: - "## complete_by_external_event_id\n\n`client.marketing.marketingEvents.events.completeByExternalEventID(externalEventId: string, externalAccountId: string, endDateTime: string, startDateTime: string): { customProperties: property_value[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/complete`\n\nMark a marketing event as completed\n\n### Parameters\n\n- `externalEventId: string`\n\n- `externalAccountId: string`\n\n- `endDateTime: string`\n The end date and time of the marketing event in ISO 8601 format\n\n- `startDateTime: string`\n The start date and time of the marketing event in ISO 8601 format\n\n### Returns\n\n- `{ customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]; eventName: string; eventOrganizer: string; endDateTime?: string; eventCancelled?: boolean; eventCompleted?: boolean; eventDescription?: string; eventType?: string; eventUrl?: string; objectId?: string; startDateTime?: string; }`\n\n - `customProperties: { dataSensitivity: 'high' | 'none' | 'standard'; isEncrypted: boolean; isLargeValue: boolean; name: string; persistenceTimestamp: number; requestId: string; selectedByUser: boolean; selectedByUserTimestamp: number; source: string; sourceId: string; sourceLabel: string; sourceMetadata: string; sourceUpstreamDeployable: string; sourceVid: number[]; timestamp: number; unit: string; updatedByUserId: number; useTimestampAsPersistenceTimestamp: boolean; value: string; }[]`\n - `eventName: string`\n - `eventOrganizer: string`\n - `endDateTime?: string`\n - `eventCancelled?: boolean`\n - `eventCompleted?: boolean`\n - `eventDescription?: string`\n - `eventType?: string`\n - `eventUrl?: string`\n - `objectId?: string`\n - `startDateTime?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst marketingEventDefaultResponse = await client.marketing.marketingEvents.events.completeByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n endDateTime: '2019-12-27T18:11:19.117Z',\n startDateTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(marketingEventDefaultResponse);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.events.completeByExternalEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst marketingEventDefaultResponse =\n await client.marketing.marketingEvents.events.completeByExternalEventID('externalEventId', {\n externalAccountId: 'externalAccountId',\n endDateTime: '2019-12-27T18:11:19.117Z',\n startDateTime: '2019-12-27T18:11:19.117Z',\n });\n\nconsole.log(marketingEventDefaultResponse.customProperties);", - }, - python: { - method: 'marketing.marketing_events.events.complete_by_external_event_id', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nmarketing_event_default_response = client.marketing.marketing_events.events.complete_by_external_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n end_date_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n start_date_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(marketing_event_default_response.custom_properties)', - }, - java: { - method: 'marketing().marketingEvents().events().completeByExternalEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventCompleteRequestParams;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventDefaultResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.events.EventCompleteByExternalEventIdParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventCompleteByExternalEventIdParams params = EventCompleteByExternalEventIdParams.builder()\n .externalEventId("externalEventId")\n .externalAccountId("externalAccountId")\n .marketingEventCompleteRequestParams(MarketingEventCompleteRequestParams.builder()\n .endDateTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .startDateTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build())\n .build();\n MarketingEventDefaultResponse marketingEventDefaultResponse = client.marketing().marketingEvents().events().completeByExternalEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Events.CompleteByExternalEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmarketingEventDefaultResponse, err := client.Marketing.MarketingEvents.Events.CompleteByExternalEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventEventCompleteByExternalEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tMarketingEventCompleteRequestParams: marketing.MarketingEventCompleteRequestParams{\n\t\t\t\tEndDateTime: time.Now(),\n\t\t\t\tStartDateTime: time.Now(),\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", marketingEventDefaultResponse.CustomProperties)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.events.complete_by_external_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nmarketing_event_default_response = hubspot.marketing.marketing_events.events.complete_by_external_event_id(\n "externalEventId",\n external_account_id: "externalAccountId",\n end_date_time: "2019-12-27T18:11:19.117Z",\n start_date_time: "2019-12-27T18:11:19.117Z"\n)\n\nputs(marketing_event_default_response)', - }, - php: { - method: 'marketing->marketingEvents->events->completeByExternalEventID', - example: - "marketing\n ->marketingEvents\n ->events\n ->completeByExternalEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n endDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n startDateTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($marketingEventDefaultResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/complete \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "endDateTime": "2019-12-27T18:11:19.117Z",\n "startDateTime": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'associate', - endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', - httpMethod: 'put', - summary: 'Associate a list with a marketing event', - description: 'Associates a list with a marketing event by marketing event id and ILS list id', - stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) associate', - qualified: 'client.marketing.marketingEvents.listAssociations.associate', - params: ['marketingEventId: string;', 'listId: string;'], - markdown: - "## associate\n\n`client.marketing.marketingEvents.listAssociations.associate(marketingEventId: string, listId: string): void`\n\n**put** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}`\n\nAssociates a list with a marketing event by marketing event id and ILS list id\n\n### Parameters\n\n- `marketingEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.associate('listId', { marketingEventId: 'marketingEventId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.associate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.associate('listId', {\n marketingEventId: 'marketingEventId',\n});", - }, - python: { - method: 'marketing.marketing_events.list_associations.associate', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.associate(\n list_id="listId",\n marketing_event_id="marketingEventId",\n)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().associate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationAssociateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationAssociateParams params = ListAssociationAssociateParams.builder()\n .marketingEventId("marketingEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().associate(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.Associate', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.Associate(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationAssociateParams{\n\t\t\tMarketingEventID: "marketingEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.associate', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.associate(\n "listId",\n marketing_event_id: "marketingEventId"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->associate', - example: - "marketing->marketingEvents->listAssociations->associate(\n 'listId', marketingEventID: 'marketingEventId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists/$LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'associate_by_external_account', - endpoint: - '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', - httpMethod: 'put', - summary: 'Associate a list with a marketing event', - description: - 'Associates a list with a marketing event by external account id, external event id, and ILS list id', - stainlessPath: - '(resource) marketing.marketing_events.list_associations > (method) associate_by_external_account', - qualified: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', - params: ['externalAccountId: string;', 'externalEventId: string;', 'listId: string;'], - markdown: - "## associate_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.associateByExternalAccount(externalAccountId: string, externalEventId: string, listId: string): void`\n\n**put** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}`\n\nAssociates a list with a marketing event by external account id, external event id, and ILS list id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.associateByExternalAccount('listId', { externalAccountId: 'externalAccountId', externalEventId: 'externalEventId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.associateByExternalAccount('listId', {\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});", - }, - python: { - method: 'marketing.marketing_events.list_associations.associate_by_external_account', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.associate_by_external_account(\n list_id="listId",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().associateByExternalAccount', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationAssociateByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationAssociateByExternalAccountParams params = ListAssociationAssociateByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().associateByExternalAccount(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.AssociateByExternalAccount', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.AssociateByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationAssociateByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.associate_by_external_account', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.associate_by_external_account(\n "listId",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->associateByExternalAccount', - example: - "marketing\n ->marketingEvents\n ->listAssociations\n ->associateByExternalAccount(\n 'listId',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists/$LIST_ID \\\n -X PUT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', - httpMethod: 'delete', - summary: 'Disassociate a list from a marketing event', - description: 'Disassociates a list from a marketing event by marketing event id and ILS list id', - stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) delete', - qualified: 'client.marketing.marketingEvents.listAssociations.delete', - params: ['marketingEventId: string;', 'listId: string;'], - markdown: - "## delete\n\n`client.marketing.marketingEvents.listAssociations.delete(marketingEventId: string, listId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}`\n\nDisassociates a list from a marketing event by marketing event id and ILS list id\n\n### Parameters\n\n- `marketingEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.delete('listId', { marketingEventId: 'marketingEventId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.delete('listId', {\n marketingEventId: 'marketingEventId',\n});", - }, - python: { - method: 'marketing.marketing_events.list_associations.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.delete(\n list_id="listId",\n marketing_event_id="marketingEventId",\n)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationDeleteParams params = ListAssociationDeleteParams.builder()\n .marketingEventId("marketingEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().delete(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.Delete(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationDeleteParams{\n\t\t\tMarketingEventID: "marketingEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.delete(\n "listId",\n marketing_event_id: "marketingEventId"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->delete', - example: - "marketing->marketingEvents->listAssociations->delete(\n 'listId', marketingEventID: 'marketingEventId'\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_by_external_account', - endpoint: - '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', - httpMethod: 'delete', - summary: 'Disassociate a list from a marketing event', - description: - 'Disassociates a list from a marketing event by external account id, external event id, and ILS list id', - stainlessPath: - '(resource) marketing.marketing_events.list_associations > (method) delete_by_external_account', - qualified: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', - params: ['externalAccountId: string;', 'externalEventId: string;', 'listId: string;'], - markdown: - "## delete_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.deleteByExternalAccount(externalAccountId: string, externalEventId: string, listId: string): void`\n\n**delete** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}`\n\nDisassociates a list from a marketing event by external account id, external event id, and ILS list id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `listId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.marketingEvents.listAssociations.deleteByExternalAccount('listId', { externalAccountId: 'externalAccountId', externalEventId: 'externalEventId' })\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.marketingEvents.listAssociations.deleteByExternalAccount('listId', {\n externalAccountId: 'externalAccountId',\n externalEventId: 'externalEventId',\n});", - }, - python: { - method: 'marketing.marketing_events.list_associations.delete_by_external_account', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.marketing_events.list_associations.delete_by_external_account(\n list_id="listId",\n external_account_id="externalAccountId",\n external_event_id="externalEventId",\n)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().deleteByExternalAccount', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationDeleteByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationDeleteByExternalAccountParams params = ListAssociationDeleteByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .listId("listId")\n .build();\n client.marketing().marketingEvents().listAssociations().deleteByExternalAccount(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.DeleteByExternalAccount', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.MarketingEvents.ListAssociations.DeleteByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"listId",\n\t\tmarketing.MarketingEventListAssociationDeleteByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tExternalEventID: "externalEventId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.delete_by_external_account', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.marketing_events.list_associations.delete_by_external_account(\n "listId",\n external_account_id: "externalAccountId",\n external_event_id: "externalEventId"\n)\n\nputs(result)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->deleteByExternalAccount', - example: - "marketing\n ->marketingEvents\n ->listAssociations\n ->deleteByExternalAccount(\n 'listId',\n externalAccountID: 'externalAccountId',\n externalEventID: 'externalEventId',\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists/$LIST_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists', - httpMethod: 'get', - summary: 'Get lists associated with a marketing event', - description: 'Gets lists associated with a marketing event by marketing event id', - stainlessPath: '(resource) marketing.marketing_events.list_associations > (method) list', - qualified: 'client.marketing.marketingEvents.listAssociations.list', - params: ['marketingEventId: string;'], - response: - '{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## list\n\n`client.marketing.marketingEvents.listAssociations.list(marketingEventId: string): { results: public_list[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists`\n\nGets lists associated with a marketing event by marketing event id\n\n### Parameters\n\n- `marketingEventId: string`\n\n### Returns\n\n- `{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalPublicList = await client.marketing.marketingEvents.listAssociations.list('marketingEventId');\n\nconsole.log(collectionResponseWithTotalPublicList);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalPublicList =\n await client.marketing.marketingEvents.listAssociations.list('marketingEventId');\n\nconsole.log(collectionResponseWithTotalPublicList.results);", - }, - python: { - method: 'marketing.marketing_events.list_associations.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_public_list = client.marketing.marketing_events.list_associations.list(\n "marketingEventId",\n)\nprint(collection_response_with_total_public_list.results)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalPublicList;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseWithTotalPublicList collectionResponseWithTotalPublicList = client.marketing().marketingEvents().listAssociations().list("marketingEventId");\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalPublicList, err := client.Marketing.MarketingEvents.ListAssociations.List(context.TODO(), "marketingEventId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalPublicList.Results)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_public_list = hubspot.marketing.marketing_events.list_associations.list("marketingEventId")\n\nputs(collection_response_with_total_public_list)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->list', - example: - "marketing\n ->marketingEvents\n ->listAssociations\n ->list('marketingEventId');\n\nvar_dump($collectionResponseWithTotalPublicList);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$MARKETING_EVENT_ID/lists \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_by_external_account', - endpoint: '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists', - httpMethod: 'get', - summary: 'Get lists associated with a marketing event', - description: 'Gets lists associated with a marketing event by external account id and external event id', - stainlessPath: - '(resource) marketing.marketing_events.list_associations > (method) list_by_external_account', - qualified: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', - params: ['externalAccountId: string;', 'externalEventId: string;'], - response: - '{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }', - markdown: - "## list_by_external_account\n\n`client.marketing.marketingEvents.listAssociations.listByExternalAccount(externalAccountId: string, externalEventId: string): { results: public_list[]; total: number; paging?: paging; }`\n\n**get** `/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists`\n\nGets lists associated with a marketing event by external account id and external event id\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]; total: number; paging?: { next?: next_page; prev?: previous_page; }; }`\n\n - `results: { listId: string; listVersion: number; name: string; objectTypeId: string; processingStatus: string; processingType: string; createdAt?: string; createdById?: string; deletedAt?: string; filtersUpdatedAt?: string; size?: number; updatedAt?: string; updatedById?: string; }[]`\n - `total: number`\n - `paging?: { next?: { after: string; link?: string; }; prev?: { before: string; link?: string; }; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseWithTotalPublicList = await client.marketing.marketingEvents.listAssociations.listByExternalAccount('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(collectionResponseWithTotalPublicList);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseWithTotalPublicList =\n await client.marketing.marketingEvents.listAssociations.listByExternalAccount('externalEventId', {\n externalAccountId: 'externalAccountId',\n });\n\nconsole.log(collectionResponseWithTotalPublicList.results);", - }, - python: { - method: 'marketing.marketing_events.list_associations.list_by_external_account', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_with_total_public_list = client.marketing.marketing_events.list_associations.list_by_external_account(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(collection_response_with_total_public_list.results)', - }, - java: { - method: 'marketing().marketingEvents().listAssociations().listByExternalAccount', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.CollectionResponseWithTotalPublicList;\nimport com.hubspot.sdk.models.marketing.marketingevents.listassociations.ListAssociationListByExternalAccountParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ListAssociationListByExternalAccountParams params = ListAssociationListByExternalAccountParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n CollectionResponseWithTotalPublicList collectionResponseWithTotalPublicList = client.marketing().marketingEvents().listAssociations().listByExternalAccount(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.ListAssociations.ListByExternalAccount', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseWithTotalPublicList, err := client.Marketing.MarketingEvents.ListAssociations.ListByExternalAccount(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventListAssociationListByExternalAccountParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseWithTotalPublicList.Results)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.list_associations.list_by_external_account', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_with_total_public_list = hubspot.marketing.marketing_events.list_associations.list_by_external_account(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(collection_response_with_total_public_list)', - }, - php: { - method: 'marketing->marketingEvents->listAssociations->listByExternalAccount', - example: - "marketing\n ->marketingEvents\n ->listAssociations\n ->listByExternalAccount(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($collectionResponseWithTotalPublicList);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/associations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/lists \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_external_account_and_event_id', - endpoint: '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}', - httpMethod: 'get', - summary: 'Read participations counters by Marketing Event external identifier', - description: - "Read Marketing event's participations counters by externalAccountId and externalEventId pair.", - stainlessPath: - '(resource) marketing.marketing_events.participations > (method) get_by_external_account_and_event_id', - qualified: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', - params: ['externalAccountId: string;', 'externalEventId: string;'], - response: '{ attended: number; cancelled: number; noShows: number; registered: number; }', - markdown: - "## get_by_external_account_and_event_id\n\n`client.marketing.marketingEvents.participations.getByExternalAccountAndEventID(externalAccountId: string, externalEventId: string): { attended: number; cancelled: number; noShows: number; registered: number; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}`\n\nRead Marketing event's participations counters by externalAccountId and externalEventId pair.\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n### Returns\n\n- `{ attended: number; cancelled: number; noShows: number; registered: number; }`\n\n - `attended: number`\n - `cancelled: number`\n - `noShows: number`\n - `registered: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByExternalAccountAndEventID('externalEventId', { externalAccountId: 'externalAccountId' });\n\nconsole.log(attendanceCounters);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attendanceCounters =\n await client.marketing.marketingEvents.participations.getByExternalAccountAndEventID(\n 'externalEventId',\n { externalAccountId: 'externalAccountId' },\n );\n\nconsole.log(attendanceCounters.attended);", - }, - python: { - method: 'marketing.marketing_events.participations.get_by_external_account_and_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattendance_counters = client.marketing.marketing_events.participations.get_by_external_account_and_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\nprint(attendance_counters.attended)', - }, - java: { - method: 'marketing().marketingEvents().participations().getByExternalAccountAndEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.AttendanceCounters;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationGetByExternalAccountAndEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationGetByExternalAccountAndEventIdParams params = ParticipationGetByExternalAccountAndEventIdParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n AttendanceCounters attendanceCounters = client.marketing().marketingEvents().participations().getByExternalAccountAndEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Participations.GetByExternalAccountAndEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattendanceCounters, err := client.Marketing.MarketingEvents.Participations.GetByExternalAccountAndEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventParticipationGetByExternalAccountAndEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attendanceCounters.Attended)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.participations.get_by_external_account_and_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattendance_counters = hubspot.marketing.marketing_events.participations.get_by_external_account_and_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(attendance_counters)', - }, - php: { - method: 'marketing->marketingEvents->participations->getByExternalAccountAndEventID', - example: - "marketing\n ->marketingEvents\n ->participations\n ->getByExternalAccountAndEventID(\n 'externalEventId', externalAccountID: 'externalAccountId'\n);\n\nvar_dump($attendanceCounters);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_by_id', - endpoint: '/marketing/marketing-events/2026-03/participations/{marketingEventId}', - httpMethod: 'get', - summary: 'Read participations counters by Marketing Event internal identifier', - description: "Read Marketing event's participations counters by internal identifier marketingEventId.", - stainlessPath: '(resource) marketing.marketing_events.participations > (method) get_by_id', - qualified: 'client.marketing.marketingEvents.participations.getByID', - params: ['marketingEventId: number;'], - response: '{ attended: number; cancelled: number; noShows: number; registered: number; }', - markdown: - "## get_by_id\n\n`client.marketing.marketingEvents.participations.getByID(marketingEventId: number): { attended: number; cancelled: number; noShows: number; registered: number; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{marketingEventId}`\n\nRead Marketing event's participations counters by internal identifier marketingEventId.\n\n### Parameters\n\n- `marketingEventId: number`\n\n### Returns\n\n- `{ attended: number; cancelled: number; noShows: number; registered: number; }`\n\n - `attended: number`\n - `cancelled: number`\n - `noShows: number`\n - `registered: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByID(0);\n\nconsole.log(attendanceCounters);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.participations.getByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst attendanceCounters = await client.marketing.marketingEvents.participations.getByID(0);\n\nconsole.log(attendanceCounters.attended);", - }, - python: { - method: 'marketing.marketing_events.participations.get_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nattendance_counters = client.marketing.marketing_events.participations.get_by_id(\n 0,\n)\nprint(attendance_counters.attended)', - }, - java: { - method: 'marketing().marketingEvents().participations().getById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.AttendanceCounters;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationGetByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AttendanceCounters attendanceCounters = client.marketing().marketingEvents().participations().getById(0L);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Participations.GetByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tattendanceCounters, err := client.Marketing.MarketingEvents.Participations.GetByID(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", attendanceCounters.Attended)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.participations.get_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nattendance_counters = hubspot.marketing.marketing_events.participations.get_by_id(0)\n\nputs(attendance_counters)', - }, - php: { - method: 'marketing->marketingEvents->participations->getByID', - example: - "marketing\n ->marketingEvents\n ->participations\n ->getByID(0);\n\nvar_dump($attendanceCounters);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$MARKETING_EVENT_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_breakdown_by_contact', - endpoint: '/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown', - httpMethod: 'get', - summary: 'Read participations breakdown by Contact identifier', - description: "Read Contact's participations by identifier - email or internal id.", - stainlessPath: - '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_contact', - qualified: 'client.marketing.marketingEvents.participations.listBreakdownByContact', - params: ['contactIdentifier: string;', 'after?: string;', 'limit?: number;', 'state?: string;'], - response: - "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", - markdown: - "## list_breakdown_by_contact\n\n`client.marketing.marketingEvents.participations.listBreakdownByContact(contactIdentifier: string, after?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown`\n\nRead Contact's participations by identifier - email or internal id.\n\n### Parameters\n\n- `contactIdentifier: string`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByContact('contactIdentifier')) {\n console.log(participationBreakdown);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.participations.listBreakdownByContact', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByContact(\n 'contactIdentifier',\n)) {\n console.log(participationBreakdown.id);\n}", - }, - python: { - method: 'marketing.marketing_events.participations.list_breakdown_by_contact', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_contact(\n contact_identifier="contactIdentifier",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().marketingEvents().participations().listBreakdownByContact', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByContactPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByContactParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByContactPage page = client.marketing().marketingEvents().participations().listBreakdownByContact("contactIdentifier");\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByContact', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByContact(\n\t\tcontext.TODO(),\n\t\t"contactIdentifier",\n\t\tmarketing.MarketingEventParticipationListBreakdownByContactParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.participations.list_breakdown_by_contact', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_contact("contactIdentifier")\n\nputs(page)', - }, - php: { - method: 'marketing->marketingEvents->participations->listBreakdownByContact', - example: - "marketing\n ->marketingEvents\n ->participations\n ->listBreakdownByContact(\n 'contactIdentifier', after: 'after', limit: 0, state: 'state'\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/contacts/$CONTACT_IDENTIFIER/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_breakdown_by_external_account_and_event_id', - endpoint: - '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown', - httpMethod: 'get', - summary: 'Read participations breakdown by Marketing Event external identifier', - description: - "Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.", - stainlessPath: - '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_external_account_and_event_id', - qualified: 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', - params: [ - 'externalAccountId: string;', - 'externalEventId: string;', - 'after?: string;', - 'contactIdentifier?: string;', - 'limit?: number;', - 'state?: string;', - ], - response: - "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", - markdown: - "## list_breakdown_by_external_account_and_event_id\n\n`client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID(externalAccountId: string, externalEventId: string, after?: string, contactIdentifier?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown`\n\nRead Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair.\n\n### Parameters\n\n- `externalAccountId: string`\n\n- `externalEventId: string`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `contactIdentifier?: string`\n The identifier of the Contact. It may be email or internal id.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID('externalEventId', { externalAccountId: 'externalAccountId' })) {\n console.log(participationBreakdown);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID(\n 'externalEventId',\n { externalAccountId: 'externalAccountId' },\n)) {\n console.log(participationBreakdown.id);\n}", - }, - python: { - method: 'marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id(\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().marketingEvents().participations().listBreakdownByExternalAccountAndEventId', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByExternalAccountAndEventIdPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByExternalAccountAndEventIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByExternalAccountAndEventIdParams params = ParticipationListBreakdownByExternalAccountAndEventIdParams.builder()\n .externalAccountId("externalAccountId")\n .externalEventId("externalEventId")\n .build();\n ParticipationListBreakdownByExternalAccountAndEventIdPage page = client.marketing().marketingEvents().participations().listBreakdownByExternalAccountAndEventId(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByExternalAccountAndEventID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByExternalAccountAndEventID(\n\t\tcontext.TODO(),\n\t\t"externalEventId",\n\t\tmarketing.MarketingEventParticipationListBreakdownByExternalAccountAndEventIDParams{\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_external_account_and_event_id(\n "externalEventId",\n external_account_id: "externalAccountId"\n)\n\nputs(page)', - }, - php: { - method: 'marketing->marketingEvents->participations->listBreakdownByExternalAccountAndEventID', - example: - "marketing\n ->marketingEvents\n ->participations\n ->listBreakdownByExternalAccountAndEventID(\n 'externalEventId',\n externalAccountID: 'externalAccountId',\n after: 'after',\n contactIdentifier: 'contactIdentifier',\n limit: 0,\n state: 'state',\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$EXTERNAL_ACCOUNT_ID/$EXTERNAL_EVENT_ID/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_breakdown_by_id', - endpoint: '/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown', - httpMethod: 'get', - summary: 'Read participations breakdown by Marketing Event internal identifier', - description: - "Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.", - stainlessPath: '(resource) marketing.marketing_events.participations > (method) list_breakdown_by_id', - qualified: 'client.marketing.marketingEvents.participations.listBreakdownByID', - params: [ - 'marketingEventId: number;', - 'after?: string;', - 'contactIdentifier?: string;', - 'limit?: number;', - 'state?: string;', - ], - response: - "{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }", - markdown: - "## list_breakdown_by_id\n\n`client.marketing.marketingEvents.participations.listBreakdownByID(marketingEventId: number, after?: string, contactIdentifier?: string, limit?: number, state?: string): { id: string; associations: participation_associations; createdAt: string; properties: participation_properties; }`\n\n**get** `/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown`\n\nRead Marketing event's participations breakdown with optional filters by internal identifier marketingEventId.\n\n### Parameters\n\n- `marketingEventId: number`\n\n- `after?: string`\n The cursor indicating the position of the last retrieved item.\n\n- `contactIdentifier?: string`\n The identifier of the Contact. It may be email or internal id.\n\n- `limit?: number`\n The limit for response size. The default value is 10, the max number is 100\n\n- `state?: string`\n The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW\n\n### Returns\n\n- `{ id: string; associations: { contact: contact_association; marketingEvent: marketing_event_association; }; createdAt: string; properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }; }`\n\n - `id: string`\n - `associations: { contact: { contactId: string; email: string; firstname?: string; lastname?: string; }; marketingEvent: { marketingEventId: string; name: string; externalAccountId?: string; externalEventId?: string; }; }`\n - `createdAt: string`\n - `properties: { attendanceState: 'ATTENDED' | 'CANCELLED' | 'EMPTY' | 'NO_SHOW' | 'REGISTERED'; occurredAt: number; attendanceDurationSeconds?: number; attendancePercentage?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByID(0)) {\n console.log(participationBreakdown);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.participations.listBreakdownByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const participationBreakdown of client.marketing.marketingEvents.participations.listBreakdownByID(\n 0,\n)) {\n console.log(participationBreakdown.id);\n}", - }, - python: { - method: 'marketing.marketing_events.participations.list_breakdown_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.marketing_events.participations.list_breakdown_by_id(\n marketing_event_id=0,\n)\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().marketingEvents().participations().listBreakdownById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByIdPage;\nimport com.hubspot.sdk.models.marketing.marketingevents.participations.ParticipationListBreakdownByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ParticipationListBreakdownByIdPage page = client.marketing().marketingEvents().participations().listBreakdownById(0L);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Participations.ListBreakdownByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.MarketingEvents.Participations.ListBreakdownByID(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.MarketingEventParticipationListBreakdownByIDParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.participations.list_breakdown_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.marketing_events.participations.list_breakdown_by_id(0)\n\nputs(page)', - }, - php: { - method: 'marketing->marketingEvents->participations->listBreakdownByID', - example: - "marketing->marketingEvents->participations->listBreakdownByID(\n 0,\n after: 'after',\n contactIdentifier: 'contactIdentifier',\n limit: 0,\n state: 'state',\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/participations/$MARKETING_EVENT_ID/breakdown \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create_or_update', - endpoint: '/marketing/marketing-events/2026-03/{appId}/settings', - httpMethod: 'post', - summary: 'Update the application settings', - description: 'Create or update the current settings for the application.', - stainlessPath: '(resource) marketing.marketing_events.settings > (method) create_or_update', - qualified: 'client.marketing.marketingEvents.settings.createOrUpdate', - params: ['appId: number;', 'eventDetailsUrl: string;'], - response: '{ appId: number; eventDetailsUrl: string; }', - markdown: - "## create_or_update\n\n`client.marketing.marketingEvents.settings.createOrUpdate(appId: number, eventDetailsUrl: string): { appId: number; eventDetailsUrl: string; }`\n\n**post** `/marketing/marketing-events/2026-03/{appId}/settings`\n\nCreate or update the current settings for the application.\n\n### Parameters\n\n- `appId: number`\n\n- `eventDetailsUrl: string`\n The url that will be used to fetch marketing event details by id. Must contain a `%s` character sequence that will be substituted with the event id. For example: `https://my.event.app/events/%s`\n\n### Returns\n\n- `{ appId: number; eventDetailsUrl: string; }`\n\n - `appId: number`\n - `eventDetailsUrl: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.createOrUpdate(0, { eventDetailsUrl: 'eventDetailsUrl' });\n\nconsole.log(eventDetailSettings);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.settings.createOrUpdate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.createOrUpdate(0, {\n eventDetailsUrl: 'eventDetailsUrl',\n});\n\nconsole.log(eventDetailSettings.appId);", - }, - python: { - method: 'marketing.marketing_events.settings.create_or_update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_detail_settings = client.marketing.marketing_events.settings.create_or_update(\n app_id=0,\n event_details_url="eventDetailsUrl",\n)\nprint(event_detail_settings.app_id)', - }, - java: { - method: 'marketing().marketingEvents().settings().createOrUpdate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettings;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettingsUrl;\nimport com.hubspot.sdk.models.marketing.marketingevents.settings.SettingCreateOrUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingCreateOrUpdateParams params = SettingCreateOrUpdateParams.builder()\n .appId(0)\n .eventDetailSettingsUrl(EventDetailSettingsUrl.builder()\n .eventDetailsUrl("eventDetailsUrl")\n .build())\n .build();\n EventDetailSettings eventDetailSettings = client.marketing().marketingEvents().settings().createOrUpdate(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Settings.NewOrUpdate', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventDetailSettings, err := client.Marketing.MarketingEvents.Settings.NewOrUpdate(\n\t\tcontext.TODO(),\n\t\t0,\n\t\tmarketing.MarketingEventSettingNewOrUpdateParams{\n\t\t\tEventDetailSettingsURL: marketing.EventDetailSettingsURLParam{\n\t\t\t\tEventDetailsURL: "eventDetailsUrl",\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventDetailSettings.AppID)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.settings.create_or_update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_detail_settings = hubspot.marketing.marketing_events.settings.create_or_update(0, event_details_url: "eventDetailsUrl")\n\nputs(event_detail_settings)', - }, - php: { - method: 'marketing->marketingEvents->settings->createOrUpdate', - example: - "marketing\n ->marketingEvents\n ->settings\n ->createOrUpdate(0, eventDetailsURL: 'eventDetailsUrl');\n\nvar_dump($eventDetailSettings);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$APP_ID/settings \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "eventDetailsUrl": "eventDetailsUrl"\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/marketing-events/2026-03/{appId}/settings', - httpMethod: 'get', - summary: 'Retrieve the application settings', - description: 'Retrieve the current settings for the application.', - stainlessPath: '(resource) marketing.marketing_events.settings > (method) get', - qualified: 'client.marketing.marketingEvents.settings.get', - params: ['appId: number;'], - response: '{ appId: number; eventDetailsUrl: string; }', - markdown: - "## get\n\n`client.marketing.marketingEvents.settings.get(appId: number): { appId: number; eventDetailsUrl: string; }`\n\n**get** `/marketing/marketing-events/2026-03/{appId}/settings`\n\nRetrieve the current settings for the application.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ appId: number; eventDetailsUrl: string; }`\n\n - `appId: number`\n - `eventDetailsUrl: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.get(0);\n\nconsole.log(eventDetailSettings);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.settings.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst eventDetailSettings = await client.marketing.marketingEvents.settings.get(0);\n\nconsole.log(eventDetailSettings.appId);", - }, - python: { - method: 'marketing.marketing_events.settings.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nevent_detail_settings = client.marketing.marketing_events.settings.get(\n 0,\n)\nprint(event_detail_settings.app_id)', - }, - java: { - method: 'marketing().marketingEvents().settings().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.marketingevents.EventDetailSettings;\nimport com.hubspot.sdk.models.marketing.marketingevents.settings.SettingGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EventDetailSettings eventDetailSettings = client.marketing().marketingEvents().settings().get(0);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.Settings.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\teventDetailSettings, err := client.Marketing.MarketingEvents.Settings.Get(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", eventDetailSettings.AppID)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.settings.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nevent_detail_settings = hubspot.marketing.marketing_events.settings.get(0)\n\nputs(event_detail_settings)', - }, - php: { - method: 'marketing->marketingEvents->settings->get', - example: - "marketing->marketingEvents->settings->get(0);\n\nvar_dump($eventDetailSettings);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'record_by_email', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert', - httpMethod: 'post', - summary: 'Record a subscriber state by contact email', - description: - 'Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. ', - stainlessPath: '(resource) marketing.marketing_events.subscriber_state > (method) record_by_email', - qualified: 'client.marketing.marketingEvents.subscriberState.recordByEmail', - params: [ - 'externalEventId: string;', - 'subscriberState: string;', - 'externalAccountId: string;', - 'inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[];', - ], - response: 'string', - markdown: - "## record_by_email\n\n`client.marketing.marketingEvents.subscriberState.recordByEmail(externalEventId: string, subscriberState: string, externalAccountId: string, inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert`\n\nRecord a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. \n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `externalAccountId: string`\n\n- `inputs: { contactProperties: object; email: string; interactionDateTime: number; properties: object; }[]`\n List of marketing event details to create or update\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByEmail('subscriberState', {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [{\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n}],\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.subscriberState.recordByEmail', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByEmail(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [\n {\n contactProperties: { foo: 'string' },\n email: 'email',\n interactionDateTime: 0,\n properties: { foo: 'string' },\n },\n ],\n },\n);\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'marketing.marketing_events.subscriber_state.record_by_email', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.subscriber_state.record_by_email(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n inputs=[{\n "contact_properties": {\n "foo": "string"\n },\n "email": "email",\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'marketing().marketingEvents().subscriberState().recordByEmail', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventEmailSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.subscriberstate.SubscriberStateRecordByEmailParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriberStateRecordByEmailParams params = SubscriberStateRecordByEmailParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .externalAccountId("externalAccountId")\n .batchInputMarketingEventEmailSubscriber(BatchInputMarketingEventEmailSubscriber.builder()\n .addInput(MarketingEventEmailSubscriber.builder()\n .contactProperties(MarketingEventEmailSubscriber.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .email("email")\n .interactionDateTime(0L)\n .properties(MarketingEventEmailSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build())\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().subscriberState().recordByEmail(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.SubscriberState.RecordByEmail', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.SubscriberState.RecordByEmail(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventSubscriberStateRecordByEmailParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tBatchInputMarketingEventEmailSubscriber: marketing.BatchInputMarketingEventEmailSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventEmailSubscriberParam{{\n\t\t\t\t\tContactProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tEmail: "email",\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.subscriber_state.record_by_email', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.subscriber_state.record_by_email(\n "subscriberState",\n external_event_id: "externalEventId",\n external_account_id: "externalAccountId",\n inputs: [{contactProperties: {foo: "string"}, email: "email", interactionDateTime: 0, properties: {foo: "string"}}]\n)\n\nputs(response)', - }, - php: { - method: 'marketing->marketingEvents->subscriberState->recordByEmail', - example: - "marketing->marketingEvents->subscriberState->recordByEmail(\n 'subscriberState',\n externalEventID: 'externalEventId',\n externalAccountID: 'externalAccountId',\n inputs: [\n [\n 'contactProperties' => ['foo' => 'string'],\n 'email' => 'email',\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n ],\n ],\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/email-upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "contactProperties": {\n "foo": "string"\n },\n "email": "email",\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n }\n }\n ]\n }\'', - }, - }, - }, - { - name: 'record_by_id', - endpoint: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert', - httpMethod: 'post', - summary: 'Record a subscriber state by contact ID', - description: - 'Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.', - stainlessPath: '(resource) marketing.marketing_events.subscriber_state > (method) record_by_id', - qualified: 'client.marketing.marketingEvents.subscriberState.recordByID', - params: [ - 'externalEventId: string;', - 'subscriberState: string;', - 'externalAccountId: string;', - 'inputs: { interactionDateTime: number; properties: object; vid: number; }[];', - ], - response: 'string', - markdown: - "## record_by_id\n\n`client.marketing.marketingEvents.subscriberState.recordByID(externalEventId: string, subscriberState: string, externalAccountId: string, inputs: { interactionDateTime: number; properties: object; vid: number; }[]): string`\n\n**post** `/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert`\n\nRecord a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.\n\n### Parameters\n\n- `externalEventId: string`\n\n- `subscriberState: string`\n\n- `externalAccountId: string`\n\n- `inputs: { interactionDateTime: number; properties: object; vid: number; }[]`\n List of HubSpot contacts to subscribe to the marketing event\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByID('subscriberState', {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [{\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n}],\n});\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.marketing.marketingEvents.subscriberState.recordByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.marketing.marketingEvents.subscriberState.recordByID(\n 'subscriberState',\n {\n externalEventId: 'externalEventId',\n externalAccountId: 'externalAccountId',\n inputs: [\n {\n interactionDateTime: 0,\n properties: { foo: 'string' },\n vid: 0,\n },\n ],\n },\n);\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'marketing.marketing_events.subscriber_state.record_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.marketing.marketing_events.subscriber_state.record_by_id(\n subscriber_state="subscriberState",\n external_event_id="externalEventId",\n external_account_id="externalAccountId",\n inputs=[{\n "interaction_date_time": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0,\n }],\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'marketing().marketingEvents().subscriberState().recordById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.marketing.marketingevents.BatchInputMarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.MarketingEventSubscriber;\nimport com.hubspot.sdk.models.marketing.marketingevents.subscriberstate.SubscriberStateRecordByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriberStateRecordByIdParams params = SubscriberStateRecordByIdParams.builder()\n .externalEventId("externalEventId")\n .subscriberState("subscriberState")\n .externalAccountId("externalAccountId")\n .batchInputMarketingEventSubscriber(BatchInputMarketingEventSubscriber.builder()\n .addInput(MarketingEventSubscriber.builder()\n .interactionDateTime(0L)\n .properties(MarketingEventSubscriber.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .vid(0L)\n .build())\n .build())\n .build();\n HttpResponse response = client.marketing().marketingEvents().subscriberState().recordById(params);\n }\n}', - }, - go: { - method: 'client.Marketing.MarketingEvents.SubscriberState.RecordByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Marketing.MarketingEvents.SubscriberState.RecordByID(\n\t\tcontext.TODO(),\n\t\t"subscriberState",\n\t\tmarketing.MarketingEventSubscriberStateRecordByIDParams{\n\t\t\tExternalEventID: "externalEventId",\n\t\t\tExternalAccountID: "externalAccountId",\n\t\t\tBatchInputMarketingEventSubscriber: marketing.BatchInputMarketingEventSubscriberParam{\n\t\t\t\tInputs: []marketing.MarketingEventSubscriberParam{{\n\t\t\t\t\tInteractionDateTime: 0,\n\t\t\t\t\tProperties: map[string]string{\n\t\t\t\t\t\t"foo": "string",\n\t\t\t\t\t},\n\t\t\t\t\tVid: 0,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'marketing.marketing_events.subscriber_state.record_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.marketing.marketing_events.subscriber_state.record_by_id(\n "subscriberState",\n external_event_id: "externalEventId",\n external_account_id: "externalAccountId",\n inputs: [{interactionDateTime: 0, properties: {foo: "string"}, vid: 0}]\n)\n\nputs(response)', - }, - php: { - method: 'marketing->marketingEvents->subscriberState->recordByID', - example: - "marketing->marketingEvents->subscriberState->recordByID(\n 'subscriberState',\n externalEventID: 'externalEventId',\n externalAccountID: 'externalAccountId',\n inputs: [\n [\n 'interactionDateTime' => 0,\n 'properties' => ['foo' => 'string'],\n 'vid' => 0,\n ],\n ],\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/marketing-events/2026-03/events/$EXTERNAL_EVENT_ID/$SUBSCRIBER_STATE/upsert \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "interactionDateTime": 0,\n "properties": {\n "foo": "string"\n },\n "vid": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/email-campaigns/2026-03/single-send', - httpMethod: 'post', - summary: 'Send an email', - description: 'Send a template email to a specific recipient.', - stainlessPath: '(resource) marketing.single_send > (method) create', - qualified: 'client.marketing.singleSend.create', - params: [ - 'contactProperties: object;', - 'customProperties: object;', - 'emailId: number;', - 'message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; };', - ], - response: - "{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }", - markdown: - "## create\n\n`client.marketing.singleSend.create(contactProperties: object, customProperties: object, emailId: number, message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }): { status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: event_id_view; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n**post** `/marketing/email-campaigns/2026-03/single-send`\n\nSend a template email to a specific recipient.\n\n### Parameters\n\n- `contactProperties: object`\n The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.\n\n- `customProperties: object`\n The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.\n\n- `emailId: number`\n The content ID for the email, which can be found in email tool UI.\n\n- `message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }`\n - `bcc: string[]`\n List of email addresses to send as Bcc.\n - `cc: string[]`\n List of email addresses to send as Cc.\n - `replyTo: string[]`\n List of Reply-To header values for the email.\n - `from?: string`\n The From header for the email.\n - `sendId?: string`\n ID for a particular send. No more than one email will be sent per sendId.\n - `to?: string`\n The recipient of the email.\n\n### Returns\n\n- `{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `statusId: string`\n - `completedAt?: string`\n - `eventId?: { id: string; created: string; }`\n - `message?: string`\n - `requestedAt?: string`\n - `sendResult?: string`\n - `startedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst emailSendStatusView = await client.marketing.singleSend.create({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n},\n});\n\nconsole.log(emailSendStatusView);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.singleSend.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst emailSendStatusView = await client.marketing.singleSend.create({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n },\n});\n\nconsole.log(emailSendStatusView.status);", - }, - python: { - method: 'marketing.single_send.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nemail_send_status_view = client.marketing.single_send.create(\n contact_properties={\n "foo": "string"\n },\n custom_properties={\n "foo": {}\n },\n email_id=0,\n message={\n "bcc": ["string"],\n "cc": ["string"],\n "reply_to": ["string"],\n },\n)\nprint(email_send_status_view.status)', - }, - java: { - method: 'marketing().singleSend().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.EmailSendStatusView;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendEmail;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendRequestEgg;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSingleSendRequestEgg params = PublicSingleSendRequestEgg.builder()\n .contactProperties(PublicSingleSendRequestEgg.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .customProperties(PublicSingleSendRequestEgg.CustomProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .emailId(0L)\n .message(PublicSingleSendEmail.builder()\n .addBcc("string")\n .addCc("string")\n .addReplyTo("string")\n .build())\n .build();\n EmailSendStatusView emailSendStatusView = client.marketing().singleSend().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.SingleSend.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temailSendStatusView, err := client.Marketing.SingleSend.New(context.TODO(), marketing.SingleSendNewParams{\n\t\tPublicSingleSendRequestEgg: marketing.PublicSingleSendRequestEggParam{\n\t\t\tContactProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tCustomProperties: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tEmailID: 0,\n\t\t\tMessage: marketing.PublicSingleSendEmailParam{\n\t\t\t\tBcc: []string{"string"},\n\t\t\t\tCc: []string{"string"},\n\t\t\t\tReplyTo: []string{"string"},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", emailSendStatusView.Status)\n}\n', - }, - ruby: { - method: 'marketing.single_send.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nemail_send_status_view = hubspot.marketing.single_send.create(\n contact_properties: {foo: "string"},\n custom_properties: {foo: {}},\n email_id: 0,\n message: {bcc: ["string"], cc: ["string"], replyTo: ["string"]}\n)\n\nputs(email_send_status_view)', - }, - php: { - method: 'marketing->singleSend->create', - example: - "marketing->singleSend->create(\n contactProperties: ['foo' => 'string'],\n customProperties: ['foo' => (object) []],\n emailID: 0,\n message: [\n 'bcc' => ['string'],\n 'cc' => ['string'],\n 'replyTo' => ['string'],\n 'from' => 'from',\n 'sendID' => 'sendId',\n 'to' => 'to',\n ],\n);\n\nvar_dump($emailSendStatusView);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/email-campaigns/2026-03/single-send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactProperties": {\n "foo": "string"\n },\n "customProperties": {\n "foo": {}\n },\n "emailId": 0,\n "message": {\n "bcc": [\n "string"\n ],\n "cc": [\n "string"\n ],\n "replyTo": [\n "string"\n ]\n }\n }\'', - }, - }, - }, - { - name: 'send', - endpoint: '/marketing/transactional/2026-03/single-email/send', - httpMethod: 'post', - summary: 'Send a single send transactional email asynchronously.', - description: - 'Asynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.', - stainlessPath: '(resource) marketing.transactional.single_email > (method) send', - qualified: 'client.marketing.transactional.singleEmail.send', - params: [ - 'contactProperties: object;', - 'customProperties: object;', - 'emailId: number;', - 'message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; };', - ], - response: - "{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }", - markdown: - "## send\n\n`client.marketing.transactional.singleEmail.send(contactProperties: object, customProperties: object, emailId: number, message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }): { status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: event_id_view; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n**post** `/marketing/transactional/2026-03/single-email/send`\n\nAsynchronously send a transactional email. Returns the status of the email send with a statusId that can be used to continuously query for the status using the Email Send Status API.\n\n### Parameters\n\n- `contactProperties: object`\n The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you’re sending the email. For example, when sending a receipt you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment.\n\n- `customProperties: object`\n The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property.\n\n- `emailId: number`\n The content ID for the email, which can be found in email tool UI.\n\n- `message: { bcc: string[]; cc: string[]; replyTo: string[]; from?: string; sendId?: string; to?: string; }`\n - `bcc: string[]`\n List of email addresses to send as Bcc.\n - `cc: string[]`\n List of email addresses to send as Cc.\n - `replyTo: string[]`\n List of Reply-To header values for the email.\n - `from?: string`\n The From header for the email.\n - `sendId?: string`\n ID for a particular send. No more than one email will be sent per sendId.\n - `to?: string`\n The recipient of the email.\n\n### Returns\n\n- `{ status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; statusId: string; completedAt?: string; eventId?: { id: string; created: string; }; message?: string; requestedAt?: string; sendResult?: string; startedAt?: string; }`\n\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `statusId: string`\n - `completedAt?: string`\n - `eventId?: { id: string; created: string; }`\n - `message?: string`\n - `requestedAt?: string`\n - `sendResult?: string`\n - `startedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst emailSendStatusView = await client.marketing.transactional.singleEmail.send({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n},\n});\n\nconsole.log(emailSendStatusView);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.singleEmail.send', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst emailSendStatusView = await client.marketing.transactional.singleEmail.send({\n contactProperties: { foo: 'string' },\n customProperties: { foo: {} },\n emailId: 0,\n message: {\n bcc: ['string'],\n cc: ['string'],\n replyTo: ['string'],\n },\n});\n\nconsole.log(emailSendStatusView.status);", - }, - python: { - method: 'marketing.transactional.single_email.send', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nemail_send_status_view = client.marketing.transactional.single_email.send(\n contact_properties={\n "foo": "string"\n },\n custom_properties={\n "foo": {}\n },\n email_id=0,\n message={\n "bcc": ["string"],\n "cc": ["string"],\n "reply_to": ["string"],\n },\n)\nprint(email_send_status_view.status)', - }, - java: { - method: 'marketing().transactional().singleEmail().send', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.marketing.EmailSendStatusView;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendEmail;\nimport com.hubspot.sdk.models.marketing.PublicSingleSendRequestEgg;\nimport java.util.Map;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicSingleSendRequestEgg params = PublicSingleSendRequestEgg.builder()\n .contactProperties(PublicSingleSendRequestEgg.ContactProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .customProperties(PublicSingleSendRequestEgg.CustomProperties.builder()\n .putAdditionalProperty("foo", JsonValue.from(Map.of()))\n .build())\n .emailId(0L)\n .message(PublicSingleSendEmail.builder()\n .addBcc("string")\n .addCc("string")\n .addReplyTo("string")\n .build())\n .build();\n EmailSendStatusView emailSendStatusView = client.marketing().transactional().singleEmail().send(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SingleEmail.Send', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temailSendStatusView, err := client.Marketing.Transactional.SingleEmail.Send(context.TODO(), marketing.TransactionalSingleEmailSendParams{\n\t\tPublicSingleSendRequestEgg: marketing.PublicSingleSendRequestEggParam{\n\t\t\tContactProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t\tCustomProperties: map[string]any{\n\t\t\t\t"foo": map[string]any{},\n\t\t\t},\n\t\t\tEmailID: 0,\n\t\t\tMessage: marketing.PublicSingleSendEmailParam{\n\t\t\t\tBcc: []string{"string"},\n\t\t\t\tCc: []string{"string"},\n\t\t\t\tReplyTo: []string{"string"},\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", emailSendStatusView.Status)\n}\n', - }, - ruby: { - method: 'marketing.transactional.single_email.send_', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nemail_send_status_view = hubspot.marketing.transactional.single_email.send_(\n contact_properties: {foo: "string"},\n custom_properties: {foo: {}},\n email_id: 0,\n message: {bcc: ["string"], cc: ["string"], replyTo: ["string"]}\n)\n\nputs(email_send_status_view)', - }, - php: { - method: 'marketing->transactional->singleEmail->send', - example: - "marketing->transactional->singleEmail->send(\n contactProperties: ['foo' => 'string'],\n customProperties: ['foo' => (object) []],\n emailID: 0,\n message: [\n 'bcc' => ['string'],\n 'cc' => ['string'],\n 'replyTo' => ['string'],\n 'from' => 'from',\n 'sendID' => 'sendId',\n 'to' => 'to',\n ],\n);\n\nvar_dump($emailSendStatusView);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/single-email/send \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "contactProperties": {\n "foo": "string"\n },\n "customProperties": {\n "foo": {}\n },\n "emailId": 0,\n "message": {\n "bcc": [\n "string"\n ],\n "cc": [\n "string"\n ],\n "replyTo": [\n "string"\n ]\n }\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/marketing/transactional/2026-03/smtp-tokens', - httpMethod: 'post', - summary: 'Create a SMTP API token.', - description: 'Create a SMTP API token.', - stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) create', - qualified: 'client.marketing.transactional.smtpTokens.create', - params: ['campaignName: string;', 'createContact: boolean;'], - response: - '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', - markdown: - "## create\n\n`client.marketing.transactional.smtpTokens.create(campaignName: string, createContact: boolean): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**post** `/marketing/transactional/2026-03/smtp-tokens`\n\nCreate a SMTP API token.\n\n### Parameters\n\n- `campaignName: string`\n A name for the campaign tied to the SMTP API token.\n\n- `createContact: boolean`\n Indicates whether a contact should be created for email recipients.\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.create({ campaignName: 'campaignName', createContact: true });\n\nconsole.log(smtpAPITokenView);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.smtpTokens.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.create({\n campaignName: 'campaignName',\n createContact: true,\n});\n\nconsole.log(smtpAPITokenView.id);", - }, - python: { - method: 'marketing.transactional.smtp_tokens.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.create(\n campaign_name="campaignName",\n create_contact=True,\n)\nprint(smtp_api_token_view.id)', - }, - java: { - method: 'marketing().transactional().smtpTokens().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenRequestEgg;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenRequestEgg params = SmtpApiTokenRequestEgg.builder()\n .campaignName("campaignName")\n .createContact(true)\n .build();\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().create(params);\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SmtpTokens.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.New(context.TODO(), marketing.TransactionalSmtpTokenNewParams{\n\t\tSmtpAPITokenRequestEgg: marketing.SmtpAPITokenRequestEggParam{\n\t\t\tCampaignName: "campaignName",\n\t\t\tCreateContact: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', - }, - ruby: { - method: 'marketing.transactional.smtp_tokens.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.create(campaign_name: "campaignName", create_contact: true)\n\nputs(smtp_api_token_view)', - }, - php: { - method: 'marketing->transactional->smtpTokens->create', - example: - "marketing->transactional->smtpTokens->create(\n campaignName: 'campaignName', createContact: true\n);\n\nvar_dump($smtpAPITokenView);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "campaignName": "campaignName",\n "createContact": true\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', - httpMethod: 'delete', - summary: 'Delete a single token by ID.', - description: 'Delete a single token by ID.', - stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) delete', - qualified: 'client.marketing.transactional.smtpTokens.delete', - params: ['tokenId: string;'], - markdown: - "## delete\n\n`client.marketing.transactional.smtpTokens.delete(tokenId: string): void`\n\n**delete** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}`\n\nDelete a single token by ID.\n\n### Parameters\n\n- `tokenId: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.marketing.transactional.smtpTokens.delete('tokenId')\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.smtpTokens.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.marketing.transactional.smtpTokens.delete('tokenId');", - }, - python: { - method: 'marketing.transactional.smtp_tokens.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.marketing.transactional.smtp_tokens.delete(\n "tokenId",\n)', - }, - java: { - method: 'marketing().transactional().smtpTokens().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.marketing().transactional().smtpTokens().delete("tokenId");\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SmtpTokens.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Marketing.Transactional.SmtpTokens.Delete(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'marketing.transactional.smtp_tokens.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.marketing.transactional.smtp_tokens.delete("tokenId")\n\nputs(result)', - }, - php: { - method: 'marketing->transactional->smtpTokens->delete', - example: - "marketing->transactional->smtpTokens->delete('tokenId');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', - httpMethod: 'get', - summary: 'Query a single token by ID.', - description: 'Query a single token by ID.', - stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) get', - qualified: 'client.marketing.transactional.smtpTokens.get', - params: ['tokenId: string;'], - response: - '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', - markdown: - "## get\n\n`client.marketing.transactional.smtpTokens.get(tokenId: string): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**get** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}`\n\nQuery a single token by ID.\n\n### Parameters\n\n- `tokenId: string`\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.get('tokenId');\n\nconsole.log(smtpAPITokenView);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.smtpTokens.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.get('tokenId');\n\nconsole.log(smtpAPITokenView.id);", - }, - python: { - method: 'marketing.transactional.smtp_tokens.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.get(\n "tokenId",\n)\nprint(smtp_api_token_view.id)', - }, - java: { - method: 'marketing().transactional().smtpTokens().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().get("tokenId");\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SmtpTokens.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.Get(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', - }, - ruby: { - method: 'marketing.transactional.smtp_tokens.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.get("tokenId")\n\nputs(smtp_api_token_view)', - }, - php: { - method: 'marketing->transactional->smtpTokens->get', - example: - "marketing->transactional->smtpTokens->get(\n 'tokenId'\n);\n\nvar_dump($smtpAPITokenView);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/marketing/transactional/2026-03/smtp-tokens', - httpMethod: 'get', - summary: 'Query SMTP API tokens by campaign name or an emailCampaignId.', - description: 'Query multiple SMTP API tokens by campaign name or a single token by emailCampaignId.', - stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) list', - qualified: 'client.marketing.transactional.smtpTokens.list', - params: ['after?: string;', 'campaignName?: string;', 'emailCampaignId?: string;', 'limit?: number;'], - response: - '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', - markdown: - "## list\n\n`client.marketing.transactional.smtpTokens.list(after?: string, campaignName?: string, emailCampaignId?: string, limit?: number): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**get** `/marketing/transactional/2026-03/smtp-tokens`\n\nQuery multiple SMTP API tokens by campaign name or a single token by emailCampaignId.\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `campaignName?: string`\n\n- `emailCampaignId?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const smtpAPITokenView of client.marketing.transactional.smtpTokens.list()) {\n console.log(smtpAPITokenView);\n}\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.smtpTokens.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const smtpAPITokenView of client.marketing.transactional.smtpTokens.list()) {\n console.log(smtpAPITokenView.id);\n}", - }, - python: { - method: 'marketing.transactional.smtp_tokens.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.marketing.transactional.smtp_tokens.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'marketing().transactional().smtpTokens().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenListPage;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpTokenListPage page = client.marketing().transactional().smtpTokens().list();\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SmtpTokens.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/marketing"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Marketing.Transactional.SmtpTokens.List(context.TODO(), marketing.TransactionalSmtpTokenListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'marketing.transactional.smtp_tokens.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.marketing.transactional.smtp_tokens.list\n\nputs(page)', - }, - php: { - method: 'marketing->transactional->smtpTokens->list', - example: - "marketing->transactional->smtpTokens->list(\n after: 'after',\n campaignName: 'campaignName',\n emailCampaignID: 'emailCampaignId',\n limit: 0,\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'reset_password', - endpoint: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset', - httpMethod: 'post', - summary: 'Reset the password of an existing token.', - description: - 'Allows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.', - stainlessPath: '(resource) marketing.transactional.smtp_tokens > (method) reset_password', - qualified: 'client.marketing.transactional.smtpTokens.resetPassword', - params: ['tokenId: string;'], - response: - '{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }', - markdown: - "## reset_password\n\n`client.marketing.transactional.smtpTokens.resetPassword(tokenId: string): { id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n**post** `/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset`\n\nAllows the creation of a replacement password for a given token. Once the password is successfully reset, the old password for the token will be invalid.\n\n### Parameters\n\n- `tokenId: string`\n\n### Returns\n\n- `{ id: string; campaignName: string; createContact: boolean; createdAt: string; createdBy: string; emailCampaignId: string; password?: string; }`\n\n - `id: string`\n - `campaignName: string`\n - `createContact: boolean`\n - `createdAt: string`\n - `createdBy: string`\n - `emailCampaignId: string`\n - `password?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.resetPassword('tokenId');\n\nconsole.log(smtpAPITokenView);\n```", - perLanguage: { - typescript: { - method: 'client.marketing.transactional.smtpTokens.resetPassword', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst smtpAPITokenView = await client.marketing.transactional.smtpTokens.resetPassword('tokenId');\n\nconsole.log(smtpAPITokenView.id);", - }, - python: { - method: 'marketing.transactional.smtp_tokens.reset_password', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsmtp_api_token_view = client.marketing.transactional.smtp_tokens.reset_password(\n "tokenId",\n)\nprint(smtp_api_token_view.id)', - }, - java: { - method: 'marketing().transactional().smtpTokens().resetPassword', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.marketing.transactional.SmtpApiTokenView;\nimport com.hubspot.sdk.models.marketing.transactional.smtptokens.SmtpTokenResetPasswordParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SmtpApiTokenView smtpApiTokenView = client.marketing().transactional().smtpTokens().resetPassword("tokenId");\n }\n}', - }, - go: { - method: 'client.Marketing.Transactional.SmtpTokens.ResetPassword', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsmtpAPITokenView, err := client.Marketing.Transactional.SmtpTokens.ResetPassword(context.TODO(), "tokenId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", smtpAPITokenView.ID)\n}\n', - }, - ruby: { - method: 'marketing.transactional.smtp_tokens.reset_password', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsmtp_api_token_view = hubspot.marketing.transactional.smtp_tokens.reset_password("tokenId")\n\nputs(smtp_api_token_view)', - }, - php: { - method: 'marketing->transactional->smtpTokens->resetPassword', - example: - "marketing\n ->transactional\n ->smtpTokens\n ->resetPassword('tokenId');\n\nvar_dump($smtpAPITokenView);", - }, - http: { - example: - 'curl https://api.hubapi.com/marketing/transactional/2026-03/smtp-tokens/$TOKEN_ID/password-reset \\\n -X POST \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/meta/network-origins/2026-03/ip-ranges', - httpMethod: 'get', - summary: 'Retrieve IP ranges', - description: - 'Retrieve a collection of IP ranges associated with specific services and directions, such as `EMAIL`, `API`, `DNS`, or `WEB_SCRAPING`. The response includes details like CIDR notation, description, and the direction of IP traffic.', - stainlessPath: '(resource) meta.origins.ip_ranges > (method) list', - qualified: 'client.meta.origins.ipRanges.list', - params: [ - "direction?: 'INGRESS' | 'EGRESS'[];", - "service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[];", - ], - response: - "{ results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]; }", - markdown: - "## list\n\n`client.meta.origins.ipRanges.list(direction?: 'INGRESS' | 'EGRESS'[], service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]): { results: ip_range[]; }`\n\n**get** `/meta/network-origins/2026-03/ip-ranges`\n\nRetrieve a collection of IP ranges associated with specific services and directions, such as `EMAIL`, `API`, `DNS`, or `WEB_SCRAPING`. The response includes details like CIDR notation, description, and the direction of IP traffic.\n\n### Parameters\n\n- `direction?: 'INGRESS' | 'EGRESS'[]`\n\n- `service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]`\n\n### Returns\n\n- `{ results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]; }`\n\n - `results: { cidr: string; description: string; direction: 'EGRESS' | 'INGRESS'; service: 'API' | 'DNS' | 'EMAIL' | 'TEST_SERVICE' | 'WEB_SCRAPING'; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseIPRangeNoPaging = await client.meta.origins.ipRanges.list();\n\nconsole.log(collectionResponseIPRangeNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.meta.origins.ipRanges.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseIPRangeNoPaging = await client.meta.origins.ipRanges.list();\n\nconsole.log(collectionResponseIPRangeNoPaging.results);", - }, - python: { - method: 'meta.origins.ip_ranges.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_ip_range_no_paging = client.meta.origins.ip_ranges.list()\nprint(collection_response_ip_range_no_paging.results)', - }, - java: { - method: 'meta().origins().ipRanges().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.meta.origins.CollectionResponseIpRangeNoPaging;\nimport com.hubspot.sdk.models.meta.origins.ipranges.IpRangeListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseIpRangeNoPaging collectionResponseIpRangeNoPaging = client.meta().origins().ipRanges().list();\n }\n}', - }, - go: { - method: 'client.Meta.Origins.IPRanges.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/meta"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseIPRangeNoPaging, err := client.Meta.Origins.IPRanges.List(context.TODO(), meta.OriginIPRangeListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseIPRangeNoPaging.Results)\n}\n', - }, - ruby: { - method: 'meta.origins.ip_ranges.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_ip_range_no_paging = hubspot.meta.origins.ip_ranges.list\n\nputs(collection_response_ip_range_no_paging)', - }, - php: { - method: 'meta->origins->ipRanges->list', - example: - "meta->origins->ipRanges->list(\n direction: ['INGRESS'], service: ['EMAIL']\n);\n\nvar_dump($collectionResponseIPRangeNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/meta/network-origins/2026-03/ip-ranges \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_simple', - endpoint: '/meta/network-origins/2026-03/ip-ranges/simple', - httpMethod: 'get', - summary: 'Retrieve simple list', - description: - 'Retrieve a simplified list of IP ranges for specified services and directions in plain text format. This endpoint provides a straightforward representation of IP ranges without additional metadata.', - stainlessPath: '(resource) meta.origins.ip_ranges > (method) list_simple', - qualified: 'client.meta.origins.ipRanges.listSimple', - params: [ - "direction?: 'INGRESS' | 'EGRESS'[];", - "service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[];", - ], - response: 'string', - markdown: - "## list_simple\n\n`client.meta.origins.ipRanges.listSimple(direction?: 'INGRESS' | 'EGRESS'[], service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]): string`\n\n**get** `/meta/network-origins/2026-03/ip-ranges/simple`\n\nRetrieve a simplified list of IP ranges for specified services and directions in plain text format. This endpoint provides a straightforward representation of IP ranges without additional metadata.\n\n### Parameters\n\n- `direction?: 'INGRESS' | 'EGRESS'[]`\n\n- `service?: 'EMAIL' | 'API' | 'DNS' | 'WEB_SCRAPING' | 'TEST_SERVICE'[]`\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.meta.origins.ipRanges.listSimple();\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.meta.origins.ipRanges.listSimple', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.meta.origins.ipRanges.listSimple();\n\nconsole.log(response);", - }, - python: { - method: 'meta.origins.ip_ranges.list_simple', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.meta.origins.ip_ranges.list_simple()\nprint(response)', - }, - java: { - method: 'meta().origins().ipRanges().listSimple', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.meta.origins.ipranges.IpRangeListSimpleParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n String response = client.meta().origins().ipRanges().listSimple();\n }\n}', - }, - go: { - method: 'client.Meta.Origins.IPRanges.ListSimple', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/meta"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Meta.Origins.IPRanges.ListSimple(context.TODO(), meta.OriginIPRangeListSimpleParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'meta.origins.ip_ranges.list_simple', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.meta.origins.ip_ranges.list_simple\n\nputs(response)', - }, - php: { - method: 'meta->origins->ipRanges->listSimple', - example: - "meta->origins->ipRanges->listSimple(\n direction: ['INGRESS'], service: ['EMAIL']\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/meta/network-origins/2026-03/ip-ranges/simple \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'book', - endpoint: '/scheduler/2026-03/meetings/meeting-links/book', - httpMethod: 'post', - summary: 'Book a meeting\n', - description: 'Book a meeting for a specified meeting page.', - stainlessPath: '(resource) scheduler.meetings.advanced > (method) book', - qualified: 'client.scheduler.meetings.advanced.book', - params: [ - 'duration: number;', - 'email: string;', - 'firstName: string;', - 'formFields: { name: string; value: string; }[];', - 'lastName: string;', - 'legalConsentResponses: { communicationTypeId: string; consented: boolean; }[];', - 'likelyAvailableUserIds: string[];', - 'slug: string;', - 'startTime: string;', - 'locale?: string;', - 'timezone?: string;', - ], - response: - '{ bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }', - markdown: - "## book\n\n`client.scheduler.meetings.advanced.book(duration: number, email: string, firstName: string, formFields: { name: string; value: string; }[], lastName: string, legalConsentResponses: { communicationTypeId: string; consented: boolean; }[], likelyAvailableUserIds: string[], slug: string, startTime: string, locale?: string, timezone?: string): { bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: external_validated_form_field[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: external_legal_consent_response[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }`\n\n**post** `/scheduler/2026-03/meetings/meeting-links/book`\n\nBook a meeting for a specified meeting page.\n\n### Parameters\n\n- `duration: number`\n The duration of the meeting in milliseconds.\n\n- `email: string`\n The email address of the person booking the meeting.\n\n- `firstName: string`\n The first name of the person booking the meeting.\n\n- `formFields: { name: string; value: string; }[]`\n\n- `lastName: string`\n The last name of the person booking the meeting.\n\n- `legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]`\n\n- `likelyAvailableUserIds: string[]`\n\n- `slug: string`\n The unique path identifier for the meeting page.\n\n- `startTime: string`\n The date and time when the meeting is scheduled to start, in ISO 8601 format.\n\n- `locale?: string`\n The locale used for formatting dates and times in the meeting booking.\n\n- `timezone?: string`\n The timezone in which the meeting is scheduled.\n\n### Returns\n\n- `{ bookingTimezone: string; calendarEventId: string; contactId: string; duration: number; end: string; formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]; guestEmails: string[]; isOffline: boolean; legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]; start: string; subject: string; locale?: string; location?: string; webConferenceMeetingId?: string; webConferenceUrl?: string; }`\n\n - `bookingTimezone: string`\n - `calendarEventId: string`\n - `contactId: string`\n - `duration: number`\n - `end: string`\n - `formFields: { isCustom: boolean; label: string; name: string; value: string; fieldType?: string; translatedLabel?: string; valueLabel?: string; }[]`\n - `guestEmails: string[]`\n - `isOffline: boolean`\n - `legalConsentResponses: { communicationTypeId: string; consented: boolean; }[]`\n - `start: string`\n - `subject: string`\n - `locale?: string`\n - `location?: string`\n - `webConferenceMeetingId?: string`\n - `webConferenceUrl?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalMeetingBookingResponse = await client.scheduler.meetings.advanced.book({\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [{ name: 'name', value: 'value' }],\n lastName: 'lastName',\n legalConsentResponses: [{ communicationTypeId: 'communicationTypeId', consented: true }],\n likelyAvailableUserIds: ['string'],\n slug: 'slug',\n startTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(externalMeetingBookingResponse);\n```", - perLanguage: { - typescript: { - method: 'client.scheduler.meetings.advanced.book', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalMeetingBookingResponse = await client.scheduler.meetings.advanced.book({\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [{ name: 'name', value: 'value' }],\n lastName: 'lastName',\n legalConsentResponses: [{ communicationTypeId: 'communicationTypeId', consented: true }],\n likelyAvailableUserIds: ['string'],\n slug: 'slug',\n startTime: '2019-12-27T18:11:19.117Z',\n});\n\nconsole.log(externalMeetingBookingResponse.bookingTimezone);", - }, - python: { - method: 'scheduler.meetings.advanced.book', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_meeting_booking_response = client.scheduler.meetings.advanced.book(\n duration=0,\n email="email",\n first_name="firstName",\n form_fields=[{\n "name": "name",\n "value": "value",\n }],\n last_name="lastName",\n legal_consent_responses=[{\n "communication_type_id": "communicationTypeId",\n "consented": True,\n }],\n likely_available_user_ids=["string"],\n slug="slug",\n start_time=datetime.fromisoformat("2019-12-27T18:11:19.117"),\n)\nprint(external_meeting_booking_response.booking_timezone)', - }, - java: { - method: 'scheduler().meetings().advanced().book', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalBookingFormField;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalLegalConsentResponse;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalMeetingBooking;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalMeetingBookingResponse;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExternalMeetingBooking params = ExternalMeetingBooking.builder()\n .duration(0L)\n .email("email")\n .firstName("firstName")\n .addFormField(ExternalBookingFormField.builder()\n .name("name")\n .value("value")\n .build())\n .lastName("lastName")\n .addLegalConsentResponse(ExternalLegalConsentResponse.builder()\n .communicationTypeId("communicationTypeId")\n .consented(true)\n .build())\n .addLikelyAvailableUserId("string")\n .slug("slug")\n .startTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .build();\n ExternalMeetingBookingResponse externalMeetingBookingResponse = client.scheduler().meetings().advanced().book(params);\n }\n}', - }, - go: { - method: 'client.Scheduler.Meetings.Advanced.Book', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalMeetingBookingResponse, err := client.Scheduler.Meetings.Advanced.Book(context.TODO(), scheduler.MeetingAdvancedBookParams{\n\t\tExternalMeetingBooking: scheduler.ExternalMeetingBookingParam{\n\t\t\tDuration: 0,\n\t\t\tEmail: "email",\n\t\t\tFirstName: "firstName",\n\t\t\tFormFields: []scheduler.ExternalBookingFormFieldParam{{\n\t\t\t\tName: "name",\n\t\t\t\tValue: "value",\n\t\t\t}},\n\t\t\tLastName: "lastName",\n\t\t\tLegalConsentResponses: []scheduler.ExternalLegalConsentResponseParam{{\n\t\t\t\tCommunicationTypeID: "communicationTypeId",\n\t\t\t\tConsented: true,\n\t\t\t}},\n\t\t\tLikelyAvailableUserIDs: []string{"string"},\n\t\t\tSlug: "slug",\n\t\t\tStartTime: time.Now(),\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalMeetingBookingResponse.BookingTimezone)\n}\n', - }, - ruby: { - method: 'scheduler.meetings.advanced.book', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_meeting_booking_response = hubspot.scheduler.meetings.advanced.book(\n duration: 0,\n email: "email",\n first_name: "firstName",\n form_fields: [{name: "name", value: "value"}],\n last_name: "lastName",\n legal_consent_responses: [{communicationTypeId: "communicationTypeId", consented: true}],\n likely_available_user_ids: ["string"],\n slug: "slug",\n start_time: "2019-12-27T18:11:19.117Z"\n)\n\nputs(external_meeting_booking_response)', - }, - php: { - method: 'scheduler->meetings->advanced->book', - example: - "scheduler->meetings->advanced->book(\n duration: 0,\n email: 'email',\n firstName: 'firstName',\n formFields: [['name' => 'name', 'value' => 'value']],\n lastName: 'lastName',\n legalConsentResponses: [\n ['communicationTypeID' => 'communicationTypeId', 'consented' => true]\n ],\n likelyAvailableUserIDs: ['string'],\n slug: 'slug',\n startTime: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n locale: 'locale',\n timezone: 'timezone',\n);\n\nvar_dump($externalMeetingBookingResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "duration": 0,\n "email": "email",\n "firstName": "firstName",\n "formFields": [\n {\n "name": "name",\n "value": "value"\n }\n ],\n "lastName": "lastName",\n "legalConsentResponses": [\n {\n "communicationTypeId": "communicationTypeId",\n "consented": true\n }\n ],\n "likelyAvailableUserIds": [\n "string"\n ],\n "slug": "slug",\n "startTime": "2019-12-27T18:11:19.117Z"\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/scheduler/2026-03/meetings/calendar', - httpMethod: 'post', - summary: 'Create a new calendar meeting event.', - description: - 'Create a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone.', - stainlessPath: '(resource) scheduler.meetings.advanced > (method) create', - qualified: 'client.scheduler.meetings.advanced.create', - params: [ - 'organizerUserId: string;', - "associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[];", - "emailReminderSchedule: { reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]; shouldIncludeInviteDescription: boolean; };", - "properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; };", - 'timezone: string;', - ], - response: - "{ id: string; createdAt: string; lastUpdatedAt: string; properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }; }", - markdown: - "## create\n\n`client.scheduler.meetings.advanced.create(organizerUserId: string, associations: { to: public_object_id; types: association_spec[]; }[], emailReminderSchedule: { reminders: external_reminder[]; shouldIncludeInviteDescription: boolean; }, properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; }, timezone: string): { id: string; createdAt: string; lastUpdatedAt: string; properties: external_calendar_meeting_event_response_properties; }`\n\n**post** `/scheduler/2026-03/meetings/calendar`\n\nCreate a new calendar event and meeting object by providing the necessary details such as associations, email reminders, meeting object properties, and timezone.\n\n### Parameters\n\n- `organizerUserId: string`\n\n- `associations: { to: { id: string; }; types: { associationCategory: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK'; associationTypeId: number; }[]; }[]`\n\n- `emailReminderSchedule: { reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]; shouldIncludeInviteDescription: boolean; }`\n - `reminders: { numberOfTimeUnits: number; timeUnit: 'DAYS' | 'HOURS' | 'MINUTES' | 'WEEKS'; }[]`\n - `shouldIncludeInviteDescription: boolean`\n Whether the invite description should be included in the reminder.\n\n- `properties: { hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hubspot_owner_id: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; }`\n - `hs_meeting_end_time: string`\n The time that the meeting should end in ISO 8601 format.\n - `hs_meeting_outcome: string`\n The outcome of the meeting. Acceptable default values are: SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, CANCELED. This property can be changed to include additional custom values.\n - `hs_meeting_start_time: string`\n The time that the meeting should start in ISO 8601 format.\n - `hs_meeting_title: string`\n The title of the meeting and calendar event.\n - `hs_timestamp: string`\n The time that the meeting should start in ISO 8601 format. This value should be the same as `hs_meeting_start_time`.\n - `hubspot_owner_id: string`\n The ownerId of the HubSpot user who will host the meeting.\n - `hs_activity_type?: string`\n The activity type of the meeting. Acceptable values are based on portal defined call and meeting types.\n - `hs_attachment_ids?: string[]`\n - `hs_attendee_owner_ids?: string[]`\n - `hs_internal_meeting_notes?: string`\n Internal notes related to the meeting.\n - `hs_meeting_body?: string`\n The description of the meeting and calendar event.\n - `hs_meeting_location?: string`\n The physical address, virtual location, or phone number where the meeting will take place.\n - `hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'`\n The type of location for the meeting. Acceptable values are: ADDRESS, CUSTOM, PHONE.\n\n- `timezone: string`\n The timezone property that will be set on the meeting event.\n\n### Returns\n\n- `{ id: string; createdAt: string; lastUpdatedAt: string; properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }; }`\n\n - `id: string`\n - `createdAt: string`\n - `lastUpdatedAt: string`\n - `properties: { hs_engagement_source: string; hs_engagement_source_id: string; hs_meeting_end_time: string; hs_meeting_outcome: string; hs_meeting_start_time: string; hs_meeting_title: string; hs_timestamp: string; hs_activity_type?: string; hs_attachment_ids?: string[]; hs_attendee_owner_ids?: string[]; hs_include_description_in_reminder?: string; hs_internal_meeting_notes?: string; hs_meeting_body?: string; hs_meeting_external_url?: string; hs_meeting_location?: string; hs_meeting_location_type?: 'ADDRESS' | 'CUSTOM' | 'PHONE'; hs_unique_id?: string; hubspot_owner_id?: string; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalCalenderMeetingEventResponse = await client.scheduler.meetings.advanced.create({\n organizerUserId: 'organizerUserId',\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n emailReminderSchedule: { reminders: [{ numberOfTimeUnits: 0, timeUnit: 'DAYS' }], shouldIncludeInviteDescription: true },\n properties: {\n hs_meeting_end_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_outcome: 'hs_meeting_outcome',\n hs_meeting_start_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_title: 'hs_meeting_title',\n hs_timestamp: '2019-12-27T18:11:19.117Z',\n hubspot_owner_id: 'hubspot_owner_id',\n},\n timezone: 'timezone',\n});\n\nconsole.log(externalCalenderMeetingEventResponse);\n```", - perLanguage: { - typescript: { - method: 'client.scheduler.meetings.advanced.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalCalenderMeetingEventResponse = await client.scheduler.meetings.advanced.create({\n organizerUserId: 'organizerUserId',\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n emailReminderSchedule: {\n reminders: [{ numberOfTimeUnits: 0, timeUnit: 'DAYS' }],\n shouldIncludeInviteDescription: true,\n },\n properties: {\n hs_meeting_end_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_outcome: 'hs_meeting_outcome',\n hs_meeting_start_time: '2019-12-27T18:11:19.117Z',\n hs_meeting_title: 'hs_meeting_title',\n hs_timestamp: '2019-12-27T18:11:19.117Z',\n hubspot_owner_id: 'hubspot_owner_id',\n },\n timezone: 'timezone',\n});\n\nconsole.log(externalCalenderMeetingEventResponse.id);", - }, - python: { - method: 'scheduler.meetings.advanced.create', - example: - 'from datetime import datetime\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_calender_meeting_event_response = client.scheduler.meetings.advanced.create(\n organizer_user_id="organizerUserId",\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n email_reminder_schedule={\n "reminders": [{\n "number_of_time_units": 0,\n "time_unit": "DAYS",\n }],\n "should_include_invite_description": True,\n },\n properties={\n "hs_meeting_end_time": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hs_meeting_outcome": "hs_meeting_outcome",\n "hs_meeting_start_time": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hs_meeting_title": "hs_meeting_title",\n "hs_timestamp": datetime.fromisoformat("2019-12-27T18:11:19.117"),\n "hubspot_owner_id": "hubspot_owner_id",\n },\n timezone="timezone",\n)\nprint(external_calender_meeting_event_response.id)', - }, - java: { - method: 'scheduler().meetings().advanced().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalAssociationCreateRequest;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalendarMeetingEventCreateProperties;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalendarMeetingEventCreateRequest;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalCalenderMeetingEventResponse;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalEmailReminderSchedule;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalReminder;\nimport com.hubspot.sdk.models.scheduler.meetings.advanced.AdvancedCreateParams;\nimport java.time.OffsetDateTime;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AdvancedCreateParams params = AdvancedCreateParams.builder()\n .organizerUserId("organizerUserId")\n .externalCalendarMeetingEventCreateRequest(ExternalCalendarMeetingEventCreateRequest.builder()\n .addAssociation(ExternalAssociationCreateRequest.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .emailReminderSchedule(ExternalEmailReminderSchedule.builder()\n .addReminder(ExternalReminder.builder()\n .numberOfTimeUnits(0)\n .timeUnit(ExternalReminder.TimeUnit.DAYS)\n .build())\n .shouldIncludeInviteDescription(true)\n .build())\n .properties(ExternalCalendarMeetingEventCreateProperties.builder()\n .hsMeetingEndTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hsMeetingOutcome("hs_meeting_outcome")\n .hsMeetingStartTime(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hsMeetingTitle("hs_meeting_title")\n .hsTimestamp(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))\n .hubSpotOwnerId("hubspot_owner_id")\n .build())\n .timezone("timezone")\n .build())\n .build();\n ExternalCalenderMeetingEventResponse externalCalenderMeetingEventResponse = client.scheduler().meetings().advanced().create(params);\n }\n}', - }, - go: { - method: 'client.Scheduler.Meetings.Advanced.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalCalenderMeetingEventResponse, err := client.Scheduler.Meetings.Advanced.New(context.TODO(), scheduler.MeetingAdvancedNewParams{\n\t\tOrganizerUserID: "organizerUserId",\n\t\tExternalCalendarMeetingEventCreateRequest: scheduler.ExternalCalendarMeetingEventCreateRequestParam{\n\t\t\tAssociations: []scheduler.ExternalAssociationCreateRequestParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tEmailReminderSchedule: scheduler.ExternalEmailReminderScheduleParam{\n\t\t\t\tReminders: []scheduler.ExternalReminderParam{{\n\t\t\t\t\tNumberOfTimeUnits: 0,\n\t\t\t\t\tTimeUnit: scheduler.ExternalReminderTimeUnitDays,\n\t\t\t\t}},\n\t\t\t\tShouldIncludeInviteDescription: true,\n\t\t\t},\n\t\t\tProperties: scheduler.ExternalCalendarMeetingEventCreatePropertiesParam{\n\t\t\t\tHsMeetingEndTime: time.Now(),\n\t\t\t\tHsMeetingOutcome: "hs_meeting_outcome",\n\t\t\t\tHsMeetingStartTime: time.Now(),\n\t\t\t\tHsMeetingTitle: "hs_meeting_title",\n\t\t\t\tHsTimestamp: time.Now(),\n\t\t\t\tHubSpotOwnerID: "hubspot_owner_id",\n\t\t\t},\n\t\t\tTimezone: "timezone",\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalCalenderMeetingEventResponse.ID)\n}\n', - }, - ruby: { - method: 'scheduler.meetings.advanced.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_calender_meeting_event_response = hubspot.scheduler.meetings.advanced.create(\n organizer_user_id: "organizerUserId",\n associations: [{to: {id: "id"}, types: [{associationCategory: :HUBSPOT_DEFINED, associationTypeId: 0}]}],\n email_reminder_schedule: {reminders: [{numberOfTimeUnits: 0, timeUnit: :DAYS}], shouldIncludeInviteDescription: true},\n properties: {\n hs_meeting_end_time: "2019-12-27T18:11:19.117Z",\n hs_meeting_outcome: "hs_meeting_outcome",\n hs_meeting_start_time: "2019-12-27T18:11:19.117Z",\n hs_meeting_title: "hs_meeting_title",\n hs_timestamp: "2019-12-27T18:11:19.117Z",\n hubspot_owner_id: "hubspot_owner_id"\n },\n timezone: "timezone"\n)\n\nputs(external_calender_meeting_event_response)', - }, - php: { - method: 'scheduler->meetings->advanced->create', - example: - "scheduler\n ->meetings\n ->advanced\n ->create(\n organizerUserID: 'organizerUserId',\n associations: [\n [\n 'to' => ['id' => 'id'],\n 'types' => [\n ['associationCategory' => 'HUBSPOT_DEFINED', 'associationTypeID' => 0]\n ],\n ],\n ],\n emailReminderSchedule: [\n 'reminders' => [['numberOfTimeUnits' => 0, 'timeUnit' => 'DAYS']],\n 'shouldIncludeInviteDescription' => true,\n ],\n properties: [\n 'hsMeetingEndTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hsMeetingOutcome' => 'hs_meeting_outcome',\n 'hsMeetingStartTime' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hsMeetingTitle' => 'hs_meeting_title',\n 'hsTimestamp' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n 'hubSpotOwnerID' => 'hubspot_owner_id',\n 'hsActivityType' => 'hs_activity_type',\n 'hsAttachmentIDs' => ['string'],\n 'hsAttendeeOwnerIDs' => ['string'],\n 'hsInternalMeetingNotes' => 'hs_internal_meeting_notes',\n 'hsMeetingBody' => 'hs_meeting_body',\n 'hsMeetingLocation' => 'hs_meeting_location',\n 'hsMeetingLocationType' => 'ADDRESS',\n ],\n timezone: 'timezone',\n);\n\nvar_dump($externalCalenderMeetingEventResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/scheduler/2026-03/meetings/calendar \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "associations": [\n {\n "to": {\n "id": "id"\n },\n "types": [\n {\n "associationCategory": "HUBSPOT_DEFINED",\n "associationTypeId": 0\n }\n ]\n }\n ],\n "emailReminderSchedule": {\n "reminders": [\n {\n "numberOfTimeUnits": 0,\n "timeUnit": "DAYS"\n }\n ],\n "shouldIncludeInviteDescription": true\n },\n "properties": {\n "hs_meeting_end_time": "2019-12-27T18:11:19.117Z",\n "hs_meeting_outcome": "hs_meeting_outcome",\n "hs_meeting_start_time": "2019-12-27T18:11:19.117Z",\n "hs_meeting_title": "hs_meeting_title",\n "hs_timestamp": "2019-12-27T18:11:19.117Z",\n "hubspot_owner_id": "hubspot_owner_id"\n },\n "timezone": "timezone"\n }\'', - }, - }, - }, - { - name: 'get_availability_by_slug', - endpoint: '/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}', - httpMethod: 'get', - summary: 'Get the availability for a meeting', - description: 'Get the next availability times for a meeting page.', - stainlessPath: '(resource) scheduler.meetings.basic > (method) get_availability_by_slug', - qualified: 'client.scheduler.meetings.basic.getAvailabilityBySlug', - params: ['slug: string;', 'timezone: string;', 'monthOffset?: number;'], - response: - '{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }', - markdown: - "## get_availability_by_slug\n\n`client.scheduler.meetings.basic.getAvailabilityBySlug(slug: string, timezone: string, monthOffset?: number): { allUsersBusyTimes: external_user_busy_times[]; linkAvailability?: external_link_availability; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}`\n\nGet the next availability times for a meeting page.\n\n### Parameters\n\n- `slug: string`\n\n- `timezone: string`\n\n- `monthOffset?: number`\n\n### Returns\n\n- `{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }`\n\n - `allUsersBusyTimes: { busyTimes: { end: number; start: number; }[]; isOffline: boolean; meetingsUser: { id: string; calendarProvider: 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN'; isSalesStarter: boolean; userId: string; userProfile: external_user_profile; }; }[]`\n - `linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalLinkAvailabilityAndBusyTimes = await client.scheduler.meetings.basic.getAvailabilityBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalLinkAvailabilityAndBusyTimes);\n```", - perLanguage: { - typescript: { - method: 'client.scheduler.meetings.basic.getAvailabilityBySlug', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalLinkAvailabilityAndBusyTimes =\n await client.scheduler.meetings.basic.getAvailabilityBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalLinkAvailabilityAndBusyTimes.allUsersBusyTimes);", - }, - python: { - method: 'scheduler.meetings.basic.get_availability_by_slug', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_link_availability_and_busy_times = client.scheduler.meetings.basic.get_availability_by_slug(\n slug="slug",\n timezone="timezone",\n)\nprint(external_link_availability_and_busy_times.all_users_busy_times)', - }, - java: { - method: 'scheduler().meetings().basic().getAvailabilityBySlug', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalLinkAvailabilityAndBusyTimes;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicGetAvailabilityBySlugParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicGetAvailabilityBySlugParams params = BasicGetAvailabilityBySlugParams.builder()\n .slug("slug")\n .timezone("timezone")\n .build();\n ExternalLinkAvailabilityAndBusyTimes externalLinkAvailabilityAndBusyTimes = client.scheduler().meetings().basic().getAvailabilityBySlug(params);\n }\n}', - }, - go: { - method: 'client.Scheduler.Meetings.Basic.GetAvailabilityBySlug', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalLinkAvailabilityAndBusyTimes, err := client.Scheduler.Meetings.Basic.GetAvailabilityBySlug(\n\t\tcontext.TODO(),\n\t\t"slug",\n\t\tscheduler.MeetingBasicGetAvailabilityBySlugParams{\n\t\t\tTimezone: "timezone",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalLinkAvailabilityAndBusyTimes.AllUsersBusyTimes)\n}\n', - }, - ruby: { - method: 'scheduler.meetings.basic.get_availability_by_slug', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_link_availability_and_busy_times = hubspot.scheduler.meetings.basic.get_availability_by_slug("slug", timezone: "timezone")\n\nputs(external_link_availability_and_busy_times)', - }, - php: { - method: 'scheduler->meetings->basic->getAvailabilityBySlug', - example: - "scheduler\n ->meetings\n ->basic\n ->getAvailabilityBySlug('slug', timezone: 'timezone', monthOffset: 0);\n\nvar_dump($externalLinkAvailabilityAndBusyTimes);", - }, - http: { - example: - 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book/availability-page/$SLUG \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_booking_info_by_slug', - endpoint: '/scheduler/2026-03/meetings/meeting-links/book/{slug}', - httpMethod: 'get', - summary: 'List booking information', - description: 'Get details about the initial information necessary for a meeting scheduler.', - stainlessPath: '(resource) scheduler.meetings.basic > (method) get_booking_info_by_slug', - qualified: 'client.scheduler.meetings.basic.getBookingInfoBySlug', - params: ['slug: string;', 'timezone: string;'], - response: - "{ allUsersBusyTimes: object[]; customParams: object; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: object; linkAvailability?: object; }", - markdown: - "## get_booking_info_by_slug\n\n`client.scheduler.meetings.basic.getBookingInfoBySlug(slug: string, timezone: string): { allUsersBusyTimes: external_user_busy_times[]; customParams: external_meetings_link_settings; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: external_branding_metadata; linkAvailability?: external_link_availability; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links/book/{slug}`\n\nGet details about the initial information necessary for a meeting scheduler.\n\n### Parameters\n\n- `slug: string`\n\n- `timezone: string`\n\n### Returns\n\n- `{ allUsersBusyTimes: { busyTimes: external_time_range[]; isOffline: boolean; meetingsUser: external_meetings_user; }[]; customParams: { availability: object; durations: number[]; formFields: external_link_form_field[]; legalConsentEnabled: boolean; meetingBufferTime: number; ownerPrioritized: boolean; startTimeIncrementMinutes: string; weeksToAdvertise: number; customAvailabilityEndDate?: number; customAvailabilityStartDate?: number; displayInfo?: external_link_display_info; guestSettings?: external_guest_settings; language?: string; legalConsentOptions?: external_legal_consent_options; locale?: string; location?: string; redirectUrl?: string; welcomeScreenInfo?: external_meetings_welcome_screen_info; }; isOffline: boolean; linkId: string; linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; brandingMetadata?: { logoAltText: string; showMarketingAd: boolean; showSalesAd: boolean; accent2Color?: string; accentColor?: string; companyAddressLine1?: string; companyAddressLine2?: string; companyAvatar?: string; companyCity?: string; companyCountry?: string; companyDomain?: string; companyName?: string; companyState?: string; companyZip?: string; logoHeight?: number; logoUrl?: string; logoWidth?: number; primaryColor?: string; secondaryColor?: string; }; linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }; }`\n\n - `allUsersBusyTimes: { busyTimes: { end: number; start: number; }[]; isOffline: boolean; meetingsUser: { id: string; calendarProvider: 'EXCHANGE' | 'GOOGLE' | 'OFFICE365' | 'UNKNOWN'; isSalesStarter: boolean; userId: string; userProfile: external_user_profile; }; }[]`\n - `customParams: { availability: object; durations: number[]; formFields: { fieldType: string; isCustom: boolean; isRequired: boolean; label: string; name: string; options: external_option[]; type: string; }[]; legalConsentEnabled: boolean; meetingBufferTime: number; ownerPrioritized: boolean; startTimeIncrementMinutes: string; weeksToAdvertise: number; customAvailabilityEndDate?: number; customAvailabilityStartDate?: number; displayInfo?: { avatar?: string; companyAvatar?: string; headline?: string; publicDisplayAvatarOption?: 'COMPANY_LOGO' | 'CUSTOM_AVATAR' | 'PROFILE_IMAGE'; }; guestSettings?: { canAddGuests: boolean; maxGuestCount: number; }; language?: string; legalConsentOptions?: { communicationConsentCheckboxes: external_communication_consent_checkbox[]; communicationConsentText: string; isLegitimateInterest: boolean; legitimateInterestSubscriptionTypes: number[]; privacyPolicyText: string; processingConsentCheckboxLabel: string; processingConsentFooterText: string; processingConsentText: string; processingConsentType: 'IMPLICIT' | 'REQUIRED_CHECKBOX'; legitimateInterestLegalBasis?: string; }; locale?: string; location?: string; redirectUrl?: string; welcomeScreenInfo?: { description?: string; logoUrl?: string; showWelcomeScreen?: boolean; title?: string; useCompanyLogo?: boolean; }; }`\n - `isOffline: boolean`\n - `linkId: string`\n - `linkType: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n - `brandingMetadata?: { logoAltText: string; showMarketingAd: boolean; showSalesAd: boolean; accent2Color?: string; accentColor?: string; companyAddressLine1?: string; companyAddressLine2?: string; companyAvatar?: string; companyCity?: string; companyCountry?: string; companyDomain?: string; companyName?: string; companyState?: string; companyZip?: string; logoHeight?: number; logoUrl?: string; logoWidth?: number; primaryColor?: string; secondaryColor?: string; }`\n - `linkAvailability?: { hasMore: boolean; linkAvailabilityByDuration: object; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst externalBookingInfo = await client.scheduler.meetings.basic.getBookingInfoBySlug('slug', { timezone: 'timezone' });\n\nconsole.log(externalBookingInfo);\n```", - perLanguage: { - typescript: { - method: 'client.scheduler.meetings.basic.getBookingInfoBySlug', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst externalBookingInfo = await client.scheduler.meetings.basic.getBookingInfoBySlug('slug', {\n timezone: 'timezone',\n});\n\nconsole.log(externalBookingInfo.allUsersBusyTimes);", - }, - python: { - method: 'scheduler.meetings.basic.get_booking_info_by_slug', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexternal_booking_info = client.scheduler.meetings.basic.get_booking_info_by_slug(\n slug="slug",\n timezone="timezone",\n)\nprint(external_booking_info.all_users_busy_times)', - }, - java: { - method: 'scheduler().meetings().basic().getBookingInfoBySlug', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.ExternalBookingInfo;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicGetBookingInfoBySlugParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicGetBookingInfoBySlugParams params = BasicGetBookingInfoBySlugParams.builder()\n .slug("slug")\n .timezone("timezone")\n .build();\n ExternalBookingInfo externalBookingInfo = client.scheduler().meetings().basic().getBookingInfoBySlug(params);\n }\n}', - }, - go: { - method: 'client.Scheduler.Meetings.Basic.GetBookingInfoBySlug', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texternalBookingInfo, err := client.Scheduler.Meetings.Basic.GetBookingInfoBySlug(\n\t\tcontext.TODO(),\n\t\t"slug",\n\t\tscheduler.MeetingBasicGetBookingInfoBySlugParams{\n\t\t\tTimezone: "timezone",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", externalBookingInfo.AllUsersBusyTimes)\n}\n', - }, - ruby: { - method: 'scheduler.meetings.basic.get_booking_info_by_slug', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexternal_booking_info = hubspot.scheduler.meetings.basic.get_booking_info_by_slug("slug", timezone: "timezone")\n\nputs(external_booking_info)', - }, - php: { - method: 'scheduler->meetings->basic->getBookingInfoBySlug', - example: - "scheduler\n ->meetings\n ->basic\n ->getBookingInfoBySlug('slug', timezone: 'timezone');\n\nvar_dump($externalBookingInfo);", - }, - http: { - example: - 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links/book/$SLUG \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/scheduler/2026-03/meetings/meeting-links', - httpMethod: 'get', - summary: 'Get meeting scheduling pages', - description: 'Get a paged list meeting scheduling pages', - stainlessPath: '(resource) scheduler.meetings.basic > (method) list', - qualified: 'client.scheduler.meetings.basic.list', - params: [ - 'after?: string;', - 'limit?: number;', - 'name?: string;', - 'organizerUserId?: string;', - "type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR';", - ], - response: - "{ id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }", - markdown: - "## list\n\n`client.scheduler.meetings.basic.list(after?: string, limit?: number, name?: string, organizerUserId?: string, type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'): { id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }`\n\n**get** `/scheduler/2026-03/meetings/meeting-links`\n\nGet a paged list meeting scheduling pages\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `name?: string`\n\n- `organizerUserId?: string`\n\n- `type?: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n\n### Returns\n\n- `{ id: string; createdAt: string; defaultLink: boolean; link: string; organizerUserId: string; slug: string; type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'; userIdsOfLinkMembers: string[]; name?: string; updatedAt?: string; }`\n\n - `id: string`\n - `createdAt: string`\n - `defaultLink: boolean`\n - `link: string`\n - `organizerUserId: string`\n - `slug: string`\n - `type: 'GROUP_CALENDAR' | 'PERSONAL_LINK' | 'ROUND_ROBIN_CALENDAR'`\n - `userIdsOfLinkMembers: string[]`\n - `name?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const externalLinkMetadata of client.scheduler.meetings.basic.list()) {\n console.log(externalLinkMetadata);\n}\n```", - perLanguage: { - typescript: { - method: 'client.scheduler.meetings.basic.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const externalLinkMetadata of client.scheduler.meetings.basic.list()) {\n console.log(externalLinkMetadata.id);\n}", - }, - python: { - method: 'scheduler.meetings.basic.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.scheduler.meetings.basic.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'scheduler().meetings().basic().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicListPage;\nimport com.hubspot.sdk.models.scheduler.meetings.basic.BasicListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BasicListPage page = client.scheduler().meetings().basic().list();\n }\n}', - }, - go: { - method: 'client.Scheduler.Meetings.Basic.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/scheduler"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Scheduler.Meetings.Basic.List(context.TODO(), scheduler.MeetingBasicListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'scheduler.meetings.basic.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.scheduler.meetings.basic.list\n\nputs(page)', - }, - php: { - method: 'scheduler->meetings->basic->list', - example: - "scheduler->meetings->basic->list(\n after: 'after',\n limit: 0,\n name: 'name',\n organizerUserID: 'organizerUserId',\n type: 'GROUP_CALENDAR',\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/scheduler/2026-03/meetings/meeting-links \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_company_currency', - endpoint: '/settings/currencies/2026-03/company-currency', - httpMethod: 'get', - summary: 'Get the company currency', - description: - 'Get the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals.', - stainlessPath: '(resource) settings.currencies > (method) get_company_currency', - qualified: 'client.settings.currencies.getCompanyCurrency', - response: '{ id: string; createdAt: string; }', - markdown: - "## get_company_currency\n\n`client.settings.currencies.getCompanyCurrency(): { id: string; createdAt: string; }`\n\n**get** `/settings/currencies/2026-03/company-currency`\n\nGet the details for the company currency. The company currency is used in deal totals, reports, and the default currency for new deals.\n\n### Returns\n\n- `{ id: string; createdAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst companyCurrency = await client.settings.currencies.getCompanyCurrency();\n\nconsole.log(companyCurrency);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.getCompanyCurrency', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst companyCurrency = await client.settings.currencies.getCompanyCurrency();\n\nconsole.log(companyCurrency.id);", - }, - python: { - method: 'settings.currencies.get_company_currency', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompany_currency = client.settings.currencies.get_company_currency()\nprint(company_currency.id)', - }, - java: { - method: 'settings().currencies().getCompanyCurrency', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrency;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyGetCompanyCurrencyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyCurrency companyCurrency = client.settings().currencies().getCompanyCurrency();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.GetCompanyCurrency', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyCurrency, err := client.Settings.Currencies.GetCompanyCurrency(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyCurrency.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.get_company_currency', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompany_currency = hubspot.settings.currencies.get_company_currency\n\nputs(company_currency)', - }, - php: { - method: 'settings->currencies->getCompanyCurrency', - example: - "settings->currencies->getCompanyCurrency();\n\nvar_dump($companyCurrency);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/company-currency \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_codes', - endpoint: '/settings/currencies/2026-03/codes', - httpMethod: 'get', - summary: 'Get all currency codes', - description: 'Retrieve a list of all available currency codes and their names.', - stainlessPath: '(resource) settings.currencies > (method) list_codes', - qualified: 'client.settings.currencies.listCodes', - response: '{ results: { currencyCode: string; currencyName: string; }[]; }', - markdown: - "## list_codes\n\n`client.settings.currencies.listCodes(): { results: currency_code_info[]; }`\n\n**get** `/settings/currencies/2026-03/codes`\n\nRetrieve a list of all available currency codes and their names.\n\n### Returns\n\n- `{ results: { currencyCode: string; currencyName: string; }[]; }`\n\n - `results: { currencyCode: string; currencyName: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.listCodes();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.listCodes', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.listCodes();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging.results);", - }, - python: { - method: 'settings.currencies.list_codes', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_currency_code_info_no_paging = client.settings.currencies.list_codes()\nprint(collection_response_currency_code_info_no_paging.results)', - }, - java: { - method: 'settings().currencies().listCodes', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseCurrencyCodeInfoNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyListCodesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseCurrencyCodeInfoNoPaging collectionResponseCurrencyCodeInfoNoPaging = client.settings().currencies().listCodes();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ListCodes', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseCurrencyCodeInfoNoPaging, err := client.Settings.Currencies.ListCodes(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseCurrencyCodeInfoNoPaging.Results)\n}\n', - }, - ruby: { - method: 'settings.currencies.list_codes', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_currency_code_info_no_paging = hubspot.settings.currencies.list_codes\n\nputs(collection_response_currency_code_info_no_paging)', - }, - php: { - method: 'settings->currencies->listCodes', - example: - "settings\n ->currencies\n ->listCodes();\n\nvar_dump($collectionResponseCurrencyCodeInfoNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/codes \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_company_currency', - endpoint: '/settings/currencies/2026-03/company-currency', - httpMethod: 'put', - summary: 'Set or update the company currency.', - description: 'Set or update the primary company currency.', - stainlessPath: '(resource) settings.currencies > (method) update_company_currency', - qualified: 'client.settings.currencies.updateCompanyCurrency', - params: ['currencyCode: string;'], - response: '{ id: string; createdAt: string; }', - markdown: - "## update_company_currency\n\n`client.settings.currencies.updateCompanyCurrency(currencyCode: string): { id: string; createdAt: string; }`\n\n**put** `/settings/currencies/2026-03/company-currency`\n\nSet or update the primary company currency.\n\n### Parameters\n\n- `currencyCode: string`\n The three-letter code representing a specific currency (ex. USD).\n\n### Returns\n\n- `{ id: string; createdAt: string; }`\n\n - `id: string`\n - `createdAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst companyCurrency = await client.settings.currencies.updateCompanyCurrency({ currencyCode: 'AED' });\n\nconsole.log(companyCurrency);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.updateCompanyCurrency', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst companyCurrency = await client.settings.currencies.updateCompanyCurrency({\n currencyCode: 'AED',\n});\n\nconsole.log(companyCurrency.id);", - }, - python: { - method: 'settings.currencies.update_company_currency', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncompany_currency = client.settings.currencies.update_company_currency(\n currency_code="AED",\n)\nprint(company_currency.id)', - }, - java: { - method: 'settings().currencies().updateCompanyCurrency', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrency;\nimport com.hubspot.sdk.models.settings.currencies.CompanyCurrencyUpdateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyCurrencyUpdateRequest params = CompanyCurrencyUpdateRequest.builder()\n .currencyCode(CompanyCurrencyUpdateRequest.CurrencyCode.AED)\n .build();\n CompanyCurrency companyCurrency = client.settings().currencies().updateCompanyCurrency(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.UpdateCompanyCurrency', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyCurrency, err := client.Settings.Currencies.UpdateCompanyCurrency(context.TODO(), settings.CurrencyUpdateCompanyCurrencyParams{\n\t\tCompanyCurrencyUpdateRequest: settings.CompanyCurrencyUpdateRequestParam{\n\t\t\tCurrencyCode: settings.CompanyCurrencyUpdateRequestCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyCurrency.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.update_company_currency', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncompany_currency = hubspot.settings.currencies.update_company_currency(currency_code: :AED)\n\nputs(company_currency)', - }, - php: { - method: 'settings->currencies->updateCompanyCurrency', - example: - "settings->currencies->updateCompanyCurrency(\n currencyCode: 'AED'\n);\n\nvar_dump($companyCurrency);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/company-currency \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "currencyCode": "AED"\n }\'', - }, - }, - }, - { - name: 'create_currency', - endpoint: '/settings/currencies/2026-03/central-fx-rates/add-currency', - httpMethod: 'post', - summary: 'Add a new currency with central exchange rates.', - description: - 'Create a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here.', - stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) create_currency', - qualified: 'client.settings.currencies.centralFxRates.createCurrency', - params: ['currencyCode: string;'], - response: - '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', - markdown: - "## create_currency\n\n`client.settings.currencies.centralFxRates.createCurrency(currencyCode: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**post** `/settings/currencies/2026-03/central-fx-rates/add-currency`\n\nCreate a new currency with central exchange rates in the portal. Unsupported currencies cannot be added here.\n\n### Parameters\n\n- `currencyCode: string`\n The currency code being added to the HubSpot portal for use with central exchange rates.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.centralFxRates.createCurrency({ currencyCode: 'AED' });\n\nconsole.log(exchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.centralFxRates.createCurrency', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.centralFxRates.createCurrency({\n currencyCode: 'AED',\n});\n\nconsole.log(exchangeRate.id);", - }, - python: { - method: 'settings.currencies.central_fx_rates.create_currency', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.central_fx_rates.create_currency(\n currency_code="AED",\n)\nprint(exchange_rate.id)', - }, - java: { - method: 'settings().currencies().centralFxRates().createCurrency', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyCreateRequest;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CurrencyCreateRequest params = CurrencyCreateRequest.builder()\n .currencyCode(CurrencyCreateRequest.CurrencyCode.AED)\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().centralFxRates().createCurrency(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.CentralFxRates.NewCurrency', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.CentralFxRates.NewCurrency(context.TODO(), settings.CurrencyCentralFxRateNewCurrencyParams{\n\t\tCurrencyCreateRequest: settings.CurrencyCreateRequestParam{\n\t\t\tCurrencyCode: settings.CurrencyCreateRequestCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.central_fx_rates.create_currency', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.central_fx_rates.create_currency(currency_code: :AED)\n\nputs(exchange_rate)', - }, - php: { - method: 'settings->currencies->centralFxRates->createCurrency', - example: - "settings->currencies->centralFxRates->createCurrency(\n currencyCode: 'AED'\n);\n\nvar_dump($exchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/add-currency \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "currencyCode": "AED"\n }\'', - }, - }, - }, - { - name: 'get_information', - endpoint: '/settings/currencies/2026-03/central-fx-rates/information', - httpMethod: 'get', - summary: 'Retrieve information about the central exchange rates feature.', - description: 'Retrieve details on whether the central exchange rates feature is enabled for the portal.', - stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) get_information', - qualified: 'client.settings.currencies.centralFxRates.getInformation', - response: '{ centralExchangeRatesEnabled: boolean; }', - markdown: - "## get_information\n\n`client.settings.currencies.centralFxRates.getInformation(): { centralExchangeRatesEnabled: boolean; }`\n\n**get** `/settings/currencies/2026-03/central-fx-rates/information`\n\nRetrieve details on whether the central exchange rates feature is enabled for the portal.\n\n### Returns\n\n- `{ centralExchangeRatesEnabled: boolean; }`\n\n - `centralExchangeRatesEnabled: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst centralExchangeRatesInformation = await client.settings.currencies.centralFxRates.getInformation();\n\nconsole.log(centralExchangeRatesInformation);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.centralFxRates.getInformation', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst centralExchangeRatesInformation =\n await client.settings.currencies.centralFxRates.getInformation();\n\nconsole.log(centralExchangeRatesInformation.centralExchangeRatesEnabled);", - }, - python: { - method: 'settings.currencies.central_fx_rates.get_information', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncentral_exchange_rates_information = client.settings.currencies.central_fx_rates.get_information()\nprint(central_exchange_rates_information.central_exchange_rates_enabled)', - }, - java: { - method: 'settings().currencies().centralFxRates().getInformation', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CentralExchangeRatesInformation;\nimport com.hubspot.sdk.models.settings.currencies.centralfxrates.CentralFxRateGetInformationParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CentralExchangeRatesInformation centralExchangeRatesInformation = client.settings().currencies().centralFxRates().getInformation();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.CentralFxRates.GetInformation', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcentralExchangeRatesInformation, err := client.Settings.Currencies.CentralFxRates.GetInformation(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", centralExchangeRatesInformation.CentralExchangeRatesEnabled)\n}\n', - }, - ruby: { - method: 'settings.currencies.central_fx_rates.get_information', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncentral_exchange_rates_information = hubspot.settings.currencies.central_fx_rates.get_information\n\nputs(central_exchange_rates_information)', - }, - php: { - method: 'settings->currencies->centralFxRates->getInformation', - example: - "settings\n ->currencies\n ->centralFxRates\n ->getInformation();\n\nvar_dump($centralExchangeRatesInformation);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/information \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_unsupported_currencies', - endpoint: '/settings/currencies/2026-03/central-fx-rates/unsupported-currencies', - httpMethod: 'get', - summary: 'Retrieve currencies not supported by central exchange rates.', - description: - 'Retrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated.', - stainlessPath: '(resource) settings.currencies.central_fx_rates > (method) get_unsupported_currencies', - qualified: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', - response: '{ results: { currencyCode: string; currencyName: string; }[]; }', - markdown: - "## get_unsupported_currencies\n\n`client.settings.currencies.centralFxRates.getUnsupportedCurrencies(): { results: currency_code_info[]; }`\n\n**get** `/settings/currencies/2026-03/central-fx-rates/unsupported-currencies`\n\nRetrieve a list of currency codes that are not supported by the central exchange rates. Unsupported currencies will need to be manually updated.\n\n### Returns\n\n- `{ results: { currencyCode: string; currencyName: string; }[]; }`\n\n - `results: { currencyCode: string; currencyName: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseCurrencyCodeInfoNoPaging = await client.settings.currencies.centralFxRates.getUnsupportedCurrencies();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseCurrencyCodeInfoNoPaging =\n await client.settings.currencies.centralFxRates.getUnsupportedCurrencies();\n\nconsole.log(collectionResponseCurrencyCodeInfoNoPaging.results);", - }, - python: { - method: 'settings.currencies.central_fx_rates.get_unsupported_currencies', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_currency_code_info_no_paging = client.settings.currencies.central_fx_rates.get_unsupported_currencies()\nprint(collection_response_currency_code_info_no_paging.results)', - }, - java: { - method: 'settings().currencies().centralFxRates().getUnsupportedCurrencies', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseCurrencyCodeInfoNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.centralfxrates.CentralFxRateGetUnsupportedCurrenciesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseCurrencyCodeInfoNoPaging collectionResponseCurrencyCodeInfoNoPaging = client.settings().currencies().centralFxRates().getUnsupportedCurrencies();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.CentralFxRates.GetUnsupportedCurrencies', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseCurrencyCodeInfoNoPaging, err := client.Settings.Currencies.CentralFxRates.GetUnsupportedCurrencies(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseCurrencyCodeInfoNoPaging.Results)\n}\n', - }, - ruby: { - method: 'settings.currencies.central_fx_rates.get_unsupported_currencies', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_currency_code_info_no_paging = hubspot.settings.currencies.central_fx_rates.get_unsupported_currencies\n\nputs(collection_response_currency_code_info_no_paging)', - }, - php: { - method: 'settings->currencies->centralFxRates->getUnsupportedCurrencies', - example: - "settings\n ->currencies\n ->centralFxRates\n ->getUnsupportedCurrencies();\n\nvar_dump($collectionResponseCurrencyCodeInfoNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/central-fx-rates/unsupported-currencies \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create_exchange_rate', - endpoint: '/settings/currencies/2026-03/exchange-rates', - httpMethod: 'post', - summary: 'Add a new exchange rate', - description: 'Create a new exchange rate with specified conversion rate and currency codes.', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) create_exchange_rate', - qualified: 'client.settings.currencies.exchangeRates.createExchangeRate', - params: ['conversionRate: number;', 'fromCurrencyCode: string;', 'effectiveAt?: string;'], - response: - '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', - markdown: - "## create_exchange_rate\n\n`client.settings.currencies.exchangeRates.createExchangeRate(conversionRate: number, fromCurrencyCode: string, effectiveAt?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates`\n\nCreate a new exchange rate with specified conversion rate and currency codes.\n\n### Parameters\n\n- `conversionRate: number`\n The conversion rate between the to and from currency code of this exchange rate.\n\n- `fromCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from.\n\n- `effectiveAt?: string`\n The date the exchange rate is in effect.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.createExchangeRate({ conversionRate: 0, fromCurrencyCode: 'AED' });\n\nconsole.log(exchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.createExchangeRate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.createExchangeRate({\n conversionRate: 0,\n fromCurrencyCode: 'AED',\n});\n\nconsole.log(exchangeRate.id);", - }, - python: { - method: 'settings.currencies.exchange_rates.create_exchange_rate', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.create_exchange_rate(\n conversion_rate=0,\n from_currency_code="AED",\n)\nprint(exchange_rate.id)', - }, - java: { - method: 'settings().currencies().exchangeRates().createExchangeRate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateCreateRequest params = ExchangeRateCreateRequest.builder()\n .conversionRate(0.0)\n .fromCurrencyCode(ExchangeRateCreateRequest.FromCurrencyCode.AED)\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().createExchangeRate(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.NewExchangeRate', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.NewExchangeRate(context.TODO(), settings.CurrencyExchangeRateNewExchangeRateParams{\n\t\tExchangeRateCreateRequest: settings.ExchangeRateCreateRequestParam{\n\t\t\tConversionRate: 0,\n\t\t\tFromCurrencyCode: settings.ExchangeRateCreateRequestFromCurrencyCodeAed,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.create_exchange_rate', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.create_exchange_rate(\n conversion_rate: 0,\n from_currency_code: :AED\n)\n\nputs(exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->createExchangeRate', - example: - "settings\n ->currencies\n ->exchangeRates\n ->createExchangeRate(\n conversionRate: 0,\n fromCurrencyCode: 'AED',\n effectiveAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($exchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionRate": 0,\n "fromCurrencyCode": "AED"\n }\'', - }, - }, - }, - { - name: 'get_exchange_rate_by_id', - endpoint: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', - httpMethod: 'get', - summary: 'Get the details for a specific exchange rate', - description: 'Retrieve the details for a specific exchange rate specified by its ID.', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) get_exchange_rate_by_id', - qualified: 'client.settings.currencies.exchangeRates.getExchangeRateByID', - params: ['exchangeRateId: string;'], - response: - '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', - markdown: - "## get_exchange_rate_by_id\n\n`client.settings.currencies.exchangeRates.getExchangeRateByID(exchangeRateId: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates/{exchangeRateId}`\n\nRetrieve the details for a specific exchange rate specified by its ID.\n\n### Parameters\n\n- `exchangeRateId: string`\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.getExchangeRateByID('exchangeRateId');\n\nconsole.log(exchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.getExchangeRateByID', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.getExchangeRateByID(\n 'exchangeRateId',\n);\n\nconsole.log(exchangeRate.id);", - }, - python: { - method: 'settings.currencies.exchange_rates.get_exchange_rate_by_id', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.get_exchange_rate_by_id(\n "exchangeRateId",\n)\nprint(exchange_rate.id)', - }, - java: { - method: 'settings().currencies().exchangeRates().getExchangeRateById', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateGetExchangeRateByIdParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().getExchangeRateById("exchangeRateId");\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.GetExchangeRateByID', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.GetExchangeRateByID(context.TODO(), "exchangeRateId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.get_exchange_rate_by_id', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.get_exchange_rate_by_id("exchangeRateId")\n\nputs(exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->getExchangeRateByID', - example: - "settings\n ->currencies\n ->exchangeRates\n ->getExchangeRateByID('exchangeRateId');\n\nvar_dump($exchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/$EXCHANGE_RATE_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_current_exchange_rates', - endpoint: '/settings/currencies/2026-03/exchange-rates/current', - httpMethod: 'get', - summary: 'Get all current exchange rates', - description: 'Retrieve all current exchange rates for all currency pairs.', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) list_current_exchange_rates', - qualified: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', - response: - '{ results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; }', - markdown: - "## list_current_exchange_rates\n\n`client.settings.currencies.exchangeRates.listCurrentExchangeRates(): { results: exchange_rate[]; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates/current`\n\nRetrieve all current exchange rates for all currency pairs.\n\n### Returns\n\n- `{ results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; }`\n\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseExchangeRateNoPaging = await client.settings.currencies.exchangeRates.listCurrentExchangeRates();\n\nconsole.log(collectionResponseExchangeRateNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseExchangeRateNoPaging =\n await client.settings.currencies.exchangeRates.listCurrentExchangeRates();\n\nconsole.log(collectionResponseExchangeRateNoPaging.results);", - }, - python: { - method: 'settings.currencies.exchange_rates.list_current_exchange_rates', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_exchange_rate_no_paging = client.settings.currencies.exchange_rates.list_current_exchange_rates()\nprint(collection_response_exchange_rate_no_paging.results)', - }, - java: { - method: 'settings().currencies().exchangeRates().listCurrentExchangeRates', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CollectionResponseExchangeRateNoPaging;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListCurrentExchangeRatesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseExchangeRateNoPaging collectionResponseExchangeRateNoPaging = client.settings().currencies().exchangeRates().listCurrentExchangeRates();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.ListCurrentExchangeRates', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseExchangeRateNoPaging, err := client.Settings.Currencies.ExchangeRates.ListCurrentExchangeRates(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseExchangeRateNoPaging.Results)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.list_current_exchange_rates', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_exchange_rate_no_paging = hubspot.settings.currencies.exchange_rates.list_current_exchange_rates\n\nputs(collection_response_exchange_rate_no_paging)', - }, - php: { - method: 'settings->currencies->exchangeRates->listCurrentExchangeRates', - example: - "settings\n ->currencies\n ->exchangeRates\n ->listCurrentExchangeRates();\n\nvar_dump($collectionResponseExchangeRateNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/current \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_exchange_rates', - endpoint: '/settings/currencies/2026-03/exchange-rates', - httpMethod: 'get', - summary: 'Get exchange rates', - description: 'Get a list of exchange rates', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) list_exchange_rates', - qualified: 'client.settings.currencies.exchangeRates.listExchangeRates', - params: ['after?: string;', 'fromCurrencyCode?: string;', 'limit?: number;', 'toCurrencyCode?: string;'], - response: - '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', - markdown: - "## list_exchange_rates\n\n`client.settings.currencies.exchangeRates.listExchangeRates(after?: string, fromCurrencyCode?: string, limit?: number, toCurrencyCode?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**get** `/settings/currencies/2026-03/exchange-rates`\n\nGet a list of exchange rates\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `fromCurrencyCode?: string`\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n- `toCurrencyCode?: string`\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const exchangeRate of client.settings.currencies.exchangeRates.listExchangeRates()) {\n console.log(exchangeRate);\n}\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.listExchangeRates', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const exchangeRate of client.settings.currencies.exchangeRates.listExchangeRates()) {\n console.log(exchangeRate.id);\n}", - }, - python: { - method: 'settings.currencies.exchange_rates.list_exchange_rates', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.currencies.exchange_rates.list_exchange_rates()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'settings().currencies().exchangeRates().listExchangeRates', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListExchangeRatesPage;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateListExchangeRatesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateListExchangeRatesPage page = client.settings().currencies().exchangeRates().listExchangeRates();\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.ListExchangeRates', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.Currencies.ExchangeRates.ListExchangeRates(context.TODO(), settings.CurrencyExchangeRateListExchangeRatesParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.list_exchange_rates', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.currencies.exchange_rates.list_exchange_rates\n\nputs(page)', - }, - php: { - method: 'settings->currencies->exchangeRates->listExchangeRates', - example: - "settings->currencies->exchangeRates->listExchangeRates(\n after: 'after', fromCurrencyCode: 'AED', limit: 0, toCurrencyCode: 'AED'\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_exchange_rate', - endpoint: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', - httpMethod: 'patch', - summary: 'Update a conversion rate', - description: 'Update an existing conversion rate, specified by its ID.', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) update_exchange_rate', - qualified: 'client.settings.currencies.exchangeRates.updateExchangeRate', - params: ['exchangeRateId: string;', 'conversionRate: number;', 'effectiveAt?: string;'], - response: - '{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }', - markdown: - "## update_exchange_rate\n\n`client.settings.currencies.exchangeRates.updateExchangeRate(exchangeRateId: string, conversionRate: number, effectiveAt?: string): { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n**patch** `/settings/currencies/2026-03/exchange-rates/{exchangeRateId}`\n\nUpdate an existing conversion rate, specified by its ID.\n\n### Parameters\n\n- `exchangeRateId: string`\n\n- `conversionRate: number`\n The updated conversion rate between the to and from currency code of this exchange rate.\n\n- `effectiveAt?: string`\n The date the exchange rate is in effect.\n\n### Returns\n\n- `{ id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }`\n\n - `id: string`\n - `conversionRate: number`\n - `createdAt: string`\n - `effectiveAt: string`\n - `fromCurrencyCode: string`\n - `toCurrencyCode: string`\n - `updatedAt: string`\n - `visibleInUI: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.updateExchangeRate('exchangeRateId', { conversionRate: 0 });\n\nconsole.log(exchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.updateExchangeRate', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst exchangeRate = await client.settings.currencies.exchangeRates.updateExchangeRate(\n 'exchangeRateId',\n { conversionRate: 0 },\n);\n\nconsole.log(exchangeRate.id);", - }, - python: { - method: 'settings.currencies.exchange_rates.update_exchange_rate', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nexchange_rate = client.settings.currencies.exchange_rates.update_exchange_rate(\n exchange_rate_id="exchangeRateId",\n conversion_rate=0,\n)\nprint(exchange_rate.id)', - }, - java: { - method: 'settings().currencies().exchangeRates().updateExchangeRate', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateMultiplier;\nimport com.hubspot.sdk.models.settings.currencies.exchangerates.ExchangeRateUpdateExchangeRateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ExchangeRateUpdateExchangeRateParams params = ExchangeRateUpdateExchangeRateParams.builder()\n .exchangeRateId("exchangeRateId")\n .exchangeRateMultiplier(ExchangeRateMultiplier.builder()\n .conversionRate(0.0)\n .build())\n .build();\n ExchangeRate exchangeRate = client.settings().currencies().exchangeRates().updateExchangeRate(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.UpdateExchangeRate', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\texchangeRate, err := client.Settings.Currencies.ExchangeRates.UpdateExchangeRate(\n\t\tcontext.TODO(),\n\t\t"exchangeRateId",\n\t\tsettings.CurrencyExchangeRateUpdateExchangeRateParams{\n\t\t\tExchangeRateMultiplier: settings.ExchangeRateMultiplierParam{\n\t\t\t\tConversionRate: 0,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", exchangeRate.ID)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.update_exchange_rate', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nexchange_rate = hubspot.settings.currencies.exchange_rates.update_exchange_rate("exchangeRateId", conversion_rate: 0)\n\nputs(exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->updateExchangeRate', - example: - "settings\n ->currencies\n ->exchangeRates\n ->updateExchangeRate(\n 'exchangeRateId',\n conversionRate: 0,\n effectiveAt: new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n);\n\nvar_dump($exchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/$EXCHANGE_RATE_ID \\\n -X PATCH \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "conversionRate": 0\n }\'', - }, - }, - }, - { - name: 'update_visibility', - endpoint: '/settings/currencies/2026-03/exchange-rates/update-visibility', - httpMethod: 'post', - summary: 'Change the visibility of a specific currency pairs', - description: - 'Change the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app.', - stainlessPath: '(resource) settings.currencies.exchange_rates > (method) update_visibility', - qualified: 'client.settings.currencies.exchangeRates.updateVisibility', - params: ['fromCurrencyCode: string;', 'toCurrencyCode: string;', 'visibleInUI: boolean;'], - markdown: - "## update_visibility\n\n`client.settings.currencies.exchangeRates.updateVisibility(fromCurrencyCode: string, toCurrencyCode: string, visibleInUI: boolean): void`\n\n**post** `/settings/currencies/2026-03/exchange-rates/update-visibility`\n\nChange the visibility setting for a currency pair. This will hide or display a currency pair for users in the HubSpot app.\n\n### Parameters\n\n- `fromCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert from.\n\n- `toCurrencyCode: string`\n This represents the three-letter currency code (such as USD for US Dollar) of the currency you want to convert to.\n\n- `visibleInUI: boolean`\n This indicates if the currency pair is shown in the MultiCurrency settings page. Setting this to false will remove the currency pair from the settings page.\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.settings.currencies.exchangeRates.updateVisibility({\n fromCurrencyCode: 'AED',\n toCurrencyCode: 'AED',\n visibleInUI: true,\n})\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.updateVisibility', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.settings.currencies.exchangeRates.updateVisibility({\n fromCurrencyCode: 'AED',\n toCurrencyCode: 'AED',\n visibleInUI: true,\n});", - }, - python: { - method: 'settings.currencies.exchange_rates.update_visibility', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.settings.currencies.exchange_rates.update_visibility(\n from_currency_code="AED",\n to_currency_code="AED",\n visible_in_ui=True,\n)', - }, - java: { - method: 'settings().currencies().exchangeRates().updateVisibility', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.CurrencyPairUpdate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CurrencyPairUpdate params = CurrencyPairUpdate.builder()\n .fromCurrencyCode(CurrencyPairUpdate.FromCurrencyCode.AED)\n .toCurrencyCode(CurrencyPairUpdate.ToCurrencyCode.AED)\n .visibleInUi(true)\n .build();\n client.settings().currencies().exchangeRates().updateVisibility(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.UpdateVisibility', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Settings.Currencies.ExchangeRates.UpdateVisibility(context.TODO(), settings.CurrencyExchangeRateUpdateVisibilityParams{\n\t\tCurrencyPairUpdate: settings.CurrencyPairUpdateParam{\n\t\t\tFromCurrencyCode: settings.CurrencyPairUpdateFromCurrencyCodeAed,\n\t\t\tToCurrencyCode: settings.CurrencyPairUpdateToCurrencyCodeAed,\n\t\t\tVisibleInUi: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.update_visibility', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.settings.currencies.exchange_rates.update_visibility(\n from_currency_code: :AED,\n to_currency_code: :AED,\n visible_in_ui: true\n)\n\nputs(result)', - }, - php: { - method: 'settings->currencies->exchangeRates->updateVisibility', - example: - "settings->currencies->exchangeRates->updateVisibility(\n fromCurrencyCode: 'AED', toCurrencyCode: 'AED', visibleInUi: true\n);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/update-visibility \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "fromCurrencyCode": "AED",\n "toCurrencyCode": "AED",\n "visibleInUI": true\n }\'', - }, - }, - }, - { - name: 'create', - endpoint: '/settings/currencies/2026-03/exchange-rates/batch/create', - httpMethod: 'post', - summary: 'Create multiple exchange rates', - description: 'Create multiple exchange rates in a single request.', - stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) create', - qualified: 'client.settings.currencies.exchangeRates.batch.create', - params: ['inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[];'], - response: - "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create\n\n`client.settings.currencies.exchangeRates.batch.create(inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/create`\n\nCreate multiple exchange rates in a single request.\n\n### Parameters\n\n- `inputs: { conversionRate: number; fromCurrencyCode: string; effectiveAt?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.create({ inputs: [{ conversionRate: 0, fromCurrencyCode: 'AED' }] });\n\nconsole.log(batchResponseExchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.batch.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.create({\n inputs: [{ conversionRate: 0, fromCurrencyCode: 'AED' }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", - }, - python: { - method: 'settings.currencies.exchange_rates.batch.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.create(\n inputs=[{\n "conversion_rate": 0,\n "from_currency_code": "AED",\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', - }, - java: { - method: 'settings().currencies().exchangeRates().batch().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.BatchInputExchangeRateCreateRequest;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateCreateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputExchangeRateCreateRequest params = BatchInputExchangeRateCreateRequest.builder()\n .addInput(ExchangeRateCreateRequest.builder()\n .conversionRate(0.0)\n .fromCurrencyCode(ExchangeRateCreateRequest.FromCurrencyCode.AED)\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().create(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.Batch.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.New(context.TODO(), settings.CurrencyExchangeRateBatchNewParams{\n\t\tBatchInputExchangeRateCreateRequest: settings.BatchInputExchangeRateCreateRequestParam{\n\t\t\tInputs: []settings.ExchangeRateCreateRequestParam{{\n\t\t\t\tConversionRate: 0,\n\t\t\t\tFromCurrencyCode: settings.ExchangeRateCreateRequestFromCurrencyCodeAed,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.batch.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.create(\n inputs: [{conversionRate: 0, fromCurrencyCode: :AED}]\n)\n\nputs(batch_response_exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->batch->create', - example: - "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->create(\n inputs: [\n [\n 'conversionRate' => 0,\n 'fromCurrencyCode' => 'AED',\n 'effectiveAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseExchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/create \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "conversionRate": 0,\n "fromCurrencyCode": "AED"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/settings/currencies/2026-03/exchange-rates/batch/read', - httpMethod: 'post', - summary: 'Retrieve multiple rates', - description: - 'Retrieve the details of multiple exchange rates in a single request, specified by their IDs.', - stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) get', - qualified: 'client.settings.currencies.exchangeRates.batch.get', - params: ['inputs: { id: string; }[];'], - response: - "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get\n\n`client.settings.currencies.exchangeRates.batch.get(inputs: { id: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/read`\n\nRetrieve the details of multiple exchange rates in a single request, specified by their IDs.\n\n### Parameters\n\n- `inputs: { id: string; }[]`\n An array of deal split inputs\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.get({ inputs: [{ id: 'id' }] });\n\nconsole.log(batchResponseExchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.batch.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.get({\n inputs: [{ id: 'id' }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", - }, - python: { - method: 'settings.currencies.exchange_rates.batch.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.get(\n inputs=[{\n "id": "id"\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', - }, - java: { - method: 'settings().currencies().exchangeRates().batch().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputPublicObjectId;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputPublicObjectId params = BatchInputPublicObjectId.builder()\n .addInput(PublicObjectId.builder()\n .id("id")\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().get(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.Batch.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.Get(context.TODO(), settings.CurrencyExchangeRateBatchGetParams{\n\t\tBatchInputPublicObjectID: shared.BatchInputPublicObjectIDParam{\n\t\t\tInputs: []shared.PublicObjectIDParam{{\n\t\t\t\tID: "id",\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.batch.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.get(inputs: [{id: "id"}])\n\nputs(batch_response_exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->batch->get', - example: - "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->get(inputs: [['id' => 'id']]);\n\nvar_dump($batchResponseExchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id"\n }\n ]\n }\'', - }, - }, - }, - { - name: 'update', - endpoint: '/settings/currencies/2026-03/exchange-rates/batch/update', - httpMethod: 'post', - summary: 'Update multiple exchange rates', - description: 'Update the conversion rates for multiple exchange rates in a batch operation.', - stainlessPath: '(resource) settings.currencies.exchange_rates.batch > (method) update', - qualified: 'client.settings.currencies.exchangeRates.batch.update', - params: ['inputs: { id: string; conversionRate: number; effectiveAt?: string; }[];'], - response: - "{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## update\n\n`client.settings.currencies.exchangeRates.batch.update(inputs: { id: string; conversionRate: number; effectiveAt?: string; }[]): { completedAt: string; results: exchange_rate[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/settings/currencies/2026-03/exchange-rates/batch/update`\n\nUpdate the conversion rates for multiple exchange rates in a batch operation.\n\n### Parameters\n\n- `inputs: { id: string; conversionRate: number; effectiveAt?: string; }[]`\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; conversionRate: number; createdAt: string; effectiveAt: string; fromCurrencyCode: string; toCurrencyCode: string; updatedAt: string; visibleInUI: boolean; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.update({ inputs: [{ id: 'id', conversionRate: 0 }] });\n\nconsole.log(batchResponseExchangeRate);\n```", - perLanguage: { - typescript: { - method: 'client.settings.currencies.exchangeRates.batch.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseExchangeRate = await client.settings.currencies.exchangeRates.batch.update({\n inputs: [{ id: 'id', conversionRate: 0 }],\n});\n\nconsole.log(batchResponseExchangeRate.completedAt);", - }, - python: { - method: 'settings.currencies.exchange_rates.batch.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_exchange_rate = client.settings.currencies.exchange_rates.batch.update(\n inputs=[{\n "id": "id",\n "conversion_rate": 0,\n }],\n)\nprint(batch_response_exchange_rate.completed_at)', - }, - java: { - method: 'settings().currencies().exchangeRates().batch().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.currencies.BatchInputExchangeRateUpdateRequest;\nimport com.hubspot.sdk.models.settings.currencies.BatchResponseExchangeRate;\nimport com.hubspot.sdk.models.settings.currencies.ExchangeRateUpdateRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputExchangeRateUpdateRequest params = BatchInputExchangeRateUpdateRequest.builder()\n .addInput(ExchangeRateUpdateRequest.builder()\n .id("id")\n .conversionRate(0.0)\n .build())\n .build();\n BatchResponseExchangeRate batchResponseExchangeRate = client.settings().currencies().exchangeRates().batch().update(params);\n }\n}', - }, - go: { - method: 'client.Settings.Currencies.ExchangeRates.Batch.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseExchangeRate, err := client.Settings.Currencies.ExchangeRates.Batch.Update(context.TODO(), settings.CurrencyExchangeRateBatchUpdateParams{\n\t\tBatchInputExchangeRateUpdateRequest: settings.BatchInputExchangeRateUpdateRequestParam{\n\t\t\tInputs: []settings.ExchangeRateUpdateRequestParam{{\n\t\t\t\tID: "id",\n\t\t\t\tConversionRate: 0,\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseExchangeRate.CompletedAt)\n}\n', - }, - ruby: { - method: 'settings.currencies.exchange_rates.batch.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_exchange_rate = hubspot.settings.currencies.exchange_rates.batch.update(inputs: [{id: "id", conversionRate: 0}])\n\nputs(batch_response_exchange_rate)', - }, - php: { - method: 'settings->currencies->exchangeRates->batch->update', - example: - "settings\n ->currencies\n ->exchangeRates\n ->batch\n ->update(\n inputs: [\n [\n 'id' => 'id',\n 'conversionRate' => 0,\n 'effectiveAt' => new \\DateTimeImmutable('2019-12-27T18:11:19.117Z'),\n ],\n ],\n);\n\nvar_dump($batchResponseExchangeRate);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/currencies/2026-03/exchange-rates/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": "id",\n "conversionRate": 0\n }\n ]\n }\'', - }, - }, - }, - { - name: 'get', - endpoint: '/tax-rates/2026-03/tax-rates/{taxRateGroupId}', - httpMethod: 'get', - summary: 'Get a specific tax rate', - description: 'Retrieve a specific tax rate by its `taxRateGroupId`.', - stainlessPath: '(resource) settings.tax_rates > (method) get', - qualified: 'client.settings.taxRates.get', - params: ['taxRateGroupId: string;'], - response: - '{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }', - markdown: - "## get\n\n`client.settings.taxRates.get(taxRateGroupId: string): { id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n**get** `/tax-rates/2026-03/tax-rates/{taxRateGroupId}`\n\nRetrieve a specific tax rate by its `taxRateGroupId`.\n\n### Parameters\n\n- `taxRateGroupId: string`\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `label: string`\n - `name: string`\n - `percentageRate: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicTaxRateGroup = await client.settings.taxRates.get('taxRateGroupId');\n\nconsole.log(publicTaxRateGroup);\n```", - perLanguage: { - typescript: { - method: 'client.settings.taxRates.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicTaxRateGroup = await client.settings.taxRates.get('taxRateGroupId');\n\nconsole.log(publicTaxRateGroup.id);", - }, - python: { - method: 'settings.tax_rates.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_tax_rate_group = client.settings.tax_rates.get(\n "taxRateGroupId",\n)\nprint(public_tax_rate_group.id)', - }, - java: { - method: 'settings().taxRates().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.taxrates.PublicTaxRateGroup;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicTaxRateGroup publicTaxRateGroup = client.settings().taxRates().get("taxRateGroupId");\n }\n}', - }, - go: { - method: 'client.Settings.TaxRates.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicTaxRateGroup, err := client.Settings.TaxRates.Get(context.TODO(), "taxRateGroupId")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicTaxRateGroup.ID)\n}\n', - }, - ruby: { - method: 'settings.tax_rates.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_tax_rate_group = hubspot.settings.tax_rates.get("taxRateGroupId")\n\nputs(public_tax_rate_group)', - }, - php: { - method: 'settings->taxRates->get', - example: - "settings->taxRates->get('taxRateGroupId');\n\nvar_dump($publicTaxRateGroup);", - }, - http: { - example: - 'curl https://api.hubapi.com/tax-rates/2026-03/tax-rates/$TAX_RATE_GROUP_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/tax-rates/2026-03/tax-rates', - httpMethod: 'get', - summary: 'Get all tax rates', - description: 'Retrieve a paginated list of all tax rates set up in the account tax rate library', - stainlessPath: '(resource) settings.tax_rates > (method) list', - qualified: 'client.settings.taxRates.list', - params: ['active?: boolean;', 'after?: string;', 'limit?: number;'], - response: - '{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }', - markdown: - "## list\n\n`client.settings.taxRates.list(active?: boolean, after?: string, limit?: number): { id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n**get** `/tax-rates/2026-03/tax-rates`\n\nRetrieve a paginated list of all tax rates set up in the account tax rate library\n\n### Parameters\n\n- `active?: boolean`\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; label: string; name: string; percentageRate: number; updatedAt: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `label: string`\n - `name: string`\n - `percentageRate: number`\n - `updatedAt: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicTaxRateGroup of client.settings.taxRates.list()) {\n console.log(publicTaxRateGroup);\n}\n```", - perLanguage: { - typescript: { - method: 'client.settings.taxRates.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicTaxRateGroup of client.settings.taxRates.list()) {\n console.log(publicTaxRateGroup.id);\n}", - }, - python: { - method: 'settings.tax_rates.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.tax_rates.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'settings().taxRates().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateListPage;\nimport com.hubspot.sdk.models.settings.taxrates.TaxRateListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n TaxRateListPage page = client.settings().taxRates().list();\n }\n}', - }, - go: { - method: 'client.Settings.TaxRates.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.TaxRates.List(context.TODO(), settings.TaxRateListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'settings.tax_rates.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.tax_rates.list\n\nputs(page)', - }, - php: { - method: 'settings->taxRates->list', - example: - "settings->taxRates->list(\n active: true, after: 'after', limit: 0\n);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/tax-rates/2026-03/tax-rates \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'create', - endpoint: '/settings/users/2026-03', - httpMethod: 'post', - summary: '', - description: '', - stainlessPath: '(resource) settings.users > (method) create', - qualified: 'client.settings.users.create', - params: [ - 'email: string;', - 'sendWelcomeEmail: boolean;', - 'firstName?: string;', - 'lastName?: string;', - 'primaryTeamId?: string;', - 'roleId?: string;', - 'secondaryTeamIds?: string[];', - ], - response: - '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', - markdown: - "## create\n\n`client.settings.users.create(email: string, sendWelcomeEmail: boolean, firstName?: string, lastName?: string, primaryTeamId?: string, roleId?: string, secondaryTeamIds?: string[]): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**post** `/settings/users/2026-03`\n\n### Parameters\n\n- `email: string`\n The user's email.\n\n- `sendWelcomeEmail: boolean`\n Whether to send a welcome email.\n\n- `firstName?: string`\n The user's first name.\n\n- `lastName?: string`\n The user's last name.\n\n- `primaryTeamId?: string`\n The user's primary team.\n\n- `roleId?: string`\n The user's role.\n\n- `secondaryTeamIds?: string[]`\n The user's additional teams.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.create({ email: 'email', sendWelcomeEmail: true });\n\nconsole.log(publicUser);\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.create', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.create({ email: 'email', sendWelcomeEmail: true });\n\nconsole.log(publicUser.id);", - }, - python: { - method: 'settings.users.create', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.create(\n email="email",\n send_welcome_email=True,\n)\nprint(public_user.id)', - }, - java: { - method: 'settings().users().create', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.UserProvisionRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserProvisionRequest params = UserProvisionRequest.builder()\n .email("email")\n .sendWelcomeEmail(true)\n .build();\n PublicUser publicUser = client.settings().users().create(params);\n }\n}', - }, - go: { - method: 'client.Settings.Users.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.New(context.TODO(), settings.UserNewParams{\n\t\tUserProvisionRequest: settings.UserProvisionRequestParam{\n\t\t\tEmail: "email",\n\t\t\tSendWelcomeEmail: true,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', - }, - ruby: { - method: 'settings.users.create', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.create(email: "email", send_welcome_email: true)\n\nputs(public_user)', - }, - php: { - method: 'settings->users->create', - example: - "settings->users->create(\n email: 'email',\n sendWelcomeEmail: true,\n firstName: 'firstName',\n lastName: 'lastName',\n primaryTeamID: 'primaryTeamId',\n roleID: 'roleId',\n secondaryTeamIDs: ['string'],\n);\n\nvar_dump($publicUser);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03 \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "email": "email",\n "sendWelcomeEmail": true\n }\'', - }, - }, - }, - { - name: 'delete', - endpoint: '/settings/users/2026-03/{userId}', - httpMethod: 'delete', - summary: 'Removes a user', - description: - "Removes a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", - stainlessPath: '(resource) settings.users > (method) delete', - qualified: 'client.settings.users.delete', - params: ['userId: string;', "idProperty?: 'EMAIL' | 'USER_ID';"], - markdown: - "## delete\n\n`client.settings.users.delete(userId: string, idProperty?: 'EMAIL' | 'USER_ID'): void`\n\n**delete** `/settings/users/2026-03/{userId}`\n\nRemoves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.settings.users.delete('userId')\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.delete', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.settings.users.delete('userId');", - }, - python: { - method: 'settings.users.delete', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.settings.users.delete(\n user_id="userId",\n)', - }, - java: { - method: 'settings().users().delete', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.UserDeleteParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.settings().users().delete("userId");\n }\n}', - }, - go: { - method: 'client.Settings.Users.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Settings.Users.Delete(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'settings.users.delete', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.settings.users.delete("userId")\n\nputs(result)', - }, - php: { - method: 'settings->users->delete', - example: - "settings->users->delete('userId', idProperty: 'EMAIL');\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get', - endpoint: '/settings/users/2026-03/{userId}', - httpMethod: 'get', - summary: 'Retrieves a user', - description: - "Retrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", - stainlessPath: '(resource) settings.users > (method) get', - qualified: 'client.settings.users.get', - params: ['userId: string;', "idProperty?: 'EMAIL' | 'USER_ID';"], - response: - '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', - markdown: - "## get\n\n`client.settings.users.get(userId: string, idProperty?: 'EMAIL' | 'USER_ID'): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**get** `/settings/users/2026-03/{userId}`\n\nRetrieves a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.get('userId');\n\nconsole.log(publicUser);\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.get', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.get('userId');\n\nconsole.log(publicUser.id);", - }, - python: { - method: 'settings.users.get', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.get(\n user_id="userId",\n)\nprint(public_user.id)', - }, - java: { - method: 'settings().users().get', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.UserGetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PublicUser publicUser = client.settings().users().get("userId");\n }\n}', - }, - go: { - method: 'client.Settings.Users.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.Get(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', - }, - ruby: { - method: 'settings.users.get', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.get("userId")\n\nputs(public_user)', - }, - php: { - method: 'settings->users->get', - example: - "settings->users->get('userId', idProperty: 'EMAIL');\n\nvar_dump($publicUser);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list', - endpoint: '/settings/users/2026-03', - httpMethod: 'get', - summary: '', - description: '', - stainlessPath: '(resource) settings.users > (method) list', - qualified: 'client.settings.users.list', - params: ['after?: string;', 'limit?: number;'], - response: - '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', - markdown: - "## list\n\n`client.settings.users.list(after?: string, limit?: number): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**get** `/settings/users/2026-03`\n\n### Parameters\n\n- `after?: string`\n The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.\n\n- `limit?: number`\n The maximum number of results to display per page.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// Automatically fetches more pages as needed.\nfor await (const publicUser of client.settings.users.list()) {\n console.log(publicUser);\n}\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.list', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const publicUser of client.settings.users.list()) {\n console.log(publicUser.id);\n}", - }, - python: { - method: 'settings.users.list', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npage = client.settings.users.list()\npage = page.results[0]\nprint(page.id)', - }, - java: { - method: 'settings().users().list', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.UserListPage;\nimport com.hubspot.sdk.models.settings.users.UserListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserListPage page = client.settings().users().list();\n }\n}', - }, - go: { - method: 'client.Settings.Users.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Settings.Users.List(context.TODO(), settings.UserListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'settings.users.list', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npage = hubspot.settings.users.list\n\nputs(page)', - }, - php: { - method: 'settings->users->list', - example: - "settings->users->list(after: 'after', limit: 0);\n\nvar_dump($page);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_roles', - endpoint: '/settings/users/2026-03/roles', - httpMethod: 'get', - summary: 'Retrieves the roles on an account', - description: 'Retrieves the roles on an account', - stainlessPath: '(resource) settings.users > (method) list_roles', - qualified: 'client.settings.users.listRoles', - response: '{ results: { id: string; name: string; requiresBillingWrite: boolean; }[]; }', - markdown: - "## list_roles\n\n`client.settings.users.listRoles(): { results: public_permission_set[]; }`\n\n**get** `/settings/users/2026-03/roles`\n\nRetrieves the roles on an account\n\n### Returns\n\n- `{ results: { id: string; name: string; requiresBillingWrite: boolean; }[]; }`\n\n - `results: { id: string; name: string; requiresBillingWrite: boolean; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicPermissionSetNoPaging = await client.settings.users.listRoles();\n\nconsole.log(collectionResponsePublicPermissionSetNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.listRoles', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicPermissionSetNoPaging = await client.settings.users.listRoles();\n\nconsole.log(collectionResponsePublicPermissionSetNoPaging.results);", - }, - python: { - method: 'settings.users.list_roles', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_permission_set_no_paging = client.settings.users.list_roles()\nprint(collection_response_public_permission_set_no_paging.results)', - }, - java: { - method: 'settings().users().listRoles', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.CollectionResponsePublicPermissionSetNoPaging;\nimport com.hubspot.sdk.models.settings.users.UserListRolesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicPermissionSetNoPaging collectionResponsePublicPermissionSetNoPaging = client.settings().users().listRoles();\n }\n}', - }, - go: { - method: 'client.Settings.Users.ListRoles', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicPermissionSetNoPaging, err := client.Settings.Users.ListRoles(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicPermissionSetNoPaging.Results)\n}\n', - }, - ruby: { - method: 'settings.users.list_roles', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_permission_set_no_paging = hubspot.settings.users.list_roles\n\nputs(collection_response_public_permission_set_no_paging)', - }, - php: { - method: 'settings->users->listRoles', - example: - "settings\n ->users\n ->listRoles();\n\nvar_dump($collectionResponsePublicPermissionSetNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03/roles \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_teams', - endpoint: '/settings/users/2026-03/teams', - httpMethod: 'get', - summary: "See details about this account's teams", - description: 'View teams for this account', - stainlessPath: '(resource) settings.users > (method) list_teams', - qualified: 'client.settings.users.listTeams', - response: '{ results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]; }', - markdown: - "## list_teams\n\n`client.settings.users.listTeams(): { results: public_team[]; }`\n\n**get** `/settings/users/2026-03/teams`\n\nView teams for this account\n\n### Returns\n\n- `{ results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]; }`\n\n - `results: { id: string; name: string; secondaryUserIds: string[]; userIds: string[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponsePublicTeamNoPaging = await client.settings.users.listTeams();\n\nconsole.log(collectionResponsePublicTeamNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.listTeams', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponsePublicTeamNoPaging = await client.settings.users.listTeams();\n\nconsole.log(collectionResponsePublicTeamNoPaging.results);", - }, - python: { - method: 'settings.users.list_teams', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_public_team_no_paging = client.settings.users.list_teams()\nprint(collection_response_public_team_no_paging.results)', - }, - java: { - method: 'settings().users().listTeams', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.CollectionResponsePublicTeamNoPaging;\nimport com.hubspot.sdk.models.settings.users.UserListTeamsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponsePublicTeamNoPaging collectionResponsePublicTeamNoPaging = client.settings().users().listTeams();\n }\n}', - }, - go: { - method: 'client.Settings.Users.ListTeams', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponsePublicTeamNoPaging, err := client.Settings.Users.ListTeams(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponsePublicTeamNoPaging.Results)\n}\n', - }, - ruby: { - method: 'settings.users.list_teams', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_public_team_no_paging = hubspot.settings.users.list_teams\n\nputs(collection_response_public_team_no_paging)', - }, - php: { - method: 'settings->users->listTeams', - example: - "settings->users->listTeams();\n\nvar_dump($collectionResponsePublicTeamNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/settings/users/2026-03/teams \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update', - endpoint: '/settings/users/2026-03/{userId}', - httpMethod: 'put', - summary: 'Modifies a user', - description: - "Modifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.", - stainlessPath: '(resource) settings.users > (method) update', - qualified: 'client.settings.users.update', - params: [ - 'userId: string;', - "idProperty?: 'EMAIL' | 'USER_ID';", - 'firstName?: string;', - 'lastName?: string;', - 'primaryTeamId?: string;', - 'roleId?: string;', - 'secondaryTeamIds?: string[];', - ], - response: - '{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }', - markdown: - "## update\n\n`client.settings.users.update(userId: string, idProperty?: 'EMAIL' | 'USER_ID', firstName?: string, lastName?: string, primaryTeamId?: string, roleId?: string, secondaryTeamIds?: string[]): { id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n**put** `/settings/users/2026-03/{userId}`\n\nModifies a user identified by `userId`. `userId` refers to the user's ID by default, or optionally email as specified by the `IdProperty` query param.\n\n### Parameters\n\n- `userId: string`\n\n- `idProperty?: 'EMAIL' | 'USER_ID'`\n\n- `firstName?: string`\n The first name of the user.\n\n- `lastName?: string`\n The last name of the user.\n\n- `primaryTeamId?: string`\n The user's primary team.\n\n- `roleId?: string`\n The user's role.\n\n- `secondaryTeamIds?: string[]`\n The user's additional teams.\n\n### Returns\n\n- `{ id: string; email: string; roleIds: string[]; superAdmin: boolean; firstName?: string; lastName?: string; primaryTeamId?: string; roleId?: string; secondaryTeamIds?: string[]; sendWelcomeEmail?: boolean; }`\n\n - `id: string`\n - `email: string`\n - `roleIds: string[]`\n - `superAdmin: boolean`\n - `firstName?: string`\n - `lastName?: string`\n - `primaryTeamId?: string`\n - `roleId?: string`\n - `secondaryTeamIds?: string[]`\n - `sendWelcomeEmail?: boolean`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst publicUser = await client.settings.users.update('userId');\n\nconsole.log(publicUser);\n```", - perLanguage: { - typescript: { - method: 'client.settings.users.update', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst publicUser = await client.settings.users.update('userId');\n\nconsole.log(publicUser.id);", - }, - python: { - method: 'settings.users.update', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\npublic_user = client.settings.users.update(\n user_id="userId",\n)\nprint(public_user.id)', - }, - java: { - method: 'settings().users().update', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.settings.users.PublicUser;\nimport com.hubspot.sdk.models.settings.users.PublicUserUpdate;\nimport com.hubspot.sdk.models.settings.users.UserUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UserUpdateParams params = UserUpdateParams.builder()\n .userId("userId")\n .publicUserUpdate(PublicUserUpdate.builder().build())\n .build();\n PublicUser publicUser = client.settings().users().update(params);\n }\n}', - }, - go: { - method: 'client.Settings.Users.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/settings"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpublicUser, err := client.Settings.Users.Update(\n\t\tcontext.TODO(),\n\t\t"userId",\n\t\tsettings.UserUpdateParams{\n\t\t\tPublicUserUpdate: settings.PublicUserUpdateParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", publicUser.ID)\n}\n', - }, - ruby: { - method: 'settings.users.update', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\npublic_user = hubspot.settings.users.update("userId")\n\nputs(public_user)', - }, - php: { - method: 'settings->users->update', - example: - "settings->users->update(\n 'userId',\n idProperty: 'EMAIL',\n firstName: 'firstName',\n lastName: 'lastName',\n primaryTeamID: 'primaryTeamId',\n roleID: 'roleId',\n secondaryTeamIDs: ['string'],\n);\n\nvar_dump($publicUser);", - }, - http: { - example: - "curl https://api.hubapi.com/settings/users/2026-03/$USER_ID \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create_batch_event_subscriptions', - endpoint: '/webhooks/2026-03/{appId}/subscriptions/batch/update', - httpMethod: 'post', - summary: 'Batch create event subscriptions', - description: 'Batch create event subscriptions for the specified app.', - stainlessPath: '(resource) webhooks > (method) create_batch_event_subscriptions', - qualified: 'client.webhooks.createBatchEventSubscriptions', - params: ['appId: number;', 'inputs: { id: number; active: boolean; }[];'], - response: - "{ completedAt: string; results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## create_batch_event_subscriptions\n\n`client.webhooks.createBatchEventSubscriptions(appId: number, inputs: { id: number; active: boolean; }[]): { completedAt: string; results: subscription_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks/2026-03/{appId}/subscriptions/batch/update`\n\nBatch create event subscriptions for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `inputs: { id: number; active: boolean; }[]`\n An array of SubscriptionBatchUpdateRequest objects, each representing a subscription to be updated. This property is required.\n\n### Returns\n\n- `{ completedAt: string; results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseSubscriptionResponse = await client.webhooks.createBatchEventSubscriptions(0, { inputs: [{ id: 0, active: true }] });\n\nconsole.log(batchResponseSubscriptionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.createBatchEventSubscriptions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseSubscriptionResponse = await client.webhooks.createBatchEventSubscriptions(0, {\n inputs: [{ id: 0, active: true }],\n});\n\nconsole.log(batchResponseSubscriptionResponse.completedAt);", - }, - python: { - method: 'webhooks.create_batch_event_subscriptions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_subscription_response = client.webhooks.create_batch_event_subscriptions(\n app_id=0,\n inputs=[{\n "id": 0,\n "active": True,\n }],\n)\nprint(batch_response_subscription_response.completed_at)', - }, - java: { - method: 'webhooks().createBatchEventSubscriptions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchInputSubscriptionBatchUpdateRequest;\nimport com.hubspot.sdk.models.webhooks.BatchResponseSubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.SubscriptionBatchUpdateRequest;\nimport com.hubspot.sdk.models.webhooks.WebhookCreateBatchEventSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookCreateBatchEventSubscriptionsParams params = WebhookCreateBatchEventSubscriptionsParams.builder()\n .appId(0)\n .batchInputSubscriptionBatchUpdateRequest(BatchInputSubscriptionBatchUpdateRequest.builder()\n .addInput(SubscriptionBatchUpdateRequest.builder()\n .id(0)\n .active(true)\n .build())\n .build())\n .build();\n BatchResponseSubscriptionResponse batchResponseSubscriptionResponse = client.webhooks().createBatchEventSubscriptions(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.NewBatchEventSubscriptions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseSubscriptionResponse, err := client.Webhooks.NewBatchEventSubscriptions(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookNewBatchEventSubscriptionsParams{\n\t\t\tBatchInputSubscriptionBatchUpdateRequest: webhooks.BatchInputSubscriptionBatchUpdateRequestParam{\n\t\t\t\tInputs: []webhooks.SubscriptionBatchUpdateRequestParam{{\n\t\t\t\t\tID: 0,\n\t\t\t\t\tActive: true,\n\t\t\t\t}},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseSubscriptionResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.create_batch_event_subscriptions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_subscription_response = hubspot.webhooks.create_batch_event_subscriptions(0, inputs: [{id: 0, active: true}])\n\nputs(batch_response_subscription_response)', - }, - php: { - method: 'webhooks->createBatchEventSubscriptions', - example: - "webhooks\n ->createBatchEventSubscriptions(0, inputs: [['id' => 0, 'active' => true]]);\n\nvar_dump($batchResponseSubscriptionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/batch/update \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n {\n "id": 0,\n "active": true\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_crm_snapshots', - endpoint: '/webhooks-journal/snapshots/2026-03/crm', - httpMethod: 'post', - summary: 'Create Snapshot', - description: - 'Create a batch of CRM object snapshots for the specified portal. This endpoint allows you to capture the state of CRM objects at a specific point in time, which can be useful for auditing or historical analysis. The request requires a list of CRM object snapshot requests, each specifying the portal ID, object ID, object type ID, and properties to include in the snapshot.', - stainlessPath: '(resource) webhooks > (method) create_crm_snapshots', - qualified: 'client.webhooks.createCrmSnapshots', - params: [ - 'snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[];', - ], - response: - '{ snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]; }', - markdown: - "## create_crm_snapshots\n\n`client.webhooks.createCrmSnapshots(snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[]): { snapshotResponses: crm_object_snapshot_response[]; }`\n\n**post** `/webhooks-journal/snapshots/2026-03/crm`\n\nCreate a batch of CRM object snapshots for the specified portal. This endpoint allows you to capture the state of CRM objects at a specific point in time, which can be useful for auditing or historical analysis. The request requires a list of CRM object snapshot requests, each specifying the portal ID, object ID, object type ID, and properties to include in the snapshot.\n\n### Parameters\n\n- `snapshotRequests: { objectId: number; objectTypeId: string; portalId: number; properties: string[]; }[]`\n An array of CrmObjectSnapshotRequest objects, each representing a request to create a snapshot for a specific CRM object. This property is required.\n\n### Returns\n\n- `{ snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]; }`\n\n - `snapshotResponses: { objectId: number; objectTypeId: string; portalId: number; snapshotStatusId: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst crmObjectSnapshotBatchResponse = await client.webhooks.createCrmSnapshots({ snapshotRequests: [{\n objectId: 0,\n objectTypeId: 'objectTypeId',\n portalId: 0,\n properties: ['string'],\n}] });\n\nconsole.log(crmObjectSnapshotBatchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.createCrmSnapshots', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst crmObjectSnapshotBatchResponse = await client.webhooks.createCrmSnapshots({\n snapshotRequests: [\n {\n objectId: 0,\n objectTypeId: 'objectTypeId',\n portalId: 0,\n properties: ['string'],\n },\n ],\n});\n\nconsole.log(crmObjectSnapshotBatchResponse.snapshotResponses);", - }, - python: { - method: 'webhooks.create_crm_snapshots', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncrm_object_snapshot_batch_response = client.webhooks.create_crm_snapshots(\n snapshot_requests=[{\n "object_id": 0,\n "object_type_id": "objectTypeId",\n "portal_id": 0,\n "properties": ["string"],\n }],\n)\nprint(crm_object_snapshot_batch_response.snapshot_responses)', - }, - java: { - method: 'webhooks().createCrmSnapshots', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotBatchRequest;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotBatchResponse;\nimport com.hubspot.sdk.models.webhooks.CrmObjectSnapshotRequest;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CrmObjectSnapshotBatchRequest params = CrmObjectSnapshotBatchRequest.builder()\n .addSnapshotRequest(CrmObjectSnapshotRequest.builder()\n .objectId(0L)\n .objectTypeId("objectTypeId")\n .portalId(0L)\n .addProperty("string")\n .build())\n .build();\n CrmObjectSnapshotBatchResponse crmObjectSnapshotBatchResponse = client.webhooks().createCrmSnapshots(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.NewCrmSnapshots', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcrmObjectSnapshotBatchResponse, err := client.Webhooks.NewCrmSnapshots(context.TODO(), webhooks.WebhookNewCrmSnapshotsParams{\n\t\tCrmObjectSnapshotBatchRequest: webhooks.CrmObjectSnapshotBatchRequestParam{\n\t\t\tSnapshotRequests: []webhooks.CrmObjectSnapshotRequestParam{{\n\t\t\t\tObjectID: 0,\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tPortalID: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t}},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", crmObjectSnapshotBatchResponse.SnapshotResponses)\n}\n', - }, - ruby: { - method: 'webhooks.create_crm_snapshots', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncrm_object_snapshot_batch_response = hubspot.webhooks.create_crm_snapshots(\n snapshot_requests: [{objectId: 0, objectTypeId: "objectTypeId", portalId: 0, properties: ["string"]}]\n)\n\nputs(crm_object_snapshot_batch_response)', - }, - php: { - method: 'webhooks->createCrmSnapshots', - example: - "webhooks->createCrmSnapshots(\n snapshotRequests: [\n [\n 'objectID' => 0,\n 'objectTypeID' => 'objectTypeId',\n 'portalID' => 0,\n 'properties' => ['string'],\n ],\n ],\n);\n\nvar_dump($crmObjectSnapshotBatchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/snapshots/2026-03/crm \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "snapshotRequests": [\n {\n "objectId": 0,\n "objectTypeId": "objectTypeId",\n "portalId": 0,\n "properties": [\n "string"\n ]\n }\n ]\n }\'', - }, - }, - }, - { - name: 'create_event_subscription', - endpoint: '/webhooks/2026-03/{appId}/subscriptions', - httpMethod: 'post', - summary: 'Create an event subscription', - description: 'Create new event subscription for the specified app.', - stainlessPath: '(resource) webhooks > (method) create_event_subscription', - qualified: 'client.webhooks.createEventSubscription', - params: [ - 'appId: number;', - 'active: boolean;', - 'eventType: string;', - 'eventTypeName?: string;', - 'objectTypeId?: string;', - 'propertyName?: string;', - ], - response: - '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', - markdown: - "## create_event_subscription\n\n`client.webhooks.createEventSubscription(appId: number, active: boolean, eventType: string, eventTypeName?: string, objectTypeId?: string, propertyName?: string): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**post** `/webhooks/2026-03/{appId}/subscriptions`\n\nCreate new event subscription for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `active: boolean`\n A boolean indicating whether the subscription is active.\n\n- `eventType: string`\n A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.\n\n- `eventTypeName?: string`\n A string providing a human-readable name for the event type.\n\n- `objectTypeId?: string`\n A string representing the ID of the object type associated with the subscription.\n\n- `propertyName?: string`\n A string indicating the specific property name related to the event type, if applicable.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.createEventSubscription(0, { active: true, eventType: 'company.associationChange' });\n\nconsole.log(subscriptionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.createEventSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.createEventSubscription(0, {\n active: true,\n eventType: 'company.associationChange',\n});\n\nconsole.log(subscriptionResponse.id);", - }, - python: { - method: 'webhooks.create_event_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.create_event_subscription(\n app_id=0,\n active=True,\n event_type="company.associationChange",\n)\nprint(subscription_response.id)', - }, - java: { - method: 'webhooks().createEventSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionCreateRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookCreateEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookCreateEventSubscriptionParams params = WebhookCreateEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionCreateRequest(SubscriptionCreateRequest.builder()\n .active(true)\n .eventType(SubscriptionCreateRequest.EventType.COMPANY_ASSOCIATION_CHANGE)\n .build())\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().createEventSubscription(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.NewEventSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.NewEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookNewEventSubscriptionParams{\n\t\t\tSubscriptionCreateRequest: webhooks.SubscriptionCreateRequestParam{\n\t\t\t\tActive: true,\n\t\t\t\tEventType: webhooks.SubscriptionCreateRequestEventTypeCompanyAssociationChange,\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.create_event_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.create_event_subscription(0, active: true, event_type: :"company.associationChange")\n\nputs(subscription_response)', - }, - php: { - method: 'webhooks->createEventSubscription', - example: - "webhooks->createEventSubscription(\n 0,\n active: true,\n eventType: 'company.associationChange',\n eventTypeName: 'eventTypeName',\n objectTypeID: 'objectTypeId',\n propertyName: 'propertyName',\n);\n\nvar_dump($subscriptionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "active": true,\n "eventType": "company.associationChange"\n }\'', - }, - }, - }, - { - name: 'create_journal_subscription', - endpoint: '/webhooks-journal/subscriptions/2026-03', - httpMethod: 'post', - summary: 'Create Subscription', - description: - 'Create a new webhook subscription for the specified portal in the HubSpot account. This endpoint allows you to define the subscription details, including the types of events you want to subscribe to. The request body must include the necessary subscription information as defined by the SubscriptionUpsertRequest schema.', - stainlessPath: '(resource) webhooks > (method) create_journal_subscription', - qualified: 'client.webhooks.createJournalSubscription', - params: [ - 'subscription_upsert_request: { actions: string[]; objectIds: number[]; objectTypeId: string; portalId: number; properties: string[]; subscriptionType: string; } | { actions: string[]; associatedObjectTypeIds: string[]; objectIds: number[]; objectTypeId: string; portalId: number; subscriptionType: string; } | { eventTypeId: string; properties: string[]; subscriptionType: string; } | { actions: string[]; listIds: number[]; objectIds: number[]; portalId: number; subscriptionType: string; } | { actions: string[]; objectTypeId: string; portalId: number; subscriptionType: string; };', - ], - response: - '{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }', - perLanguage: { - typescript: { - method: 'client.webhooks.createJournalSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse1 = await client.webhooks.createJournalSubscription();\n\nconsole.log(subscriptionResponse1.id);", - }, - python: { - method: 'webhooks.create_journal_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response_1 = client.webhooks.create_journal_subscription()\nprint(subscription_response_1.id)', - }, - java: { - method: 'webhooks().createJournalSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.AppLifecycleEventSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.AssociationSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.GdprPrivacyDeletionSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.ListMembershipSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.ObjectSubscriptionUpsertRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse1;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ObjectSubscriptionUpsertRequest params = ObjectSubscriptionUpsertRequest.builder()\n .addAction(ObjectSubscriptionUpsertRequest.Action.CREATE)\n .addObjectId(0L)\n .objectTypeId("objectTypeId")\n .portalId(0L)\n .addProperty("string")\n .subscriptionType(ObjectSubscriptionUpsertRequest.SubscriptionType.OBJECT)\n .build();\n SubscriptionResponse1 subscriptionResponse1 = client.webhooks().createJournalSubscription(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.NewJournalSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse1, err := client.Webhooks.NewJournalSubscription(context.TODO(), webhooks.WebhookNewJournalSubscriptionParams{\n\t\tSubscriptionUpsertRequest: webhooks.SubscriptionUpsertRequestUnionParam{\n\t\t\tOfObjectSubscriptionUpsertRequest: &webhooks.ObjectSubscriptionUpsertRequestParam{\n\t\t\t\tActions: []string{"CREATE"},\n\t\t\t\tObjectIDs: []int64{0},\n\t\t\t\tObjectTypeID: "objectTypeId",\n\t\t\t\tPortalID: 0,\n\t\t\t\tProperties: []string{"string"},\n\t\t\t\tSubscriptionType: webhooks.ObjectSubscriptionUpsertRequestSubscriptionTypeObject,\n\t\t\t},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse1.ID)\n}\n', - }, - ruby: { - method: 'webhooks.create_journal_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response_1 = hubspot.webhooks.create_journal_subscription(\n subscription_upsert_request: {\n actions: [:CREATE],\n objectIds: [0],\n objectTypeId: "objectTypeId",\n portalId: 0,\n properties: ["string"],\n subscriptionType: :OBJECT\n }\n)\n\nputs(subscription_response_1)', - }, - php: { - method: 'webhooks->createJournalSubscription', - example: - "webhooks->createJournalSubscription();\n\nvar_dump($subscriptionResponse1);", - }, - http: { - example: - "curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03 \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'create_subscription_filter', - endpoint: '/webhooks-journal/subscriptions/2026-03/filters', - httpMethod: 'post', - summary: 'Create Filter', - description: - 'Create a new filter for a webhook subscription in your HubSpot account. This endpoint allows you to define specific conditions that a webhook event must meet to trigger the subscription. It is useful for managing and customizing the behavior of webhook subscriptions based on specific criteria.', - stainlessPath: '(resource) webhooks > (method) create_subscription_filter', - qualified: 'client.webhooks.createSubscriptionFilter', - params: [ - "filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; };", - 'subscriptionId: number;', - ], - response: '{ filterId: number; }', - markdown: - "## create_subscription_filter\n\n`client.webhooks.createSubscriptionFilter(filter: { conditions: condition[]; }, subscriptionId: number): { filterId: number; }`\n\n**post** `/webhooks-journal/subscriptions/2026-03/filters`\n\nCreate a new filter for a webhook subscription in your HubSpot account. This endpoint allows you to define specific conditions that a webhook event must meet to trigger the subscription. It is useful for managing and customizing the behavior of webhook subscriptions based on specific criteria.\n\n### Parameters\n\n- `filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; }`\n Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. \n - `conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]`\n An array of conditions that define the criteria for the filter. Each condition specifies a property, an operator, and optionally a value or values.\n\n- `subscriptionId: number`\n The unique identifier of the subscription to which the filter will be applied. It is an integer formatted as int64.\n\n### Returns\n\n- `{ filterId: number; }`\n\n - `filterId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterCreateResponse = await client.webhooks.createSubscriptionFilter({\n filter: { conditions: [{\n filterType: 'CRM_OBJECT_PROPERTY',\n operator: 'CONTAINS',\n property: 'property',\n}] },\n subscriptionId: 0,\n});\n\nconsole.log(filterCreateResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.createSubscriptionFilter', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterCreateResponse = await client.webhooks.createSubscriptionFilter({\n filter: {\n conditions: [\n {\n filterType: 'CRM_OBJECT_PROPERTY',\n operator: 'CONTAINS',\n property: 'property',\n },\n ],\n },\n subscriptionId: 0,\n});\n\nconsole.log(filterCreateResponse.filterId);", - }, - python: { - method: 'webhooks.create_subscription_filter', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_create_response = client.webhooks.create_subscription_filter(\n filter={\n "conditions": [{\n "filter_type": "CRM_OBJECT_PROPERTY",\n "operator": "CONTAINS",\n "property": "property",\n }]\n },\n subscription_id=0,\n)\nprint(filter_create_response.filter_id)', - }, - java: { - method: 'webhooks().createSubscriptionFilter', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.Condition;\nimport com.hubspot.sdk.models.webhooks.Filter;\nimport com.hubspot.sdk.models.webhooks.FilterCreateRequest;\nimport com.hubspot.sdk.models.webhooks.FilterCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FilterCreateRequest params = FilterCreateRequest.builder()\n .filter(Filter.builder()\n .addCondition(Condition.builder()\n .filterType(Condition.FilterType.CRM_OBJECT_PROPERTY)\n .operator(Condition.Operator.CONTAINS)\n .property("property")\n .build())\n .build())\n .subscriptionId(0L)\n .build();\n FilterCreateResponse filterCreateResponse = client.webhooks().createSubscriptionFilter(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.NewSubscriptionFilter', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterCreateResponse, err := client.Webhooks.NewSubscriptionFilter(context.TODO(), webhooks.WebhookNewSubscriptionFilterParams{\n\t\tFilterCreateRequest: webhooks.FilterCreateRequestParam{\n\t\t\tFilter: webhooks.FilterParam{\n\t\t\t\tConditions: []webhooks.ConditionParam{{\n\t\t\t\t\tFilterType: webhooks.ConditionFilterTypeCrmObjectProperty,\n\t\t\t\t\tOperator: webhooks.ConditionOperatorContains,\n\t\t\t\t\tProperty: "property",\n\t\t\t\t}},\n\t\t\t},\n\t\t\tSubscriptionID: 0,\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterCreateResponse.FilterID)\n}\n', - }, - ruby: { - method: 'webhooks.create_subscription_filter', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_create_response = hubspot.webhooks.create_subscription_filter(\n filter: {conditions: [{filterType: :CRM_OBJECT_PROPERTY, operator: :CONTAINS, property: "property"}]},\n subscription_id: 0\n)\n\nputs(filter_create_response)', - }, - php: { - method: 'webhooks->createSubscriptionFilter', - example: - "webhooks->createSubscriptionFilter(\n filter: [\n 'conditions' => [\n [\n 'filterType' => 'CRM_OBJECT_PROPERTY',\n 'operator' => 'CONTAINS',\n 'property' => 'property',\n 'value' => 'value',\n 'values' => ['string'],\n ],\n ],\n ],\n subscriptionID: 0,\n);\n\nvar_dump($filterCreateResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "filter": {\n "conditions": [\n {\n "filterType": "CRM_OBJECT_PROPERTY",\n "operator": "CONTAINS",\n "property": "property"\n }\n ]\n },\n "subscriptionId": 0\n }\'', - }, - }, - }, - { - name: 'delete_event_subscription', - endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - httpMethod: 'delete', - summary: 'Delete event subscription', - description: 'Delete an existing event subscription by ID.', - stainlessPath: '(resource) webhooks > (method) delete_event_subscription', - qualified: 'client.webhooks.deleteEventSubscription', - params: ['appId: number;', 'subscriptionId: number;'], - markdown: - "## delete_event_subscription\n\n`client.webhooks.deleteEventSubscription(appId: number, subscriptionId: number): void`\n\n**delete** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nDelete an existing event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteEventSubscription(0, { appId: 0 })\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.deleteEventSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteEventSubscription(0, { appId: 0 });", - }, - python: { - method: 'webhooks.delete_event_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_event_subscription(\n subscription_id=0,\n app_id=0,\n)', - }, - java: { - method: 'webhooks().deleteEventSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookDeleteEventSubscriptionParams params = WebhookDeleteEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .build();\n client.webhooks().deleteEventSubscription(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.DeleteEventSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookDeleteEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'webhooks.delete_event_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_event_subscription(0, app_id: 0)\n\nputs(result)', - }, - php: { - method: 'webhooks->deleteEventSubscription', - example: - "webhooks->deleteEventSubscription(0, appID: 0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_journal_subscription', - endpoint: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', - httpMethod: 'delete', - summary: 'Delete subscription', - description: - 'Delete a specific webhook journal subscription using its unique identifier. This operation is useful for managing and cleaning up subscriptions that are no longer needed or relevant.', - stainlessPath: '(resource) webhooks > (method) delete_journal_subscription', - qualified: 'client.webhooks.deleteJournalSubscription', - params: ['subscriptionId: number;'], - markdown: - "## delete_journal_subscription\n\n`client.webhooks.deleteJournalSubscription(subscriptionId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/{subscriptionId}`\n\nDelete a specific webhook journal subscription using its unique identifier. This operation is useful for managing and cleaning up subscriptions that are no longer needed or relevant.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteJournalSubscription(0)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.deleteJournalSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteJournalSubscription(0);", - }, - python: { - method: 'webhooks.delete_journal_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_journal_subscription(\n 0,\n)', - }, - java: { - method: 'webhooks().deleteJournalSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteJournalSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteJournalSubscription(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.DeleteJournalSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteJournalSubscription(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'webhooks.delete_journal_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_journal_subscription(0)\n\nputs(result)', - }, - php: { - method: 'webhooks->deleteJournalSubscription', - example: - "webhooks->deleteJournalSubscription(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/$SUBSCRIPTION_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_journal_subscription_for_portal', - endpoint: '/webhooks-journal/subscriptions/2026-03/portals/{portalId}', - httpMethod: 'delete', - summary: 'Delete subscription', - description: - 'Delete a webhook journal subscription for a specific portal. This operation removes the subscription associated with the given portalId, and no content is returned upon successful deletion.', - stainlessPath: '(resource) webhooks > (method) delete_journal_subscription_for_portal', - qualified: 'client.webhooks.deleteJournalSubscriptionForPortal', - params: ['portalId: number;'], - markdown: - "## delete_journal_subscription_for_portal\n\n`client.webhooks.deleteJournalSubscriptionForPortal(portalId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/portals/{portalId}`\n\nDelete a webhook journal subscription for a specific portal. This operation removes the subscription associated with the given portalId, and no content is returned upon successful deletion.\n\n### Parameters\n\n- `portalId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteJournalSubscriptionForPortal(0)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.deleteJournalSubscriptionForPortal', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteJournalSubscriptionForPortal(0);", - }, - python: { - method: 'webhooks.delete_journal_subscription_for_portal', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_journal_subscription_for_portal(\n 0,\n)', - }, - java: { - method: 'webhooks().deleteJournalSubscriptionForPortal', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteJournalSubscriptionForPortalParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteJournalSubscriptionForPortal(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.DeleteJournalSubscriptionForPortal', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteJournalSubscriptionForPortal(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'webhooks.delete_journal_subscription_for_portal', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_journal_subscription_for_portal(0)\n\nputs(result)', - }, - php: { - method: 'webhooks->deleteJournalSubscriptionForPortal', - example: - "webhooks->deleteJournalSubscriptionForPortal(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/portals/$PORTAL_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_settings', - endpoint: '/webhooks/2026-03/{appId}/settings', - httpMethod: 'delete', - summary: 'Delete webhook settings', - description: - 'Delete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.', - stainlessPath: '(resource) webhooks > (method) delete_settings', - qualified: 'client.webhooks.deleteSettings', - params: ['appId: number;'], - markdown: - "## delete_settings\n\n`client.webhooks.deleteSettings(appId: number): void`\n\n**delete** `/webhooks/2026-03/{appId}/settings`\n\nDelete the webhook settings for the specified app. Event subscriptions will not be deleted, but will be paused until another webhook is created.\n\n### Parameters\n\n- `appId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteSettings(0)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.deleteSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteSettings(0);", - }, - python: { - method: 'webhooks.delete_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_settings(\n 0,\n)', - }, - java: { - method: 'webhooks().deleteSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteSettings(0);\n }\n}', - }, - go: { - method: 'client.Webhooks.DeleteSettings', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'webhooks.delete_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_settings(0)\n\nputs(result)', - }, - php: { - method: 'webhooks->deleteSettings', - example: - "webhooks->deleteSettings(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'delete_subscription_filter', - endpoint: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', - httpMethod: 'delete', - summary: 'Delete filter', - description: - 'Delete a specific filter associated with a webhook journal subscription. This operation is useful for managing and cleaning up filters that are no longer needed in your subscription setup. The endpoint requires the unique identifier of the filter to be deleted.', - stainlessPath: '(resource) webhooks > (method) delete_subscription_filter', - qualified: 'client.webhooks.deleteSubscriptionFilter', - params: ['filterId: number;'], - markdown: - "## delete_subscription_filter\n\n`client.webhooks.deleteSubscriptionFilter(filterId: number): void`\n\n**delete** `/webhooks-journal/subscriptions/2026-03/filters/{filterId}`\n\nDelete a specific filter associated with a webhook journal subscription. This operation is useful for managing and cleaning up filters that are no longer needed in your subscription setup. The endpoint requires the unique identifier of the filter to be deleted.\n\n### Parameters\n\n- `filterId: number`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nawait client.webhooks.deleteSubscriptionFilter(0)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.deleteSubscriptionFilter', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nawait client.webhooks.deleteSubscriptionFilter(0);", - }, - python: { - method: 'webhooks.delete_subscription_filter', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nclient.webhooks.delete_subscription_filter(\n 0,\n)', - }, - java: { - method: 'webhooks().deleteSubscriptionFilter', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.WebhookDeleteSubscriptionFilterParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n client.webhooks().deleteSubscriptionFilter(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.DeleteSubscriptionFilter', - example: - 'package main\n\nimport (\n\t"context"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\terr := client.Webhooks.DeleteSubscriptionFilter(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n', - }, - ruby: { - method: 'webhooks.delete_subscription_filter', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresult = hubspot.webhooks.delete_subscription_filter(0)\n\nputs(result)', - }, - php: { - method: 'webhooks->deleteSubscriptionFilter', - example: - "webhooks->deleteSubscriptionFilter(0);\n\nvar_dump($result);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/$FILTER_ID \\\n -X DELETE \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_earliest_journal_batch', - endpoint: '/webhooks-journal/journal/2026-03/batch/earliest/{count}', - httpMethod: 'get', - summary: 'Retrieve Batch', - description: - 'Retrieve the earliest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching historical webhook data in batches, allowing you to process or analyze the earliest entries first.', - stainlessPath: '(resource) webhooks > (method) get_earliest_journal_batch', - qualified: 'client.webhooks.getEarliestJournalBatch', - params: ['count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_earliest_journal_batch\n\n`client.webhooks.getEarliestJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/earliest/{count}`\n\nRetrieve the earliest batch of webhook journal entries up to the specified count. This endpoint is useful for fetching historical webhook data in batches, allowing you to process or analyze the earliest entries first.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the webhook journal entries by. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getEarliestJournalBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_earliest_journal_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_earliest_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getEarliestJournalBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getEarliestJournalBatch(1);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetEarliestJournalBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetEarliestJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetEarliestJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_earliest_journal_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_earliest_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getEarliestJournalBatch', - example: - "webhooks->getEarliestJournalBatch(\n 1, installPortalID: 0\n);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/earliest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_earliest_journal_entry', - endpoint: '/webhooks-journal/journal/2026-03/earliest', - httpMethod: 'get', - summary: 'Retrieve earliest', - description: - 'Retrieve the earliest entry from the webhooks journal for the specified version. This endpoint is useful for accessing the oldest records available in the journal, which can be helpful for auditing or historical data analysis.', - stainlessPath: '(resource) webhooks > (method) get_earliest_journal_entry', - qualified: 'client.webhooks.getEarliestJournalEntry', - params: ['installPortalId?: number;'], - response: 'string', - markdown: - "## get_earliest_journal_entry\n\n`client.webhooks.getEarliestJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/earliest`\n\nRetrieve the earliest entry from the webhooks journal for the specified version. This endpoint is useful for accessing the oldest records available in the journal, which can be helpful for auditing or historical data analysis.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries. It is an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getEarliestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getEarliestJournalEntry', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getEarliestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_earliest_journal_entry', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_earliest_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getEarliestJournalEntry', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getEarliestJournalEntry();\n }\n}', - }, - go: { - method: 'client.Webhooks.GetEarliestJournalEntry', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetEarliestJournalEntry(context.TODO(), webhooks.WebhookGetEarliestJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_earliest_journal_entry', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_earliest_journal_entry\n\nputs(response)', - }, - php: { - method: 'webhooks->getEarliestJournalEntry', - example: - "webhooks->getEarliestJournalEntry(installPortalID: 0);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/earliest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_earliest_local_journal_batch', - endpoint: '/webhooks-journal/journal-local/2026-03/batch/earliest/{count}', - httpMethod: 'get', - summary: 'Retrieve Batch', - description: - 'Retrieve the earliest batch of webhook journal entries based on the specified count. This endpoint is useful for fetching a specific number of the earliest entries in the webhook journal for analysis or processing.', - stainlessPath: '(resource) webhooks > (method) get_earliest_local_journal_batch', - qualified: 'client.webhooks.getEarliestLocalJournalBatch', - params: ['count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_earliest_local_journal_batch\n\n`client.webhooks.getEarliestLocalJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/earliest/{count}`\n\nRetrieve the earliest batch of webhook journal entries based on the specified count. This endpoint is useful for fetching a specific number of the earliest entries in the webhook journal for analysis or processing.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getEarliestLocalJournalBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getEarliestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_earliest_local_journal_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_earliest_local_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getEarliestLocalJournalBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestLocalJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getEarliestLocalJournalBatch(1);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetEarliestLocalJournalBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetEarliestLocalJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetEarliestLocalJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_earliest_local_journal_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_earliest_local_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getEarliestLocalJournalBatch', - example: - "webhooks\n ->getEarliestLocalJournalBatch(1, installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/earliest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_earliest_local_journal_entry', - endpoint: '/webhooks-journal/journal-local/2026-03/earliest', - httpMethod: 'get', - summary: 'Retrieve earliest', - description: - 'Retrieve the earliest entry from the webhooks journal for the specified portal. This endpoint is useful for accessing the oldest records in the journal, which can be helpful for auditing or tracking purposes.', - stainlessPath: '(resource) webhooks > (method) get_earliest_local_journal_entry', - qualified: 'client.webhooks.getEarliestLocalJournalEntry', - params: ['installPortalId?: number;'], - response: 'string', - markdown: - "## get_earliest_local_journal_entry\n\n`client.webhooks.getEarliestLocalJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/earliest`\n\nRetrieve the earliest entry from the webhooks journal for the specified portal. This endpoint is useful for accessing the oldest records in the journal, which can be helpful for auditing or tracking purposes.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries by. This parameter is optional and should be an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getEarliestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getEarliestLocalJournalEntry', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getEarliestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_earliest_local_journal_entry', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_earliest_local_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getEarliestLocalJournalEntry', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEarliestLocalJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getEarliestLocalJournalEntry();\n }\n}', - }, - go: { - method: 'client.Webhooks.GetEarliestLocalJournalEntry', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetEarliestLocalJournalEntry(context.TODO(), webhooks.WebhookGetEarliestLocalJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_earliest_local_journal_entry', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_earliest_local_journal_entry\n\nputs(response)', - }, - php: { - method: 'webhooks->getEarliestLocalJournalEntry', - example: - "webhooks->getEarliestLocalJournalEntry(installPortalID: 0);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/earliest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_event_subscription', - endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - httpMethod: 'get', - summary: 'Read an event subscription', - description: 'Retrieve a specific event subscription by ID.', - stainlessPath: '(resource) webhooks > (method) get_event_subscription', - qualified: 'client.webhooks.getEventSubscription', - params: ['appId: number;', 'subscriptionId: number;'], - response: - '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', - markdown: - "## get_event_subscription\n\n`client.webhooks.getEventSubscription(appId: number, subscriptionId: number): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**get** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nRetrieve a specific event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.getEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getEventSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.getEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse.id);", - }, - python: { - method: 'webhooks.get_event_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.get_event_subscription(\n subscription_id=0,\n app_id=0,\n)\nprint(subscription_response.id)', - }, - java: { - method: 'webhooks().getEventSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetEventSubscriptionParams params = WebhookGetEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().getEventSubscription(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetEventSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.GetEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookGetEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.get_event_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.get_event_subscription(0, app_id: 0)\n\nputs(subscription_response)', - }, - php: { - method: 'webhooks->getEventSubscription', - example: - "webhooks->getEventSubscription(0, appID: 0);\n\nvar_dump($subscriptionResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_journal_batch_by_request', - endpoint: '/webhooks-journal/journal/2026-03/batch/read', - httpMethod: 'post', - summary: 'Batch read', - description: - 'Perform a batch read operation on the webhooks journal for the specified date. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently.', - stainlessPath: '(resource) webhooks > (method) get_journal_batch_by_request', - qualified: 'client.webhooks.getJournalBatchByRequest', - params: ['inputs: string[];', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_journal_batch_by_request\n\n`client.webhooks.getJournalBatchByRequest(inputs: string[], installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks-journal/journal/2026-03/batch/read`\n\nPerform a batch read operation on the webhooks journal for the specified date. This endpoint allows you to retrieve multiple entries from the webhooks journal in a single request, which can be useful for processing large amounts of data efficiently.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This is an integer value.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchByRequest({ inputs: ['string'] });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getJournalBatchByRequest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchByRequest({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_journal_batch_by_request', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_journal_batch_by_request(\n inputs=["string"],\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getJournalBatchByRequest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getJournalBatchByRequest(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetJournalBatchByRequest', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetJournalBatchByRequest(context.TODO(), webhooks.WebhookGetJournalBatchByRequestParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_journal_batch_by_request', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_journal_batch_by_request(inputs: ["string"])\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getJournalBatchByRequest', - example: - "webhooks\n ->getJournalBatchByRequest(inputs: ['string'], installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_journal_batch_from_offset', - endpoint: '/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}', - httpMethod: 'get', - summary: 'Fetch Batch Entries', - description: - 'Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a specified number of entries, making it useful for paginating through large sets of webhook journal data.', - stainlessPath: '(resource) webhooks > (method) get_journal_batch_from_offset', - qualified: 'client.webhooks.getJournalBatchFromOffset', - params: ['offset: string;', 'count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_journal_batch_from_offset\n\n`client.webhooks.getJournalBatchFromOffset(offset: string, count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}`\n\nRetrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a specified number of entries, making it useful for paginating through large sets of webhook journal data.\n\n### Parameters\n\n- `offset: string`\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to specify the portal context for the request.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchFromOffset(1, { offset: 'offset' });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getJournalBatchFromOffset', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getJournalBatchFromOffset(1, {\n offset: 'offset',\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_journal_batch_from_offset', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_journal_batch_from_offset(\n count=1,\n offset="offset",\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getJournalBatchFromOffset', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalBatchFromOffsetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetJournalBatchFromOffsetParams params = WebhookGetJournalBatchFromOffsetParams.builder()\n .offset("offset")\n .count(1)\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getJournalBatchFromOffset(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetJournalBatchFromOffset', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetJournalBatchFromOffset(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetJournalBatchFromOffsetParams{\n\t\t\tOffset: "offset",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_journal_batch_from_offset', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_journal_batch_from_offset(1, offset: "offset")\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getJournalBatchFromOffset', - example: - "webhooks\n ->getJournalBatchFromOffset(1, offset: 'offset', installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/$OFFSET/next/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_journal_status', - endpoint: '/webhooks-journal/journal/2026-03/status/{statusId}', - httpMethod: 'get', - summary: 'Retrieve status', - description: - 'Retrieve the status of a specific webhook journal entry using its status ID. This endpoint is useful for checking the current state of a webhook process, such as whether it is pending, in progress, completed, failed, or expired.', - stainlessPath: '(resource) webhooks > (method) get_journal_status', - qualified: 'client.webhooks.getJournalStatus', - params: ['statusId: string;'], - response: - "{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }", - markdown: - "## get_journal_status\n\n`client.webhooks.getJournalStatus(statusId: string): { id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/status/{statusId}`\n\nRetrieve the status of a specific webhook journal entry using its status ID. This endpoint is useful for checking the current state of a webhook process, such as whether it is pending, in progress, completed, failed, or expired.\n\n### Parameters\n\n- `statusId: string`\n\n### Returns\n\n- `{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n - `id: string`\n - `initiatedAt: number`\n - `status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'`\n - `completedAt?: number`\n - `errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'`\n - `message?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst snapshotStatusResponse = await client.webhooks.getJournalStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(snapshotStatusResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getJournalStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst snapshotStatusResponse = await client.webhooks.getJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(snapshotStatusResponse.id);", - }, - python: { - method: 'webhooks.get_journal_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsnapshot_status_response = client.webhooks.get_journal_status(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(snapshot_status_response.id)', - }, - java: { - method: 'webhooks().getJournalStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SnapshotStatusResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SnapshotStatusResponse snapshotStatusResponse = client.webhooks().getJournalStatus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}', - }, - go: { - method: 'client.Webhooks.GetJournalStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsnapshotStatusResponse, err := client.Webhooks.GetJournalStatus(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", snapshotStatusResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.get_journal_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsnapshot_status_response = hubspot.webhooks.get_journal_status("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\nputs(snapshot_status_response)', - }, - php: { - method: 'webhooks->getJournalStatus', - example: - "webhooks->getJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n);\n\nvar_dump($snapshotStatusResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/status/$STATUS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_journal_subscription', - endpoint: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', - httpMethod: 'get', - summary: 'Retrieve subscription', - description: - "Retrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription's configuration and status within the HubSpot account.", - stainlessPath: '(resource) webhooks > (method) get_journal_subscription', - qualified: 'client.webhooks.getJournalSubscription', - params: ['subscriptionId: number;'], - response: - '{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }', - markdown: - "## get_journal_subscription\n\n`client.webhooks.getJournalSubscription(subscriptionId: number): { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03/{subscriptionId}`\n\nRetrieve details of a specific webhook subscription using its unique identifier. This endpoint is useful for obtaining information about a particular subscription's configuration and status within the HubSpot account.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }`\n\n - `id: number`\n - `actions: string[]`\n - `appId: number`\n - `createdAt: string`\n - `objectTypeId: string`\n - `subscriptionType: string`\n - `updatedAt: string`\n - `actionOverrides?: object`\n - `associatedObjectTypeIds?: string[]`\n - `createdBy?: number`\n - `deletedAt?: string`\n - `listIds?: number[]`\n - `objectIds?: number[]`\n - `portalId?: number`\n - `properties?: string[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse1 = await client.webhooks.getJournalSubscription(0);\n\nconsole.log(subscriptionResponse1);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getJournalSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse1 = await client.webhooks.getJournalSubscription(0);\n\nconsole.log(subscriptionResponse1.id);", - }, - python: { - method: 'webhooks.get_journal_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response_1 = client.webhooks.get_journal_subscription(\n 0,\n)\nprint(subscription_response_1.id)', - }, - java: { - method: 'webhooks().getJournalSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse1;\nimport com.hubspot.sdk.models.webhooks.WebhookGetJournalSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionResponse1 subscriptionResponse1 = client.webhooks().getJournalSubscription(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetJournalSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse1, err := client.Webhooks.GetJournalSubscription(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse1.ID)\n}\n', - }, - ruby: { - method: 'webhooks.get_journal_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response_1 = hubspot.webhooks.get_journal_subscription(0)\n\nputs(subscription_response_1)', - }, - php: { - method: 'webhooks->getJournalSubscription', - example: - "webhooks->getJournalSubscription(0);\n\nvar_dump($subscriptionResponse1);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_latest_journal_batch', - endpoint: '/webhooks-journal/journal/2026-03/batch/latest/{count}', - httpMethod: 'get', - summary: 'Retrieve latest batch', - description: - 'Retrieve the latest batch of webhook journal entries. This endpoint allows you to specify the number of entries to fetch, providing a way to access recent webhook activity within your HubSpot account.', - stainlessPath: '(resource) webhooks > (method) get_latest_journal_batch', - qualified: 'client.webhooks.getLatestJournalBatch', - params: ['count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_latest_journal_batch\n\n`client.webhooks.getLatestJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal/2026-03/batch/latest/{count}`\n\nRetrieve the latest batch of webhook journal entries. This endpoint allows you to specify the number of entries to fetch, providing a way to access recent webhook activity within your HubSpot account.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to identify the specific portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLatestJournalBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_latest_journal_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_latest_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getLatestJournalBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLatestJournalBatch(1);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLatestJournalBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLatestJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLatestJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_latest_journal_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_latest_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getLatestJournalBatch', - example: - "webhooks->getLatestJournalBatch(\n 1, installPortalID: 0\n);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/batch/latest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_latest_journal_entry', - endpoint: '/webhooks-journal/journal/2026-03/latest', - httpMethod: 'get', - summary: 'Retrieve latest journal', - description: - 'Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events processed by your HubSpot account. It allows you to filter the results by the portal ID to ensure you are retrieving data relevant to a specific installation.', - stainlessPath: '(resource) webhooks > (method) get_latest_journal_entry', - qualified: 'client.webhooks.getLatestJournalEntry', - params: ['installPortalId?: number;'], - response: 'string', - markdown: - "## get_latest_journal_entry\n\n`client.webhooks.getLatestJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/latest`\n\nRetrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events processed by your HubSpot account. It allows you to filter the results by the portal ID to ensure you are retrieving data relevant to a specific installation.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the journal entries. It is an integer value.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getLatestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLatestJournalEntry', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getLatestJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_latest_journal_entry', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_latest_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getLatestJournalEntry', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getLatestJournalEntry();\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLatestJournalEntry', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetLatestJournalEntry(context.TODO(), webhooks.WebhookGetLatestJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_latest_journal_entry', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_latest_journal_entry\n\nputs(response)', - }, - php: { - method: 'webhooks->getLatestJournalEntry', - example: - "webhooks->getLatestJournalEntry(installPortalID: 0);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/latest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_latest_local_journal_batch', - endpoint: '/webhooks-journal/journal-local/2026-03/batch/latest/{count}', - httpMethod: 'get', - summary: 'Retrieve latest batch', - description: - 'Retrieve the latest batch of webhook journal entries. This endpoint is useful for accessing the most recent data entries processed by the webhook journal. It requires specifying the number of entries to retrieve.', - stainlessPath: '(resource) webhooks > (method) get_latest_local_journal_batch', - qualified: 'client.webhooks.getLatestLocalJournalBatch', - params: ['count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_latest_local_journal_batch\n\n`client.webhooks.getLatestLocalJournalBatch(count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/latest/{count}`\n\nRetrieve the latest batch of webhook journal entries. This endpoint is useful for accessing the most recent data entries processed by the webhook journal. It requires specifying the number of entries to retrieve.\n\n### Parameters\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This parameter is optional and used to filter the journal entries by a specific portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLatestLocalJournalBatch', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLatestLocalJournalBatch(1);\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_latest_local_journal_batch', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_latest_local_journal_batch(\n count=1,\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getLatestLocalJournalBatch', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestLocalJournalBatchParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLatestLocalJournalBatch(1);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLatestLocalJournalBatch', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLatestLocalJournalBatch(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLatestLocalJournalBatchParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_latest_local_journal_batch', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_latest_local_journal_batch(1)\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getLatestLocalJournalBatch', - example: - "webhooks\n ->getLatestLocalJournalBatch(1, installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/latest/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_latest_local_journal_entry', - endpoint: '/webhooks-journal/journal-local/2026-03/latest', - httpMethod: 'get', - summary: 'Retrieve latest journal', - description: - 'Retrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events that have been logged, allowing you to process or analyze them as needed.', - stainlessPath: '(resource) webhooks > (method) get_latest_local_journal_entry', - qualified: 'client.webhooks.getLatestLocalJournalEntry', - params: ['installPortalId?: number;'], - response: 'string', - markdown: - "## get_latest_local_journal_entry\n\n`client.webhooks.getLatestLocalJournalEntry(installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/latest`\n\nRetrieve the latest entries from the webhooks journal for the specified portal. This endpoint is useful for accessing the most recent webhook events that have been logged, allowing you to process or analyze them as needed.\n\n### Parameters\n\n- `installPortalId?: number`\n The ID of the portal for which to retrieve the latest journal entries. This parameter is optional and should be an integer.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getLatestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLatestLocalJournalEntry', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getLatestLocalJournalEntry();\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_latest_local_journal_entry', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_latest_local_journal_entry()\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getLatestLocalJournalEntry', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLatestLocalJournalEntryParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getLatestLocalJournalEntry();\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLatestLocalJournalEntry', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetLatestLocalJournalEntry(context.TODO(), webhooks.WebhookGetLatestLocalJournalEntryParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_latest_local_journal_entry', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_latest_local_journal_entry\n\nputs(response)', - }, - php: { - method: 'webhooks->getLatestLocalJournalEntry', - example: - "webhooks->getLatestLocalJournalEntry(installPortalID: 0);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/latest \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_local_journal_batch_by_request', - endpoint: '/webhooks-journal/journal-local/2026-03/batch/read', - httpMethod: 'post', - summary: 'Batch read', - description: - 'Perform a batch read operation on the webhooks journal. This endpoint allows you to read multiple entries from the journal in a single request. It requires a JSON request body specifying the inputs to be read. The response includes the results of the batch read operation, and may return multiple statuses if there are errors.', - stainlessPath: '(resource) webhooks > (method) get_local_journal_batch_by_request', - qualified: 'client.webhooks.getLocalJournalBatchByRequest', - params: ['inputs: string[];', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_local_journal_batch_by_request\n\n`client.webhooks.getLocalJournalBatchByRequest(inputs: string[], installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**post** `/webhooks-journal/journal-local/2026-03/batch/read`\n\nPerform a batch read operation on the webhooks journal. This endpoint allows you to read multiple entries from the journal in a single request. It requires a JSON request body specifying the inputs to be read. The response includes the results of the batch read operation, and may return multiple statuses if there are errors.\n\n### Parameters\n\n- `inputs: string[]`\n Strings to input.\n\n- `installPortalId?: number`\n The ID of the portal where the webhooks are installed. This parameter is optional and is used to specify the target portal.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchByRequest({ inputs: ['string'] });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLocalJournalBatchByRequest', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchByRequest({\n inputs: ['string'],\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_local_journal_batch_by_request', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_local_journal_batch_by_request(\n inputs=["string"],\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getLocalJournalBatchByRequest', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.BatchInputString;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n BatchInputString params = BatchInputString.builder()\n .addInput("string")\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLocalJournalBatchByRequest(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLocalJournalBatchByRequest', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/shared"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLocalJournalBatchByRequest(context.TODO(), webhooks.WebhookGetLocalJournalBatchByRequestParams{\n\t\tBatchInputString: shared.BatchInputStringParam{\n\t\t\tInputs: []string{"string"},\n\t\t},\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_local_journal_batch_by_request', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_local_journal_batch_by_request(inputs: ["string"])\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getLocalJournalBatchByRequest', - example: - "webhooks\n ->getLocalJournalBatchByRequest(inputs: ['string'], installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/read \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "inputs": [\n "string"\n ]\n }\'', - }, - }, - }, - { - name: 'get_local_journal_batch_from_offset', - endpoint: '/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}', - httpMethod: 'get', - summary: 'Retrieve batch', - description: - 'Retrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, facilitating the processing of webhook data in manageable chunks.', - stainlessPath: '(resource) webhooks > (method) get_local_journal_batch_from_offset', - qualified: 'client.webhooks.getLocalJournalBatchFromOffset', - params: ['offset: string;', 'count: number;', 'installPortalId?: number;'], - response: - "{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }", - markdown: - "## get_local_journal_batch_from_offset\n\n`client.webhooks.getLocalJournalBatchFromOffset(offset: string, count: number, installPortalId?: number): { completedAt: string; results: journal_fetch_response[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}`\n\nRetrieve a batch of webhook journal entries starting from a specified offset. This endpoint allows you to fetch a defined number of entries, facilitating the processing of webhook data in manageable chunks.\n\n### Parameters\n\n- `offset: string`\n\n- `count: number`\n\n- `installPortalId?: number`\n The ID of the portal installation. This is an integer value used to specify the portal context for the request.\n\n### Returns\n\n- `{ completedAt: string; results: { currentOffset: string; expiresAt: string; url: string; }[]; startedAt: string; status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; links?: object; requestedAt?: string; }`\n\n - `completedAt: string`\n - `results: { currentOffset: string; expiresAt: string; url: string; }[]`\n - `startedAt: string`\n - `status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'`\n - `links?: object`\n - `requestedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchFromOffset(1, { offset: 'offset' });\n\nconsole.log(batchResponseJournalFetchResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLocalJournalBatchFromOffset', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst batchResponseJournalFetchResponse = await client.webhooks.getLocalJournalBatchFromOffset(1, {\n offset: 'offset',\n});\n\nconsole.log(batchResponseJournalFetchResponse.completedAt);", - }, - python: { - method: 'webhooks.get_local_journal_batch_from_offset', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nbatch_response_journal_fetch_response = client.webhooks.get_local_journal_batch_from_offset(\n count=1,\n offset="offset",\n)\nprint(batch_response_journal_fetch_response.completed_at)', - }, - java: { - method: 'webhooks().getLocalJournalBatchFromOffset', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.BatchResponseJournalFetchResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLocalJournalBatchFromOffsetParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookGetLocalJournalBatchFromOffsetParams params = WebhookGetLocalJournalBatchFromOffsetParams.builder()\n .offset("offset")\n .count(1)\n .build();\n BatchResponseJournalFetchResponse batchResponseJournalFetchResponse = client.webhooks().getLocalJournalBatchFromOffset(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLocalJournalBatchFromOffset', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tbatchResponseJournalFetchResponse, err := client.Webhooks.GetLocalJournalBatchFromOffset(\n\t\tcontext.TODO(),\n\t\t1,\n\t\twebhooks.WebhookGetLocalJournalBatchFromOffsetParams{\n\t\t\tOffset: "offset",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", batchResponseJournalFetchResponse.CompletedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_local_journal_batch_from_offset', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nbatch_response_journal_fetch_response = hubspot.webhooks.get_local_journal_batch_from_offset(1, offset: "offset")\n\nputs(batch_response_journal_fetch_response)', - }, - php: { - method: 'webhooks->getLocalJournalBatchFromOffset', - example: - "webhooks\n ->getLocalJournalBatchFromOffset(1, offset: 'offset', installPortalID: 0);\n\nvar_dump($batchResponseJournalFetchResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/batch/$OFFSET/next/$COUNT \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_local_journal_status', - endpoint: '/webhooks-journal/journal-local/2026-03/status/{statusId}', - httpMethod: 'get', - summary: 'Retrieve status', - description: - 'Retrieve the status of a specific webhook journal entry using its unique status ID. This endpoint is useful for monitoring the progress or completion of webhook processing tasks.', - stainlessPath: '(resource) webhooks > (method) get_local_journal_status', - qualified: 'client.webhooks.getLocalJournalStatus', - params: ['statusId: string;'], - response: - "{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }", - markdown: - "## get_local_journal_status\n\n`client.webhooks.getLocalJournalStatus(statusId: string): { id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n**get** `/webhooks-journal/journal-local/2026-03/status/{statusId}`\n\nRetrieve the status of a specific webhook journal entry using its unique status ID. This endpoint is useful for monitoring the progress or completion of webhook processing tasks.\n\n### Parameters\n\n- `statusId: string`\n\n### Returns\n\n- `{ id: string; initiatedAt: number; status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; completedAt?: number; errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; message?: string; }`\n\n - `id: string`\n - `initiatedAt: number`\n - `status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'`\n - `completedAt?: number`\n - `errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'`\n - `message?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst snapshotStatusResponse = await client.webhooks.getLocalJournalStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(snapshotStatusResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getLocalJournalStatus', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst snapshotStatusResponse = await client.webhooks.getLocalJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n);\n\nconsole.log(snapshotStatusResponse.id);", - }, - python: { - method: 'webhooks.get_local_journal_status', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsnapshot_status_response = client.webhooks.get_local_journal_status(\n "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n)\nprint(snapshot_status_response.id)', - }, - java: { - method: 'webhooks().getLocalJournalStatus', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SnapshotStatusResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetLocalJournalStatusParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SnapshotStatusResponse snapshotStatusResponse = client.webhooks().getLocalJournalStatus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");\n }\n}', - }, - go: { - method: 'client.Webhooks.GetLocalJournalStatus', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsnapshotStatusResponse, err := client.Webhooks.GetLocalJournalStatus(context.TODO(), "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", snapshotStatusResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.get_local_journal_status', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsnapshot_status_response = hubspot.webhooks.get_local_journal_status("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n\nputs(snapshot_status_response)', - }, - php: { - method: 'webhooks->getLocalJournalStatus', - example: - "webhooks->getLocalJournalStatus(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n);\n\nvar_dump($snapshotStatusResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/status/$STATUS_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_next_journal_entries', - endpoint: '/webhooks-journal/journal/2026-03/offset/{offset}/next', - httpMethod: 'get', - summary: 'Retrieve Next Batch', - description: - 'Retrieve the next batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data, allowing you to continue fetching entries from where you last left off.', - stainlessPath: '(resource) webhooks > (method) get_next_journal_entries', - qualified: 'client.webhooks.getNextJournalEntries', - params: ['offset: string;', 'installPortalId?: number;'], - response: 'string', - markdown: - "## get_next_journal_entries\n\n`client.webhooks.getNextJournalEntries(offset: string, installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal/2026-03/offset/{offset}/next`\n\nRetrieve the next batch of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through large sets of webhook data, allowing you to continue fetching entries from where you last left off.\n\n### Parameters\n\n- `offset: string`\n\n- `installPortalId?: number`\n The ID of the portal installation to filter the webhook journal entries. This is an optional parameter.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getNextJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getNextJournalEntries', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getNextJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_next_journal_entries', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_next_journal_entries(\n offset="offset",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getNextJournalEntries', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetNextJournalEntriesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getNextJournalEntries("offset");\n }\n}', - }, - go: { - method: 'client.Webhooks.GetNextJournalEntries', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetNextJournalEntries(\n\t\tcontext.TODO(),\n\t\t"offset",\n\t\twebhooks.WebhookGetNextJournalEntriesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_next_journal_entries', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_next_journal_entries("offset")\n\nputs(response)', - }, - php: { - method: 'webhooks->getNextJournalEntries', - example: - "webhooks->getNextJournalEntries(\n 'offset', installPortalID: 0\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal/2026-03/offset/$OFFSET/next \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_next_local_journal_entries', - endpoint: '/webhooks-journal/journal-local/2026-03/offset/{offset}/next', - httpMethod: 'get', - summary: 'Retrieve Next Batch', - description: - 'Retrieve the next set of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through webhook journal data in a sequential manner, allowing you to fetch entries beyond a given point.', - stainlessPath: '(resource) webhooks > (method) get_next_local_journal_entries', - qualified: 'client.webhooks.getNextLocalJournalEntries', - params: ['offset: string;', 'installPortalId?: number;'], - response: 'string', - markdown: - "## get_next_local_journal_entries\n\n`client.webhooks.getNextLocalJournalEntries(offset: string, installPortalId?: number): string`\n\n**get** `/webhooks-journal/journal-local/2026-03/offset/{offset}/next`\n\nRetrieve the next set of webhook journal entries starting from a specified offset. This endpoint is useful for paginating through webhook journal data in a sequential manner, allowing you to fetch entries beyond a given point.\n\n### Parameters\n\n- `offset: string`\n\n- `installPortalId?: number`\n The ID of the portal where the webhook is installed. This is an integer value.\n\n### Returns\n\n- `string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst response = await client.webhooks.getNextLocalJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob()\nconsole.log(content)\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getNextLocalJournalEntries', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.webhooks.getNextLocalJournalEntries('offset');\n\nconsole.log(response);\n\nconst content = await response.blob();\nconsole.log(content);", - }, - python: { - method: 'webhooks.get_next_local_journal_entries', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nresponse = client.webhooks.get_next_local_journal_entries(\n offset="offset",\n)\nprint(response)\ncontent = response.read()\nprint(content)', - }, - java: { - method: 'webhooks().getNextLocalJournalEntries', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetNextLocalJournalEntriesParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HttpResponse response = client.webhooks().getNextLocalJournalEntries("offset");\n }\n}', - }, - go: { - method: 'client.Webhooks.GetNextLocalJournalEntries', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.Webhooks.GetNextLocalJournalEntries(\n\t\tcontext.TODO(),\n\t\t"offset",\n\t\twebhooks.WebhookGetNextLocalJournalEntriesParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'webhooks.get_next_local_journal_entries', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nresponse = hubspot.webhooks.get_next_local_journal_entries("offset")\n\nputs(response)', - }, - php: { - method: 'webhooks->getNextLocalJournalEntries', - example: - "webhooks->getNextLocalJournalEntries(\n 'offset', installPortalID: 0\n);\n\nvar_dump($response);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/journal-local/2026-03/offset/$OFFSET/next \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_settings', - endpoint: '/webhooks/2026-03/{appId}/settings', - httpMethod: 'get', - summary: 'Read webhook settings', - description: - 'Retrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.', - stainlessPath: '(resource) webhooks > (method) get_settings', - qualified: 'client.webhooks.getSettings', - params: ['appId: number;'], - response: - '{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }', - markdown: - "## get_settings\n\n`client.webhooks.getSettings(appId: number): { createdAt: string; targetUrl: string; throttling: throttling_settings; updatedAt?: string; }`\n\n**get** `/webhooks/2026-03/{appId}/settings`\n\nRetrieve the webhook settings for the specified app, including the webhook’s target URL, throttle configuration, and create/update date.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }`\n\n - `createdAt: string`\n - `targetUrl: string`\n - `throttling: { maxConcurrentRequests: number; }`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.webhooks.getSettings(0);\n\nconsole.log(settingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.webhooks.getSettings(0);\n\nconsole.log(settingsResponse.createdAt);", - }, - python: { - method: 'webhooks.get_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.webhooks.get_settings(\n 0,\n)\nprint(settings_response.created_at)', - }, - java: { - method: 'webhooks().getSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SettingsResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SettingsResponse settingsResponse = client.webhooks().getSettings(0);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Webhooks.GetSettings(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'webhooks.get_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.webhooks.get_settings(0)\n\nputs(settings_response)', - }, - php: { - method: 'webhooks->getSettings', - example: - "webhooks->getSettings(0);\n\nvar_dump($settingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'get_subscription_filter', - endpoint: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', - httpMethod: 'get', - summary: 'Retrieve filter', - description: - 'Retrieve details of a specific filter associated with a webhook subscription in the HubSpot account. This endpoint is useful for accessing the configuration and conditions of a filter by its unique identifier.', - stainlessPath: '(resource) webhooks > (method) get_subscription_filter', - qualified: 'client.webhooks.getSubscriptionFilter', - params: ['filterId: number;'], - response: '{ id: number; createdAt: number; filter: { conditions: condition[]; }; }', - markdown: - "## get_subscription_filter\n\n`client.webhooks.getSubscriptionFilter(filterId: number): { id: number; createdAt: number; filter: filter; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03/filters/{filterId}`\n\nRetrieve details of a specific filter associated with a webhook subscription in the HubSpot account. This endpoint is useful for accessing the configuration and conditions of a filter by its unique identifier.\n\n### Parameters\n\n- `filterId: number`\n\n### Returns\n\n- `{ id: number; createdAt: number; filter: { conditions: condition[]; }; }`\n\n - `id: number`\n - `createdAt: number`\n - `filter: { conditions: { filterType: 'CRM_OBJECT_PROPERTY'; operator: string; property: string; value?: string; values?: string[]; }[]; }`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterResponse = await client.webhooks.getSubscriptionFilter(0);\n\nconsole.log(filterResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.getSubscriptionFilter', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterResponse = await client.webhooks.getSubscriptionFilter(0);\n\nconsole.log(filterResponse.id);", - }, - python: { - method: 'webhooks.get_subscription_filter', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_response = client.webhooks.get_subscription_filter(\n 0,\n)\nprint(filter_response.id)', - }, - java: { - method: 'webhooks().getSubscriptionFilter', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.FilterResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookGetSubscriptionFilterParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n FilterResponse filterResponse = client.webhooks().getSubscriptionFilter(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.GetSubscriptionFilter', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterResponse, err := client.Webhooks.GetSubscriptionFilter(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.get_subscription_filter', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_response = hubspot.webhooks.get_subscription_filter(0)\n\nputs(filter_response)', - }, - php: { - method: 'webhooks->getSubscriptionFilter', - example: - "webhooks->getSubscriptionFilter(0);\n\nvar_dump($filterResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/$FILTER_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_event_subscriptions', - endpoint: '/webhooks/2026-03/{appId}/subscriptions', - httpMethod: 'get', - summary: 'Read event subscriptions', - description: 'Retrieve event subscriptions for the specified app.', - stainlessPath: '(resource) webhooks > (method) list_event_subscriptions', - qualified: 'client.webhooks.listEventSubscriptions', - params: ['appId: number;'], - response: - '{ results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; }', - markdown: - "## list_event_subscriptions\n\n`client.webhooks.listEventSubscriptions(appId: number): { results: subscription_response[]; }`\n\n**get** `/webhooks/2026-03/{appId}/subscriptions`\n\nRetrieve event subscriptions for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n### Returns\n\n- `{ results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]; }`\n\n - `results: { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionListResponse = await client.webhooks.listEventSubscriptions(0);\n\nconsole.log(subscriptionListResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.listEventSubscriptions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionListResponse = await client.webhooks.listEventSubscriptions(0);\n\nconsole.log(subscriptionListResponse.results);", - }, - python: { - method: 'webhooks.list_event_subscriptions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_list_response = client.webhooks.list_event_subscriptions(\n 0,\n)\nprint(subscription_list_response.results)', - }, - java: { - method: 'webhooks().listEventSubscriptions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionListResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookListEventSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SubscriptionListResponse subscriptionListResponse = client.webhooks().listEventSubscriptions(0);\n }\n}', - }, - go: { - method: 'client.Webhooks.ListEventSubscriptions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionListResponse, err := client.Webhooks.ListEventSubscriptions(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionListResponse.Results)\n}\n', - }, - ruby: { - method: 'webhooks.list_event_subscriptions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_list_response = hubspot.webhooks.list_event_subscriptions(0)\n\nputs(subscription_list_response)', - }, - php: { - method: 'webhooks->listEventSubscriptions', - example: - "webhooks->listEventSubscriptions(0);\n\nvar_dump($subscriptionListResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_journal_subscriptions', - endpoint: '/webhooks-journal/subscriptions/2026-03', - httpMethod: 'get', - summary: 'List subscriptions', - description: - 'Retrieve a list of webhook journal subscriptions for the specified API version. This endpoint provides details about each subscription, including actions, object types, and associated properties. It is useful for managing and reviewing current webhook subscriptions.', - stainlessPath: '(resource) webhooks > (method) list_journal_subscriptions', - qualified: 'client.webhooks.listJournalSubscriptions', - response: - '{ results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]; }', - markdown: - "## list_journal_subscriptions\n\n`client.webhooks.listJournalSubscriptions(): { results: subscription_response_1[]; }`\n\n**get** `/webhooks-journal/subscriptions/2026-03`\n\nRetrieve a list of webhook journal subscriptions for the specified API version. This endpoint provides details about each subscription, including actions, object types, and associated properties. It is useful for managing and reviewing current webhook subscriptions.\n\n### Returns\n\n- `{ results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]; }`\n\n - `results: { id: number; actions: string[]; appId: number; createdAt: string; objectTypeId: string; subscriptionType: string; updatedAt: string; actionOverrides?: object; associatedObjectTypeIds?: string[]; createdBy?: number; deletedAt?: string; listIds?: number[]; objectIds?: number[]; portalId?: number; properties?: string[]; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst collectionResponseSubscriptionResponseNoPaging = await client.webhooks.listJournalSubscriptions();\n\nconsole.log(collectionResponseSubscriptionResponseNoPaging);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.listJournalSubscriptions', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst collectionResponseSubscriptionResponseNoPaging =\n await client.webhooks.listJournalSubscriptions();\n\nconsole.log(collectionResponseSubscriptionResponseNoPaging.results);", - }, - python: { - method: 'webhooks.list_journal_subscriptions', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\ncollection_response_subscription_response_no_paging = client.webhooks.list_journal_subscriptions()\nprint(collection_response_subscription_response_no_paging.results)', - }, - java: { - method: 'webhooks().listJournalSubscriptions', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.CollectionResponseSubscriptionResponseNoPaging;\nimport com.hubspot.sdk.models.webhooks.WebhookListJournalSubscriptionsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CollectionResponseSubscriptionResponseNoPaging collectionResponseSubscriptionResponseNoPaging = client.webhooks().listJournalSubscriptions();\n }\n}', - }, - go: { - method: 'client.Webhooks.ListJournalSubscriptions', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcollectionResponseSubscriptionResponseNoPaging, err := client.Webhooks.ListJournalSubscriptions(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", collectionResponseSubscriptionResponseNoPaging.Results)\n}\n', - }, - ruby: { - method: 'webhooks.list_journal_subscriptions', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\ncollection_response_subscription_response_no_paging = hubspot.webhooks.list_journal_subscriptions\n\nputs(collection_response_subscription_response_no_paging)', - }, - php: { - method: 'webhooks->listJournalSubscriptions', - example: - "webhooks\n ->listJournalSubscriptions();\n\nvar_dump($collectionResponseSubscriptionResponseNoPaging);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03 \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'list_subscription_filters', - endpoint: '/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}', - httpMethod: 'get', - summary: 'Retrieve Filters', - description: - 'Retrieve the filters associated with a specific webhook subscription in the HubSpot account. This endpoint is useful for obtaining detailed information about the filters applied to a given subscription, identified by its subscription ID.', - stainlessPath: '(resource) webhooks > (method) list_subscription_filters', - qualified: 'client.webhooks.listSubscriptionFilters', - params: ['subscriptionId: number;'], - response: '{ id: number; createdAt: number; filter: object; }[]', - markdown: - "## list_subscription_filters\n\n`client.webhooks.listSubscriptionFilters(subscriptionId: number): object[]`\n\n**get** `/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}`\n\nRetrieve the filters associated with a specific webhook subscription in the HubSpot account. This endpoint is useful for obtaining detailed information about the filters applied to a given subscription, identified by its subscription ID.\n\n### Parameters\n\n- `subscriptionId: number`\n\n### Returns\n\n- `{ id: number; createdAt: number; filter: object; }[]`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst filterResponses = await client.webhooks.listSubscriptionFilters(0);\n\nconsole.log(filterResponses);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.listSubscriptionFilters', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst filterResponses = await client.webhooks.listSubscriptionFilters(0);\n\nconsole.log(filterResponses);", - }, - python: { - method: 'webhooks.list_subscription_filters', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nfilter_responses = client.webhooks.list_subscription_filters(\n 0,\n)\nprint(filter_responses)', - }, - java: { - method: 'webhooks().listSubscriptionFilters', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.FilterResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookListSubscriptionFiltersParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List filterResponses = client.webhooks().listSubscriptionFilters(0L);\n }\n}', - }, - go: { - method: 'client.Webhooks.ListSubscriptionFilters', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tfilterResponses, err := client.Webhooks.ListSubscriptionFilters(context.TODO(), 0)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", filterResponses)\n}\n', - }, - ruby: { - method: 'webhooks.list_subscription_filters', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nfilter_responses = hubspot.webhooks.list_subscription_filters(0)\n\nputs(filter_responses)', - }, - php: { - method: 'webhooks->listSubscriptionFilters', - example: - "webhooks->listSubscriptionFilters(0);\n\nvar_dump($filterResponses);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks-journal/subscriptions/2026-03/filters/subscription/$SUBSCRIPTION_ID \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, - }, - { - name: 'update_event_subscription', - endpoint: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - httpMethod: 'patch', - summary: 'Update an event subscription', - description: 'Update an existing event subscription by ID.', - stainlessPath: '(resource) webhooks > (method) update_event_subscription', - qualified: 'client.webhooks.updateEventSubscription', - params: ['appId: number;', 'subscriptionId: number;', 'active?: boolean;'], - response: - '{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }', - markdown: - "## update_event_subscription\n\n`client.webhooks.updateEventSubscription(appId: number, subscriptionId: number, active?: boolean): { id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n**patch** `/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}`\n\nUpdate an existing event subscription by ID.\n\n### Parameters\n\n- `appId: number`\n\n- `subscriptionId: number`\n\n- `active?: boolean`\n A boolean indicating whether the subscription is active. If true, the subscription is active; if false, it is inactive.\n\n### Returns\n\n- `{ id: string; active: boolean; createdAt: string; eventType: string; eventTypeName?: string; objectTypeId?: string; propertyName?: string; updatedAt?: string; }`\n\n - `id: string`\n - `active: boolean`\n - `createdAt: string`\n - `eventType: string`\n - `eventTypeName?: string`\n - `objectTypeId?: string`\n - `propertyName?: string`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst subscriptionResponse = await client.webhooks.updateEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.updateEventSubscription', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst subscriptionResponse = await client.webhooks.updateEventSubscription(0, { appId: 0 });\n\nconsole.log(subscriptionResponse.id);", - }, - python: { - method: 'webhooks.update_event_subscription', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsubscription_response = client.webhooks.update_event_subscription(\n subscription_id=0,\n app_id=0,\n)\nprint(subscription_response.id)', - }, - java: { - method: 'webhooks().updateEventSubscription', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SubscriptionPatchRequest;\nimport com.hubspot.sdk.models.webhooks.SubscriptionResponse;\nimport com.hubspot.sdk.models.webhooks.WebhookUpdateEventSubscriptionParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookUpdateEventSubscriptionParams params = WebhookUpdateEventSubscriptionParams.builder()\n .appId(0)\n .subscriptionId(0)\n .subscriptionPatchRequest(SubscriptionPatchRequest.builder().build())\n .build();\n SubscriptionResponse subscriptionResponse = client.webhooks().updateEventSubscription(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.UpdateEventSubscription', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsubscriptionResponse, err := client.Webhooks.UpdateEventSubscription(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookUpdateEventSubscriptionParams{\n\t\t\tAppID: 0,\n\t\t\tSubscriptionPatchRequest: webhooks.SubscriptionPatchRequestParam{},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", subscriptionResponse.ID)\n}\n', - }, - ruby: { - method: 'webhooks.update_event_subscription', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsubscription_response = hubspot.webhooks.update_event_subscription(0, app_id: 0)\n\nputs(subscription_response)', - }, - php: { - method: 'webhooks->updateEventSubscription', - example: - "webhooks->updateEventSubscription(\n 0, appID: 0, active: true\n);\n\nvar_dump($subscriptionResponse);", - }, - http: { - example: - "curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/subscriptions/$SUBSCRIPTION_ID \\\n -X PATCH \\\n -H 'Content-Type: application/json' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{}'", - }, - }, - }, - { - name: 'update_settings', - endpoint: '/webhooks/2026-03/{appId}/settings', - httpMethod: 'put', - summary: 'Update webhook settings', - description: 'Update webhook settings for the specified app.', - stainlessPath: '(resource) webhooks > (method) update_settings', - qualified: 'client.webhooks.updateSettings', - params: ['appId: number;', 'targetUrl: string;', 'throttling: { maxConcurrentRequests: number; };'], - response: - '{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }', - markdown: - "## update_settings\n\n`client.webhooks.updateSettings(appId: number, targetUrl: string, throttling: { maxConcurrentRequests: number; }): { createdAt: string; targetUrl: string; throttling: throttling_settings; updatedAt?: string; }`\n\n**put** `/webhooks/2026-03/{appId}/settings`\n\nUpdate webhook settings for the specified app.\n\n### Parameters\n\n- `appId: number`\n\n- `targetUrl: string`\n The URL to which webhook events will be sent. It is a string.\n\n- `throttling: { maxConcurrentRequests: number; }`\n - `maxConcurrentRequests: number`\n The maximum number of concurrent requests allowed. This is an integer value.\n\n### Returns\n\n- `{ createdAt: string; targetUrl: string; throttling: { maxConcurrentRequests: number; }; updatedAt?: string; }`\n\n - `createdAt: string`\n - `targetUrl: string`\n - `throttling: { maxConcurrentRequests: number; }`\n - `updatedAt?: string`\n\n### Example\n\n```typescript\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\nconst settingsResponse = await client.webhooks.updateSettings(0, {\n targetUrl: 'targetUrl',\n throttling: { maxConcurrentRequests: 0 },\n});\n\nconsole.log(settingsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.webhooks.updateSettings', - example: - "import HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst settingsResponse = await client.webhooks.updateSettings(0, {\n targetUrl: 'targetUrl',\n throttling: { maxConcurrentRequests: 0 },\n});\n\nconsole.log(settingsResponse.createdAt);", - }, - python: { - method: 'webhooks.update_settings', - example: - 'from hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\nsettings_response = client.webhooks.update_settings(\n app_id=0,\n target_url="targetUrl",\n throttling={\n "max_concurrent_requests": 0\n },\n)\nprint(settings_response.created_at)', - }, - java: { - method: 'webhooks().updateSettings', - example: - 'package com.hubspot.sdk.example;\n\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.webhooks.SettingsChangeRequest;\nimport com.hubspot.sdk.models.webhooks.SettingsResponse;\nimport com.hubspot.sdk.models.webhooks.ThrottlingSettings;\nimport com.hubspot.sdk.models.webhooks.WebhookUpdateSettingsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n HubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n WebhookUpdateSettingsParams params = WebhookUpdateSettingsParams.builder()\n .appId(0)\n .settingsChangeRequest(SettingsChangeRequest.builder()\n .targetUrl("targetUrl")\n .throttling(ThrottlingSettings.builder()\n .maxConcurrentRequests(0)\n .build())\n .build())\n .build();\n SettingsResponse settingsResponse = client.webhooks().updateSettings(params);\n }\n}', - }, - go: { - method: 'client.Webhooks.UpdateSettings', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n\t"github.com/HubSpot/hubspot-sdk-go/webhooks"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsettingsResponse, err := client.Webhooks.UpdateSettings(\n\t\tcontext.TODO(),\n\t\t0,\n\t\twebhooks.WebhookUpdateSettingsParams{\n\t\t\tSettingsChangeRequest: webhooks.SettingsChangeRequestParam{\n\t\t\t\tTargetURL: "targetUrl",\n\t\t\t\tThrottling: webhooks.ThrottlingSettingsParam{\n\t\t\t\t\tMaxConcurrentRequests: 0,\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", settingsResponse.CreatedAt)\n}\n', - }, - ruby: { - method: 'webhooks.update_settings', - example: - 'require "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsettings_response = hubspot.webhooks.update_settings(0, target_url: "targetUrl", throttling: {maxConcurrentRequests: 0})\n\nputs(settings_response)', - }, - php: { - method: 'webhooks->updateSettings', - example: - "webhooks->updateSettings(\n 0, targetURL: 'targetUrl', throttling: ['maxConcurrentRequests' => 0]\n);\n\nvar_dump($settingsResponse);", - }, - http: { - example: - 'curl https://api.hubapi.com/webhooks/2026-03/$APP_ID/settings \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "targetUrl": "targetUrl",\n "throttling": {\n "maxConcurrentRequests": 0\n }\n }\'', - }, - }, - }, -]; - -const EMBEDDED_READMES: { language: string; content: string }[] = [ - { - language: 'go', - content: - '# HubSpot Go API Library\n\nGo Reference\n\nThe HubSpot Go library provides convenient access to the [HubSpot REST API](https://developers.hubspot.com/docs/api-reference/overview)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/HubSpot/hubspot-sdk-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/HubSpot/hubspot-sdk-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/HubSpot/hubspot-sdk-go"\n\t"github.com/HubSpot/hubspot-sdk-go/crm"\n\t"github.com/HubSpot/hubspot-sdk-go/option"\n)\n\nfunc main() {\n\tclient := hubspotsdk.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresult, err := client.Crm.Objects.Contacts.Get(\n\t\tcontext.TODO(),\n\t\t"contactId",\n\t\tcrm.ObjectContactGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", result.ID)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.Crm.Objects.Contacts.New(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/HubSpot/hubspot-sdk-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.Crm.Objects.Contacts.ListAutoPaging(context.TODO(), crm.ObjectContactListParams{\n\tLimit: hubspotsdk.Int(100),\n})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tsimplePublicObjectWithAssociations := iter.Current()\n\tfmt.Printf("%+v\\n", simplePublicObjectWithAssociations)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.Crm.Objects.Contacts.List(context.TODO(), crm.ObjectContactListParams{\n\tLimit: hubspotsdk.Int(100),\n})\nfor page != nil {\n\tfor _, contact := range page.Results {\n\t\tfmt.Printf("%+v\\n", contact)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.Crm.Objects.Contacts.New(context.TODO(), crm.ObjectContactNewParams{\n\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\tID: "id",\n\t\t\t},\n\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\tAssociationTypeID: 0,\n\t\t\t}},\n\t\t}},\n\t\tProperties: map[string]string{\n\t\t\t"foo": "string",\n\t\t},\n\t},\n})\nif err != nil {\n\tvar apierr *hubspotsdk.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/crm/objects/2026-03/contacts": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.Crm.Objects.Contacts.New(\n\tctx,\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n```go\n// A file from the file system\nfile, err := os.Open("/path/to/file")\ncms.HubdbTableImportDraftParams{\n\tFile: file,\n}\n\n// A file from a string\ncms.HubdbTableImportDraftParams{\n\tFile: strings.NewReader("my file contents"),\n}\n\n// With a custom filename and contentType\ncms.HubdbTableImportDraftParams{\n\tFile: hubspotsdk.File(strings.NewReader(`{"hello": "foo"}`), "file.go", "application/json"),\n}\n```\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := hubspotsdk.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.Crm.Objects.Contacts.New(\n\tcontext.TODO(),\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\nsimplePublicObject, err := client.Crm.Objects.Contacts.New(\n\tcontext.TODO(),\n\tcrm.ObjectContactNewParams{\n\t\tSimplePublicObjectInputForCreate: crm.SimplePublicObjectInputForCreateParam{\n\t\t\tAssociations: []crm.PublicAssociationsForObjectParam{{\n\t\t\t\tTo: shared.PublicObjectIDParam{\n\t\t\t\t\tID: "id",\n\t\t\t\t},\n\t\t\t\tTypes: []shared.AssociationSpecParam{{\n\t\t\t\t\tAssociationCategory: shared.AssociationSpecAssociationCategoryHubSpotDefined,\n\t\t\t\t\tAssociationTypeID: 0,\n\t\t\t\t}},\n\t\t\t}},\n\t\t\tProperties: map[string]string{\n\t\t\t\t"foo": "string",\n\t\t\t},\n\t\t},\n\t},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", simplePublicObject)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', - }, - { - language: 'java', - content: - '# HubSpot Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.hubspot.sdk/hubspot-java)](https://central.sonatype.com/artifact/com.hubspot.sdk/hubspot-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.hubspot.sdk/hubspot-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.hubspot.sdk/hubspot-java/0.0.1)\n\n\nThe HubSpot Java SDK provides convenient access to the [HubSpot REST API](https://developers.hubspot.com/docs/api-reference/overview) from applications written in Java.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.hubspot.sdk/hubspot-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.hubspot.sdk:hubspot-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.hubspot.sdk\n hubspot-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get("contactId");\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------- | ----------------- | -------------------- | -------- | -------------------------- |\n| `baseUrl` | `hubspot.baseUrl` | `HUBSPOT_BASE_URL` | true | `"https://api.hubapi.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\n\nHubSpotClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the HubSpot API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.crm().objects().contacts().get(...)` should be called with an instance of `ContactGetParams`, and it will return an instance of `SimplePublicObjectWithAssociations`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\nimport java.util.concurrent.CompletableFuture;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture result = client.async().crm().objects().contacts().get("contactId");\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClientAsync;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClientAsync;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\nimport java.util.concurrent.CompletableFuture;\n\nHubSpotClientAsync client = HubSpotOkHttpClientAsync.builder()\n // Configures using the `hubspot.baseUrl` system property\n // Or configures using the `HUBSPOT_BASE_URL` environment variable\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture result = client.crm().objects().contacts().get("contactId");\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n## File uploads\n\nThe SDK defines methods that accept files.\n\nTo upload a file, pass a [`Path`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html):\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.nio.file.Paths;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(Paths.get("/path/to/file"))\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nOr an arbitrary [`InputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html):\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.net.URL;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(new URL("https://example.com//path/to/file").openStream())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nOr a `byte[]` array:\n\n```java\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file("content".getBytes())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\nNote that when passing a non-`Path` its filename is unknown so it will not be included in the request. To manually set a filename, pass a [`MultipartField`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt):\n\n```java\nimport com.hubspot.sdk.core.MultipartField;\nimport com.hubspot.sdk.models.cms.hubdb.ImportResult;\nimport com.hubspot.sdk.models.cms.hubdb.tables.TableImportDraftParams;\nimport java.io.InputStream;\nimport java.net.URL;\n\nTableImportDraftParams params = TableImportDraftParams.builder()\n .tableIdOrName("tableIdOrName")\n .file(MultipartField.builder()\n .value(new URL("https://example.com//path/to/file").openStream())\n .filename("/path/to/file")\n .build())\n .build();\nImportResult importResult = client.cms().hubdb().tables().importDraft(params);\n```\n\n## Binary responses\n\nThe SDK defines methods that return binary responses, which are used for API responses that shouldn\'t necessarily be parsed, like non-JSON data.\n\nThese methods return [`HttpResponse`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/HttpResponse.kt):\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport com.hubspot.sdk.models.auth.oauth.OAuthCreateTokenParams;\n\nHttpResponse response = client.auth().oauth().createToken();\n```\n\nTo save the response content to a file, use the [`Files.copy(...)`](https://docs.oracle.com/javase/8/docs/api/java/nio/file/Files.html#copy-java.io.InputStream-java.nio.file.Path-java.nio.file.CopyOption...-) method:\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\nimport java.nio.file.StandardCopyOption;\n\ntry (HttpResponse response = client.auth().oauth().createToken(params)) {\n Files.copy(\n response.body(),\n Paths.get(path),\n StandardCopyOption.REPLACE_EXISTING\n );\n} catch (Exception e) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(e);\n}\n```\n\nOr transfer the response content to any [`OutputStream`](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html):\n\n```java\nimport com.hubspot.sdk.core.http.HttpResponse;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\ntry (HttpResponse response = client.auth().oauth().createToken(params)) {\n response.body().transferTo(Files.newOutputStream(Paths.get(path)));\n} catch (Exception e) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(e);\n}\n```\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.core.http.Headers;\nimport com.hubspot.sdk.core.http.HttpResponseFor;\nimport com.hubspot.sdk.models.AssociationSpec;\nimport com.hubspot.sdk.models.PublicObjectId;\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\nimport com.hubspot.sdk.models.crm.objects.PublicAssociationsForObject;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectInputForCreate;\n\nSimplePublicObjectInputForCreate params = SimplePublicObjectInputForCreate.builder()\n .addAssociation(PublicAssociationsForObject.builder()\n .to(PublicObjectId.builder()\n .id("id")\n .build())\n .addType(AssociationSpec.builder()\n .associationCategory(AssociationSpec.AssociationCategory.HUBSPOT_DEFINED)\n .associationTypeId(0)\n .build())\n .build())\n .properties(SimplePublicObjectInputForCreate.Properties.builder()\n .putAdditionalProperty("foo", JsonValue.from("string"))\n .build())\n .build();\nHttpResponseFor simplePublicObject = client.crm().objects().contacts().withRawResponse().create(params);\n\nint statusCode = simplePublicObject.statusCode();\nHeaders headers = simplePublicObject.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\n\nSimplePublicObject parsedSimplePublicObject = simplePublicObject.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`HubSpotServiceException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/UnexpectedStatusCodeException.kt) |\n\n- [`HubSpotIoException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotIoException.kt): I/O networking errors.\n\n- [`HubSpotRetryableException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`HubSpotInvalidDataException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`HubSpotException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\n\nContactListPage page = client.crm().objects().contacts().list();\n\n// Process as an Iterable\nfor (SimplePublicObjectWithAssociations contact : page.autoPager()) {\n System.out.println(contact);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(contact -> System.out.println(contact));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.hubspot.sdk.core.http.AsyncStreamResponse;\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPageAsync;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().crm().objects().contacts().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(contact -> {\n System.out.println(contact);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(SimplePublicObjectWithAssociations contact) {\n System.out.println(contact);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(contact -> {\n System.out.println(contact);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactListPage;\n\nContactListPage page = client.crm().objects().contacts().list();\nwhile (true) {\n for (SimplePublicObjectWithAssociations contact : page.items()) {\n System.out.println(contact);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nEnable logging by setting the `HUBSPOT_LOG` environment variable to `info`:\n\n```sh\nexport HUBSPOT_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport HUBSPOT_LOG=debug\n```\n\nOr configure the client manually using the `logLevel` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.LogLevel;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .logLevel(LogLevel.INFO)\n .accessToken("My Access Token")\n .build();\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `hubspot-java-core` is published with a [configuration file](hubspot-java-core/src/main/resources/META-INF/proguard/hubspot-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.hubspot.sdk.models.crm.SimplePublicObject;\n\nSimplePublicObject simplePublicObject = client.crm().objects().contacts().create(\n params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()\n);\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.time.Duration;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\nIf the proxy responds with `407 Proxy Authentication Required`, supply credentials by also configuring `proxyAuthenticator`:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport com.hubspot.sdk.core.http.ProxyAuthenticator;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .proxy(...)\n // Or a custom implementation of `ProxyAuthenticator`.\n .proxyAuthenticator(ProxyAuthenticator.basic("username", "password"))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\nimport java.time.Duration;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `hubspot-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`HubSpotClient`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClient.kt), [`HubSpotClientAsync`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsync.kt), [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt), and [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), all of which can work with any HTTP client\n- `hubspot-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) and [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), which provide a way to construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) and [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), respectively, using OkHttp\n- `hubspot-java`\n - Depends on and exposes the APIs of both `hubspot-java-core` and `hubspot-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`hubspot-java` dependency](#installation) with `hubspot-java-core`\n2. Copy `hubspot-java-client-okhttp`\'s [`OkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) or [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), similarly to [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`hubspot-java` dependency](#installation) with `hubspot-java-core`\n2. Write a class that implements the [`HttpClient`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/http/HttpClient.kt) interface\n3. Construct [`HubSpotClientImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientImpl.kt) or [`HubSpotClientAsyncImpl`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/client/HubSpotClientAsyncImpl.kt), similarly to [`HubSpotOkHttpClient`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClient.kt) or [`HubSpotOkHttpClientAsync`](hubspot-java-client-okhttp/src/main/kotlin/com/hubspot/sdk/client/okhttp/HubSpotOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt) object to its setter:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/core/Values.kt):\n\n```java\nimport com.hubspot.sdk.core.JsonMissing;\nimport com.hubspot.sdk.models.crm.objects.contacts.ContactGetParams;\n\nContactGetParams params = ContactGetParams.builder()\n .contactId(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.hubspot.sdk.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.crm().objects().contacts().get(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.hubspot.sdk.core.JsonField;\nimport java.util.Optional;\n\nJsonField field = client.crm().objects().contacts().get(params)._field();\n\nif (field.isMissing()) {\n // The property is absent from the JSON response\n} else if (field.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = field.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = field.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`HubSpotInvalidDataException`](hubspot-java-core/src/main/kotlin/com/hubspot/sdk/errors/HubSpotInvalidDataException.kt) only if you directly access the property.\n\nValidating the response is _not_ forwards compatible with new types from the API for existing fields.\n\nIf you would still prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.hubspot.sdk.models.crm.objects.SimplePublicObjectWithAssociations;\n\nSimplePublicObjectWithAssociations result = client.crm().objects().contacts().get(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.hubspot.sdk.client.HubSpotClient;\nimport com.hubspot.sdk.client.okhttp.HubSpotOkHttpClient;\n\nHubSpotClient client = HubSpotOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-java/issues) with questions, bugs, or suggestions.\n', - }, - { - language: 'php', - content: - "# HubSpot PHP API Library\n\nThe HubSpot PHP library provides convenient access to the HubSpot REST API from any PHP 8.1.0+ application.\n\n## Installation\n\n\n```\ncomposer require \"hubspot/sdk 0.0.1\"\n```\n\n\n## Usage\n\n```php\ncrm->objects->contacts->get(\n 'contactId'\n);\n\nvar_dump($simplePublicObjectWithAssociations->id);\n```", - }, - { - language: 'python', - content: - '# HubSpot Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/hubspot-sdk.svg?label=pypi%20(stable))](https://pypi.org/project/hubspot-sdk/)\n\nThe HubSpot Python library provides convenient access to the HubSpot REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install hubspot-sdk\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot(\n access_token="My Access Token",\n)\n\nresult = client.crm.objects.contacts.get(\n contact_id="contactId",\n)\nprint(result.id)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncHubSpot` instead of `HubSpot` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom hubspot_sdk import AsyncHubSpot\n\nclient = AsyncHubSpot(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n result = await client.crm.objects.contacts.get(\n contact_id="contactId",\n )\n print(result.id)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install hubspot-sdk[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom hubspot_sdk import DefaultAioHttpClient\nfrom hubspot_sdk import AsyncHubSpot\n\nasync def main() -> None:\n async with AsyncHubSpot(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n result = await client.crm.objects.contacts.get(\n contact_id="contactId",\n )\n print(result.id)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the HubSpot API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\nall_contacts = []\n# Automatically fetches more pages as needed.\nfor contact in client.crm.objects.contacts.list(\n limit=100,\n):\n # Do something with contact here\n all_contacts.append(contact)\nprint(all_contacts)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom hubspot_sdk import AsyncHubSpot\n\nclient = AsyncHubSpot()\n\nasync def main() -> None:\n all_contacts = []\n # Iterate through items across all pages, issuing requests as needed.\n async for contact in client.crm.objects.contacts.list(\n limit=100,\n):\n all_contacts.append(contact)\n print(all_contacts)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.crm.objects.contacts.list(\n limit=100,\n)\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.results)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.crm.objects.contacts.list(\n limit=100,\n)\n\nprint(f"next page cursor: {first_page.paging.next.after}") # => "next page cursor: ..."\nfor contact in first_page.results:\n print(contact.id)\n\n# Remove `await` for non-async usage.\n```\n\n## Nested params\n\nNested parameters are dictionaries, typed using `TypedDict`, for example:\n\n```python\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\npublic_action_definition = client.automation.actions.definitions.create(\n app_id=0,\n action_url="actionUrl",\n functions=[{\n "function_source": "functionSource",\n "function_type": "POST_ACTION_EXECUTION",\n }],\n input_fields=[{\n "is_required": True,\n "type_definition": {\n "name": "name",\n "options": [{\n "label": "label",\n "value": "value",\n }],\n "type": "bool",\n },\n }],\n labels={\n "foo": {\n "action_name": "actionName"\n }\n },\n object_types=["string"],\n published=True,\n object_request_options={\n "properties": ["string"]\n },\n)\nprint(public_action_definition.object_request_options)\n```\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.\n\n```python\nfrom pathlib import Path\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\nclient.cms.hubdb.tables.import_draft(\n table_id_or_name="tableIdOrName",\n file=Path("/path/to/file"),\n)\n```\n\nThe async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `hubspot_sdk.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `hubspot_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `hubspot_sdk.APIError`.\n\n```python\nimport hubspot_sdk\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\n\ntry:\n client.crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n )\nexcept hubspot_sdk.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept hubspot_sdk.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept hubspot_sdk.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom hubspot_sdk import HubSpot\n\n# Configure the default for all requests:\nclient = HubSpot(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom hubspot_sdk import HubSpot\n\n# Configure the default for all requests:\nclient = HubSpot(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = HubSpot(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).crm.objects.contacts.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `HUBSPOT_LOG` to `info`.\n\n```shell\n$ export HUBSPOT_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom hubspot_sdk import HubSpot\n\nclient = HubSpot()\nresponse = client.crm.objects.contacts.with_raw_response.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n)\nprint(response.headers.get(\'X-My-Header\'))\n\ncontact = response.parse() # get the object that `crm.objects.contacts.create()` would have returned\nprint(contact.id)\n```\n\nThese methods return an [`APIResponse`](https://github.com/HubSpot/hubspot-sdk-python/tree/main/src/hubspot_sdk/_response.py) object.\n\nThe async client returns an [`AsyncAPIResponse`](https://github.com/HubSpot/hubspot-sdk-python/tree/main/src/hubspot_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\n```python\nwith client.crm.objects.contacts.with_streaming_response.create(\n associations=[{\n "to": {\n "id": "id"\n },\n "types": [{\n "association_category": "HUBSPOT_DEFINED",\n "association_type_id": 0,\n }],\n }],\n properties={\n "foo": "string"\n },\n) as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom hubspot_sdk import HubSpot, DefaultHttpxClient\n\nclient = HubSpot(\n # Or use the `HUBSPOT_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom hubspot_sdk import HubSpot\n\nwith HubSpot() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport hubspot_sdk\nprint(hubspot_sdk.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', - }, - { - language: 'ruby', - content: - '# HubSpot Ruby API library\n\nThe HubSpot Ruby library provides convenient access to the HubSpot REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/HubSpot/hubspot-sdk-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/hubspot-sdk).\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "hubspot-sdk", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "hubspot_sdk"\n\nhubspot = HubSpotSDK::Client.new(access_token: "My Access Token")\n\nsimple_public_object_with_associations = hubspot.crm.objects.contacts.get("contactId")\n\nputs(simple_public_object_with_associations.id)\n```\n\n\n\n### Pagination\n\nList methods in the HubSpot API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = hubspot.crm.objects.contacts.list(limit: 100)\n\n# Fetch single item from page.\ncontact = page.results[0]\nputs(contact.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |contact|\n puts(contact.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.results[0].id)\nend\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.\n\n```ruby\nrequire "pathname"\n\n# Use `Pathname` to send the filename and/or avoid paging a large file into memory:\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: Pathname("/path/to/file"))\n\n# Alternatively, pass file contents or a `StringIO` directly:\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: File.read("/path/to/file"))\n\n# Or, to control the filename and/or content type:\nfile = HubSpotSDK::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")\nimport_result = hubspot.cms.hubdb.tables.import_draft(file: file)\n\nputs(import_result.duplicateRows)\n```\n\nNote that you can also pass a raw `IO` descriptor, but this disables retries, as the library can\'t be sure if the descriptor is a file or pipe (which cannot be rewound).\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `HubSpotSDK::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n contact = hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"}\n )\nrescue HubSpotSDK::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue HubSpotSDK::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue HubSpotSDK::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nhubspot = HubSpotSDK::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nhubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {max_retries: 5}\n)\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nhubspot = HubSpotSDK::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nhubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {timeout: 5}\n)\n```\n\nOn timeout, `HubSpotSDK::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `HubSpotSDK::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\nsimple_public_object =\n hubspot.crm.objects.contacts.create(\n associations: [{to: {id: "id"}, types: [{associationCategory: "HUBSPOT_DEFINED", associationTypeId: 0}]}],\n properties: {foo: "string"},\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(simple_public_object[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `HubSpotSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `HubSpotSDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nhubspot.crm.objects.contacts.get("contactId")\n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nhubspot.crm.objects.contacts.get("contactId")\n\n# You can also splat a full Params class:\nparams = HubSpotSDK::Crm::Objects::ContactGetParams.new\nhubspot.crm.objects.contacts.get("contactId", **params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :authorization_code\nputs(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE)\n\n# Revealed type: `T.all(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType, Symbol)`\nT.reveal_type(HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nhubspot.auth.oauth.create_token(\n grant_type: HubSpotSDK::Auth::OAuthCreateTokenParams::GrantType::AUTHORIZATION_CODE,\n # …\n)\n\n# Literal values are also permissible:\nhubspot.auth.oauth.create_token(\n grant_type: :authorization_code,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/HubSpot/hubspot-sdk-ruby/tree/main/CONTRIBUTING.md).\n', - }, - { - language: 'typescript', - content: - "# HubSpot TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@hubspot/sdk.svg?label=npm%20(stable))](https://npmjs.org/package/@hubspot/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@hubspot/sdk)\n\nThis library provides convenient access to the HubSpot REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developers.hubspot.com](https://developers.hubspot.com/docs/api-reference/overview). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the HubSpot MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40hubspot%2Fsdk-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBodWJzcG90L3Nkay1tY3AiXSwiZW52Ijp7IkhVQlNQT1RfQUNDRVNTX1RPS0VOIjoiTXkgQWNjZXNzIFRva2VuIiwiSFVCU1BPVF9ERVZFTE9QRVJfQVBJX0tFWSI6Ik15IERldmVsb3BlciBBUEkgS2V5In19)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40hubspot%2Fsdk-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40hubspot%2Fsdk-mcp%22%5D%2C%22env%22%3A%7B%22HUBSPOT_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22HUBSPOT_DEVELOPER_API_KEY%22%3A%22My%20Developer%20API%20Key%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @hubspot/sdk\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst result = await client.crm.objects.contacts.get('contactId');\n\nconsole.log(result.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n accessToken: 'My Access Token',\n});\n\nconst params: HubSpot.Crm.Objects.ContactCreateParams = {\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n};\nconst simplePublicObject: HubSpot.SimplePublicObject = await client.crm.objects.contacts.create(\n params,\n);\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n## File uploads\n\nRequest parameters that correspond to file uploads can be passed in many different forms:\n- `File` (or an object with the same structure)\n- a `fetch` `Response` (or an object with the same structure)\n- an `fs.ReadStream`\n- the return value of our `toFile` helper\n\n```ts\nimport fs from 'fs';\nimport HubSpot, { toFile } from '@hubspot/sdk';\n\nconst client = new HubSpot();\n\n// If you have access to Node `fs` we recommend using `fs.createReadStream()`:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: fs.createReadStream('/path/to/file'),\n});\n\n// Or if you have the web `File` API you can pass a `File` instance:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: new File(['my bytes'], 'file'),\n});\n\n// You can also pass a `fetch` `Response`:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await fetch('https://somesite/file'),\n});\n\n// Finally, if none of the above are convenient, you can use our `toFile` helper:\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await toFile(Buffer.from('my bytes'), 'file'),\n});\nawait client.cms.hubdb.tables.importDraft('tableIdOrName', {\n file: await toFile(new Uint8Array([0, 1, 2]), 'file'),\n});\n```\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst simplePublicObject = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .catch(async (err) => {\n if (err instanceof HubSpot.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n });\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new HubSpot({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}, {\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new HubSpot({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n}, {\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the HubSpot API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllSimplePublicObjectWithAssociations(params) {\n const allSimplePublicObjectWithAssociations = [];\n // Automatically fetches more pages as needed.\n for await (const simplePublicObjectWithAssociations of client.crm.objects.contacts.list({\n limit: 100,\n })) {\n allSimplePublicObjectWithAssociations.push(simplePublicObjectWithAssociations);\n }\n return allSimplePublicObjectWithAssociations;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.crm.objects.contacts.list({ limit: 100 });\nfor (const simplePublicObjectWithAssociations of page.results) {\n console.log(simplePublicObjectWithAssociations);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n\n\n## Advanced Usage\n\n### Tree shaking\n\nThis library supports tree shaking to reduce bundle size. Instead of importing the full client, you can create a client only including the API resources you need:\n\n~~~ts\nimport { createClient } from '@hubspot/sdk/tree-shakable';\nimport { Contacts } from '@hubspot/sdk/resources/crm/objects/contacts/contacts';\nimport { BaseTables } from '@hubspot/sdk/resources/cms/hubdb/tables';\n\nconst client = createClient({\n // Specify the resources you'd like to use ...\n resources: [Contacts, BaseTables],\n});\n\n// ... then make API calls as usual.\nconst simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n}],\n properties: { foo: 'string' },\n});\nconst hubDBTableV3 = await client.cms.hubdb.tables.cloneDraft('tableIdOrName', { copyRows: true, isHubspotDefined: true });\n~~~\n\nEach API resource has two versions, the full resource (e.g., `Contacts`) which includes all subresources, and the base resource (e.g., `BaseContacts`) which does not.\n\nThe tree-shaken client is fully typed, so TypeScript will provide accurate autocomplete and prevent access to resources not included in your configuration.\nThe `createClient` function automatically infers the correct type, but you can also use the `PartialHubSpot` type explicitly:\n\n~~~ts\nimport HubSpot from '@hubspot/sdk';\nimport { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable';\nimport { BaseContacts } from '@hubspot/sdk/resources/crm/objects/contacts/contacts';\n\n// Explicit variable type\nconst client: PartialHubSpot<{ crm: { objects: { contacts: BaseContacts } } }> = createClient({\n resources: [BaseContacts],\n /* ... */\n});\n\n// Function parameter type\nasync function main(client: PartialHubSpot<{ crm: { objects: { contacts: BaseContacts } } }>) {\n const simplePublicObject = await client.crm.objects.contacts.create({\n associations: [{\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n }],\n properties: { foo: 'string' },\n });\n}\n\n// Works with any client that has the contacts resource\nconst treeShakableClient = createClient({\n resources: [BaseContacts],\n /* ... */\n});\nconst fullClient = new HubSpot(/* ... */);\n\nmain(treeShakableClient); // Works\nmain(fullClient); // Also works\n~~~\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new HubSpot();\n\nconst response = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: simplePublicObject, response: raw } = await client.crm.objects.contacts\n .create({\n associations: [\n {\n to: { id: 'id' },\n types: [{ associationCategory: 'HUBSPOT_DEFINED', associationTypeId: 0 }],\n },\n ],\n properties: { foo: 'string' },\n })\n .withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nconsole.log(simplePublicObject.id);\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `HUBSPOT_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new HubSpot({\n logger: logger.child({ name: 'HubSpot' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.crm.objects.contacts.get({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport fetch from 'my-fetch';\n\nconst client = new HubSpot({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport HubSpot from '@hubspot/sdk';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new HubSpot({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport HubSpot from '@hubspot/sdk';\n\nconst client = new HubSpot({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport HubSpot from 'npm:@hubspot/sdk';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new HubSpot({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/HubSpot/hubspot-sdk-typescript/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", - }, -]; - -const INDEX_OPTIONS = { - fields: [ - 'name', - 'endpoint', - 'summary', - 'description', - 'qualified', - 'stainlessPath', - 'content', - 'sectionContext', - ], - storeFields: ['kind', '_original'], - searchOptions: { - prefix: true, - fuzzy: 0.1, - boost: { - name: 5, - stainlessPath: 3, - endpoint: 3, - qualified: 3, - summary: 2, - content: 1, - description: 1, - } as Record, - }, -}; - -/** - * Self-contained local search engine backed by MiniSearch. - * Method data is embedded at SDK build time; prose documents - * can be loaded from an optional docs directory at runtime. - */ -export class LocalDocsSearch { - private methodIndex: MiniSearch; - private proseIndex: MiniSearch; - - private constructor() { - this.methodIndex = new MiniSearch(INDEX_OPTIONS); - this.proseIndex = new MiniSearch(INDEX_OPTIONS); - } - - static async create(opts?: { docsDir?: string }): Promise { - const instance = new LocalDocsSearch(); - instance.indexMethods(EMBEDDED_METHODS); - for (const readme of EMBEDDED_READMES) { - instance.indexProse(readme.content, `readme:${readme.language}`); - } - if (opts?.docsDir) { - await instance.loadDocsDirectory(opts.docsDir); - } - return instance; - } - - search(props: { - query: string; - language?: string; - detail?: string; - maxResults?: number; - maxLength?: number; - }): SearchResult { - const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props; - - const useMarkdown = detail === 'verbose' || detail === 'high'; - - // Search both indices and merge results by score. - // Filter prose hits so language-tagged content (READMEs and docs with - // frontmatter) only matches the requested language. - const methodHits = this.methodIndex - .search(query) - .map((hit) => ({ ...hit, _kind: 'http_method' as const })); - const proseHits = this.proseIndex - .search(query) - .filter((hit) => { - const source = ((hit as Record)['_original'] as ProseChunk | undefined)?.source; - if (!source) return true; - // Check for language-tagged sources: "readme:" or "lang::" - let taggedLang: string | undefined; - if (source.startsWith('readme:')) taggedLang = source.slice('readme:'.length); - else if (source.startsWith('lang:')) taggedLang = source.split(':')[1]; - if (!taggedLang) return true; - return taggedLang === language || (language === 'javascript' && taggedLang === 'typescript'); - }) - .map((hit) => ({ ...hit, _kind: 'prose' as const })); - const merged = [...methodHits, ...proseHits].sort((a, b) => b.score - a.score); - const top = merged.slice(0, maxResults); - - const fullResults: (string | Record)[] = []; - - for (const hit of top) { - const original = (hit as Record)['_original']; - if (hit._kind === 'http_method') { - const m = original as MethodEntry; - if (useMarkdown && m.markdown) { - fullResults.push(m.markdown); - } else { - // Use per-language data when available, falling back to the - // top-level fields (which are TypeScript-specific in the - // legacy codepath). - const langData = m.perLanguage?.[language]; - fullResults.push({ - method: langData?.method ?? m.qualified, - summary: m.summary, - description: m.description, - endpoint: `${m.httpMethod.toUpperCase()} ${m.endpoint}`, - ...(langData?.example ? { example: langData.example } : {}), - ...(m.params ? { params: m.params } : {}), - ...(m.response ? { response: m.response } : {}), - }); - } - } else { - const c = original as ProseChunk; - fullResults.push({ - content: c.content, - ...(c.source ? { source: c.source } : {}), - }); - } - } - - let totalLength = 0; - const results: (string | Record)[] = []; - for (const result of fullResults) { - const len = typeof result === 'string' ? result.length : JSON.stringify(result).length; - totalLength += len; - if (totalLength > maxLength) break; - results.push(result); - } - - if (results.length < fullResults.length) { - results.unshift(`Truncated; showing ${results.length} of ${fullResults.length} results.`); - } - - return { results }; - } - - private indexMethods(methods: MethodEntry[]): void { - const docs: MiniSearchDocument[] = methods.map((m, i) => ({ - id: `method-${i}`, - kind: 'http_method' as const, - name: m.name, - endpoint: m.endpoint, - summary: m.summary, - description: m.description, - qualified: m.qualified, - stainlessPath: m.stainlessPath, - _original: m as unknown as Record, - })); - if (docs.length > 0) { - this.methodIndex.addAll(docs); - } - } - - private async loadDocsDirectory(docsDir: string): Promise { - let entries; - try { - entries = await fs.readdir(docsDir, { withFileTypes: true }); - } catch (err) { - getLogger().warn({ err, docsDir }, 'Could not read docs directory'); - return; - } - - const files = entries - .filter((e) => e.isFile()) - .filter((e) => e.name.endsWith('.md') || e.name.endsWith('.markdown') || e.name.endsWith('.json')); - - for (const file of files) { - try { - const filePath = path.join(docsDir, file.name); - const content = await fs.readFile(filePath, 'utf-8'); - - if (file.name.endsWith('.json')) { - const texts = extractTexts(JSON.parse(content)); - if (texts.length > 0) { - this.indexProse(texts.join('\n\n'), file.name); - } - } else { - // Parse optional YAML frontmatter for language tagging. - // Files with a "language" field in frontmatter will only - // surface in searches for that language. - // - // Example: - // --- - // language: python - // --- - // # Error handling in Python - // ... - const frontmatter = parseFrontmatter(content); - const source = frontmatter.language ? `lang:${frontmatter.language}:${file.name}` : file.name; - this.indexProse(content, source); - } - } catch (err) { - getLogger().warn({ err, file: file.name }, 'Failed to index docs file'); - } - } - } - - private indexProse(markdown: string, source: string): void { - const chunks = chunkMarkdown(markdown); - const baseId = this.proseIndex.documentCount; - - const docs: MiniSearchDocument[] = chunks.map((chunk, i) => ({ - id: `prose-${baseId + i}`, - kind: 'prose' as const, - content: chunk.content, - ...(chunk.sectionContext != null ? { sectionContext: chunk.sectionContext } : {}), - _original: { ...chunk, source } as unknown as Record, - })); - - if (docs.length > 0) { - this.proseIndex.addAll(docs); - } - } -} - -/** Lightweight markdown chunker — splits on headers, chunks by word count. */ -function chunkMarkdown(markdown: string): { content: string; tag: string; sectionContext?: string }[] { - // Strip YAML frontmatter - const stripped = markdown.replace(/^---\n[\s\S]*?\n---\n?/, ''); - const lines = stripped.split('\n'); - - const chunks: { content: string; tag: string; sectionContext?: string }[] = []; - const headers: string[] = []; - let current: string[] = []; - - const flush = () => { - const text = current.join('\n').trim(); - if (!text) return; - const sectionContext = headers.length > 0 ? headers.join(' > ') : undefined; - // Split into ~200-word chunks - const words = text.split(/\s+/); - for (let i = 0; i < words.length; i += 200) { - const slice = words.slice(i, i + 200).join(' '); - if (slice) { - chunks.push({ content: slice, tag: 'p', ...(sectionContext != null ? { sectionContext } : {}) }); - } - } - current = []; - }; - - for (const line of lines) { - const headerMatch = line.match(/^(#{1,6})\s+(.+)/); - if (headerMatch) { - flush(); - const level = headerMatch[1]!.length; - const text = headerMatch[2]!.trim(); - while (headers.length >= level) headers.pop(); - headers.push(text); - } else { - current.push(line); - } - } - flush(); - - return chunks; -} - -/** Recursively extracts string values from a JSON structure. */ -function extractTexts(data: unknown, depth = 0): string[] { - if (depth > 10) return []; - if (typeof data === 'string') return data.trim() ? [data] : []; - if (Array.isArray(data)) return data.flatMap((item) => extractTexts(item, depth + 1)); - if (typeof data === 'object' && data !== null) { - return Object.values(data).flatMap((v) => extractTexts(v, depth + 1)); - } - return []; -} - -/** Parses YAML frontmatter from a markdown string, extracting the language field if present. */ -function parseFrontmatter(markdown: string): { language?: string } { - const match = markdown.match(/^---\n([\s\S]*?)\n---/); - if (!match) return {}; - const body = match[1] ?? ''; - const langMatch = body.match(/^language:\s*(.+)$/m); - return langMatch ? { language: langMatch[1]!.trim() } : {}; -} diff --git a/packages/mcp-server/src/logger.ts b/packages/mcp-server/src/logger.ts deleted file mode 100644 index 29dab11c..00000000 --- a/packages/mcp-server/src/logger.ts +++ /dev/null @@ -1,28 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { pino, type Level, type Logger } from 'pino'; -import pretty from 'pino-pretty'; - -let _logger: Logger | undefined; - -export function configureLogger({ level, pretty: usePretty }: { level: Level; pretty: boolean }): void { - _logger = pino( - { - level, - timestamp: pino.stdTimeFunctions.isoTime, - formatters: { - level(label) { - return { level: label }; - }, - }, - }, - usePretty ? pretty({ colorize: true, levelFirst: true, destination: 2 }) : process.stderr, - ); -} - -export function getLogger(): Logger { - if (!_logger) { - throw new Error('Logger has not been configured. Call configureLogger() before using the logger.'); - } - return _logger; -} diff --git a/packages/mcp-server/src/methods.ts b/packages/mcp-server/src/methods.ts deleted file mode 100644 index 7683c8ee..00000000 --- a/packages/mcp-server/src/methods.ts +++ /dev/null @@ -1,5982 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { McpOptions } from './options'; - -export type SdkMethod = { - clientCallName: string; - fullyQualifiedName: string; - httpMethod?: 'get' | 'post' | 'put' | 'patch' | 'delete' | 'query'; - httpPath?: string; -}; - -export const sdkMethods: SdkMethod[] = [ - { - clientCallName: 'client.account.get', - fullyQualifiedName: 'account.get', - httpMethod: 'get', - httpPath: '/account-info/2026-03/details', - }, - { - clientCallName: 'client.account.getDailyPrivateAppsUsage', - fullyQualifiedName: 'account.getDailyPrivateAppsUsage', - httpMethod: 'get', - httpPath: '/account-info/2026-03/api-usage/daily/private-apps', - }, - { - clientCallName: 'client.account.activity.listAuditLogs', - fullyQualifiedName: 'account.activity.listAuditLogs', - httpMethod: 'get', - httpPath: '/account-info/2026-03/activity/audit-logs', - }, - { - clientCallName: 'client.account.activity.listLoginActivities', - fullyQualifiedName: 'account.activity.listLoginActivities', - httpMethod: 'get', - httpPath: '/account-info/2026-03/activity/login', - }, - { - clientCallName: 'client.account.activity.listSecurityActivities', - fullyQualifiedName: 'account.activity.listSecurityActivities', - httpMethod: 'get', - httpPath: '/account-info/2026-03/activity/security', - }, - { - clientCallName: 'client.auth.oauth.createToken', - fullyQualifiedName: 'auth.oauth.createToken', - httpMethod: 'post', - httpPath: '/oauth/2026-03/token', - }, - { - clientCallName: 'client.auth.oauth.introspectToken', - fullyQualifiedName: 'auth.oauth.introspectToken', - httpMethod: 'post', - httpPath: '/oauth/2026-03/token/introspect', - }, - { - clientCallName: 'client.auth.oauth.revokeToken', - fullyQualifiedName: 'auth.oauth.revokeToken', - httpMethod: 'post', - httpPath: '/oauth/2026-03/token/revoke', - }, - { - clientCallName: 'client.automation.actions.callbacks.complete', - fullyQualifiedName: 'automation.actions.callbacks.complete', - httpMethod: 'post', - httpPath: '/automation/actions/callbacks/2026-03/{callbackId}/complete', - }, - { - clientCallName: 'client.automation.actions.callbacks.completeBatch', - fullyQualifiedName: 'automation.actions.callbacks.completeBatch', - httpMethod: 'post', - httpPath: '/automation/actions/callbacks/2026-03/complete', - }, - { - clientCallName: 'client.automation.actions.definitions.create', - fullyQualifiedName: 'automation.actions.definitions.create', - httpMethod: 'post', - httpPath: '/automation/actions/2026-03/{appId}', - }, - { - clientCallName: 'client.automation.actions.definitions.update', - fullyQualifiedName: 'automation.actions.definitions.update', - httpMethod: 'patch', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', - }, - { - clientCallName: 'client.automation.actions.definitions.list', - fullyQualifiedName: 'automation.actions.definitions.list', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}', - }, - { - clientCallName: 'client.automation.actions.definitions.delete', - fullyQualifiedName: 'automation.actions.definitions.delete', - httpMethod: 'delete', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', - }, - { - clientCallName: 'client.automation.actions.definitions.createRequiresObject', - fullyQualifiedName: 'automation.actions.definitions.createRequiresObject', - httpMethod: 'post', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', - }, - { - clientCallName: 'client.automation.actions.definitions.get', - fullyQualifiedName: 'automation.actions.definitions.get', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}', - }, - { - clientCallName: 'client.automation.actions.definitions.getRequiresObject', - fullyQualifiedName: 'automation.actions.definitions.getRequiresObject', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/requires-object', - }, - { - clientCallName: 'client.automation.actions.functions.list', - fullyQualifiedName: 'automation.actions.functions.list', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions', - }, - { - clientCallName: 'client.automation.actions.functions.delete', - fullyQualifiedName: 'automation.actions.functions.delete', - httpMethod: 'delete', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - }, - { - clientCallName: 'client.automation.actions.functions.createOrReplace', - fullyQualifiedName: 'automation.actions.functions.createOrReplace', - httpMethod: 'put', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - }, - { - clientCallName: 'client.automation.actions.functions.createOrReplaceByFunctionType', - fullyQualifiedName: 'automation.actions.functions.createOrReplaceByFunctionType', - httpMethod: 'put', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - }, - { - clientCallName: 'client.automation.actions.functions.deleteByFunctionType', - fullyQualifiedName: 'automation.actions.functions.deleteByFunctionType', - httpMethod: 'delete', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - }, - { - clientCallName: 'client.automation.actions.functions.get', - fullyQualifiedName: 'automation.actions.functions.get', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}', - }, - { - clientCallName: 'client.automation.actions.functions.getByFunctionType', - fullyQualifiedName: 'automation.actions.functions.getByFunctionType', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}', - }, - { - clientCallName: 'client.automation.actions.revisions.list', - fullyQualifiedName: 'automation.actions.revisions.list', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/revisions', - }, - { - clientCallName: 'client.automation.actions.revisions.get', - fullyQualifiedName: 'automation.actions.revisions.get', - httpMethod: 'get', - httpPath: '/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.automation.sequences.list', - fullyQualifiedName: 'automation.sequences.list', - httpMethod: 'get', - httpPath: '/automation/sequences/2026-03', - }, - { - clientCallName: 'client.automation.sequences.createEnrollment', - fullyQualifiedName: 'automation.sequences.createEnrollment', - httpMethod: 'post', - httpPath: '/automation/sequences/2026-03/enrollments', - }, - { - clientCallName: 'client.automation.sequences.get', - fullyQualifiedName: 'automation.sequences.get', - httpMethod: 'get', - httpPath: '/automation/sequences/2026-03/{sequenceId}', - }, - { - clientCallName: 'client.automation.sequences.getEnrollmentByContactID', - fullyQualifiedName: 'automation.sequences.getEnrollmentByContactID', - httpMethod: 'get', - httpPath: '/automation/sequences/2026-03/enrollments/contact/{contactId}', - }, - { - clientCallName: 'client.businessUnits.businessUnitEntries.getByUserID', - fullyQualifiedName: 'businessUnits.businessUnitEntries.getByUserID', - httpMethod: 'get', - httpPath: '/business-units/public/2026-03/business-units/user/{userId}', - }, - { - clientCallName: 'client.cms.auditLogs.list', - fullyQualifiedName: 'cms.auditLogs.list', - httpMethod: 'get', - httpPath: '/cms/audit-logs/2026-03', - }, - { - clientCallName: 'client.cms.auditLogs.export', - fullyQualifiedName: 'cms.auditLogs.export', - httpMethod: 'post', - httpPath: '/cms/audit-logs/2026-03/export', - }, - { - clientCallName: 'client.cms.blogs.authors.create', - fullyQualifiedName: 'cms.blogs.authors.create', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors', - }, - { - clientCallName: 'client.cms.blogs.authors.update', - fullyQualifiedName: 'cms.blogs.authors.update', - httpMethod: 'patch', - httpPath: '/cms/blogs/2026-03/authors/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.authors.list', - fullyQualifiedName: 'cms.blogs.authors.list', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors', - }, - { - clientCallName: 'client.cms.blogs.authors.delete', - fullyQualifiedName: 'cms.blogs.authors.delete', - httpMethod: 'delete', - httpPath: '/cms/blogs/2026-03/authors/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.authors.attachToLangGroup', - fullyQualifiedName: 'cms.blogs.authors.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.blogs.authors.createLanguageVariation', - fullyQualifiedName: 'cms.blogs.authors.createLanguageVariation', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.blogs.authors.detachFromLangGroup', - fullyQualifiedName: 'cms.blogs.authors.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.blogs.authors.get', - fullyQualifiedName: 'cms.blogs.authors.get', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.authors.getCursor', - fullyQualifiedName: 'cms.blogs.authors.getCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor', - }, - { - clientCallName: 'client.cms.blogs.authors.getCursorByQuery', - fullyQualifiedName: 'cms.blogs.authors.getCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.authors.getPostsCursor', - fullyQualifiedName: 'cms.blogs.authors.getPostsCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor', - }, - { - clientCallName: 'client.cms.blogs.authors.getPostsCursorByQuery', - fullyQualifiedName: 'cms.blogs.authors.getPostsCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.authors.getTagsCursor', - fullyQualifiedName: 'cms.blogs.authors.getTagsCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor', - }, - { - clientCallName: 'client.cms.blogs.authors.getTagsCursorByQuery', - fullyQualifiedName: 'cms.blogs.authors.getTagsCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.authors.setNewLangPrimary', - fullyQualifiedName: 'cms.blogs.authors.setNewLangPrimary', - httpMethod: 'put', - httpPath: '/cms/blogs/2026-03/authors/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.blogs.authors.updateLanguages', - fullyQualifiedName: 'cms.blogs.authors.updateLanguages', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.blogs.authors.batch.create', - fullyQualifiedName: 'cms.blogs.authors.batch.create', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/batch/create', - }, - { - clientCallName: 'client.cms.blogs.authors.batch.update', - fullyQualifiedName: 'cms.blogs.authors.batch.update', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/batch/update', - }, - { - clientCallName: 'client.cms.blogs.authors.batch.delete', - fullyQualifiedName: 'cms.blogs.authors.batch.delete', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/batch/archive', - }, - { - clientCallName: 'client.cms.blogs.authors.batch.get', - fullyQualifiedName: 'cms.blogs.authors.batch.get', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/authors/batch/read', - }, - { - clientCallName: 'client.cms.blogs.posts.create', - fullyQualifiedName: 'cms.blogs.posts.create', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts', - }, - { - clientCallName: 'client.cms.blogs.posts.update', - fullyQualifiedName: 'cms.blogs.posts.update', - httpMethod: 'patch', - httpPath: '/cms/blogs/2026-03/posts/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.posts.list', - fullyQualifiedName: 'cms.blogs.posts.list', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor', - }, - { - clientCallName: 'client.cms.blogs.posts.delete', - fullyQualifiedName: 'cms.blogs.posts.delete', - httpMethod: 'delete', - httpPath: '/cms/blogs/2026-03/posts/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.posts.clone', - fullyQualifiedName: 'cms.blogs.posts.clone', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/clone', - }, - { - clientCallName: 'client.cms.blogs.posts.get', - fullyQualifiedName: 'cms.blogs.posts.get', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.posts.getDraftByID', - fullyQualifiedName: 'cms.blogs.posts.getDraftByID', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft', - }, - { - clientCallName: 'client.cms.blogs.posts.listAuthors', - fullyQualifiedName: 'cms.blogs.posts.listAuthors', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor', - }, - { - clientCallName: 'client.cms.blogs.posts.listTags', - fullyQualifiedName: 'cms.blogs.posts.listTags', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor', - }, - { - clientCallName: 'client.cms.blogs.posts.pushLive', - fullyQualifiedName: 'cms.blogs.posts.pushLive', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft/push-live', - }, - { - clientCallName: 'client.cms.blogs.posts.query', - fullyQualifiedName: 'cms.blogs.posts.query', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.posts.queryAuthors', - fullyQualifiedName: 'cms.blogs.posts.queryAuthors', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.posts.queryTags', - fullyQualifiedName: 'cms.blogs.posts.queryTags', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.posts.resetDraft', - fullyQualifiedName: 'cms.blogs.posts.resetDraft', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft/reset', - }, - { - clientCallName: 'client.cms.blogs.posts.schedule', - fullyQualifiedName: 'cms.blogs.posts.schedule', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/schedule', - }, - { - clientCallName: 'client.cms.blogs.posts.updateDraft', - fullyQualifiedName: 'cms.blogs.posts.updateDraft', - httpMethod: 'patch', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/draft', - }, - { - clientCallName: 'client.cms.blogs.posts.batch.create', - fullyQualifiedName: 'cms.blogs.posts.batch.create', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/batch/create', - }, - { - clientCallName: 'client.cms.blogs.posts.batch.update', - fullyQualifiedName: 'cms.blogs.posts.batch.update', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/batch/update', - }, - { - clientCallName: 'client.cms.blogs.posts.batch.delete', - fullyQualifiedName: 'cms.blogs.posts.batch.delete', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/batch/archive', - }, - { - clientCallName: 'client.cms.blogs.posts.batch.get', - fullyQualifiedName: 'cms.blogs.posts.batch.get', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/batch/read', - }, - { - clientCallName: 'client.cms.blogs.posts.multiLanguage.attachToLangGroup', - fullyQualifiedName: 'cms.blogs.posts.multiLanguage.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.blogs.posts.multiLanguage.createLangVariation', - fullyQualifiedName: 'cms.blogs.posts.multiLanguage.createLangVariation', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.blogs.posts.multiLanguage.detachFromLangGroup', - fullyQualifiedName: 'cms.blogs.posts.multiLanguage.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.blogs.posts.multiLanguage.setLangPrimary', - fullyQualifiedName: 'cms.blogs.posts.multiLanguage.setLangPrimary', - httpMethod: 'put', - httpPath: '/cms/blogs/2026-03/posts/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.blogs.posts.multiLanguage.updateLangs', - fullyQualifiedName: 'cms.blogs.posts.multiLanguage.updateLangs', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.blogs.posts.revisions.getPreviousVersion', - fullyQualifiedName: 'cms.blogs.posts.revisions.getPreviousVersion', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.cms.blogs.posts.revisions.getPreviousVersions', - fullyQualifiedName: 'cms.blogs.posts.revisions.getPreviousVersions', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions', - }, - { - clientCallName: 'client.cms.blogs.posts.revisions.restorePreviousVersion', - fullyQualifiedName: 'cms.blogs.posts.revisions.restorePreviousVersion', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore', - }, - { - clientCallName: 'client.cms.blogs.posts.revisions.restorePreviousVersionToDraft', - fullyQualifiedName: 'cms.blogs.posts.revisions.restorePreviousVersionToDraft', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/posts/{objectId}/revisions/{revisionId}/restore-to-draft', - }, - { - clientCallName: 'client.cms.blogs.settings.list', - fullyQualifiedName: 'cms.blogs.settings.list', - httpMethod: 'get', - httpPath: '/cms/blog-settings/2026-03/settings', - }, - { - clientCallName: 'client.cms.blogs.settings.get', - fullyQualifiedName: 'cms.blogs.settings.get', - httpMethod: 'get', - httpPath: '/cms/blog-settings/2026-03/settings/{blogId}', - }, - { - clientCallName: 'client.cms.blogs.settings.getRevision', - fullyQualifiedName: 'cms.blogs.settings.getRevision', - httpMethod: 'get', - httpPath: '/cms/blog-settings/2026-03/settings/{blogId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.cms.blogs.settings.listRevisions', - fullyQualifiedName: 'cms.blogs.settings.listRevisions', - httpMethod: 'get', - httpPath: '/cms/blog-settings/2026-03/settings/{blogId}/revisions', - }, - { - clientCallName: 'client.cms.blogs.settings.multiLanguage.attachToLangGroup', - fullyQualifiedName: 'cms.blogs.settings.multiLanguage.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/blog-settings/2026-03/settings/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.blogs.settings.multiLanguage.createLanguageVariation', - fullyQualifiedName: 'cms.blogs.settings.multiLanguage.createLanguageVariation', - httpMethod: 'post', - httpPath: '/cms/blog-settings/2026-03/settings/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.blogs.settings.multiLanguage.detachFromLangGroup', - fullyQualifiedName: 'cms.blogs.settings.multiLanguage.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/blog-settings/2026-03/settings/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.blogs.settings.multiLanguage.setNewLangPrimary', - fullyQualifiedName: 'cms.blogs.settings.multiLanguage.setNewLangPrimary', - httpMethod: 'put', - httpPath: '/cms/blog-settings/2026-03/settings/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.blogs.settings.multiLanguage.updateLanguages', - fullyQualifiedName: 'cms.blogs.settings.multiLanguage.updateLanguages', - httpMethod: 'post', - httpPath: '/cms/blog-settings/2026-03/settings/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.blogs.tags.create', - fullyQualifiedName: 'cms.blogs.tags.create', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags', - }, - { - clientCallName: 'client.cms.blogs.tags.update', - fullyQualifiedName: 'cms.blogs.tags.update', - httpMethod: 'patch', - httpPath: '/cms/blogs/2026-03/tags/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.tags.list', - fullyQualifiedName: 'cms.blogs.tags.list', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags', - }, - { - clientCallName: 'client.cms.blogs.tags.delete', - fullyQualifiedName: 'cms.blogs.tags.delete', - httpMethod: 'delete', - httpPath: '/cms/blogs/2026-03/tags/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.tags.attachToLangGroup', - fullyQualifiedName: 'cms.blogs.tags.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.blogs.tags.createLangVariation', - fullyQualifiedName: 'cms.blogs.tags.createLangVariation', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.blogs.tags.detachFromLangGroup', - fullyQualifiedName: 'cms.blogs.tags.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.blogs.tags.get', - fullyQualifiedName: 'cms.blogs.tags.get', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/{objectId}', - }, - { - clientCallName: 'client.cms.blogs.tags.listAuthorsCursor', - fullyQualifiedName: 'cms.blogs.tags.listAuthorsCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor', - }, - { - clientCallName: 'client.cms.blogs.tags.listAuthorsCursorByQuery', - fullyQualifiedName: 'cms.blogs.tags.listAuthorsCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/authors/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.tags.listCursor', - fullyQualifiedName: 'cms.blogs.tags.listCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor', - }, - { - clientCallName: 'client.cms.blogs.tags.listCursorByQuery', - fullyQualifiedName: 'cms.blogs.tags.listCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/tags/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.tags.listPostsCursor', - fullyQualifiedName: 'cms.blogs.tags.listPostsCursor', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor', - }, - { - clientCallName: 'client.cms.blogs.tags.listPostsCursorByQuery', - fullyQualifiedName: 'cms.blogs.tags.listPostsCursorByQuery', - httpMethod: 'get', - httpPath: '/cms/blogs/2026-03/posts/cursor/query', - }, - { - clientCallName: 'client.cms.blogs.tags.setLangPrimary', - fullyQualifiedName: 'cms.blogs.tags.setLangPrimary', - httpMethod: 'put', - httpPath: '/cms/blogs/2026-03/tags/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.blogs.tags.updateLangs', - fullyQualifiedName: 'cms.blogs.tags.updateLangs', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.blogs.tags.batch.delete', - fullyQualifiedName: 'cms.blogs.tags.batch.delete', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/batch/archive', - }, - { - clientCallName: 'client.cms.blogs.tags.batch.createBatch', - fullyQualifiedName: 'cms.blogs.tags.batch.createBatch', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/batch/create', - }, - { - clientCallName: 'client.cms.blogs.tags.batch.getBatch', - fullyQualifiedName: 'cms.blogs.tags.batch.getBatch', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/batch/read', - }, - { - clientCallName: 'client.cms.blogs.tags.batch.updateBatch', - fullyQualifiedName: 'cms.blogs.tags.batch.updateBatch', - httpMethod: 'post', - httpPath: '/cms/blogs/2026-03/tags/batch/update', - }, - { - clientCallName: 'client.cms.domains.list', - fullyQualifiedName: 'cms.domains.list', - httpMethod: 'get', - httpPath: '/cms/domains/2026-03', - }, - { - clientCallName: 'client.cms.domains.get', - fullyQualifiedName: 'cms.domains.get', - httpMethod: 'get', - httpPath: '/cms/domains/2026-03/{domainId}', - }, - { - clientCallName: 'client.cms.hubdb.rows.create', - fullyQualifiedName: 'cms.hubdb.rows.create', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', - }, - { - clientCallName: 'client.cms.hubdb.rows.list', - fullyQualifiedName: 'cms.hubdb.rows.list', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows', - }, - { - clientCallName: 'client.cms.hubdb.rows.cloneBatch', - fullyQualifiedName: 'cms.hubdb.rows.cloneBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/clone', - }, - { - clientCallName: 'client.cms.hubdb.rows.cloneDraft', - fullyQualifiedName: 'cms.hubdb.rows.cloneDraft', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft/clone', - }, - { - clientCallName: 'client.cms.hubdb.rows.createBatch', - fullyQualifiedName: 'cms.hubdb.rows.createBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/create', - }, - { - clientCallName: 'client.cms.hubdb.rows.deleteDraft', - fullyQualifiedName: 'cms.hubdb.rows.deleteDraft', - httpMethod: 'delete', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - }, - { - clientCallName: 'client.cms.hubdb.rows.get', - fullyQualifiedName: 'cms.hubdb.rows.get', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}', - }, - { - clientCallName: 'client.cms.hubdb.rows.getBatch', - fullyQualifiedName: 'cms.hubdb.rows.getBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/batch/read', - }, - { - clientCallName: 'client.cms.hubdb.rows.getDraft', - fullyQualifiedName: 'cms.hubdb.rows.getDraft', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - }, - { - clientCallName: 'client.cms.hubdb.rows.getDraftBatch', - fullyQualifiedName: 'cms.hubdb.rows.getDraftBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/read', - }, - { - clientCallName: 'client.cms.hubdb.rows.purgeBatch', - fullyQualifiedName: 'cms.hubdb.rows.purgeBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/purge', - }, - { - clientCallName: 'client.cms.hubdb.rows.replaceBatch', - fullyQualifiedName: 'cms.hubdb.rows.replaceBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/replace', - }, - { - clientCallName: 'client.cms.hubdb.rows.replaceDraft', - fullyQualifiedName: 'cms.hubdb.rows.replaceDraft', - httpMethod: 'put', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - }, - { - clientCallName: 'client.cms.hubdb.rows.updateBatch', - fullyQualifiedName: 'cms.hubdb.rows.updateBatch', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/draft/batch/update', - }, - { - clientCallName: 'client.cms.hubdb.rows.updateDraft', - fullyQualifiedName: 'cms.hubdb.rows.updateDraft', - httpMethod: 'patch', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/rows/{rowId}/draft', - }, - { - clientCallName: 'client.cms.hubdb.tables.create', - fullyQualifiedName: 'cms.hubdb.tables.create', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables', - }, - { - clientCallName: 'client.cms.hubdb.tables.list', - fullyQualifiedName: 'cms.hubdb.tables.list', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables', - }, - { - clientCallName: 'client.cms.hubdb.tables.delete', - fullyQualifiedName: 'cms.hubdb.tables.delete', - httpMethod: 'delete', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}', - }, - { - clientCallName: 'client.cms.hubdb.tables.cloneDraft', - fullyQualifiedName: 'cms.hubdb.tables.cloneDraft', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/clone', - }, - { - clientCallName: 'client.cms.hubdb.tables.deleteVersion', - fullyQualifiedName: 'cms.hubdb.tables.deleteVersion', - httpMethod: 'delete', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/versions/{versionId}', - }, - { - clientCallName: 'client.cms.hubdb.tables.export', - fullyQualifiedName: 'cms.hubdb.tables.export', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/export', - }, - { - clientCallName: 'client.cms.hubdb.tables.exportDraft', - fullyQualifiedName: 'cms.hubdb.tables.exportDraft', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/export', - }, - { - clientCallName: 'client.cms.hubdb.tables.get', - fullyQualifiedName: 'cms.hubdb.tables.get', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}', - }, - { - clientCallName: 'client.cms.hubdb.tables.getDraft', - fullyQualifiedName: 'cms.hubdb.tables.getDraft', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', - }, - { - clientCallName: 'client.cms.hubdb.tables.importDraft', - fullyQualifiedName: 'cms.hubdb.tables.importDraft', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/import', - }, - { - clientCallName: 'client.cms.hubdb.tables.listDraft', - fullyQualifiedName: 'cms.hubdb.tables.listDraft', - httpMethod: 'get', - httpPath: '/cms/hubdb/2026-03/tables/draft', - }, - { - clientCallName: 'client.cms.hubdb.tables.publishDraft', - fullyQualifiedName: 'cms.hubdb.tables.publishDraft', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/publish', - }, - { - clientCallName: 'client.cms.hubdb.tables.resetDraft', - fullyQualifiedName: 'cms.hubdb.tables.resetDraft', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft/reset', - }, - { - clientCallName: 'client.cms.hubdb.tables.unpublish', - fullyQualifiedName: 'cms.hubdb.tables.unpublish', - httpMethod: 'post', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/unpublish', - }, - { - clientCallName: 'client.cms.hubdb.tables.updateDraft', - fullyQualifiedName: 'cms.hubdb.tables.updateDraft', - httpMethod: 'patch', - httpPath: '/cms/hubdb/2026-03/tables/{tableIdOrName}/draft', - }, - { - clientCallName: 'client.cms.mediaBridge.createAssociation', - fullyQualifiedName: 'cms.mediaBridge.createAssociation', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations', - }, - { - clientCallName: 'client.cms.mediaBridge.createAttentionSpanEvent', - fullyQualifiedName: 'cms.mediaBridge.createAttentionSpanEvent', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/events/attention-span', - }, - { - clientCallName: 'client.cms.mediaBridge.createMediaPlayedEvent', - fullyQualifiedName: 'cms.mediaBridge.createMediaPlayedEvent', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/events/media-played', - }, - { - clientCallName: 'client.cms.mediaBridge.createMediaPlayedPercentEvent', - fullyQualifiedName: 'cms.mediaBridge.createMediaPlayedPercentEvent', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/events/media-played-percent', - }, - { - clientCallName: 'client.cms.mediaBridge.createObjectType', - fullyQualifiedName: 'cms.mediaBridge.createObjectType', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/settings/object-definitions', - }, - { - clientCallName: 'client.cms.mediaBridge.createOembedDomain', - fullyQualifiedName: 'cms.mediaBridge.createOembedDomain', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - }, - { - clientCallName: 'client.cms.mediaBridge.createProperty', - fullyQualifiedName: 'cms.mediaBridge.createProperty', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}', - }, - { - clientCallName: 'client.cms.mediaBridge.createPropertyGroup', - fullyQualifiedName: 'cms.mediaBridge.createPropertyGroup', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', - }, - { - clientCallName: 'client.cms.mediaBridge.createVideoAssociationDefinition', - fullyQualifiedName: 'cms.mediaBridge.createVideoAssociationDefinition', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/settings/video-association-definition', - }, - { - clientCallName: 'client.cms.mediaBridge.deleteAssociation', - fullyQualifiedName: 'cms.mediaBridge.deleteAssociation', - httpMethod: 'delete', - httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}/associations/{associationId}', - }, - { - clientCallName: 'client.cms.mediaBridge.deleteOembedDomain', - fullyQualifiedName: 'cms.mediaBridge.deleteOembedDomain', - httpMethod: 'delete', - httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - }, - { - clientCallName: 'client.cms.mediaBridge.deleteProperty', - fullyQualifiedName: 'cms.mediaBridge.deleteProperty', - httpMethod: 'delete', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.cms.mediaBridge.deletePropertyGroup', - fullyQualifiedName: 'cms.mediaBridge.deletePropertyGroup', - httpMethod: 'delete', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.cms.mediaBridge.getEventVisibilitySettings', - fullyQualifiedName: 'cms.mediaBridge.getEventVisibilitySettings', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/settings/event-visibility', - }, - { - clientCallName: 'client.cms.mediaBridge.getOembedDomain', - fullyQualifiedName: 'cms.mediaBridge.getOembedDomain', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', - }, - { - clientCallName: 'client.cms.mediaBridge.getProperty', - fullyQualifiedName: 'cms.mediaBridge.getProperty', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.cms.mediaBridge.getPropertyGroup', - fullyQualifiedName: 'cms.mediaBridge.getPropertyGroup', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.cms.mediaBridge.getSchema', - fullyQualifiedName: 'cms.mediaBridge.getSchema', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}', - }, - { - clientCallName: 'client.cms.mediaBridge.listObjectTypesByMediaType', - fullyQualifiedName: 'cms.mediaBridge.listObjectTypesByMediaType', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/settings/object-definitions/{mediaType}', - }, - { - clientCallName: 'client.cms.mediaBridge.listOembedDomains', - fullyQualifiedName: 'cms.mediaBridge.listOembedDomains', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains', - }, - { - clientCallName: 'client.cms.mediaBridge.listProperties', - fullyQualifiedName: 'cms.mediaBridge.listProperties', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}', - }, - { - clientCallName: 'client.cms.mediaBridge.listPropertyGroups', - fullyQualifiedName: 'cms.mediaBridge.listPropertyGroups', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups', - }, - { - clientCallName: 'client.cms.mediaBridge.listSchemas', - fullyQualifiedName: 'cms.mediaBridge.listSchemas', - httpMethod: 'get', - httpPath: '/media-bridge/2026-03/{appId}/schemas', - }, - { - clientCallName: 'client.cms.mediaBridge.registerAppName', - fullyQualifiedName: 'cms.mediaBridge.registerAppName', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/settings/register', - }, - { - clientCallName: 'client.cms.mediaBridge.updateEventVisibilitySettings', - fullyQualifiedName: 'cms.mediaBridge.updateEventVisibilitySettings', - httpMethod: 'patch', - httpPath: '/media-bridge/2026-03/{appId}/settings/event-visibility', - }, - { - clientCallName: 'client.cms.mediaBridge.updateOembedDomain', - fullyQualifiedName: 'cms.mediaBridge.updateOembedDomain', - httpMethod: 'patch', - httpPath: '/media-bridge/2026-03/{appId}/settings/oembed-domains/{oEmbedDomainId}', - }, - { - clientCallName: 'client.cms.mediaBridge.updateProperty', - fullyQualifiedName: 'cms.mediaBridge.updateProperty', - httpMethod: 'patch', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.cms.mediaBridge.updatePropertyGroup', - fullyQualifiedName: 'cms.mediaBridge.updatePropertyGroup', - httpMethod: 'patch', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.cms.mediaBridge.updateSchema', - fullyQualifiedName: 'cms.mediaBridge.updateSchema', - httpMethod: 'patch', - httpPath: '/media-bridge/2026-03/{appId}/schemas/{objectType}', - }, - { - clientCallName: 'client.cms.mediaBridge.updateSettings', - fullyQualifiedName: 'cms.mediaBridge.updateSettings', - httpMethod: 'put', - httpPath: '/media-bridge/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.cms.mediaBridge.batch.create', - fullyQualifiedName: 'cms.mediaBridge.batch.create', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/create', - }, - { - clientCallName: 'client.cms.mediaBridge.batch.delete', - fullyQualifiedName: 'cms.mediaBridge.batch.delete', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/archive', - }, - { - clientCallName: 'client.cms.mediaBridge.batch.get', - fullyQualifiedName: 'cms.mediaBridge.batch.get', - httpMethod: 'post', - httpPath: '/media-bridge/2026-03/{appId}/properties/{objectType}/batch/read', - }, - { - clientCallName: 'client.cms.pages.landingPages.create', - fullyQualifiedName: 'cms.pages.landingPages.create', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages', - }, - { - clientCallName: 'client.cms.pages.landingPages.update', - fullyQualifiedName: 'cms.pages.landingPages.update', - httpMethod: 'patch', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.list', - fullyQualifiedName: 'cms.pages.landingPages.list', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages', - }, - { - clientCallName: 'client.cms.pages.landingPages.delete', - fullyQualifiedName: 'cms.pages.landingPages.delete', - httpMethod: 'delete', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.clone', - fullyQualifiedName: 'cms.pages.landingPages.clone', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/clone', - }, - { - clientCallName: 'client.cms.pages.landingPages.get', - fullyQualifiedName: 'cms.pages.landingPages.get', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.schedule', - fullyQualifiedName: 'cms.pages.landingPages.schedule', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/schedule', - }, - { - clientCallName: 'client.cms.pages.landingPages.abTest.createLandingPageVariation', - fullyQualifiedName: 'cms.pages.landingPages.abTest.createLandingPageVariation', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/ab-test/create-variation', - }, - { - clientCallName: 'client.cms.pages.landingPages.abTest.endLandingPageTest', - fullyQualifiedName: 'cms.pages.landingPages.abTest.endLandingPageTest', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/ab-test/end', - }, - { - clientCallName: 'client.cms.pages.landingPages.abTest.rerunLandingPageTest', - fullyQualifiedName: 'cms.pages.landingPages.abTest.rerunLandingPageTest', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/ab-test/rerun', - }, - { - clientCallName: 'client.cms.pages.landingPages.batch.createLandingPages', - fullyQualifiedName: 'cms.pages.landingPages.batch.createLandingPages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/batch/create', - }, - { - clientCallName: 'client.cms.pages.landingPages.batch.deleteLandingPages', - fullyQualifiedName: 'cms.pages.landingPages.batch.deleteLandingPages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/batch/archive', - }, - { - clientCallName: 'client.cms.pages.landingPages.batch.getLandingPages', - fullyQualifiedName: 'cms.pages.landingPages.batch.getLandingPages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/batch/read', - }, - { - clientCallName: 'client.cms.pages.landingPages.batch.updateLandingPages', - fullyQualifiedName: 'cms.pages.landingPages.batch.updateLandingPages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/batch/update', - }, - { - clientCallName: 'client.cms.pages.landingPages.draft.update', - fullyQualifiedName: 'cms.pages.landingPages.draft.update', - httpMethod: 'patch', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft', - }, - { - clientCallName: 'client.cms.pages.landingPages.draft.get', - fullyQualifiedName: 'cms.pages.landingPages.draft.get', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft', - }, - { - clientCallName: 'client.cms.pages.landingPages.draft.pushLive', - fullyQualifiedName: 'cms.pages.landingPages.draft.pushLive', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft/push-live', - }, - { - clientCallName: 'client.cms.pages.landingPages.draft.reset', - fullyQualifiedName: 'cms.pages.landingPages.draft.reset', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/draft/reset', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.create', - fullyQualifiedName: 'cms.pages.landingPages.folders.create', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.update', - fullyQualifiedName: 'cms.pages.landingPages.folders.update', - httpMethod: 'patch', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.list', - fullyQualifiedName: 'cms.pages.landingPages.folders.list', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/folders', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.delete', - fullyQualifiedName: 'cms.pages.landingPages.folders.delete', - httpMethod: 'delete', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.batchGet', - fullyQualifiedName: 'cms.pages.landingPages.folders.batchGet', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/read', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.createFolders', - fullyQualifiedName: 'cms.pages.landingPages.folders.createFolders', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/create', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.deleteFolders', - fullyQualifiedName: 'cms.pages.landingPages.folders.deleteFolders', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/archive', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.get', - fullyQualifiedName: 'cms.pages.landingPages.folders.get', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.getRevision', - fullyQualifiedName: 'cms.pages.landingPages.folders.getRevision', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.listRevisions', - fullyQualifiedName: 'cms.pages.landingPages.folders.listRevisions', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.restoreRevision', - fullyQualifiedName: 'cms.pages.landingPages.folders.restoreRevision', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders/{objectId}/revisions/{revisionId}/restore', - }, - { - clientCallName: 'client.cms.pages.landingPages.folders.updateFolders', - fullyQualifiedName: 'cms.pages.landingPages.folders.updateFolders', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/folders/batch/update', - }, - { - clientCallName: 'client.cms.pages.landingPages.multiLanguage.attachToLangGroup', - fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.pages.landingPages.multiLanguage.createLanguageVariation', - fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.createLanguageVariation', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.pages.landingPages.multiLanguage.detachFromLangGroup', - fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.pages.landingPages.multiLanguage.setNewLangPrimary', - fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.setNewLangPrimary', - httpMethod: 'put', - httpPath: '/cms/pages/2026-03/landing-pages/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.pages.landingPages.multiLanguage.updateLanguages', - fullyQualifiedName: 'cms.pages.landingPages.multiLanguage.updateLanguages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.pages.landingPages.revisions.getLandingPageRevision', - fullyQualifiedName: 'cms.pages.landingPages.revisions.getLandingPageRevision', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.cms.pages.landingPages.revisions.listLandingPageRevisions', - fullyQualifiedName: 'cms.pages.landingPages.revisions.listLandingPageRevisions', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions', - }, - { - clientCallName: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevision', - fullyQualifiedName: 'cms.pages.landingPages.revisions.restoreLandingPageRevision', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore', - }, - { - clientCallName: 'client.cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', - fullyQualifiedName: 'cms.pages.landingPages.revisions.restoreLandingPageRevisionToDraft', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft', - }, - { - clientCallName: 'client.cms.pages.sitePages.create', - fullyQualifiedName: 'cms.pages.sitePages.create', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages', - }, - { - clientCallName: 'client.cms.pages.sitePages.update', - fullyQualifiedName: 'cms.pages.sitePages.update', - httpMethod: 'patch', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.sitePages.list', - fullyQualifiedName: 'cms.pages.sitePages.list', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/site-pages', - }, - { - clientCallName: 'client.cms.pages.sitePages.delete', - fullyQualifiedName: 'cms.pages.sitePages.delete', - httpMethod: 'delete', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.sitePages.clone', - fullyQualifiedName: 'cms.pages.sitePages.clone', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/clone', - }, - { - clientCallName: 'client.cms.pages.sitePages.get', - fullyQualifiedName: 'cms.pages.sitePages.get', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}', - }, - { - clientCallName: 'client.cms.pages.sitePages.schedule', - fullyQualifiedName: 'cms.pages.sitePages.schedule', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/schedule', - }, - { - clientCallName: 'client.cms.pages.sitePages.abTest.createSitePageVariation', - fullyQualifiedName: 'cms.pages.sitePages.abTest.createSitePageVariation', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/ab-test/create-variation', - }, - { - clientCallName: 'client.cms.pages.sitePages.abTest.endSitePageTest', - fullyQualifiedName: 'cms.pages.sitePages.abTest.endSitePageTest', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/ab-test/end', - }, - { - clientCallName: 'client.cms.pages.sitePages.abTest.rerunSitePageTest', - fullyQualifiedName: 'cms.pages.sitePages.abTest.rerunSitePageTest', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/ab-test/rerun', - }, - { - clientCallName: 'client.cms.pages.sitePages.batch.createSitePages', - fullyQualifiedName: 'cms.pages.sitePages.batch.createSitePages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/batch/create', - }, - { - clientCallName: 'client.cms.pages.sitePages.batch.deleteSitePages', - fullyQualifiedName: 'cms.pages.sitePages.batch.deleteSitePages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/batch/archive', - }, - { - clientCallName: 'client.cms.pages.sitePages.batch.getSitePages', - fullyQualifiedName: 'cms.pages.sitePages.batch.getSitePages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/batch/read', - }, - { - clientCallName: 'client.cms.pages.sitePages.batch.updateSitePages', - fullyQualifiedName: 'cms.pages.sitePages.batch.updateSitePages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/batch/update', - }, - { - clientCallName: 'client.cms.pages.sitePages.draft.getDraft', - fullyQualifiedName: 'cms.pages.sitePages.draft.getDraft', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft', - }, - { - clientCallName: 'client.cms.pages.sitePages.draft.publishDraft', - fullyQualifiedName: 'cms.pages.sitePages.draft.publishDraft', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft/push-live', - }, - { - clientCallName: 'client.cms.pages.sitePages.draft.resetSitePageDraft', - fullyQualifiedName: 'cms.pages.sitePages.draft.resetSitePageDraft', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft/reset', - }, - { - clientCallName: 'client.cms.pages.sitePages.draft.updateDraft', - fullyQualifiedName: 'cms.pages.sitePages.draft.updateDraft', - httpMethod: 'patch', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/draft', - }, - { - clientCallName: 'client.cms.pages.sitePages.multiLanguage.attachToLangGroup', - fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.attachToLangGroup', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/multi-language/attach-to-lang-group', - }, - { - clientCallName: 'client.cms.pages.sitePages.multiLanguage.createLanguageVariation', - fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.createLanguageVariation', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/multi-language/create-language-variation', - }, - { - clientCallName: 'client.cms.pages.sitePages.multiLanguage.detachFromLangGroup', - fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.detachFromLangGroup', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/multi-language/detach-from-lang-group', - }, - { - clientCallName: 'client.cms.pages.sitePages.multiLanguage.setNewLangPrimary', - fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.setNewLangPrimary', - httpMethod: 'put', - httpPath: '/cms/pages/2026-03/site-pages/multi-language/set-new-lang-primary', - }, - { - clientCallName: 'client.cms.pages.sitePages.multiLanguage.updateLanguages', - fullyQualifiedName: 'cms.pages.sitePages.multiLanguage.updateLanguages', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/multi-language/update-languages', - }, - { - clientCallName: 'client.cms.pages.sitePages.revisions.getSitePageRevision', - fullyQualifiedName: 'cms.pages.sitePages.revisions.getSitePageRevision', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.cms.pages.sitePages.revisions.listSitePageRevisions', - fullyQualifiedName: 'cms.pages.sitePages.revisions.listSitePageRevisions', - httpMethod: 'get', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions', - }, - { - clientCallName: 'client.cms.pages.sitePages.revisions.restoreSitePageRevision', - fullyQualifiedName: 'cms.pages.sitePages.revisions.restoreSitePageRevision', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore', - }, - { - clientCallName: 'client.cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', - fullyQualifiedName: 'cms.pages.sitePages.revisions.restoreSitePageRevisionToDraft', - httpMethod: 'post', - httpPath: '/cms/pages/2026-03/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft', - }, - { - clientCallName: 'client.cms.siteSearch.getIndexedData', - fullyQualifiedName: 'cms.siteSearch.getIndexedData', - httpMethod: 'get', - httpPath: '/cms/site-search/2026-03/indexed-data/{contentId}', - }, - { - clientCallName: 'client.cms.sourceCode.extractAsync', - fullyQualifiedName: 'cms.sourceCode.extractAsync', - httpMethod: 'post', - httpPath: '/cms/source-code/2026-03/extract/async', - }, - { - clientCallName: 'client.cms.sourceCode.getExtractionStatus', - fullyQualifiedName: 'cms.sourceCode.getExtractionStatus', - httpMethod: 'get', - httpPath: '/cms/source-code/2026-03/extract/async/tasks/{taskId}/status', - }, - { - clientCallName: 'client.cms.urlMappings.create', - fullyQualifiedName: 'cms.urlMappings.create', - httpMethod: 'post', - httpPath: '/url-mappings/2026-03/url-mappings', - }, - { - clientCallName: 'client.cms.urlMappings.list', - fullyQualifiedName: 'cms.urlMappings.list', - httpMethod: 'get', - httpPath: '/url-mappings/2026-03/url-mappings', - }, - { - clientCallName: 'client.cms.urlMappings.delete', - fullyQualifiedName: 'cms.urlMappings.delete', - httpMethod: 'delete', - httpPath: '/url-mappings/2026-03/url-mappings/{id}', - }, - { - clientCallName: 'client.cms.urlMappings.get', - fullyQualifiedName: 'cms.urlMappings.get', - httpMethod: 'get', - httpPath: '/url-mappings/2026-03/url-mappings/{id}', - }, - { - clientCallName: 'client.cms.urlRedirects.create', - fullyQualifiedName: 'cms.urlRedirects.create', - httpMethod: 'post', - httpPath: '/cms/url-redirects/2026-03', - }, - { - clientCallName: 'client.cms.urlRedirects.update', - fullyQualifiedName: 'cms.urlRedirects.update', - httpMethod: 'patch', - httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', - }, - { - clientCallName: 'client.cms.urlRedirects.list', - fullyQualifiedName: 'cms.urlRedirects.list', - httpMethod: 'get', - httpPath: '/cms/url-redirects/2026-03', - }, - { - clientCallName: 'client.cms.urlRedirects.delete', - fullyQualifiedName: 'cms.urlRedirects.delete', - httpMethod: 'delete', - httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', - }, - { - clientCallName: 'client.cms.urlRedirects.get', - fullyQualifiedName: 'cms.urlRedirects.get', - httpMethod: 'get', - httpPath: '/cms/url-redirects/2026-03/{urlRedirectId}', - }, - { - clientCallName: 'client.communicationPreferences.generateLinks', - fullyQualifiedName: 'communicationPreferences.generateLinks', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/links/generate', - }, - { - clientCallName: 'client.communicationPreferences.getStatuses', - fullyQualifiedName: 'communicationPreferences.getStatuses', - httpMethod: 'get', - httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}', - }, - { - clientCallName: 'client.communicationPreferences.getUnsubscribeAllStatus', - fullyQualifiedName: 'communicationPreferences.getUnsubscribeAllStatus', - httpMethod: 'get', - httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', - }, - { - clientCallName: 'client.communicationPreferences.unsubscribeAll', - fullyQualifiedName: 'communicationPreferences.unsubscribeAll', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}/unsubscribe-all', - }, - { - clientCallName: 'client.communicationPreferences.updateStatus', - fullyQualifiedName: 'communicationPreferences.updateStatus', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/{subscriberIdString}', - }, - { - clientCallName: 'client.communicationPreferences.definitions.list', - fullyQualifiedName: 'communicationPreferences.definitions.list', - httpMethod: 'get', - httpPath: '/communication-preferences/2026-03/definitions', - }, - { - clientCallName: 'client.communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', - fullyQualifiedName: 'communicationPreferences.statuses.batch.getUnsubscribeAllStatuses', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read', - }, - { - clientCallName: 'client.communicationPreferences.statuses.batch.read', - fullyQualifiedName: 'communicationPreferences.statuses.batch.read', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/batch/read', - }, - { - clientCallName: 'client.communicationPreferences.statuses.batch.unsubscribeAll', - fullyQualifiedName: 'communicationPreferences.statuses.batch.unsubscribeAll', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/batch/unsubscribe-all', - }, - { - clientCallName: 'client.communicationPreferences.statuses.batch.updateStatuses', - fullyQualifiedName: 'communicationPreferences.statuses.batch.updateStatuses', - httpMethod: 'post', - httpPath: '/communication-preferences/2026-03/statuses/batch/write', - }, - { - clientCallName: 'client.conversations.customChannels.create', - fullyQualifiedName: 'conversations.customChannels.create', - httpMethod: 'post', - httpPath: '/conversations/custom-channels/2026-03', - }, - { - clientCallName: 'client.conversations.customChannels.update', - fullyQualifiedName: 'conversations.customChannels.update', - httpMethod: 'patch', - httpPath: '/conversations/custom-channels/2026-03/{channelId}', - }, - { - clientCallName: 'client.conversations.customChannels.list', - fullyQualifiedName: 'conversations.customChannels.list', - httpMethod: 'get', - httpPath: '/conversations/custom-channels/2026-03', - }, - { - clientCallName: 'client.conversations.customChannels.delete', - fullyQualifiedName: 'conversations.customChannels.delete', - httpMethod: 'delete', - httpPath: '/conversations/custom-channels/2026-03/{channelId}', - }, - { - clientCallName: 'client.conversations.customChannels.get', - fullyQualifiedName: 'conversations.customChannels.get', - httpMethod: 'get', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', - }, - { - clientCallName: 'client.conversations.customChannels.channelAccounts.create', - fullyQualifiedName: 'conversations.customChannels.channelAccounts.create', - httpMethod: 'post', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', - }, - { - clientCallName: 'client.conversations.customChannels.channelAccounts.update', - fullyQualifiedName: 'conversations.customChannels.channelAccounts.update', - httpMethod: 'patch', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts/{channelAccountId}', - }, - { - clientCallName: 'client.conversations.customChannels.channelAccounts.list', - fullyQualifiedName: 'conversations.customChannels.channelAccounts.list', - httpMethod: 'get', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/channel-accounts', - }, - { - clientCallName: 'client.conversations.customChannels.channelAccounts.updateStagingToken', - fullyQualifiedName: 'conversations.customChannels.channelAccounts.updateStagingToken', - httpMethod: 'patch', - httpPath: - '/conversations/custom-channels/2026-03/{channelId}/channel-account-staging-tokens/{accountToken}', - }, - { - clientCallName: 'client.conversations.customChannels.messages.create', - fullyQualifiedName: 'conversations.customChannels.messages.create', - httpMethod: 'post', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages', - }, - { - clientCallName: 'client.conversations.customChannels.messages.update', - fullyQualifiedName: 'conversations.customChannels.messages.update', - httpMethod: 'patch', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', - }, - { - clientCallName: 'client.conversations.customChannels.messages.get', - fullyQualifiedName: 'conversations.customChannels.messages.get', - httpMethod: 'get', - httpPath: '/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}', - }, - { - clientCallName: 'client.conversations.visitorIdentification.generateToken', - fullyQualifiedName: 'conversations.visitorIdentification.generateToken', - httpMethod: 'post', - httpPath: '/visitor-identification/2026-03/tokens/create', - }, - { - clientCallName: 'client.crm.appUninstalls.uninstall', - fullyQualifiedName: 'crm.appUninstalls.uninstall', - httpMethod: 'delete', - httpPath: '/appinstalls/2026-03/external-install', - }, - { - clientCallName: 'client.crm.associations.create', - fullyQualifiedName: 'crm.associations.create', - httpMethod: 'put', - httpPath: - '/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}', - }, - { - clientCallName: 'client.crm.associations.list', - fullyQualifiedName: 'crm.associations.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}', - }, - { - clientCallName: 'client.crm.associations.delete', - fullyQualifiedName: 'crm.associations.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', - }, - { - clientCallName: 'client.crm.associations.requestHighUsageReport', - fullyQualifiedName: 'crm.associations.requestHighUsageReport', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/usage/high-usage-report/{userId}', - }, - { - clientCallName: 'client.crm.associations.search', - fullyQualifiedName: 'crm.associations.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/search', - }, - { - clientCallName: 'client.crm.associations.updateLabels', - fullyQualifiedName: 'crm.associations.updateLabels', - httpMethod: 'put', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}', - }, - { - clientCallName: 'client.crm.associations.batch.create', - fullyQualifiedName: 'crm.associations.batch.create', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create', - }, - { - clientCallName: 'client.crm.associations.batch.delete', - fullyQualifiedName: 'crm.associations.batch.delete', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive', - }, - { - clientCallName: 'client.crm.associations.batch.createDefault', - fullyQualifiedName: 'crm.associations.batch.createDefault', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default', - }, - { - clientCallName: 'client.crm.associations.batch.deleteLabels', - fullyQualifiedName: 'crm.associations.batch.deleteLabels', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive', - }, - { - clientCallName: 'client.crm.associations.batch.get', - fullyQualifiedName: 'crm.associations.batch.get', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read', - }, - { - clientCallName: 'client.crm.associationsSchema.labels.batchCreate', - fullyQualifiedName: 'crm.associationsSchema.labels.batchCreate', - httpMethod: 'post', - httpPath: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create', - }, - { - clientCallName: 'client.crm.associationsSchema.labels.createLabel', - fullyQualifiedName: 'crm.associationsSchema.labels.createLabel', - httpMethod: 'post', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - }, - { - clientCallName: 'client.crm.associationsSchema.labels.deleteLabel', - fullyQualifiedName: 'crm.associationsSchema.labels.deleteLabel', - httpMethod: 'delete', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}', - }, - { - clientCallName: 'client.crm.associationsSchema.labels.listLabels', - fullyQualifiedName: 'crm.associationsSchema.labels.listLabels', - httpMethod: 'get', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - }, - { - clientCallName: 'client.crm.associationsSchema.labels.updateLabel', - fullyQualifiedName: 'crm.associationsSchema.labels.updateLabel', - httpMethod: 'put', - httpPath: '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels', - }, - { - clientCallName: 'client.crm.associationsSchema.limits.list', - fullyQualifiedName: 'crm.associationsSchema.limits.list', - httpMethod: 'get', - httpPath: '/crm/associations/2026-03/definitions/configurations/all', - }, - { - clientCallName: 'client.crm.associationsSchema.limits.batchDelete', - fullyQualifiedName: 'crm.associationsSchema.limits.batchDelete', - httpMethod: 'post', - httpPath: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge', - }, - { - clientCallName: 'client.crm.associationsSchema.limits.batchUpdate', - fullyQualifiedName: 'crm.associationsSchema.limits.batchUpdate', - httpMethod: 'post', - httpPath: - '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update', - }, - { - clientCallName: 'client.crm.associationsSchema.limits.getByObjectTypes', - fullyQualifiedName: 'crm.associationsSchema.limits.getByObjectTypes', - httpMethod: 'get', - httpPath: '/crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}', - }, - { - clientCallName: 'client.crm.dealSplits.batch.read', - fullyQualifiedName: 'crm.dealSplits.batch.read', - httpMethod: 'post', - httpPath: '/deal-splits/2026-03/batch/read', - }, - { - clientCallName: 'client.crm.dealSplits.batch.upsert', - fullyQualifiedName: 'crm.dealSplits.batch.upsert', - httpMethod: 'post', - httpPath: '/deal-splits/2026-03/batch/upsert', - }, - { - clientCallName: 'client.crm.exports.createAsync', - fullyQualifiedName: 'crm.exports.createAsync', - httpMethod: 'post', - httpPath: '/crm/exports/2026-03/export/async', - }, - { - clientCallName: 'client.crm.exports.get', - fullyQualifiedName: 'crm.exports.get', - httpMethod: 'get', - httpPath: '/crm/exports/2026-03/export/{exportId}', - }, - { - clientCallName: 'client.crm.exports.getStatus', - fullyQualifiedName: 'crm.exports.getStatus', - httpMethod: 'get', - httpPath: '/crm/exports/2026-03/export/async/tasks/{taskId}/status', - }, - { - clientCallName: 'client.crm.extensions.calling.createChannelConnectionSettings', - fullyQualifiedName: 'crm.extensions.calling.createChannelConnectionSettings', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - }, - { - clientCallName: 'client.crm.extensions.calling.createInboundCall', - fullyQualifiedName: 'crm.extensions.calling.createInboundCall', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/inbound-call', - }, - { - clientCallName: 'client.crm.extensions.calling.createRecordingReady', - fullyQualifiedName: 'crm.extensions.calling.createRecordingReady', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/recordings/ready', - }, - { - clientCallName: 'client.crm.extensions.calling.createRecordingSettings', - fullyQualifiedName: 'crm.extensions.calling.createRecordingSettings', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - }, - { - clientCallName: 'client.crm.extensions.calling.createSettings', - fullyQualifiedName: 'crm.extensions.calling.createSettings', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.crm.extensions.calling.deleteChannelConnectionSettings', - fullyQualifiedName: 'crm.extensions.calling.deleteChannelConnectionSettings', - httpMethod: 'delete', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - }, - { - clientCallName: 'client.crm.extensions.calling.deleteSettings', - fullyQualifiedName: 'crm.extensions.calling.deleteSettings', - httpMethod: 'delete', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.crm.extensions.calling.getChannelConnectionSettings', - fullyQualifiedName: 'crm.extensions.calling.getChannelConnectionSettings', - httpMethod: 'get', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - }, - { - clientCallName: 'client.crm.extensions.calling.getRecordingSettings', - fullyQualifiedName: 'crm.extensions.calling.getRecordingSettings', - httpMethod: 'get', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - }, - { - clientCallName: 'client.crm.extensions.calling.getSettings', - fullyQualifiedName: 'crm.extensions.calling.getSettings', - httpMethod: 'get', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.crm.extensions.calling.updateChannelConnectionSettings', - fullyQualifiedName: 'crm.extensions.calling.updateChannelConnectionSettings', - httpMethod: 'patch', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/channel-connection', - }, - { - clientCallName: 'client.crm.extensions.calling.updateRecordingSettings', - fullyQualifiedName: 'crm.extensions.calling.updateRecordingSettings', - httpMethod: 'patch', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings/recording', - }, - { - clientCallName: 'client.crm.extensions.calling.updateSettings', - fullyQualifiedName: 'crm.extensions.calling.updateSettings', - httpMethod: 'patch', - httpPath: '/crm/extensions/calling/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.crm.extensions.calling.transcripts.create', - fullyQualifiedName: 'crm.extensions.calling.transcripts.create', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/transcripts', - }, - { - clientCallName: 'client.crm.extensions.calling.transcripts.delete', - fullyQualifiedName: 'crm.extensions.calling.transcripts.delete', - httpMethod: 'delete', - httpPath: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', - }, - { - clientCallName: 'client.crm.extensions.calling.transcripts.createInboundCall', - fullyQualifiedName: 'crm.extensions.calling.transcripts.createInboundCall', - httpMethod: 'post', - httpPath: '/crm/extensions/calling/2026-03/inbound-call', - }, - { - clientCallName: 'client.crm.extensions.calling.transcripts.get', - fullyQualifiedName: 'crm.extensions.calling.transcripts.get', - httpMethod: 'get', - httpPath: '/crm/extensions/calling/2026-03/transcripts/{transcriptId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.create', - fullyQualifiedName: 'crm.extensions.cardsDev.create', - httpMethod: 'post', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.update', - fullyQualifiedName: 'crm.extensions.cardsDev.update', - httpMethod: 'patch', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.delete', - fullyQualifiedName: 'crm.extensions.cardsDev.delete', - httpMethod: 'delete', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.get', - fullyQualifiedName: 'crm.extensions.cardsDev.get', - httpMethod: 'get', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.getByID', - fullyQualifiedName: 'crm.extensions.cardsDev.getByID', - httpMethod: 'get', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/{cardId}', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.getSampleResponse', - fullyQualifiedName: 'crm.extensions.cardsDev.getSampleResponse', - httpMethod: 'get', - httpPath: '/crm/extensions/cards-dev/2026-03/sample-response', - }, - { - clientCallName: 'client.crm.extensions.cardsDev.migrateViews', - fullyQualifiedName: 'crm.extensions.cardsDev.migrateViews', - httpMethod: 'post', - httpPath: '/crm/extensions/cards-dev/2026-03/{appId}/views/migrate', - }, - { - clientCallName: 'client.crm.extensions.videoConferencing.update', - fullyQualifiedName: 'crm.extensions.videoConferencing.update', - httpMethod: 'put', - httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - }, - { - clientCallName: 'client.crm.extensions.videoConferencing.delete', - fullyQualifiedName: 'crm.extensions.videoConferencing.delete', - httpMethod: 'delete', - httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - }, - { - clientCallName: 'client.crm.extensions.videoConferencing.get', - fullyQualifiedName: 'crm.extensions.videoConferencing.get', - httpMethod: 'get', - httpPath: '/crm/extensions/videoconferencing/2026-03/settings/{appId}', - }, - { - clientCallName: 'client.crm.featureFlags.update', - fullyQualifiedName: 'crm.featureFlags.update', - httpMethod: 'put', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', - }, - { - clientCallName: 'client.crm.featureFlags.delete', - fullyQualifiedName: 'crm.featureFlags.delete', - httpMethod: 'delete', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', - }, - { - clientCallName: 'client.crm.featureFlags.deletePortalState', - fullyQualifiedName: 'crm.featureFlags.deletePortalState', - httpMethod: 'delete', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - }, - { - clientCallName: 'client.crm.featureFlags.get', - fullyQualifiedName: 'crm.featureFlags.get', - httpMethod: 'get', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}', - }, - { - clientCallName: 'client.crm.featureFlags.getPortalState', - fullyQualifiedName: 'crm.featureFlags.getPortalState', - httpMethod: 'get', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - }, - { - clientCallName: 'client.crm.featureFlags.listAll', - fullyQualifiedName: 'crm.featureFlags.listAll', - httpMethod: 'get', - httpPath: '/feature-flags/2026-03/{appId}/flags/all', - }, - { - clientCallName: 'client.crm.featureFlags.listPortals', - fullyQualifiedName: 'crm.featureFlags.listPortals', - httpMethod: 'get', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals', - }, - { - clientCallName: 'client.crm.featureFlags.updatePortalState', - fullyQualifiedName: 'crm.featureFlags.updatePortalState', - httpMethod: 'put', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/{portalId}', - }, - { - clientCallName: 'client.crm.featureFlags.batch.delete', - fullyQualifiedName: 'crm.featureFlags.batch.delete', - httpMethod: 'post', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/delete', - }, - { - clientCallName: 'client.crm.featureFlags.batch.upsert', - fullyQualifiedName: 'crm.featureFlags.batch.upsert', - httpMethod: 'post', - httpPath: '/feature-flags/2026-03/{appId}/flags/{flagName}/portals/batch/upsert', - }, - { - clientCallName: 'client.crm.imports.create', - fullyQualifiedName: 'crm.imports.create', - httpMethod: 'post', - httpPath: '/crm/imports/2026-03', - }, - { - clientCallName: 'client.crm.imports.list', - fullyQualifiedName: 'crm.imports.list', - httpMethod: 'get', - httpPath: '/crm/imports/2026-03', - }, - { - clientCallName: 'client.crm.imports.cancel', - fullyQualifiedName: 'crm.imports.cancel', - httpMethod: 'post', - httpPath: '/crm/imports/2026-03/{importId}/cancel', - }, - { - clientCallName: 'client.crm.imports.get', - fullyQualifiedName: 'crm.imports.get', - httpMethod: 'get', - httpPath: '/crm/imports/2026-03/{importId}', - }, - { - clientCallName: 'client.crm.imports.listErrors', - fullyQualifiedName: 'crm.imports.listErrors', - httpMethod: 'get', - httpPath: '/crm/imports/2026-03/{importId}/errors', - }, - { - clientCallName: 'client.crm.limits.getAssociationLabelLimits', - fullyQualifiedName: 'crm.limits.getAssociationLabelLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/associations/labels', - }, - { - clientCallName: 'client.crm.limits.getAssociationRecordsLimitsByObjectType', - fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsByObjectType', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/{toObjectTypeId}', - }, - { - clientCallName: 'client.crm.limits.getAssociationRecordsLimitsFromObjects', - fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsFromObjects', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/associations/records/from', - }, - { - clientCallName: 'client.crm.limits.getAssociationRecordsLimitsToObjects', - fullyQualifiedName: 'crm.limits.getAssociationRecordsLimitsToObjects', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/associations/records/{fromObjectTypeId}/to', - }, - { - clientCallName: 'client.crm.limits.getCalculatedPropertyLimits', - fullyQualifiedName: 'crm.limits.getCalculatedPropertyLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/calculated-properties', - }, - { - clientCallName: 'client.crm.limits.getCustomObjectTypeLimits', - fullyQualifiedName: 'crm.limits.getCustomObjectTypeLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/custom-object-types', - }, - { - clientCallName: 'client.crm.limits.getCustomPropertyLimits', - fullyQualifiedName: 'crm.limits.getCustomPropertyLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/custom-properties', - }, - { - clientCallName: 'client.crm.limits.getPipelineLimits', - fullyQualifiedName: 'crm.limits.getPipelineLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/pipelines', - }, - { - clientCallName: 'client.crm.limits.getRecordLimits', - fullyQualifiedName: 'crm.limits.getRecordLimits', - httpMethod: 'get', - httpPath: '/crm/limits/2026-03/records', - }, - { - clientCallName: 'client.crm.lists.create', - fullyQualifiedName: 'crm.lists.create', - httpMethod: 'post', - httpPath: '/crm/lists/2026-03', - }, - { - clientCallName: 'client.crm.lists.list', - fullyQualifiedName: 'crm.lists.list', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03', - }, - { - clientCallName: 'client.crm.lists.delete', - fullyQualifiedName: 'crm.lists.delete', - httpMethod: 'delete', - httpPath: '/crm/lists/2026-03/{listId}', - }, - { - clientCallName: 'client.crm.lists.addAndRemoveMemberships', - fullyQualifiedName: 'crm.lists.addAndRemoveMemberships', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/memberships/add-and-remove', - }, - { - clientCallName: 'client.crm.lists.addMemberships', - fullyQualifiedName: 'crm.lists.addMemberships', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/memberships/add', - }, - { - clientCallName: 'client.crm.lists.addMembershipsFrom', - fullyQualifiedName: 'crm.lists.addMembershipsFrom', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/memberships/add-from/{sourceListId}', - }, - { - clientCallName: 'client.crm.lists.batchReadMemberships', - fullyQualifiedName: 'crm.lists.batchReadMemberships', - httpMethod: 'post', - httpPath: '/crm/lists/2026-03/records/memberships/batch/read', - }, - { - clientCallName: 'client.crm.lists.createFolder', - fullyQualifiedName: 'crm.lists.createFolder', - httpMethod: 'post', - httpPath: '/crm/lists/2026-03/folders', - }, - { - clientCallName: 'client.crm.lists.createIDMapping', - fullyQualifiedName: 'crm.lists.createIDMapping', - httpMethod: 'post', - httpPath: '/crm/lists/2026-03/idmapping', - }, - { - clientCallName: 'client.crm.lists.deleteFolder', - fullyQualifiedName: 'crm.lists.deleteFolder', - httpMethod: 'delete', - httpPath: '/crm/lists/2026-03/folders/{folderId}', - }, - { - clientCallName: 'client.crm.lists.deleteMemberships', - fullyQualifiedName: 'crm.lists.deleteMemberships', - httpMethod: 'delete', - httpPath: '/crm/lists/2026-03/{listId}/memberships', - }, - { - clientCallName: 'client.crm.lists.get', - fullyQualifiedName: 'crm.lists.get', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/{listId}', - }, - { - clientCallName: 'client.crm.lists.getByObjectTypeAndName', - fullyQualifiedName: 'crm.lists.getByObjectTypeAndName', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/object-type-id/{objectTypeId}/name/{listName}', - }, - { - clientCallName: 'client.crm.lists.getIDMapping', - fullyQualifiedName: 'crm.lists.getIDMapping', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/idmapping', - }, - { - clientCallName: 'client.crm.lists.getMembershipsJoinOrder', - fullyQualifiedName: 'crm.lists.getMembershipsJoinOrder', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/{listId}/memberships/join-order', - }, - { - clientCallName: 'client.crm.lists.getRecordMemberships', - fullyQualifiedName: 'crm.lists.getRecordMemberships', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/records/{objectTypeId}/{recordId}/memberships', - }, - { - clientCallName: 'client.crm.lists.getScheduleConversion', - fullyQualifiedName: 'crm.lists.getScheduleConversion', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', - }, - { - clientCallName: 'client.crm.lists.getSizeAndEditsHistoryBetween', - fullyQualifiedName: 'crm.lists.getSizeAndEditsHistoryBetween', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/{listId}/size-and-edits-history/between', - }, - { - clientCallName: 'client.crm.lists.listBySearch', - fullyQualifiedName: 'crm.lists.listBySearch', - httpMethod: 'post', - httpPath: '/crm/lists/2026-03/search', - }, - { - clientCallName: 'client.crm.lists.listFolders', - fullyQualifiedName: 'crm.lists.listFolders', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/folders', - }, - { - clientCallName: 'client.crm.lists.listMemberships', - fullyQualifiedName: 'crm.lists.listMemberships', - httpMethod: 'get', - httpPath: '/crm/lists/2026-03/{listId}/memberships', - }, - { - clientCallName: 'client.crm.lists.moveFolder', - fullyQualifiedName: 'crm.lists.moveFolder', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/folders/{folderId}/move/{newParentFolderId}', - }, - { - clientCallName: 'client.crm.lists.moveList', - fullyQualifiedName: 'crm.lists.moveList', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/folders/move-list', - }, - { - clientCallName: 'client.crm.lists.removeMemberships', - fullyQualifiedName: 'crm.lists.removeMemberships', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/memberships/remove', - }, - { - clientCallName: 'client.crm.lists.renameFolder', - fullyQualifiedName: 'crm.lists.renameFolder', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/folders/{folderId}/rename', - }, - { - clientCallName: 'client.crm.lists.restore', - fullyQualifiedName: 'crm.lists.restore', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/restore', - }, - { - clientCallName: 'client.crm.lists.scheduleConversion', - fullyQualifiedName: 'crm.lists.scheduleConversion', - httpMethod: 'delete', - httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', - }, - { - clientCallName: 'client.crm.lists.updateListFilters', - fullyQualifiedName: 'crm.lists.updateListFilters', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/update-list-filters', - }, - { - clientCallName: 'client.crm.lists.updateListName', - fullyQualifiedName: 'crm.lists.updateListName', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/update-list-name', - }, - { - clientCallName: 'client.crm.lists.updateScheduleConversion', - fullyQualifiedName: 'crm.lists.updateScheduleConversion', - httpMethod: 'put', - httpPath: '/crm/lists/2026-03/{listId}/schedule-conversion', - }, - { - clientCallName: 'client.crm.objectLibrary.enablement.getAll', - fullyQualifiedName: 'crm.objectLibrary.enablement.getAll', - httpMethod: 'get', - httpPath: '/crm/object-library/2026-03/enablement', - }, - { - clientCallName: 'client.crm.objectLibrary.enablement.getByObjectTypeID', - fullyQualifiedName: 'crm.objectLibrary.enablement.getByObjectTypeID', - httpMethod: 'get', - httpPath: '/crm/object-library/2026-03/enablement/{objectTypeId}', - }, - { - clientCallName: 'client.crm.objectSchemas.create', - fullyQualifiedName: 'crm.objectSchemas.create', - httpMethod: 'post', - httpPath: '/crm-object-schemas/2026-03/schemas', - }, - { - clientCallName: 'client.crm.objectSchemas.update', - fullyQualifiedName: 'crm.objectSchemas.update', - httpMethod: 'patch', - httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', - }, - { - clientCallName: 'client.crm.objectSchemas.list', - fullyQualifiedName: 'crm.objectSchemas.list', - httpMethod: 'get', - httpPath: '/crm-object-schemas/2026-03/schemas', - }, - { - clientCallName: 'client.crm.objectSchemas.delete', - fullyQualifiedName: 'crm.objectSchemas.delete', - httpMethod: 'delete', - httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', - }, - { - clientCallName: 'client.crm.objectSchemas.createAssociation', - fullyQualifiedName: 'crm.objectSchemas.createAssociation', - httpMethod: 'post', - httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}/associations', - }, - { - clientCallName: 'client.crm.objectSchemas.deleteAssociation', - fullyQualifiedName: 'crm.objectSchemas.deleteAssociation', - httpMethod: 'delete', - httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}/associations/{associationIdentifier}', - }, - { - clientCallName: 'client.crm.objectSchemas.get', - fullyQualifiedName: 'crm.objectSchemas.get', - httpMethod: 'get', - httpPath: '/crm-object-schemas/2026-03/schemas/{objectType}', - }, - { - clientCallName: 'client.crm.objectSchemas.batch.get', - fullyQualifiedName: 'crm.objectSchemas.batch.get', - httpMethod: 'post', - httpPath: '/crm-object-schemas/2026-03/schemas/batch/read', - }, - { - clientCallName: 'client.crm.objects.calls.create', - fullyQualifiedName: 'crm.objects.calls.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls', - }, - { - clientCallName: 'client.crm.objects.calls.update', - fullyQualifiedName: 'crm.objects.calls.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/calls/{callId}', - }, - { - clientCallName: 'client.crm.objects.calls.list', - fullyQualifiedName: 'crm.objects.calls.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/calls', - }, - { - clientCallName: 'client.crm.objects.calls.delete', - fullyQualifiedName: 'crm.objects.calls.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/calls/{callId}', - }, - { - clientCallName: 'client.crm.objects.calls.get', - fullyQualifiedName: 'crm.objects.calls.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/calls/{callId}', - }, - { - clientCallName: 'client.crm.objects.calls.search', - fullyQualifiedName: 'crm.objects.calls.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/search', - }, - { - clientCallName: 'client.crm.objects.calls.batch.create', - fullyQualifiedName: 'crm.objects.calls.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/batch/create', - }, - { - clientCallName: 'client.crm.objects.calls.batch.update', - fullyQualifiedName: 'crm.objects.calls.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/batch/update', - }, - { - clientCallName: 'client.crm.objects.calls.batch.delete', - fullyQualifiedName: 'crm.objects.calls.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/batch/archive', - }, - { - clientCallName: 'client.crm.objects.calls.batch.get', - fullyQualifiedName: 'crm.objects.calls.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/batch/read', - }, - { - clientCallName: 'client.crm.objects.calls.batch.upsert', - fullyQualifiedName: 'crm.objects.calls.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/calls/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.carts.create', - fullyQualifiedName: 'crm.objects.carts.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts', - }, - { - clientCallName: 'client.crm.objects.carts.update', - fullyQualifiedName: 'crm.objects.carts.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/carts/{cartId}', - }, - { - clientCallName: 'client.crm.objects.carts.list', - fullyQualifiedName: 'crm.objects.carts.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/carts', - }, - { - clientCallName: 'client.crm.objects.carts.delete', - fullyQualifiedName: 'crm.objects.carts.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/carts/{cartId}', - }, - { - clientCallName: 'client.crm.objects.carts.get', - fullyQualifiedName: 'crm.objects.carts.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/carts/{cartId}', - }, - { - clientCallName: 'client.crm.objects.carts.search', - fullyQualifiedName: 'crm.objects.carts.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/search', - }, - { - clientCallName: 'client.crm.objects.carts.batch.create', - fullyQualifiedName: 'crm.objects.carts.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/batch/create', - }, - { - clientCallName: 'client.crm.objects.carts.batch.update', - fullyQualifiedName: 'crm.objects.carts.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/batch/update', - }, - { - clientCallName: 'client.crm.objects.carts.batch.delete', - fullyQualifiedName: 'crm.objects.carts.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/batch/archive', - }, - { - clientCallName: 'client.crm.objects.carts.batch.get', - fullyQualifiedName: 'crm.objects.carts.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/batch/read', - }, - { - clientCallName: 'client.crm.objects.carts.batch.upsert', - fullyQualifiedName: 'crm.objects.carts.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/carts/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.commercePayments.create', - fullyQualifiedName: 'crm.objects.commercePayments.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments', - }, - { - clientCallName: 'client.crm.objects.commercePayments.update', - fullyQualifiedName: 'crm.objects.commercePayments.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - }, - { - clientCallName: 'client.crm.objects.commercePayments.list', - fullyQualifiedName: 'crm.objects.commercePayments.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/commerce_payments', - }, - { - clientCallName: 'client.crm.objects.commercePayments.delete', - fullyQualifiedName: 'crm.objects.commercePayments.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - }, - { - clientCallName: 'client.crm.objects.commercePayments.get', - fullyQualifiedName: 'crm.objects.commercePayments.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/commerce_payments/{commercePaymentId}', - }, - { - clientCallName: 'client.crm.objects.commercePayments.search', - fullyQualifiedName: 'crm.objects.commercePayments.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/search', - }, - { - clientCallName: 'client.crm.objects.commercePayments.batch.create', - fullyQualifiedName: 'crm.objects.commercePayments.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/batch/create', - }, - { - clientCallName: 'client.crm.objects.commercePayments.batch.update', - fullyQualifiedName: 'crm.objects.commercePayments.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/batch/update', - }, - { - clientCallName: 'client.crm.objects.commercePayments.batch.delete', - fullyQualifiedName: 'crm.objects.commercePayments.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/batch/archive', - }, - { - clientCallName: 'client.crm.objects.commercePayments.batch.get', - fullyQualifiedName: 'crm.objects.commercePayments.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/batch/read', - }, - { - clientCallName: 'client.crm.objects.commercePayments.batch.upsert', - fullyQualifiedName: 'crm.objects.commercePayments.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/commerce_payments/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.communications.create', - fullyQualifiedName: 'crm.objects.communications.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications', - }, - { - clientCallName: 'client.crm.objects.communications.update', - fullyQualifiedName: 'crm.objects.communications.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/communications/{communicationId}', - }, - { - clientCallName: 'client.crm.objects.communications.list', - fullyQualifiedName: 'crm.objects.communications.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/communications', - }, - { - clientCallName: 'client.crm.objects.communications.delete', - fullyQualifiedName: 'crm.objects.communications.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/communications/{communicationId}', - }, - { - clientCallName: 'client.crm.objects.communications.get', - fullyQualifiedName: 'crm.objects.communications.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/communications/{communicationId}', - }, - { - clientCallName: 'client.crm.objects.communications.search', - fullyQualifiedName: 'crm.objects.communications.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/search', - }, - { - clientCallName: 'client.crm.objects.communications.batch.create', - fullyQualifiedName: 'crm.objects.communications.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/batch/create', - }, - { - clientCallName: 'client.crm.objects.communications.batch.update', - fullyQualifiedName: 'crm.objects.communications.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/batch/update', - }, - { - clientCallName: 'client.crm.objects.communications.batch.delete', - fullyQualifiedName: 'crm.objects.communications.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/batch/archive', - }, - { - clientCallName: 'client.crm.objects.communications.batch.get', - fullyQualifiedName: 'crm.objects.communications.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/batch/read', - }, - { - clientCallName: 'client.crm.objects.communications.batch.upsert', - fullyQualifiedName: 'crm.objects.communications.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/communications/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.companies.create', - fullyQualifiedName: 'crm.objects.companies.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies', - }, - { - clientCallName: 'client.crm.objects.companies.update', - fullyQualifiedName: 'crm.objects.companies.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/companies/{companyId}', - }, - { - clientCallName: 'client.crm.objects.companies.list', - fullyQualifiedName: 'crm.objects.companies.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/companies', - }, - { - clientCallName: 'client.crm.objects.companies.delete', - fullyQualifiedName: 'crm.objects.companies.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/companies/{companyId}', - }, - { - clientCallName: 'client.crm.objects.companies.get', - fullyQualifiedName: 'crm.objects.companies.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/companies/{companyId}', - }, - { - clientCallName: 'client.crm.objects.companies.merge', - fullyQualifiedName: 'crm.objects.companies.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/merge', - }, - { - clientCallName: 'client.crm.objects.companies.search', - fullyQualifiedName: 'crm.objects.companies.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/search', - }, - { - clientCallName: 'client.crm.objects.companies.batch.create', - fullyQualifiedName: 'crm.objects.companies.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/batch/create', - }, - { - clientCallName: 'client.crm.objects.companies.batch.update', - fullyQualifiedName: 'crm.objects.companies.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/batch/update', - }, - { - clientCallName: 'client.crm.objects.companies.batch.delete', - fullyQualifiedName: 'crm.objects.companies.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/batch/archive', - }, - { - clientCallName: 'client.crm.objects.companies.batch.get', - fullyQualifiedName: 'crm.objects.companies.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/batch/read', - }, - { - clientCallName: 'client.crm.objects.companies.batch.upsert', - fullyQualifiedName: 'crm.objects.companies.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/companies/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.contacts.create', - fullyQualifiedName: 'crm.objects.contacts.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts', - }, - { - clientCallName: 'client.crm.objects.contacts.update', - fullyQualifiedName: 'crm.objects.contacts.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/contacts/{contactId}', - }, - { - clientCallName: 'client.crm.objects.contacts.list', - fullyQualifiedName: 'crm.objects.contacts.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/contacts', - }, - { - clientCallName: 'client.crm.objects.contacts.delete', - fullyQualifiedName: 'crm.objects.contacts.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/contacts/{contactId}', - }, - { - clientCallName: 'client.crm.objects.contacts.gdprDelete', - fullyQualifiedName: 'crm.objects.contacts.gdprDelete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/gdpr-delete', - }, - { - clientCallName: 'client.crm.objects.contacts.get', - fullyQualifiedName: 'crm.objects.contacts.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/contacts/{contactId}', - }, - { - clientCallName: 'client.crm.objects.contacts.merge', - fullyQualifiedName: 'crm.objects.contacts.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/merge', - }, - { - clientCallName: 'client.crm.objects.contacts.search', - fullyQualifiedName: 'crm.objects.contacts.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/search', - }, - { - clientCallName: 'client.crm.objects.contacts.batch.create', - fullyQualifiedName: 'crm.objects.contacts.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/batch/create', - }, - { - clientCallName: 'client.crm.objects.contacts.batch.update', - fullyQualifiedName: 'crm.objects.contacts.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/batch/update', - }, - { - clientCallName: 'client.crm.objects.contacts.batch.delete', - fullyQualifiedName: 'crm.objects.contacts.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/batch/archive', - }, - { - clientCallName: 'client.crm.objects.contacts.batch.get', - fullyQualifiedName: 'crm.objects.contacts.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/batch/read', - }, - { - clientCallName: 'client.crm.objects.contacts.batch.upsert', - fullyQualifiedName: 'crm.objects.contacts.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contacts/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.contracts.list', - fullyQualifiedName: 'crm.objects.contracts.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/contracts', - }, - { - clientCallName: 'client.crm.objects.contracts.get', - fullyQualifiedName: 'crm.objects.contracts.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/contracts/{contractId}', - }, - { - clientCallName: 'client.crm.objects.contracts.batch.get', - fullyQualifiedName: 'crm.objects.contracts.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/contracts/batch/read', - }, - { - clientCallName: 'client.crm.objects.courses.create', - fullyQualifiedName: 'crm.objects.courses.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410', - }, - { - clientCallName: 'client.crm.objects.courses.update', - fullyQualifiedName: 'crm.objects.courses.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/0-410/{courseId}', - }, - { - clientCallName: 'client.crm.objects.courses.list', - fullyQualifiedName: 'crm.objects.courses.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-410', - }, - { - clientCallName: 'client.crm.objects.courses.delete', - fullyQualifiedName: 'crm.objects.courses.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/0-410/{courseId}', - }, - { - clientCallName: 'client.crm.objects.courses.get', - fullyQualifiedName: 'crm.objects.courses.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-410/{courseId}', - }, - { - clientCallName: 'client.crm.objects.courses.search', - fullyQualifiedName: 'crm.objects.courses.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/search', - }, - { - clientCallName: 'client.crm.objects.courses.batch.create', - fullyQualifiedName: 'crm.objects.courses.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/batch/create', - }, - { - clientCallName: 'client.crm.objects.courses.batch.update', - fullyQualifiedName: 'crm.objects.courses.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/batch/update', - }, - { - clientCallName: 'client.crm.objects.courses.batch.delete', - fullyQualifiedName: 'crm.objects.courses.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/batch/archive', - }, - { - clientCallName: 'client.crm.objects.courses.batch.get', - fullyQualifiedName: 'crm.objects.courses.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/batch/read', - }, - { - clientCallName: 'client.crm.objects.courses.batch.upsert', - fullyQualifiedName: 'crm.objects.courses.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-410/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.custom.create', - fullyQualifiedName: 'crm.objects.custom.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.objects.custom.update', - fullyQualifiedName: 'crm.objects.custom.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.custom.list', - fullyQualifiedName: 'crm.objects.custom.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.objects.custom.delete', - fullyQualifiedName: 'crm.objects.custom.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.custom.get', - fullyQualifiedName: 'crm.objects.custom.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.custom.merge', - fullyQualifiedName: 'crm.objects.custom.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/merge', - }, - { - clientCallName: 'client.crm.objects.custom.search', - fullyQualifiedName: 'crm.objects.custom.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/search', - }, - { - clientCallName: 'client.crm.objects.custom.batch.create', - fullyQualifiedName: 'crm.objects.custom.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/create', - }, - { - clientCallName: 'client.crm.objects.custom.batch.update', - fullyQualifiedName: 'crm.objects.custom.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/update', - }, - { - clientCallName: 'client.crm.objects.custom.batch.delete', - fullyQualifiedName: 'crm.objects.custom.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/archive', - }, - { - clientCallName: 'client.crm.objects.custom.batch.get', - fullyQualifiedName: 'crm.objects.custom.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/read', - }, - { - clientCallName: 'client.crm.objects.custom.batch.upsert', - fullyQualifiedName: 'crm.objects.custom.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.deals.create', - fullyQualifiedName: 'crm.objects.deals.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3', - }, - { - clientCallName: 'client.crm.objects.deals.update', - fullyQualifiedName: 'crm.objects.deals.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/0-3/{dealId}', - }, - { - clientCallName: 'client.crm.objects.deals.list', - fullyQualifiedName: 'crm.objects.deals.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-3', - }, - { - clientCallName: 'client.crm.objects.deals.delete', - fullyQualifiedName: 'crm.objects.deals.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/0-3/{dealId}', - }, - { - clientCallName: 'client.crm.objects.deals.get', - fullyQualifiedName: 'crm.objects.deals.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-3/{dealId}', - }, - { - clientCallName: 'client.crm.objects.deals.merge', - fullyQualifiedName: 'crm.objects.deals.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/merge', - }, - { - clientCallName: 'client.crm.objects.deals.search', - fullyQualifiedName: 'crm.objects.deals.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/search', - }, - { - clientCallName: 'client.crm.objects.deals.batch.create', - fullyQualifiedName: 'crm.objects.deals.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/batch/create', - }, - { - clientCallName: 'client.crm.objects.deals.batch.update', - fullyQualifiedName: 'crm.objects.deals.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/batch/update', - }, - { - clientCallName: 'client.crm.objects.deals.batch.delete', - fullyQualifiedName: 'crm.objects.deals.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/batch/archive', - }, - { - clientCallName: 'client.crm.objects.deals.batch.get', - fullyQualifiedName: 'crm.objects.deals.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/batch/read', - }, - { - clientCallName: 'client.crm.objects.deals.batch.upsert', - fullyQualifiedName: 'crm.objects.deals.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-3/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.discounts.create', - fullyQualifiedName: 'crm.objects.discounts.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts', - }, - { - clientCallName: 'client.crm.objects.discounts.update', - fullyQualifiedName: 'crm.objects.discounts.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/discounts/{discountId}', - }, - { - clientCallName: 'client.crm.objects.discounts.list', - fullyQualifiedName: 'crm.objects.discounts.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/discounts', - }, - { - clientCallName: 'client.crm.objects.discounts.delete', - fullyQualifiedName: 'crm.objects.discounts.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/discounts/{discountId}', - }, - { - clientCallName: 'client.crm.objects.discounts.get', - fullyQualifiedName: 'crm.objects.discounts.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/discounts/{discountId}', - }, - { - clientCallName: 'client.crm.objects.discounts.search', - fullyQualifiedName: 'crm.objects.discounts.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/search', - }, - { - clientCallName: 'client.crm.objects.discounts.batch.create', - fullyQualifiedName: 'crm.objects.discounts.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/batch/create', - }, - { - clientCallName: 'client.crm.objects.discounts.batch.update', - fullyQualifiedName: 'crm.objects.discounts.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/batch/update', - }, - { - clientCallName: 'client.crm.objects.discounts.batch.delete', - fullyQualifiedName: 'crm.objects.discounts.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/batch/archive', - }, - { - clientCallName: 'client.crm.objects.discounts.batch.get', - fullyQualifiedName: 'crm.objects.discounts.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/batch/read', - }, - { - clientCallName: 'client.crm.objects.discounts.batch.upsert', - fullyQualifiedName: 'crm.objects.discounts.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/discounts/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.emails.create', - fullyQualifiedName: 'crm.objects.emails.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails', - }, - { - clientCallName: 'client.crm.objects.emails.update', - fullyQualifiedName: 'crm.objects.emails.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/emails/{emailId}', - }, - { - clientCallName: 'client.crm.objects.emails.list', - fullyQualifiedName: 'crm.objects.emails.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/emails', - }, - { - clientCallName: 'client.crm.objects.emails.delete', - fullyQualifiedName: 'crm.objects.emails.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/emails/{emailId}', - }, - { - clientCallName: 'client.crm.objects.emails.get', - fullyQualifiedName: 'crm.objects.emails.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/emails/{emailId}', - }, - { - clientCallName: 'client.crm.objects.emails.search', - fullyQualifiedName: 'crm.objects.emails.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/search', - }, - { - clientCallName: 'client.crm.objects.emails.batch.create', - fullyQualifiedName: 'crm.objects.emails.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/batch/create', - }, - { - clientCallName: 'client.crm.objects.emails.batch.update', - fullyQualifiedName: 'crm.objects.emails.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/batch/update', - }, - { - clientCallName: 'client.crm.objects.emails.batch.delete', - fullyQualifiedName: 'crm.objects.emails.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/batch/archive', - }, - { - clientCallName: 'client.crm.objects.emails.batch.get', - fullyQualifiedName: 'crm.objects.emails.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/batch/read', - }, - { - clientCallName: 'client.crm.objects.emails.batch.upsert', - fullyQualifiedName: 'crm.objects.emails.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/emails/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.feedbackSubmissions.list', - fullyQualifiedName: 'crm.objects.feedbackSubmissions.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/feedback_submissions', - }, - { - clientCallName: 'client.crm.objects.feedbackSubmissions.get', - fullyQualifiedName: 'crm.objects.feedbackSubmissions.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/feedback_submissions/{feedbackSubmissionId}', - }, - { - clientCallName: 'client.crm.objects.feedbackSubmissions.search', - fullyQualifiedName: 'crm.objects.feedbackSubmissions.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/feedback_submissions/search', - }, - { - clientCallName: 'client.crm.objects.feedbackSubmissions.batch.get', - fullyQualifiedName: 'crm.objects.feedbackSubmissions.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/feedback_submissions/batch/read', - }, - { - clientCallName: 'client.crm.objects.fees.create', - fullyQualifiedName: 'crm.objects.fees.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees', - }, - { - clientCallName: 'client.crm.objects.fees.update', - fullyQualifiedName: 'crm.objects.fees.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/fees/{feeId}', - }, - { - clientCallName: 'client.crm.objects.fees.list', - fullyQualifiedName: 'crm.objects.fees.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/fees', - }, - { - clientCallName: 'client.crm.objects.fees.delete', - fullyQualifiedName: 'crm.objects.fees.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/fees/{feeId}', - }, - { - clientCallName: 'client.crm.objects.fees.get', - fullyQualifiedName: 'crm.objects.fees.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/fees/{feeId}', - }, - { - clientCallName: 'client.crm.objects.fees.search', - fullyQualifiedName: 'crm.objects.fees.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/search', - }, - { - clientCallName: 'client.crm.objects.fees.batch.create', - fullyQualifiedName: 'crm.objects.fees.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/batch/create', - }, - { - clientCallName: 'client.crm.objects.fees.batch.update', - fullyQualifiedName: 'crm.objects.fees.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/batch/update', - }, - { - clientCallName: 'client.crm.objects.fees.batch.delete', - fullyQualifiedName: 'crm.objects.fees.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/batch/archive', - }, - { - clientCallName: 'client.crm.objects.fees.batch.get', - fullyQualifiedName: 'crm.objects.fees.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/batch/read', - }, - { - clientCallName: 'client.crm.objects.fees.batch.upsert', - fullyQualifiedName: 'crm.objects.fees.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/fees/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.genericObjects.create', - fullyQualifiedName: 'crm.objects.genericObjects.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.objects.genericObjects.update', - fullyQualifiedName: 'crm.objects.genericObjects.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.genericObjects.list', - fullyQualifiedName: 'crm.objects.genericObjects.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.objects.genericObjects.delete', - fullyQualifiedName: 'crm.objects.genericObjects.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.genericObjects.get', - fullyQualifiedName: 'crm.objects.genericObjects.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/{objectType}/{objectId}', - }, - { - clientCallName: 'client.crm.objects.genericObjects.search', - fullyQualifiedName: 'crm.objects.genericObjects.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/search', - }, - { - clientCallName: 'client.crm.objects.genericObjects.batch.create', - fullyQualifiedName: 'crm.objects.genericObjects.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/create', - }, - { - clientCallName: 'client.crm.objects.genericObjects.batch.update', - fullyQualifiedName: 'crm.objects.genericObjects.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/update', - }, - { - clientCallName: 'client.crm.objects.genericObjects.batch.delete', - fullyQualifiedName: 'crm.objects.genericObjects.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/archive', - }, - { - clientCallName: 'client.crm.objects.genericObjects.batch.get', - fullyQualifiedName: 'crm.objects.genericObjects.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/read', - }, - { - clientCallName: 'client.crm.objects.genericObjects.batch.upsert', - fullyQualifiedName: 'crm.objects.genericObjects.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/{objectType}/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.goalTargets.create', - fullyQualifiedName: 'crm.objects.goalTargets.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets', - }, - { - clientCallName: 'client.crm.objects.goalTargets.update', - fullyQualifiedName: 'crm.objects.goalTargets.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - }, - { - clientCallName: 'client.crm.objects.goalTargets.list', - fullyQualifiedName: 'crm.objects.goalTargets.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/goal_targets', - }, - { - clientCallName: 'client.crm.objects.goalTargets.delete', - fullyQualifiedName: 'crm.objects.goalTargets.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - }, - { - clientCallName: 'client.crm.objects.goalTargets.get', - fullyQualifiedName: 'crm.objects.goalTargets.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/goal_targets/{goalTargetId}', - }, - { - clientCallName: 'client.crm.objects.goalTargets.search', - fullyQualifiedName: 'crm.objects.goalTargets.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/search', - }, - { - clientCallName: 'client.crm.objects.goalTargets.batch.create', - fullyQualifiedName: 'crm.objects.goalTargets.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/batch/create', - }, - { - clientCallName: 'client.crm.objects.goalTargets.batch.update', - fullyQualifiedName: 'crm.objects.goalTargets.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/batch/update', - }, - { - clientCallName: 'client.crm.objects.goalTargets.batch.delete', - fullyQualifiedName: 'crm.objects.goalTargets.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/batch/archive', - }, - { - clientCallName: 'client.crm.objects.goalTargets.batch.get', - fullyQualifiedName: 'crm.objects.goalTargets.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/batch/read', - }, - { - clientCallName: 'client.crm.objects.goalTargets.batch.upsert', - fullyQualifiedName: 'crm.objects.goalTargets.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/goal_targets/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.invoices.create', - fullyQualifiedName: 'crm.objects.invoices.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices', - }, - { - clientCallName: 'client.crm.objects.invoices.update', - fullyQualifiedName: 'crm.objects.invoices.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', - }, - { - clientCallName: 'client.crm.objects.invoices.list', - fullyQualifiedName: 'crm.objects.invoices.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/invoices', - }, - { - clientCallName: 'client.crm.objects.invoices.delete', - fullyQualifiedName: 'crm.objects.invoices.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', - }, - { - clientCallName: 'client.crm.objects.invoices.get', - fullyQualifiedName: 'crm.objects.invoices.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/invoices/{invoiceId}', - }, - { - clientCallName: 'client.crm.objects.invoices.search', - fullyQualifiedName: 'crm.objects.invoices.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/search', - }, - { - clientCallName: 'client.crm.objects.invoices.batch.create', - fullyQualifiedName: 'crm.objects.invoices.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/batch/create', - }, - { - clientCallName: 'client.crm.objects.invoices.batch.update', - fullyQualifiedName: 'crm.objects.invoices.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/batch/update', - }, - { - clientCallName: 'client.crm.objects.invoices.batch.delete', - fullyQualifiedName: 'crm.objects.invoices.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/batch/archive', - }, - { - clientCallName: 'client.crm.objects.invoices.batch.get', - fullyQualifiedName: 'crm.objects.invoices.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/batch/read', - }, - { - clientCallName: 'client.crm.objects.invoices.batch.upsert', - fullyQualifiedName: 'crm.objects.invoices.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/invoices/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.leads.create', - fullyQualifiedName: 'crm.objects.leads.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads', - }, - { - clientCallName: 'client.crm.objects.leads.update', - fullyQualifiedName: 'crm.objects.leads.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/leads/{leadsId}', - }, - { - clientCallName: 'client.crm.objects.leads.list', - fullyQualifiedName: 'crm.objects.leads.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/leads', - }, - { - clientCallName: 'client.crm.objects.leads.delete', - fullyQualifiedName: 'crm.objects.leads.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/leads/{leadsId}', - }, - { - clientCallName: 'client.crm.objects.leads.get', - fullyQualifiedName: 'crm.objects.leads.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/leads/{leadsId}', - }, - { - clientCallName: 'client.crm.objects.leads.search', - fullyQualifiedName: 'crm.objects.leads.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/search', - }, - { - clientCallName: 'client.crm.objects.leads.batch.create', - fullyQualifiedName: 'crm.objects.leads.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/batch/create', - }, - { - clientCallName: 'client.crm.objects.leads.batch.update', - fullyQualifiedName: 'crm.objects.leads.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/batch/update', - }, - { - clientCallName: 'client.crm.objects.leads.batch.delete', - fullyQualifiedName: 'crm.objects.leads.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/batch/archive', - }, - { - clientCallName: 'client.crm.objects.leads.batch.get', - fullyQualifiedName: 'crm.objects.leads.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/batch/read', - }, - { - clientCallName: 'client.crm.objects.leads.batch.upsert', - fullyQualifiedName: 'crm.objects.leads.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/leads/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.lineItems.create', - fullyQualifiedName: 'crm.objects.lineItems.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items', - }, - { - clientCallName: 'client.crm.objects.lineItems.update', - fullyQualifiedName: 'crm.objects.lineItems.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', - }, - { - clientCallName: 'client.crm.objects.lineItems.list', - fullyQualifiedName: 'crm.objects.lineItems.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/line_items', - }, - { - clientCallName: 'client.crm.objects.lineItems.delete', - fullyQualifiedName: 'crm.objects.lineItems.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', - }, - { - clientCallName: 'client.crm.objects.lineItems.get', - fullyQualifiedName: 'crm.objects.lineItems.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/line_items/{lineItemId}', - }, - { - clientCallName: 'client.crm.objects.lineItems.search', - fullyQualifiedName: 'crm.objects.lineItems.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/search', - }, - { - clientCallName: 'client.crm.objects.lineItems.batch.create', - fullyQualifiedName: 'crm.objects.lineItems.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/batch/create', - }, - { - clientCallName: 'client.crm.objects.lineItems.batch.update', - fullyQualifiedName: 'crm.objects.lineItems.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/batch/update', - }, - { - clientCallName: 'client.crm.objects.lineItems.batch.delete', - fullyQualifiedName: 'crm.objects.lineItems.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/batch/archive', - }, - { - clientCallName: 'client.crm.objects.lineItems.batch.get', - fullyQualifiedName: 'crm.objects.lineItems.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/batch/read', - }, - { - clientCallName: 'client.crm.objects.lineItems.batch.upsert', - fullyQualifiedName: 'crm.objects.lineItems.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/line_items/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.listings.create', - fullyQualifiedName: 'crm.objects.listings.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420', - }, - { - clientCallName: 'client.crm.objects.listings.update', - fullyQualifiedName: 'crm.objects.listings.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/0-420/{listingId}', - }, - { - clientCallName: 'client.crm.objects.listings.list', - fullyQualifiedName: 'crm.objects.listings.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-420', - }, - { - clientCallName: 'client.crm.objects.listings.delete', - fullyQualifiedName: 'crm.objects.listings.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/0-420/{listingId}', - }, - { - clientCallName: 'client.crm.objects.listings.get', - fullyQualifiedName: 'crm.objects.listings.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-420/{listingId}', - }, - { - clientCallName: 'client.crm.objects.listings.search', - fullyQualifiedName: 'crm.objects.listings.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/search', - }, - { - clientCallName: 'client.crm.objects.listings.batch.create', - fullyQualifiedName: 'crm.objects.listings.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/batch/create', - }, - { - clientCallName: 'client.crm.objects.listings.batch.update', - fullyQualifiedName: 'crm.objects.listings.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/batch/update', - }, - { - clientCallName: 'client.crm.objects.listings.batch.delete', - fullyQualifiedName: 'crm.objects.listings.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/batch/archive', - }, - { - clientCallName: 'client.crm.objects.listings.batch.get', - fullyQualifiedName: 'crm.objects.listings.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/batch/read', - }, - { - clientCallName: 'client.crm.objects.listings.batch.upsert', - fullyQualifiedName: 'crm.objects.listings.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-420/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.meetings.create', - fullyQualifiedName: 'crm.objects.meetings.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings', - }, - { - clientCallName: 'client.crm.objects.meetings.update', - fullyQualifiedName: 'crm.objects.meetings.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/meetings/{meetingId}', - }, - { - clientCallName: 'client.crm.objects.meetings.list', - fullyQualifiedName: 'crm.objects.meetings.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/meetings', - }, - { - clientCallName: 'client.crm.objects.meetings.delete', - fullyQualifiedName: 'crm.objects.meetings.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/meetings/{meetingId}', - }, - { - clientCallName: 'client.crm.objects.meetings.get', - fullyQualifiedName: 'crm.objects.meetings.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/meetings/{meetingId}', - }, - { - clientCallName: 'client.crm.objects.meetings.search', - fullyQualifiedName: 'crm.objects.meetings.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/search', - }, - { - clientCallName: 'client.crm.objects.meetings.batch.create', - fullyQualifiedName: 'crm.objects.meetings.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/batch/create', - }, - { - clientCallName: 'client.crm.objects.meetings.batch.update', - fullyQualifiedName: 'crm.objects.meetings.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/batch/update', - }, - { - clientCallName: 'client.crm.objects.meetings.batch.delete', - fullyQualifiedName: 'crm.objects.meetings.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/batch/archive', - }, - { - clientCallName: 'client.crm.objects.meetings.batch.get', - fullyQualifiedName: 'crm.objects.meetings.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/batch/read', - }, - { - clientCallName: 'client.crm.objects.meetings.batch.upsert', - fullyQualifiedName: 'crm.objects.meetings.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/meetings/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.notes.create', - fullyQualifiedName: 'crm.objects.notes.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes', - }, - { - clientCallName: 'client.crm.objects.notes.update', - fullyQualifiedName: 'crm.objects.notes.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/notes/{noteId}', - }, - { - clientCallName: 'client.crm.objects.notes.list', - fullyQualifiedName: 'crm.objects.notes.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/notes', - }, - { - clientCallName: 'client.crm.objects.notes.delete', - fullyQualifiedName: 'crm.objects.notes.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/notes/{noteId}', - }, - { - clientCallName: 'client.crm.objects.notes.get', - fullyQualifiedName: 'crm.objects.notes.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/notes/{noteId}', - }, - { - clientCallName: 'client.crm.objects.notes.search', - fullyQualifiedName: 'crm.objects.notes.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/search', - }, - { - clientCallName: 'client.crm.objects.notes.batch.create', - fullyQualifiedName: 'crm.objects.notes.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/batch/create', - }, - { - clientCallName: 'client.crm.objects.notes.batch.update', - fullyQualifiedName: 'crm.objects.notes.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/batch/update', - }, - { - clientCallName: 'client.crm.objects.notes.batch.delete', - fullyQualifiedName: 'crm.objects.notes.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/batch/archive', - }, - { - clientCallName: 'client.crm.objects.notes.batch.get', - fullyQualifiedName: 'crm.objects.notes.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/batch/read', - }, - { - clientCallName: 'client.crm.objects.notes.batch.upsert', - fullyQualifiedName: 'crm.objects.notes.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/notes/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.orders.create', - fullyQualifiedName: 'crm.objects.orders.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders', - }, - { - clientCallName: 'client.crm.objects.orders.update', - fullyQualifiedName: 'crm.objects.orders.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/orders/{orderId}', - }, - { - clientCallName: 'client.crm.objects.orders.list', - fullyQualifiedName: 'crm.objects.orders.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/orders', - }, - { - clientCallName: 'client.crm.objects.orders.delete', - fullyQualifiedName: 'crm.objects.orders.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/orders/{orderId}', - }, - { - clientCallName: 'client.crm.objects.orders.get', - fullyQualifiedName: 'crm.objects.orders.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/orders/{orderId}', - }, - { - clientCallName: 'client.crm.objects.orders.search', - fullyQualifiedName: 'crm.objects.orders.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/search', - }, - { - clientCallName: 'client.crm.objects.orders.batch.create', - fullyQualifiedName: 'crm.objects.orders.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/batch/create', - }, - { - clientCallName: 'client.crm.objects.orders.batch.update', - fullyQualifiedName: 'crm.objects.orders.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/batch/update', - }, - { - clientCallName: 'client.crm.objects.orders.batch.delete', - fullyQualifiedName: 'crm.objects.orders.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/batch/archive', - }, - { - clientCallName: 'client.crm.objects.orders.batch.get', - fullyQualifiedName: 'crm.objects.orders.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/batch/read', - }, - { - clientCallName: 'client.crm.objects.orders.batch.upsert', - fullyQualifiedName: 'crm.objects.orders.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/orders/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.partnerClients.update', - fullyQualifiedName: 'crm.objects.partnerClients.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}', - }, - { - clientCallName: 'client.crm.objects.partnerClients.list', - fullyQualifiedName: 'crm.objects.partnerClients.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/partner_clients', - }, - { - clientCallName: 'client.crm.objects.partnerClients.get', - fullyQualifiedName: 'crm.objects.partnerClients.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}', - }, - { - clientCallName: 'client.crm.objects.partnerClients.listAssociations', - fullyQualifiedName: 'crm.objects.partnerClients.listAssociations', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}', - }, - { - clientCallName: 'client.crm.objects.partnerClients.search', - fullyQualifiedName: 'crm.objects.partnerClients.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_clients/search', - }, - { - clientCallName: 'client.crm.objects.partnerClients.batch.update', - fullyQualifiedName: 'crm.objects.partnerClients.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_clients/batch/update', - }, - { - clientCallName: 'client.crm.objects.partnerClients.batch.get', - fullyQualifiedName: 'crm.objects.partnerClients.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_clients/batch/read', - }, - { - clientCallName: 'client.crm.objects.partnerServices.update', - fullyQualifiedName: 'crm.objects.partnerServices.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}', - }, - { - clientCallName: 'client.crm.objects.partnerServices.list', - fullyQualifiedName: 'crm.objects.partnerServices.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}/associations/{toObjectType}', - }, - { - clientCallName: 'client.crm.objects.partnerServices.get', - fullyQualifiedName: 'crm.objects.partnerServices.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/partner_services/{partnerServiceId}', - }, - { - clientCallName: 'client.crm.objects.partnerServices.search', - fullyQualifiedName: 'crm.objects.partnerServices.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_services/search', - }, - { - clientCallName: 'client.crm.objects.partnerServices.batch.update', - fullyQualifiedName: 'crm.objects.partnerServices.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_services/batch/update', - }, - { - clientCallName: 'client.crm.objects.partnerServices.batch.get', - fullyQualifiedName: 'crm.objects.partnerServices.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/partner_services/batch/read', - }, - { - clientCallName: 'client.crm.objects.postalMail.create', - fullyQualifiedName: 'crm.objects.postalMail.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail', - }, - { - clientCallName: 'client.crm.objects.postalMail.update', - fullyQualifiedName: 'crm.objects.postalMail.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', - }, - { - clientCallName: 'client.crm.objects.postalMail.list', - fullyQualifiedName: 'crm.objects.postalMail.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/postal_mail', - }, - { - clientCallName: 'client.crm.objects.postalMail.delete', - fullyQualifiedName: 'crm.objects.postalMail.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', - }, - { - clientCallName: 'client.crm.objects.postalMail.get', - fullyQualifiedName: 'crm.objects.postalMail.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/postal_mail/{postalMailId}', - }, - { - clientCallName: 'client.crm.objects.postalMail.search', - fullyQualifiedName: 'crm.objects.postalMail.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/search', - }, - { - clientCallName: 'client.crm.objects.postalMail.batch.create', - fullyQualifiedName: 'crm.objects.postalMail.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/batch/create', - }, - { - clientCallName: 'client.crm.objects.postalMail.batch.update', - fullyQualifiedName: 'crm.objects.postalMail.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/batch/update', - }, - { - clientCallName: 'client.crm.objects.postalMail.batch.delete', - fullyQualifiedName: 'crm.objects.postalMail.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/batch/archive', - }, - { - clientCallName: 'client.crm.objects.postalMail.batch.get', - fullyQualifiedName: 'crm.objects.postalMail.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/batch/read', - }, - { - clientCallName: 'client.crm.objects.postalMail.batch.upsert', - fullyQualifiedName: 'crm.objects.postalMail.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/postal_mail/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.products.create', - fullyQualifiedName: 'crm.objects.products.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products', - }, - { - clientCallName: 'client.crm.objects.products.update', - fullyQualifiedName: 'crm.objects.products.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/products/{productId}', - }, - { - clientCallName: 'client.crm.objects.products.list', - fullyQualifiedName: 'crm.objects.products.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/products', - }, - { - clientCallName: 'client.crm.objects.products.delete', - fullyQualifiedName: 'crm.objects.products.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/products/{productId}', - }, - { - clientCallName: 'client.crm.objects.products.get', - fullyQualifiedName: 'crm.objects.products.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/products/{productId}', - }, - { - clientCallName: 'client.crm.objects.products.search', - fullyQualifiedName: 'crm.objects.products.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/search', - }, - { - clientCallName: 'client.crm.objects.products.batch.create', - fullyQualifiedName: 'crm.objects.products.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/batch/create', - }, - { - clientCallName: 'client.crm.objects.products.batch.update', - fullyQualifiedName: 'crm.objects.products.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/batch/update', - }, - { - clientCallName: 'client.crm.objects.products.batch.delete', - fullyQualifiedName: 'crm.objects.products.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/batch/archive', - }, - { - clientCallName: 'client.crm.objects.products.batch.get', - fullyQualifiedName: 'crm.objects.products.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/batch/read', - }, - { - clientCallName: 'client.crm.objects.products.batch.upsert', - fullyQualifiedName: 'crm.objects.products.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/products/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.projects.create', - fullyQualifiedName: 'crm.objects.projects.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects', - }, - { - clientCallName: 'client.crm.objects.projects.update', - fullyQualifiedName: 'crm.objects.projects.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/projects/{projectId}', - }, - { - clientCallName: 'client.crm.objects.projects.list', - fullyQualifiedName: 'crm.objects.projects.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/projects', - }, - { - clientCallName: 'client.crm.objects.projects.delete', - fullyQualifiedName: 'crm.objects.projects.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/projects/{projectId}', - }, - { - clientCallName: 'client.crm.objects.projects.get', - fullyQualifiedName: 'crm.objects.projects.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/projects/{projectId}', - }, - { - clientCallName: 'client.crm.objects.projects.merge', - fullyQualifiedName: 'crm.objects.projects.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/merge', - }, - { - clientCallName: 'client.crm.objects.projects.search', - fullyQualifiedName: 'crm.objects.projects.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/search', - }, - { - clientCallName: 'client.crm.objects.projects.batch.create', - fullyQualifiedName: 'crm.objects.projects.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/batch/create', - }, - { - clientCallName: 'client.crm.objects.projects.batch.update', - fullyQualifiedName: 'crm.objects.projects.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/batch/update', - }, - { - clientCallName: 'client.crm.objects.projects.batch.delete', - fullyQualifiedName: 'crm.objects.projects.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/batch/archive', - }, - { - clientCallName: 'client.crm.objects.projects.batch.get', - fullyQualifiedName: 'crm.objects.projects.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/batch/read', - }, - { - clientCallName: 'client.crm.objects.projects.batch.upsert', - fullyQualifiedName: 'crm.objects.projects.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/projects/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.quotes.create', - fullyQualifiedName: 'crm.objects.quotes.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes', - }, - { - clientCallName: 'client.crm.objects.quotes.update', - fullyQualifiedName: 'crm.objects.quotes.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/quotes/{quoteId}', - }, - { - clientCallName: 'client.crm.objects.quotes.list', - fullyQualifiedName: 'crm.objects.quotes.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/quotes', - }, - { - clientCallName: 'client.crm.objects.quotes.delete', - fullyQualifiedName: 'crm.objects.quotes.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/quotes/{quoteId}', - }, - { - clientCallName: 'client.crm.objects.quotes.get', - fullyQualifiedName: 'crm.objects.quotes.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/quotes/{quoteId}', - }, - { - clientCallName: 'client.crm.objects.quotes.search', - fullyQualifiedName: 'crm.objects.quotes.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/search', - }, - { - clientCallName: 'client.crm.objects.quotes.batch.create', - fullyQualifiedName: 'crm.objects.quotes.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/batch/create', - }, - { - clientCallName: 'client.crm.objects.quotes.batch.update', - fullyQualifiedName: 'crm.objects.quotes.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/batch/update', - }, - { - clientCallName: 'client.crm.objects.quotes.batch.delete', - fullyQualifiedName: 'crm.objects.quotes.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/batch/archive', - }, - { - clientCallName: 'client.crm.objects.quotes.batch.get', - fullyQualifiedName: 'crm.objects.quotes.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/batch/read', - }, - { - clientCallName: 'client.crm.objects.quotes.batch.upsert', - fullyQualifiedName: 'crm.objects.quotes.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/quotes/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.services.create', - fullyQualifiedName: 'crm.objects.services.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162', - }, - { - clientCallName: 'client.crm.objects.services.update', - fullyQualifiedName: 'crm.objects.services.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/0-162/{serviceId}', - }, - { - clientCallName: 'client.crm.objects.services.list', - fullyQualifiedName: 'crm.objects.services.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-162', - }, - { - clientCallName: 'client.crm.objects.services.delete', - fullyQualifiedName: 'crm.objects.services.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/0-162/{serviceId}', - }, - { - clientCallName: 'client.crm.objects.services.get', - fullyQualifiedName: 'crm.objects.services.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/0-162/{serviceId}', - }, - { - clientCallName: 'client.crm.objects.services.search', - fullyQualifiedName: 'crm.objects.services.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/search', - }, - { - clientCallName: 'client.crm.objects.services.batch.create', - fullyQualifiedName: 'crm.objects.services.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/batch/create', - }, - { - clientCallName: 'client.crm.objects.services.batch.update', - fullyQualifiedName: 'crm.objects.services.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/batch/update', - }, - { - clientCallName: 'client.crm.objects.services.batch.delete', - fullyQualifiedName: 'crm.objects.services.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/batch/archive', - }, - { - clientCallName: 'client.crm.objects.services.batch.get', - fullyQualifiedName: 'crm.objects.services.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/batch/read', - }, - { - clientCallName: 'client.crm.objects.services.batch.upsert', - fullyQualifiedName: 'crm.objects.services.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/0-162/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.subscriptions.create', - fullyQualifiedName: 'crm.objects.subscriptions.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions', - }, - { - clientCallName: 'client.crm.objects.subscriptions.update', - fullyQualifiedName: 'crm.objects.subscriptions.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.crm.objects.subscriptions.list', - fullyQualifiedName: 'crm.objects.subscriptions.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/subscriptions', - }, - { - clientCallName: 'client.crm.objects.subscriptions.delete', - fullyQualifiedName: 'crm.objects.subscriptions.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.crm.objects.subscriptions.get', - fullyQualifiedName: 'crm.objects.subscriptions.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.crm.objects.subscriptions.search', - fullyQualifiedName: 'crm.objects.subscriptions.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/search', - }, - { - clientCallName: 'client.crm.objects.subscriptions.batch.create', - fullyQualifiedName: 'crm.objects.subscriptions.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/batch/create', - }, - { - clientCallName: 'client.crm.objects.subscriptions.batch.update', - fullyQualifiedName: 'crm.objects.subscriptions.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/batch/update', - }, - { - clientCallName: 'client.crm.objects.subscriptions.batch.delete', - fullyQualifiedName: 'crm.objects.subscriptions.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/batch/archive', - }, - { - clientCallName: 'client.crm.objects.subscriptions.batch.get', - fullyQualifiedName: 'crm.objects.subscriptions.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/batch/read', - }, - { - clientCallName: 'client.crm.objects.subscriptions.batch.upsert', - fullyQualifiedName: 'crm.objects.subscriptions.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/subscriptions/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.tasks.create', - fullyQualifiedName: 'crm.objects.tasks.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks', - }, - { - clientCallName: 'client.crm.objects.tasks.update', - fullyQualifiedName: 'crm.objects.tasks.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/tasks/{taskId}', - }, - { - clientCallName: 'client.crm.objects.tasks.list', - fullyQualifiedName: 'crm.objects.tasks.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/tasks', - }, - { - clientCallName: 'client.crm.objects.tasks.delete', - fullyQualifiedName: 'crm.objects.tasks.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/tasks/{taskId}', - }, - { - clientCallName: 'client.crm.objects.tasks.get', - fullyQualifiedName: 'crm.objects.tasks.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/tasks/{taskId}', - }, - { - clientCallName: 'client.crm.objects.tasks.search', - fullyQualifiedName: 'crm.objects.tasks.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/search', - }, - { - clientCallName: 'client.crm.objects.tasks.batch.create', - fullyQualifiedName: 'crm.objects.tasks.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/batch/create', - }, - { - clientCallName: 'client.crm.objects.tasks.batch.update', - fullyQualifiedName: 'crm.objects.tasks.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/batch/update', - }, - { - clientCallName: 'client.crm.objects.tasks.batch.delete', - fullyQualifiedName: 'crm.objects.tasks.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/batch/archive', - }, - { - clientCallName: 'client.crm.objects.tasks.batch.get', - fullyQualifiedName: 'crm.objects.tasks.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/batch/read', - }, - { - clientCallName: 'client.crm.objects.tasks.batch.upsert', - fullyQualifiedName: 'crm.objects.tasks.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tasks/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.taxes.create', - fullyQualifiedName: 'crm.objects.taxes.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes', - }, - { - clientCallName: 'client.crm.objects.taxes.update', - fullyQualifiedName: 'crm.objects.taxes.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/taxes/{taxId}', - }, - { - clientCallName: 'client.crm.objects.taxes.list', - fullyQualifiedName: 'crm.objects.taxes.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/taxes', - }, - { - clientCallName: 'client.crm.objects.taxes.delete', - fullyQualifiedName: 'crm.objects.taxes.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/taxes/{taxId}', - }, - { - clientCallName: 'client.crm.objects.taxes.get', - fullyQualifiedName: 'crm.objects.taxes.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/taxes/{taxId}', - }, - { - clientCallName: 'client.crm.objects.taxes.search', - fullyQualifiedName: 'crm.objects.taxes.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/search', - }, - { - clientCallName: 'client.crm.objects.taxes.batch.create', - fullyQualifiedName: 'crm.objects.taxes.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/batch/create', - }, - { - clientCallName: 'client.crm.objects.taxes.batch.update', - fullyQualifiedName: 'crm.objects.taxes.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/batch/update', - }, - { - clientCallName: 'client.crm.objects.taxes.batch.delete', - fullyQualifiedName: 'crm.objects.taxes.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/batch/archive', - }, - { - clientCallName: 'client.crm.objects.taxes.batch.get', - fullyQualifiedName: 'crm.objects.taxes.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/batch/read', - }, - { - clientCallName: 'client.crm.objects.taxes.batch.upsert', - fullyQualifiedName: 'crm.objects.taxes.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/taxes/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.tickets.create', - fullyQualifiedName: 'crm.objects.tickets.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets', - }, - { - clientCallName: 'client.crm.objects.tickets.update', - fullyQualifiedName: 'crm.objects.tickets.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/tickets/{ticketId}', - }, - { - clientCallName: 'client.crm.objects.tickets.list', - fullyQualifiedName: 'crm.objects.tickets.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/tickets', - }, - { - clientCallName: 'client.crm.objects.tickets.delete', - fullyQualifiedName: 'crm.objects.tickets.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/tickets/{ticketId}', - }, - { - clientCallName: 'client.crm.objects.tickets.get', - fullyQualifiedName: 'crm.objects.tickets.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/tickets/{ticketId}', - }, - { - clientCallName: 'client.crm.objects.tickets.merge', - fullyQualifiedName: 'crm.objects.tickets.merge', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/merge', - }, - { - clientCallName: 'client.crm.objects.tickets.search', - fullyQualifiedName: 'crm.objects.tickets.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/search', - }, - { - clientCallName: 'client.crm.objects.tickets.batch.create', - fullyQualifiedName: 'crm.objects.tickets.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/batch/create', - }, - { - clientCallName: 'client.crm.objects.tickets.batch.update', - fullyQualifiedName: 'crm.objects.tickets.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/batch/update', - }, - { - clientCallName: 'client.crm.objects.tickets.batch.delete', - fullyQualifiedName: 'crm.objects.tickets.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/batch/archive', - }, - { - clientCallName: 'client.crm.objects.tickets.batch.get', - fullyQualifiedName: 'crm.objects.tickets.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/batch/read', - }, - { - clientCallName: 'client.crm.objects.tickets.batch.upsert', - fullyQualifiedName: 'crm.objects.tickets.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/tickets/batch/upsert', - }, - { - clientCallName: 'client.crm.objects.users.create', - fullyQualifiedName: 'crm.objects.users.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users', - }, - { - clientCallName: 'client.crm.objects.users.update', - fullyQualifiedName: 'crm.objects.users.update', - httpMethod: 'patch', - httpPath: '/crm/objects/2026-03/users/{userId}', - }, - { - clientCallName: 'client.crm.objects.users.list', - fullyQualifiedName: 'crm.objects.users.list', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/users', - }, - { - clientCallName: 'client.crm.objects.users.delete', - fullyQualifiedName: 'crm.objects.users.delete', - httpMethod: 'delete', - httpPath: '/crm/objects/2026-03/users/{userId}', - }, - { - clientCallName: 'client.crm.objects.users.get', - fullyQualifiedName: 'crm.objects.users.get', - httpMethod: 'get', - httpPath: '/crm/objects/2026-03/users/{userId}', - }, - { - clientCallName: 'client.crm.objects.users.search', - fullyQualifiedName: 'crm.objects.users.search', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/search', - }, - { - clientCallName: 'client.crm.objects.users.batch.create', - fullyQualifiedName: 'crm.objects.users.batch.create', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/batch/create', - }, - { - clientCallName: 'client.crm.objects.users.batch.update', - fullyQualifiedName: 'crm.objects.users.batch.update', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/batch/update', - }, - { - clientCallName: 'client.crm.objects.users.batch.delete', - fullyQualifiedName: 'crm.objects.users.batch.delete', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/batch/archive', - }, - { - clientCallName: 'client.crm.objects.users.batch.get', - fullyQualifiedName: 'crm.objects.users.batch.get', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/batch/read', - }, - { - clientCallName: 'client.crm.objects.users.batch.upsert', - fullyQualifiedName: 'crm.objects.users.batch.upsert', - httpMethod: 'post', - httpPath: '/crm/objects/2026-03/users/batch/upsert', - }, - { - clientCallName: 'client.crm.owners.list', - fullyQualifiedName: 'crm.owners.list', - httpMethod: 'get', - httpPath: '/crm/owners/2026-03', - }, - { - clientCallName: 'client.crm.owners.get', - fullyQualifiedName: 'crm.owners.get', - httpMethod: 'get', - httpPath: '/crm/owners/2026-03/{ownerId}', - }, - { - clientCallName: 'client.crm.pipelines.create', - fullyQualifiedName: 'crm.pipelines.create', - httpMethod: 'post', - httpPath: '/crm/pipelines/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.pipelines.update', - fullyQualifiedName: 'crm.pipelines.update', - httpMethod: 'patch', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - }, - { - clientCallName: 'client.crm.pipelines.list', - fullyQualifiedName: 'crm.pipelines.list', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.pipelines.delete', - fullyQualifiedName: 'crm.pipelines.delete', - httpMethod: 'delete', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - }, - { - clientCallName: 'client.crm.pipelines.createStage', - fullyQualifiedName: 'crm.pipelines.createStage', - httpMethod: 'post', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', - }, - { - clientCallName: 'client.crm.pipelines.deleteStage', - fullyQualifiedName: 'crm.pipelines.deleteStage', - httpMethod: 'delete', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - }, - { - clientCallName: 'client.crm.pipelines.get', - fullyQualifiedName: 'crm.pipelines.get', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - }, - { - clientCallName: 'client.crm.pipelines.getStage', - fullyQualifiedName: 'crm.pipelines.getStage', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - }, - { - clientCallName: 'client.crm.pipelines.listAudit', - fullyQualifiedName: 'crm.pipelines.listAudit', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/audit', - }, - { - clientCallName: 'client.crm.pipelines.listStageAudit', - fullyQualifiedName: 'crm.pipelines.listStageAudit', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}/audit', - }, - { - clientCallName: 'client.crm.pipelines.listStages', - fullyQualifiedName: 'crm.pipelines.listStages', - httpMethod: 'get', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages', - }, - { - clientCallName: 'client.crm.pipelines.updateAllProperties', - fullyQualifiedName: 'crm.pipelines.updateAllProperties', - httpMethod: 'put', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}', - }, - { - clientCallName: 'client.crm.pipelines.updateStage', - fullyQualifiedName: 'crm.pipelines.updateStage', - httpMethod: 'patch', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - }, - { - clientCallName: 'client.crm.pipelines.updateStageAllProperties', - fullyQualifiedName: 'crm.pipelines.updateStageAllProperties', - httpMethod: 'put', - httpPath: '/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}', - }, - { - clientCallName: 'client.crm.properties.create', - fullyQualifiedName: 'crm.properties.create', - httpMethod: 'post', - httpPath: '/crm/properties/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.properties.update', - fullyQualifiedName: 'crm.properties.update', - httpMethod: 'patch', - httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.crm.properties.list', - fullyQualifiedName: 'crm.properties.list', - httpMethod: 'get', - httpPath: '/crm/properties/2026-03/{objectType}', - }, - { - clientCallName: 'client.crm.properties.delete', - fullyQualifiedName: 'crm.properties.delete', - httpMethod: 'delete', - httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.crm.properties.get', - fullyQualifiedName: 'crm.properties.get', - httpMethod: 'get', - httpPath: '/crm/properties/2026-03/{objectType}/{propertyName}', - }, - { - clientCallName: 'client.crm.properties.batch.create', - fullyQualifiedName: 'crm.properties.batch.create', - httpMethod: 'post', - httpPath: '/crm/properties/2026-03/{objectType}/batch/create', - }, - { - clientCallName: 'client.crm.properties.batch.delete', - fullyQualifiedName: 'crm.properties.batch.delete', - httpMethod: 'post', - httpPath: '/crm/properties/2026-03/{objectType}/batch/archive', - }, - { - clientCallName: 'client.crm.properties.batch.get', - fullyQualifiedName: 'crm.properties.batch.get', - httpMethod: 'post', - httpPath: '/crm/properties/2026-03/{objectType}/batch/read', - }, - { - clientCallName: 'client.crm.properties.groups.create', - fullyQualifiedName: 'crm.properties.groups.create', - httpMethod: 'post', - httpPath: '/crm/properties/2026-03/{objectType}/groups', - }, - { - clientCallName: 'client.crm.properties.groups.update', - fullyQualifiedName: 'crm.properties.groups.update', - httpMethod: 'patch', - httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.crm.properties.groups.list', - fullyQualifiedName: 'crm.properties.groups.list', - httpMethod: 'get', - httpPath: '/crm/properties/2026-03/{objectType}/groups', - }, - { - clientCallName: 'client.crm.properties.groups.delete', - fullyQualifiedName: 'crm.properties.groups.delete', - httpMethod: 'delete', - httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.crm.properties.groups.get', - fullyQualifiedName: 'crm.properties.groups.get', - httpMethod: 'get', - httpPath: '/crm/properties/2026-03/{objectType}/groups/{groupName}', - }, - { - clientCallName: 'client.crm.propertiesValidations.getByObjectTypeID', - fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeID', - httpMethod: 'get', - httpPath: '/crm/property-validations/2026-03/{objectTypeId}', - }, - { - clientCallName: 'client.crm.propertiesValidations.getByObjectTypeIDAndPropertyName', - fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeIDAndPropertyName', - httpMethod: 'get', - httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}', - }, - { - clientCallName: 'client.crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', - fullyQualifiedName: 'crm.propertiesValidations.getByObjectTypeIDPropertyNameAndRuleType', - httpMethod: 'get', - httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', - }, - { - clientCallName: 'client.crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', - fullyQualifiedName: 'crm.propertiesValidations.updateByObjectTypeIDPropertyNameAndRuleType', - httpMethod: 'put', - httpPath: '/crm/property-validations/2026-03/{objectTypeId}/{propertyName}/rule-type/{ruleType}', - }, - { - clientCallName: 'client.crm.timeline.createEvent', - fullyQualifiedName: 'crm.timeline.createEvent', - httpMethod: 'post', - httpPath: '/integrators/timeline/2026-03/events', - }, - { - clientCallName: 'client.crm.timeline.createProjectType', - fullyQualifiedName: 'crm.timeline.createProjectType', - httpMethod: 'post', - httpPath: '/integrators/timeline/2026-03/types/projects', - }, - { - clientCallName: 'client.crm.timeline.batch.create', - fullyQualifiedName: 'crm.timeline.batch.create', - httpMethod: 'post', - httpPath: '/integrators/timeline/2026-03/events/batch', - }, - { - clientCallName: 'client.events.definitions.create', - fullyQualifiedName: 'events.definitions.create', - httpMethod: 'post', - httpPath: '/events/2026-03/event-definitions', - }, - { - clientCallName: 'client.events.definitions.update', - fullyQualifiedName: 'events.definitions.update', - httpMethod: 'patch', - httpPath: '/events/2026-03/event-definitions/{eventName}', - }, - { - clientCallName: 'client.events.definitions.list', - fullyQualifiedName: 'events.definitions.list', - httpMethod: 'get', - httpPath: '/events/2026-03/event-definitions', - }, - { - clientCallName: 'client.events.definitions.delete', - fullyQualifiedName: 'events.definitions.delete', - httpMethod: 'delete', - httpPath: '/events/2026-03/event-definitions/{eventName}', - }, - { - clientCallName: 'client.events.definitions.createProperty', - fullyQualifiedName: 'events.definitions.createProperty', - httpMethod: 'post', - httpPath: '/events/2026-03/event-definitions/{eventName}/property', - }, - { - clientCallName: 'client.events.definitions.deleteProperty', - fullyQualifiedName: 'events.definitions.deleteProperty', - httpMethod: 'delete', - httpPath: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', - }, - { - clientCallName: 'client.events.definitions.get', - fullyQualifiedName: 'events.definitions.get', - httpMethod: 'get', - httpPath: '/events/2026-03/event-definitions/{eventName}', - }, - { - clientCallName: 'client.events.definitions.sendBatch', - fullyQualifiedName: 'events.definitions.sendBatch', - httpMethod: 'post', - httpPath: '/events/2026-03/send/batch', - }, - { - clientCallName: 'client.events.definitions.updateProperty', - fullyQualifiedName: 'events.definitions.updateProperty', - httpMethod: 'patch', - httpPath: '/events/2026-03/event-definitions/{eventName}/property/{propertyName}', - }, - { - clientCallName: 'client.events.occurrences.list', - fullyQualifiedName: 'events.occurrences.list', - httpMethod: 'get', - httpPath: '/events/event-occurrences/2026-03', - }, - { - clientCallName: 'client.events.occurrences.listEventTypes', - fullyQualifiedName: 'events.occurrences.listEventTypes', - httpMethod: 'get', - httpPath: '/events/event-occurrences/2026-03/event-types', - }, - { - clientCallName: 'client.events.send.batchSend', - fullyQualifiedName: 'events.send.batchSend', - httpMethod: 'post', - httpPath: '/events/2026-03/send/batch', - }, - { - clientCallName: 'client.events.send.send', - fullyQualifiedName: 'events.send.send', - httpMethod: 'post', - httpPath: '/events/2026-03/send', - }, - { - clientCallName: 'client.files.fileAssets.create', - fullyQualifiedName: 'files.fileAssets.create', - httpMethod: 'post', - httpPath: '/files/2026-03/folders', - }, - { - clientCallName: 'client.files.fileAssets.update', - fullyQualifiedName: 'files.fileAssets.update', - httpMethod: 'patch', - httpPath: '/files/2026-03/files/{fileId}', - }, - { - clientCallName: 'client.files.fileAssets.delete', - fullyQualifiedName: 'files.fileAssets.delete', - httpMethod: 'delete', - httpPath: '/files/2026-03/files/{fileId}', - }, - { - clientCallName: 'client.files.fileAssets.gdprDelete', - fullyQualifiedName: 'files.fileAssets.gdprDelete', - httpMethod: 'delete', - httpPath: '/files/2026-03/files/{fileId}/gdpr-delete', - }, - { - clientCallName: 'client.files.fileAssets.get', - fullyQualifiedName: 'files.fileAssets.get', - httpMethod: 'get', - httpPath: '/files/2026-03/files/{fileId}', - }, - { - clientCallName: 'client.files.fileAssets.getImportTaskStatus', - fullyQualifiedName: 'files.fileAssets.getImportTaskStatus', - httpMethod: 'get', - httpPath: '/files/2026-03/files/import-from-url/async/tasks/{taskId}/status', - }, - { - clientCallName: 'client.files.fileAssets.getSignedURL', - fullyQualifiedName: 'files.fileAssets.getSignedURL', - httpMethod: 'get', - httpPath: '/files/2026-03/files/{fileId}/signed-url', - }, - { - clientCallName: 'client.files.fileAssets.importFromURLAsync', - fullyQualifiedName: 'files.fileAssets.importFromURLAsync', - httpMethod: 'post', - httpPath: '/files/2026-03/files/import-from-url/async', - }, - { - clientCallName: 'client.files.fileAssets.replace', - fullyQualifiedName: 'files.fileAssets.replace', - httpMethod: 'put', - httpPath: '/files/2026-03/files/{fileId}', - }, - { - clientCallName: 'client.files.fileAssets.search', - fullyQualifiedName: 'files.fileAssets.search', - httpMethod: 'get', - httpPath: '/files/2026-03/files/search', - }, - { - clientCallName: 'client.files.fileAssets.upload', - fullyQualifiedName: 'files.fileAssets.upload', - httpMethod: 'post', - httpPath: '/files/2026-03/files', - }, - { - clientCallName: 'client.files.folders.deleteByID', - fullyQualifiedName: 'files.folders.deleteByID', - httpMethod: 'delete', - httpPath: '/files/2026-03/folders/{folderId}', - }, - { - clientCallName: 'client.files.folders.deleteByPath', - fullyQualifiedName: 'files.folders.deleteByPath', - httpMethod: 'delete', - httpPath: '/files/2026-03/folders/{folderPath}', - }, - { - clientCallName: 'client.files.folders.getByID', - fullyQualifiedName: 'files.folders.getByID', - httpMethod: 'get', - httpPath: '/files/2026-03/folders/{folderId}', - }, - { - clientCallName: 'client.files.folders.getByPath', - fullyQualifiedName: 'files.folders.getByPath', - httpMethod: 'get', - httpPath: '/files/2026-03/folders/{folderPath}', - }, - { - clientCallName: 'client.files.folders.getUpdateAsyncStatus', - fullyQualifiedName: 'files.folders.getUpdateAsyncStatus', - httpMethod: 'get', - httpPath: '/files/2026-03/folders/update/async/tasks/{taskId}/status', - }, - { - clientCallName: 'client.files.folders.search', - fullyQualifiedName: 'files.folders.search', - httpMethod: 'get', - httpPath: '/files/2026-03/folders/search', - }, - { - clientCallName: 'client.files.folders.updateAsyncByID', - fullyQualifiedName: 'files.folders.updateAsyncByID', - httpMethod: 'post', - httpPath: '/files/2026-03/folders/update/async', - }, - { - clientCallName: 'client.files.folders.updateByID', - fullyQualifiedName: 'files.folders.updateByID', - httpMethod: 'patch', - httpPath: '/files/2026-03/folders/{folderId}', - }, - { - clientCallName: 'client.marketing.campaigns.create', - fullyQualifiedName: 'marketing.campaigns.create', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03', - }, - { - clientCallName: 'client.marketing.campaigns.update', - fullyQualifiedName: 'marketing.campaigns.update', - httpMethod: 'patch', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', - }, - { - clientCallName: 'client.marketing.campaigns.list', - fullyQualifiedName: 'marketing.campaigns.list', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03', - }, - { - clientCallName: 'client.marketing.campaigns.delete', - fullyQualifiedName: 'marketing.campaigns.delete', - httpMethod: 'delete', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', - }, - { - clientCallName: 'client.marketing.campaigns.get', - fullyQualifiedName: 'marketing.campaigns.get', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}', - }, - { - clientCallName: 'client.marketing.campaigns.assets.update', - fullyQualifiedName: 'marketing.campaigns.assets.update', - httpMethod: 'put', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', - }, - { - clientCallName: 'client.marketing.campaigns.assets.list', - fullyQualifiedName: 'marketing.campaigns.assets.list', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}', - }, - { - clientCallName: 'client.marketing.campaigns.assets.delete', - fullyQualifiedName: 'marketing.campaigns.assets.delete', - httpMethod: 'delete', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}', - }, - { - clientCallName: 'client.marketing.campaigns.batch.create', - fullyQualifiedName: 'marketing.campaigns.batch.create', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/batch/create', - }, - { - clientCallName: 'client.marketing.campaigns.batch.update', - fullyQualifiedName: 'marketing.campaigns.batch.update', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/batch/update', - }, - { - clientCallName: 'client.marketing.campaigns.batch.delete', - fullyQualifiedName: 'marketing.campaigns.batch.delete', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/batch/archive', - }, - { - clientCallName: 'client.marketing.campaigns.batch.get', - fullyQualifiedName: 'marketing.campaigns.batch.get', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/batch/read', - }, - { - clientCallName: 'client.marketing.campaigns.budget.create', - fullyQualifiedName: 'marketing.campaigns.budget.create', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget', - }, - { - clientCallName: 'client.marketing.campaigns.budget.update', - fullyQualifiedName: 'marketing.campaigns.budget.update', - httpMethod: 'put', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - }, - { - clientCallName: 'client.marketing.campaigns.budget.delete', - fullyQualifiedName: 'marketing.campaigns.budget.delete', - httpMethod: 'delete', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - }, - { - clientCallName: 'client.marketing.campaigns.budget.get', - fullyQualifiedName: 'marketing.campaigns.budget.get', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}', - }, - { - clientCallName: 'client.marketing.campaigns.budget.getTotals', - fullyQualifiedName: 'marketing.campaigns.budget.getTotals', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/budget/totals', - }, - { - clientCallName: 'client.marketing.campaigns.metrics.getAttributionMetrics', - fullyQualifiedName: 'marketing.campaigns.metrics.getAttributionMetrics', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/metrics', - }, - { - clientCallName: 'client.marketing.campaigns.metrics.getRevenueAttribution', - fullyQualifiedName: 'marketing.campaigns.metrics.getRevenueAttribution', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/revenue', - }, - { - clientCallName: 'client.marketing.campaigns.metrics.listContactIDsByType', - fullyQualifiedName: 'marketing.campaigns.metrics.listContactIDsByType', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}', - }, - { - clientCallName: 'client.marketing.campaigns.spend.create', - fullyQualifiedName: 'marketing.campaigns.spend.create', - httpMethod: 'post', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend', - }, - { - clientCallName: 'client.marketing.campaigns.spend.update', - fullyQualifiedName: 'marketing.campaigns.spend.update', - httpMethod: 'put', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - }, - { - clientCallName: 'client.marketing.campaigns.spend.delete', - fullyQualifiedName: 'marketing.campaigns.spend.delete', - httpMethod: 'delete', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - }, - { - clientCallName: 'client.marketing.campaigns.spend.get', - fullyQualifiedName: 'marketing.campaigns.spend.get', - httpMethod: 'get', - httpPath: '/marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}', - }, - { - clientCallName: 'client.marketing.emails.create', - fullyQualifiedName: 'marketing.emails.create', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03', - }, - { - clientCallName: 'client.marketing.emails.update', - fullyQualifiedName: 'marketing.emails.update', - httpMethod: 'patch', - httpPath: '/marketing/emails/2026-03/{emailId}', - }, - { - clientCallName: 'client.marketing.emails.list', - fullyQualifiedName: 'marketing.emails.list', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03', - }, - { - clientCallName: 'client.marketing.emails.delete', - fullyQualifiedName: 'marketing.emails.delete', - httpMethod: 'delete', - httpPath: '/marketing/emails/2026-03/{emailId}', - }, - { - clientCallName: 'client.marketing.emails.clone', - fullyQualifiedName: 'marketing.emails.clone', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/clone', - }, - { - clientCallName: 'client.marketing.emails.createAbTestVariation', - fullyQualifiedName: 'marketing.emails.createAbTestVariation', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/ab-test/create-variation', - }, - { - clientCallName: 'client.marketing.emails.get', - fullyQualifiedName: 'marketing.emails.get', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/statistics/list', - }, - { - clientCallName: 'client.marketing.emails.getAbTestVariation', - fullyQualifiedName: 'marketing.emails.getAbTestVariation', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/{emailId}/ab-test/get-variation', - }, - { - clientCallName: 'client.marketing.emails.getDraft', - fullyQualifiedName: 'marketing.emails.getDraft', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/{emailId}/draft', - }, - { - clientCallName: 'client.marketing.emails.getHistogram', - fullyQualifiedName: 'marketing.emails.getHistogram', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/statistics/histogram', - }, - { - clientCallName: 'client.marketing.emails.getRevision', - fullyQualifiedName: 'marketing.emails.getRevision', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}', - }, - { - clientCallName: 'client.marketing.emails.listRevisions', - fullyQualifiedName: 'marketing.emails.listRevisions', - httpMethod: 'get', - httpPath: '/marketing/emails/2026-03/{emailId}/revisions', - }, - { - clientCallName: 'client.marketing.emails.publish', - fullyQualifiedName: 'marketing.emails.publish', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/{emailId}/publish', - }, - { - clientCallName: 'client.marketing.emails.resetDraft', - fullyQualifiedName: 'marketing.emails.resetDraft', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/{emailId}/draft/reset', - }, - { - clientCallName: 'client.marketing.emails.restoreRevision', - fullyQualifiedName: 'marketing.emails.restoreRevision', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore', - }, - { - clientCallName: 'client.marketing.emails.restoreRevisionToDraft', - fullyQualifiedName: 'marketing.emails.restoreRevisionToDraft', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/{emailId}/revisions/{revisionId}/restore-to-draft', - }, - { - clientCallName: 'client.marketing.emails.unpublish', - fullyQualifiedName: 'marketing.emails.unpublish', - httpMethod: 'post', - httpPath: '/marketing/emails/2026-03/{emailId}/unpublish', - }, - { - clientCallName: 'client.marketing.emails.updateDraft', - fullyQualifiedName: 'marketing.emails.updateDraft', - httpMethod: 'patch', - httpPath: '/marketing/emails/2026-03/{emailId}/draft', - }, - { - clientCallName: 'client.marketing.marketingEvents.create', - fullyQualifiedName: 'marketing.marketingEvents.create', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events', - }, - { - clientCallName: 'client.marketing.marketingEvents.update', - fullyQualifiedName: 'marketing.marketingEvents.update', - httpMethod: 'patch', - httpPath: '/marketing/marketing-events/2026-03/{objectId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.list', - fullyQualifiedName: 'marketing.marketingEvents.list', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03', - }, - { - clientCallName: 'client.marketing.marketingEvents.delete', - fullyQualifiedName: 'marketing.marketingEvents.delete', - httpMethod: 'delete', - httpPath: '/marketing/marketing-events/2026-03/{objectId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.deleteBatch', - fullyQualifiedName: 'marketing.marketingEvents.deleteBatch', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/batch/archive', - }, - { - clientCallName: 'client.marketing.marketingEvents.deleteBatchByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.deleteBatchByExternalEventID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/delete', - }, - { - clientCallName: 'client.marketing.marketingEvents.deleteByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.deleteByExternalEventID', - httpMethod: 'delete', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.get', - fullyQualifiedName: 'marketing.marketingEvents.get', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/{objectId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.getByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.getByExternalEventID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.searchByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.searchByExternalEventID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/events/search', - }, - { - clientCallName: 'client.marketing.marketingEvents.searchIdentifiersByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.searchIdentifiersByExternalEventID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/{externalEventId}/identifiers', - }, - { - clientCallName: 'client.marketing.marketingEvents.updateBatch', - fullyQualifiedName: 'marketing.marketingEvents.updateBatch', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/batch/update', - }, - { - clientCallName: 'client.marketing.marketingEvents.updateByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.updateByExternalEventID', - httpMethod: 'patch', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.upsertBatch', - fullyQualifiedName: 'marketing.marketingEvents.upsertBatch', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/upsert', - }, - { - clientCallName: 'client.marketing.marketingEvents.upsertByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.upsertByExternalEventID', - httpMethod: 'put', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.attendance.createByEventIDAndContactID', - fullyQualifiedName: 'marketing.marketingEvents.attendance.createByEventIDAndContactID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/create', - }, - { - clientCallName: 'client.marketing.marketingEvents.attendance.createByEventIDAndEmail', - fullyQualifiedName: 'marketing.marketingEvents.attendance.createByEventIDAndEmail', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/{objectId}/attendance/{subscriberState}/email-create', - }, - { - clientCallName: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', - fullyQualifiedName: 'marketing.marketingEvents.attendance.createByExternalEventIDAndContactID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/create', - }, - { - clientCallName: 'client.marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', - fullyQualifiedName: 'marketing.marketingEvents.attendance.createByExternalEventIDAndEmail', - httpMethod: 'post', - httpPath: - '/marketing/marketing-events/2026-03/attendance/{externalEventId}/{subscriberState}/email-create', - }, - { - clientCallName: 'client.marketing.marketingEvents.events.cancelByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.events.cancelByExternalEventID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/cancel', - }, - { - clientCallName: 'client.marketing.marketingEvents.events.completeByExternalEventID', - fullyQualifiedName: 'marketing.marketingEvents.events.completeByExternalEventID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/complete', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.list', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.list', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.delete', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.delete', - httpMethod: 'delete', - httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.associate', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.associate', - httpMethod: 'put', - httpPath: '/marketing/marketing-events/2026-03/associations/{marketingEventId}/lists/{listId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.associateByExternalAccount', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.associateByExternalAccount', - httpMethod: 'put', - httpPath: - '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.deleteByExternalAccount', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.deleteByExternalAccount', - httpMethod: 'delete', - httpPath: - '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists/{listId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.listAssociations.listByExternalAccount', - fullyQualifiedName: 'marketing.marketingEvents.listAssociations.listByExternalAccount', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/associations/{externalAccountId}/{externalEventId}/lists', - }, - { - clientCallName: 'client.marketing.marketingEvents.participations.getByExternalAccountAndEventID', - fullyQualifiedName: 'marketing.marketingEvents.participations.getByExternalAccountAndEventID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.participations.getByID', - fullyQualifiedName: 'marketing.marketingEvents.participations.getByID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/participations/{marketingEventId}', - }, - { - clientCallName: 'client.marketing.marketingEvents.participations.listBreakdownByContact', - fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByContact', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/participations/contacts/{contactIdentifier}/breakdown', - }, - { - clientCallName: - 'client.marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', - fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByExternalAccountAndEventID', - httpMethod: 'get', - httpPath: - '/marketing/marketing-events/2026-03/participations/{externalAccountId}/{externalEventId}/breakdown', - }, - { - clientCallName: 'client.marketing.marketingEvents.participations.listBreakdownByID', - fullyQualifiedName: 'marketing.marketingEvents.participations.listBreakdownByID', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/participations/{marketingEventId}/breakdown', - }, - { - clientCallName: 'client.marketing.marketingEvents.settings.createOrUpdate', - fullyQualifiedName: 'marketing.marketingEvents.settings.createOrUpdate', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.marketing.marketingEvents.settings.get', - fullyQualifiedName: 'marketing.marketingEvents.settings.get', - httpMethod: 'get', - httpPath: '/marketing/marketing-events/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.marketing.marketingEvents.subscriberState.recordByEmail', - fullyQualifiedName: 'marketing.marketingEvents.subscriberState.recordByEmail', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/email-upsert', - }, - { - clientCallName: 'client.marketing.marketingEvents.subscriberState.recordByID', - fullyQualifiedName: 'marketing.marketingEvents.subscriberState.recordByID', - httpMethod: 'post', - httpPath: '/marketing/marketing-events/2026-03/events/{externalEventId}/{subscriberState}/upsert', - }, - { - clientCallName: 'client.marketing.singleSend.create', - fullyQualifiedName: 'marketing.singleSend.create', - httpMethod: 'post', - httpPath: '/marketing/email-campaigns/2026-03/single-send', - }, - { - clientCallName: 'client.marketing.transactional.singleEmail.send', - fullyQualifiedName: 'marketing.transactional.singleEmail.send', - httpMethod: 'post', - httpPath: '/marketing/transactional/2026-03/single-email/send', - }, - { - clientCallName: 'client.marketing.transactional.smtpTokens.create', - fullyQualifiedName: 'marketing.transactional.smtpTokens.create', - httpMethod: 'post', - httpPath: '/marketing/transactional/2026-03/smtp-tokens', - }, - { - clientCallName: 'client.marketing.transactional.smtpTokens.list', - fullyQualifiedName: 'marketing.transactional.smtpTokens.list', - httpMethod: 'get', - httpPath: '/marketing/transactional/2026-03/smtp-tokens', - }, - { - clientCallName: 'client.marketing.transactional.smtpTokens.delete', - fullyQualifiedName: 'marketing.transactional.smtpTokens.delete', - httpMethod: 'delete', - httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', - }, - { - clientCallName: 'client.marketing.transactional.smtpTokens.get', - fullyQualifiedName: 'marketing.transactional.smtpTokens.get', - httpMethod: 'get', - httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}', - }, - { - clientCallName: 'client.marketing.transactional.smtpTokens.resetPassword', - fullyQualifiedName: 'marketing.transactional.smtpTokens.resetPassword', - httpMethod: 'post', - httpPath: '/marketing/transactional/2026-03/smtp-tokens/{tokenId}/password-reset', - }, - { - clientCallName: 'client.meta.origins.ipRanges.list', - fullyQualifiedName: 'meta.origins.ipRanges.list', - httpMethod: 'get', - httpPath: '/meta/network-origins/2026-03/ip-ranges', - }, - { - clientCallName: 'client.meta.origins.ipRanges.listSimple', - fullyQualifiedName: 'meta.origins.ipRanges.listSimple', - httpMethod: 'get', - httpPath: '/meta/network-origins/2026-03/ip-ranges/simple', - }, - { - clientCallName: 'client.scheduler.meetings.advanced.create', - fullyQualifiedName: 'scheduler.meetings.advanced.create', - httpMethod: 'post', - httpPath: '/scheduler/2026-03/meetings/calendar', - }, - { - clientCallName: 'client.scheduler.meetings.advanced.book', - fullyQualifiedName: 'scheduler.meetings.advanced.book', - httpMethod: 'post', - httpPath: '/scheduler/2026-03/meetings/meeting-links/book', - }, - { - clientCallName: 'client.scheduler.meetings.basic.list', - fullyQualifiedName: 'scheduler.meetings.basic.list', - httpMethod: 'get', - httpPath: '/scheduler/2026-03/meetings/meeting-links', - }, - { - clientCallName: 'client.scheduler.meetings.basic.getAvailabilityBySlug', - fullyQualifiedName: 'scheduler.meetings.basic.getAvailabilityBySlug', - httpMethod: 'get', - httpPath: '/scheduler/2026-03/meetings/meeting-links/book/availability-page/{slug}', - }, - { - clientCallName: 'client.scheduler.meetings.basic.getBookingInfoBySlug', - fullyQualifiedName: 'scheduler.meetings.basic.getBookingInfoBySlug', - httpMethod: 'get', - httpPath: '/scheduler/2026-03/meetings/meeting-links/book/{slug}', - }, - { - clientCallName: 'client.settings.currencies.getCompanyCurrency', - fullyQualifiedName: 'settings.currencies.getCompanyCurrency', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/company-currency', - }, - { - clientCallName: 'client.settings.currencies.listCodes', - fullyQualifiedName: 'settings.currencies.listCodes', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/codes', - }, - { - clientCallName: 'client.settings.currencies.updateCompanyCurrency', - fullyQualifiedName: 'settings.currencies.updateCompanyCurrency', - httpMethod: 'put', - httpPath: '/settings/currencies/2026-03/company-currency', - }, - { - clientCallName: 'client.settings.currencies.centralFxRates.createCurrency', - fullyQualifiedName: 'settings.currencies.centralFxRates.createCurrency', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/central-fx-rates/add-currency', - }, - { - clientCallName: 'client.settings.currencies.centralFxRates.getInformation', - fullyQualifiedName: 'settings.currencies.centralFxRates.getInformation', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/central-fx-rates/information', - }, - { - clientCallName: 'client.settings.currencies.centralFxRates.getUnsupportedCurrencies', - fullyQualifiedName: 'settings.currencies.centralFxRates.getUnsupportedCurrencies', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/central-fx-rates/unsupported-currencies', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.createExchangeRate', - fullyQualifiedName: 'settings.currencies.exchangeRates.createExchangeRate', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/exchange-rates', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.getExchangeRateByID', - fullyQualifiedName: 'settings.currencies.exchangeRates.getExchangeRateByID', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.listCurrentExchangeRates', - fullyQualifiedName: 'settings.currencies.exchangeRates.listCurrentExchangeRates', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/exchange-rates/current', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.listExchangeRates', - fullyQualifiedName: 'settings.currencies.exchangeRates.listExchangeRates', - httpMethod: 'get', - httpPath: '/settings/currencies/2026-03/exchange-rates', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.updateExchangeRate', - fullyQualifiedName: 'settings.currencies.exchangeRates.updateExchangeRate', - httpMethod: 'patch', - httpPath: '/settings/currencies/2026-03/exchange-rates/{exchangeRateId}', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.updateVisibility', - fullyQualifiedName: 'settings.currencies.exchangeRates.updateVisibility', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/exchange-rates/update-visibility', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.batch.create', - fullyQualifiedName: 'settings.currencies.exchangeRates.batch.create', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/exchange-rates/batch/create', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.batch.update', - fullyQualifiedName: 'settings.currencies.exchangeRates.batch.update', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/exchange-rates/batch/update', - }, - { - clientCallName: 'client.settings.currencies.exchangeRates.batch.get', - fullyQualifiedName: 'settings.currencies.exchangeRates.batch.get', - httpMethod: 'post', - httpPath: '/settings/currencies/2026-03/exchange-rates/batch/read', - }, - { - clientCallName: 'client.settings.taxRates.list', - fullyQualifiedName: 'settings.taxRates.list', - httpMethod: 'get', - httpPath: '/tax-rates/2026-03/tax-rates', - }, - { - clientCallName: 'client.settings.taxRates.get', - fullyQualifiedName: 'settings.taxRates.get', - httpMethod: 'get', - httpPath: '/tax-rates/2026-03/tax-rates/{taxRateGroupId}', - }, - { - clientCallName: 'client.settings.users.create', - fullyQualifiedName: 'settings.users.create', - httpMethod: 'post', - httpPath: '/settings/users/2026-03', - }, - { - clientCallName: 'client.settings.users.update', - fullyQualifiedName: 'settings.users.update', - httpMethod: 'put', - httpPath: '/settings/users/2026-03/{userId}', - }, - { - clientCallName: 'client.settings.users.list', - fullyQualifiedName: 'settings.users.list', - httpMethod: 'get', - httpPath: '/settings/users/2026-03', - }, - { - clientCallName: 'client.settings.users.delete', - fullyQualifiedName: 'settings.users.delete', - httpMethod: 'delete', - httpPath: '/settings/users/2026-03/{userId}', - }, - { - clientCallName: 'client.settings.users.get', - fullyQualifiedName: 'settings.users.get', - httpMethod: 'get', - httpPath: '/settings/users/2026-03/{userId}', - }, - { - clientCallName: 'client.settings.users.listRoles', - fullyQualifiedName: 'settings.users.listRoles', - httpMethod: 'get', - httpPath: '/settings/users/2026-03/roles', - }, - { - clientCallName: 'client.settings.users.listTeams', - fullyQualifiedName: 'settings.users.listTeams', - httpMethod: 'get', - httpPath: '/settings/users/2026-03/teams', - }, - { - clientCallName: 'client.webhooks.createBatchEventSubscriptions', - fullyQualifiedName: 'webhooks.createBatchEventSubscriptions', - httpMethod: 'post', - httpPath: '/webhooks/2026-03/{appId}/subscriptions/batch/update', - }, - { - clientCallName: 'client.webhooks.createCrmSnapshots', - fullyQualifiedName: 'webhooks.createCrmSnapshots', - httpMethod: 'post', - httpPath: '/webhooks-journal/snapshots/2026-03/crm', - }, - { - clientCallName: 'client.webhooks.createEventSubscription', - fullyQualifiedName: 'webhooks.createEventSubscription', - httpMethod: 'post', - httpPath: '/webhooks/2026-03/{appId}/subscriptions', - }, - { - clientCallName: 'client.webhooks.createJournalSubscription', - fullyQualifiedName: 'webhooks.createJournalSubscription', - httpMethod: 'post', - httpPath: '/webhooks-journal/subscriptions/2026-03', - }, - { - clientCallName: 'client.webhooks.createSubscriptionFilter', - fullyQualifiedName: 'webhooks.createSubscriptionFilter', - httpMethod: 'post', - httpPath: '/webhooks-journal/subscriptions/2026-03/filters', - }, - { - clientCallName: 'client.webhooks.deleteEventSubscription', - fullyQualifiedName: 'webhooks.deleteEventSubscription', - httpMethod: 'delete', - httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.deleteJournalSubscription', - fullyQualifiedName: 'webhooks.deleteJournalSubscription', - httpMethod: 'delete', - httpPath: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.deleteJournalSubscriptionForPortal', - fullyQualifiedName: 'webhooks.deleteJournalSubscriptionForPortal', - httpMethod: 'delete', - httpPath: '/webhooks-journal/subscriptions/2026-03/portals/{portalId}', - }, - { - clientCallName: 'client.webhooks.deleteSettings', - fullyQualifiedName: 'webhooks.deleteSettings', - httpMethod: 'delete', - httpPath: '/webhooks/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.webhooks.deleteSubscriptionFilter', - fullyQualifiedName: 'webhooks.deleteSubscriptionFilter', - httpMethod: 'delete', - httpPath: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', - }, - { - clientCallName: 'client.webhooks.getEarliestJournalBatch', - fullyQualifiedName: 'webhooks.getEarliestJournalBatch', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/batch/earliest/{count}', - }, - { - clientCallName: 'client.webhooks.getEarliestJournalEntry', - fullyQualifiedName: 'webhooks.getEarliestJournalEntry', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/earliest', - }, - { - clientCallName: 'client.webhooks.getEarliestLocalJournalBatch', - fullyQualifiedName: 'webhooks.getEarliestLocalJournalBatch', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/batch/earliest/{count}', - }, - { - clientCallName: 'client.webhooks.getEarliestLocalJournalEntry', - fullyQualifiedName: 'webhooks.getEarliestLocalJournalEntry', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/earliest', - }, - { - clientCallName: 'client.webhooks.getEventSubscription', - fullyQualifiedName: 'webhooks.getEventSubscription', - httpMethod: 'get', - httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.getJournalBatchByRequest', - fullyQualifiedName: 'webhooks.getJournalBatchByRequest', - httpMethod: 'post', - httpPath: '/webhooks-journal/journal/2026-03/batch/read', - }, - { - clientCallName: 'client.webhooks.getJournalBatchFromOffset', - fullyQualifiedName: 'webhooks.getJournalBatchFromOffset', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/batch/{offset}/next/{count}', - }, - { - clientCallName: 'client.webhooks.getJournalStatus', - fullyQualifiedName: 'webhooks.getJournalStatus', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/status/{statusId}', - }, - { - clientCallName: 'client.webhooks.getJournalSubscription', - fullyQualifiedName: 'webhooks.getJournalSubscription', - httpMethod: 'get', - httpPath: '/webhooks-journal/subscriptions/2026-03/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.getLatestJournalBatch', - fullyQualifiedName: 'webhooks.getLatestJournalBatch', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/batch/latest/{count}', - }, - { - clientCallName: 'client.webhooks.getLatestJournalEntry', - fullyQualifiedName: 'webhooks.getLatestJournalEntry', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/latest', - }, - { - clientCallName: 'client.webhooks.getLatestLocalJournalBatch', - fullyQualifiedName: 'webhooks.getLatestLocalJournalBatch', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/batch/latest/{count}', - }, - { - clientCallName: 'client.webhooks.getLatestLocalJournalEntry', - fullyQualifiedName: 'webhooks.getLatestLocalJournalEntry', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/latest', - }, - { - clientCallName: 'client.webhooks.getLocalJournalBatchByRequest', - fullyQualifiedName: 'webhooks.getLocalJournalBatchByRequest', - httpMethod: 'post', - httpPath: '/webhooks-journal/journal-local/2026-03/batch/read', - }, - { - clientCallName: 'client.webhooks.getLocalJournalBatchFromOffset', - fullyQualifiedName: 'webhooks.getLocalJournalBatchFromOffset', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/batch/{offset}/next/{count}', - }, - { - clientCallName: 'client.webhooks.getLocalJournalStatus', - fullyQualifiedName: 'webhooks.getLocalJournalStatus', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/status/{statusId}', - }, - { - clientCallName: 'client.webhooks.getNextJournalEntries', - fullyQualifiedName: 'webhooks.getNextJournalEntries', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal/2026-03/offset/{offset}/next', - }, - { - clientCallName: 'client.webhooks.getNextLocalJournalEntries', - fullyQualifiedName: 'webhooks.getNextLocalJournalEntries', - httpMethod: 'get', - httpPath: '/webhooks-journal/journal-local/2026-03/offset/{offset}/next', - }, - { - clientCallName: 'client.webhooks.getSettings', - fullyQualifiedName: 'webhooks.getSettings', - httpMethod: 'get', - httpPath: '/webhooks/2026-03/{appId}/settings', - }, - { - clientCallName: 'client.webhooks.getSubscriptionFilter', - fullyQualifiedName: 'webhooks.getSubscriptionFilter', - httpMethod: 'get', - httpPath: '/webhooks-journal/subscriptions/2026-03/filters/{filterId}', - }, - { - clientCallName: 'client.webhooks.listEventSubscriptions', - fullyQualifiedName: 'webhooks.listEventSubscriptions', - httpMethod: 'get', - httpPath: '/webhooks/2026-03/{appId}/subscriptions', - }, - { - clientCallName: 'client.webhooks.listJournalSubscriptions', - fullyQualifiedName: 'webhooks.listJournalSubscriptions', - httpMethod: 'get', - httpPath: '/webhooks-journal/subscriptions/2026-03', - }, - { - clientCallName: 'client.webhooks.listSubscriptionFilters', - fullyQualifiedName: 'webhooks.listSubscriptionFilters', - httpMethod: 'get', - httpPath: '/webhooks-journal/subscriptions/2026-03/filters/subscription/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.updateEventSubscription', - fullyQualifiedName: 'webhooks.updateEventSubscription', - httpMethod: 'patch', - httpPath: '/webhooks/2026-03/{appId}/subscriptions/{subscriptionId}', - }, - { - clientCallName: 'client.webhooks.updateSettings', - fullyQualifiedName: 'webhooks.updateSettings', - httpMethod: 'put', - httpPath: '/webhooks/2026-03/{appId}/settings', - }, -]; - -function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { - if (!options) { - return undefined; - } - - let allowedMethods: SdkMethod[]; - - if (options.codeAllowHttpGets || options.codeAllowedMethods) { - // Start with nothing allowed and then add into it from options - let allowedMethodsSet = new Set(); - - if (options.codeAllowHttpGets) { - // Add all methods that map to an HTTP GET - sdkMethods - .filter((method) => method.httpMethod === 'get') - .forEach((method) => allowedMethodsSet.add(method)); - } - - if (options.codeAllowedMethods) { - // Add all methods that match any of the allowed regexps - const allowedRegexps = options.codeAllowedMethods.map((pattern) => { - try { - return new RegExp(pattern); - } catch (e) { - throw new Error( - `Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`, - ); - } - }); - - sdkMethods - .filter((method) => allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName))) - .forEach((method) => allowedMethodsSet.add(method)); - } - - allowedMethods = Array.from(allowedMethodsSet); - } else { - // Start with everything allowed - allowedMethods = [...sdkMethods]; - } - - if (options.codeBlockedMethods) { - // Filter down based on blocked regexps - const blockedRegexps = options.codeBlockedMethods.map((pattern) => { - try { - return new RegExp(pattern); - } catch (e) { - throw new Error( - `Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`, - ); - } - }); - - allowedMethods = allowedMethods.filter( - (method) => !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)), - ); - } - - return allowedMethods; -} - -export function blockedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { - const allowedMethods = allowedMethodsForCodeTool(options); - if (!allowedMethods) { - return undefined; - } - - const allowedSet = new Set(allowedMethods.map((method) => method.fullyQualifiedName)); - - // Return any methods that are not explicitly allowed - return sdkMethods.filter((method) => !allowedSet.has(method.fullyQualifiedName)); -} diff --git a/packages/mcp-server/src/options.ts b/packages/mcp-server/src/options.ts deleted file mode 100644 index f1518764..00000000 --- a/packages/mcp-server/src/options.ts +++ /dev/null @@ -1,185 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import qs from 'qs'; -import yargs from 'yargs'; -import { hideBin } from 'yargs/helpers'; -import z from 'zod'; -import { readEnv } from './util'; - -export type CLIOptions = McpOptions & { - debug: boolean; - logFormat: 'json' | 'pretty'; - transport: 'stdio' | 'http'; - port: number | undefined; - socket: string | undefined; -}; - -export type McpOptions = { - includeCodeTool?: boolean | undefined; - includeDocsTools?: boolean | undefined; - stainlessApiKey?: string | undefined; - docsSearchMode?: 'stainless-api' | 'local' | undefined; - docsDir?: string | undefined; - codeAllowHttpGets?: boolean | undefined; - codeAllowedMethods?: string[] | undefined; - codeBlockedMethods?: string[] | undefined; - codeExecutionMode: McpCodeExecutionMode; - customInstructionsPath?: string | undefined; -}; - -export type McpCodeExecutionMode = 'stainless-sandbox' | 'local'; - -export function parseCLIOptions(): CLIOptions { - const opts = yargs(hideBin(process.argv)) - .option('code-allow-http-gets', { - type: 'boolean', - description: - 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.', - }) - .option('code-allowed-methods', { - type: 'string', - array: true, - description: - 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', - }) - .option('code-blocked-methods', { - type: 'string', - array: true, - description: - 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', - }) - .option('code-execution-mode', { - type: 'string', - choices: ['stainless-sandbox', 'local'], - default: 'stainless-sandbox', - description: - "Where to run code execution in code tool; 'stainless-sandbox' will execute code in Stainless-hosted sandboxes whereas 'local' will execute code locally on the MCP server machine.", - }) - .option('custom-instructions-path', { - type: 'string', - description: 'Path to custom instructions for the MCP server', - }) - .option('debug', { type: 'boolean', description: 'Enable debug logging' }) - .option('docs-dir', { - type: 'string', - description: - 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.', - }) - .option('docs-search-mode', { - type: 'string', - choices: ['stainless-api', 'local'], - default: 'stainless-api', - description: - "Where to search documentation; 'stainless-api' uses the Stainless-hosted search API whereas 'local' uses an in-memory search index built from embedded SDK method data and optional local docs files.", - }) - .option('log-format', { - type: 'string', - choices: ['json', 'pretty'], - description: 'Format for log output; defaults to json unless tty is detected', - }) - .option('no-tools', { - type: 'string', - array: true, - choices: ['code', 'docs'], - description: 'Tools to explicitly disable', - }) - .option('port', { - type: 'number', - default: 3000, - description: 'Port to serve on if using http transport', - }) - .option('socket', { type: 'string', description: 'Unix socket to serve on if using http transport' }) - .option('stainless-api-key', { - type: 'string', - default: readEnv('STAINLESS_API_KEY'), - description: - 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', - }) - .option('tools', { - type: 'string', - array: true, - choices: ['code', 'docs'], - description: 'Tools to explicitly enable', - }) - .option('transport', { - type: 'string', - choices: ['stdio', 'http'], - default: 'stdio', - description: 'What transport to use; stdio for local servers or http for remote servers', - }) - .env('MCP_SERVER') - .version(true) - .help(); - - const argv = opts.parseSync(); - - const shouldIncludeToolType = (toolType: 'code' | 'docs') => - argv.noTools?.includes(toolType) ? false - : argv.tools?.includes(toolType) ? true - : undefined; - - const includeCodeTool = shouldIncludeToolType('code'); - const includeDocsTools = shouldIncludeToolType('docs'); - - const transport = argv.transport as 'stdio' | 'http'; - const logFormat = - argv.logFormat ? (argv.logFormat as 'json' | 'pretty') - : process.stderr.isTTY ? 'pretty' - : 'json'; - - return { - ...(includeCodeTool !== undefined && { includeCodeTool }), - ...(includeDocsTools !== undefined && { includeDocsTools }), - debug: !!argv.debug, - stainlessApiKey: argv.stainlessApiKey, - docsSearchMode: argv.docsSearchMode as 'stainless-api' | 'local' | undefined, - docsDir: argv.docsDir, - codeAllowHttpGets: argv.codeAllowHttpGets, - codeAllowedMethods: argv.codeAllowedMethods, - codeBlockedMethods: argv.codeBlockedMethods, - codeExecutionMode: argv.codeExecutionMode as McpCodeExecutionMode, - customInstructionsPath: argv.customInstructionsPath, - transport, - logFormat, - port: argv.port, - socket: argv.socket, - }; -} - -const coerceArray = (zodType: T) => - z.preprocess( - (val) => - Array.isArray(val) ? val - : val ? [val] - : val, - z.array(zodType).optional(), - ); - -const QueryOptions = z.object({ - tools: coerceArray(z.enum(['code', 'docs'])).describe('Specify which MCP tools to use'), - no_tools: coerceArray(z.enum(['code', 'docs'])).describe('Specify which MCP tools to not use.'), - tool: coerceArray(z.string()).describe('Include tools matching the specified names'), -}); - -export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): McpOptions { - const queryObject = typeof query === 'string' ? qs.parse(query) : query; - const queryOptions = QueryOptions.parse(queryObject); - - let codeTool: boolean | undefined = - queryOptions.no_tools && queryOptions.no_tools?.includes('code') ? false - : queryOptions.tools?.includes('code') ? true - : defaultOptions.includeCodeTool; - - let docsTools: boolean | undefined = - queryOptions.no_tools && queryOptions.no_tools?.includes('docs') ? false - : queryOptions.tools?.includes('docs') ? true - : defaultOptions.includeDocsTools; - - return { - ...(codeTool !== undefined && { includeCodeTool: codeTool }), - ...(docsTools !== undefined && { includeDocsTools: docsTools }), - codeExecutionMode: defaultOptions.codeExecutionMode, - docsSearchMode: defaultOptions.docsSearchMode, - docsDir: defaultOptions.docsDir, - }; -} diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts deleted file mode 100644 index 7136e102..00000000 --- a/packages/mcp-server/src/server.ts +++ /dev/null @@ -1,213 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import { Server } from '@modelcontextprotocol/sdk/server/index.js'; -import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; -import { - CallToolRequestSchema, - ListToolsRequestSchema, - SetLevelRequestSchema, -} from '@modelcontextprotocol/sdk/types.js'; -import { ClientOptions } from '@hubspot/sdk'; -import HubSpot from '@hubspot/sdk'; -import { codeTool } from './code-tool'; -import docsSearchTool from './docs-search-tool'; -import { setLocalSearch } from './docs-search-tool'; -import { LocalDocsSearch } from './local-docs-search'; -import { getInstructions } from './instructions'; -import { McpOptions } from './options'; -import { blockedMethodsForCodeTool } from './methods'; -import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from './types'; -import { readEnv } from './util'; - -export const newMcpServer = async ({ - stainlessApiKey, - customInstructionsPath, -}: { - stainlessApiKey?: string | undefined; - customInstructionsPath?: string | undefined; -}) => - new McpServer( - { - name: 'hubspot_sdk_api', - version: '0.1.0-alpha.9', - }, - { - instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), - capabilities: { tools: {}, logging: {} }, - }, - ); - -/** - * Initializes the provided MCP Server with the given tools and handlers. - * If not provided, the default client, tools and handlers will be used. - */ -export async function initMcpServer(params: { - server: Server | McpServer; - clientOptions?: ClientOptions; - mcpOptions?: McpOptions; - stainlessApiKey?: string | undefined; - upstreamClientEnvs?: Record | undefined; - mcpSessionId?: string | undefined; - mcpClientInfo?: { name: string; version: string } | undefined; -}) { - const server = params.server instanceof McpServer ? params.server.server : params.server; - - const logAtLevel = - (level: 'debug' | 'info' | 'warning' | 'error') => - (message: string, ...rest: unknown[]) => { - void server.sendLoggingMessage({ - level, - data: { message, rest }, - }); - }; - const logger = { - debug: logAtLevel('debug'), - info: logAtLevel('info'), - warn: logAtLevel('warning'), - error: logAtLevel('error'), - }; - - if (params.mcpOptions?.docsSearchMode === 'local') { - const docsDir = params.mcpOptions?.docsDir; - const localSearch = await LocalDocsSearch.create(docsDir ? { docsDir } : undefined); - setLocalSearch(localSearch); - } - - let _client: HubSpot | undefined; - let _clientError: Error | undefined; - let _logLevel: 'debug' | 'info' | 'warn' | 'error' | 'off' | undefined; - - const getClient = (): HubSpot => { - if (_clientError) throw _clientError; - if (!_client) { - try { - _client = new HubSpot({ - ...{ - accessToken: readEnv('HUBSPOT_ACCESS_TOKEN'), - developerAPIKey: readEnv('HUBSPOT_DEVELOPER_API_KEY'), - }, - logger, - ...params.clientOptions, - defaultHeaders: { - ...params.clientOptions?.defaultHeaders, - 'X-Stainless-MCP': 'true', - }, - }); - if (_logLevel) { - _client = _client.withOptions({ logLevel: _logLevel }); - } - } catch (e) { - _clientError = e instanceof Error ? e : new Error(String(e)); - throw _clientError; - } - } - return _client; - }; - - const providedTools = selectTools(params.mcpOptions); - const toolMap = Object.fromEntries(providedTools.map((mcpTool) => [mcpTool.tool.name, mcpTool])); - - server.setRequestHandler(ListToolsRequestSchema, async () => { - return { - tools: providedTools.map((mcpTool) => mcpTool.tool), - }; - }); - - server.setRequestHandler(CallToolRequestSchema, async (request) => { - const { name, arguments: args } = request.params; - const mcpTool = toolMap[name]; - if (!mcpTool) { - throw new Error(`Unknown tool: ${name}`); - } - - let client: HubSpot; - try { - client = getClient(); - } catch (error) { - return { - content: [ - { - type: 'text' as const, - text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, - }, - ], - isError: true, - }; - } - - return executeHandler({ - handler: mcpTool.handler, - reqContext: { - client, - stainlessApiKey: params.stainlessApiKey ?? params.mcpOptions?.stainlessApiKey, - upstreamClientEnvs: params.upstreamClientEnvs, - mcpSessionId: params.mcpSessionId, - mcpClientInfo: params.mcpClientInfo, - }, - args, - }); - }); - - server.setRequestHandler(SetLevelRequestSchema, async (request) => { - const { level } = request.params; - let logLevel: 'debug' | 'info' | 'warn' | 'error' | 'off'; - switch (level) { - case 'debug': - logLevel = 'debug'; - break; - case 'info': - logLevel = 'info'; - break; - case 'notice': - case 'warning': - logLevel = 'warn'; - break; - case 'error': - logLevel = 'error'; - break; - default: - logLevel = 'off'; - break; - } - _logLevel = logLevel; - if (_client) { - _client = _client.withOptions({ logLevel }); - } - return {}; - }); -} - -/** - * Selects the tools to include in the MCP Server based on the provided options. - */ -export function selectTools(options?: McpOptions): McpTool[] { - const includedTools = []; - - if (options?.includeCodeTool ?? true) { - includedTools.push( - codeTool({ - blockedMethods: blockedMethodsForCodeTool(options), - codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', - }), - ); - } - if (options?.includeDocsTools ?? true) { - includedTools.push(docsSearchTool); - } - return includedTools; -} - -/** - * Runs the provided handler with the given client and arguments. - */ -export async function executeHandler({ - handler, - reqContext, - args, -}: { - handler: HandlerFunction; - reqContext: McpRequestContext; - args: Record | undefined; -}): Promise { - return await handler({ reqContext, args: args || {} }); -} diff --git a/packages/mcp-server/src/stdio.ts b/packages/mcp-server/src/stdio.ts deleted file mode 100644 index b04a5441..00000000 --- a/packages/mcp-server/src/stdio.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'; -import { McpOptions } from './options'; -import { initMcpServer, newMcpServer } from './server'; -import { getLogger } from './logger'; - -export const launchStdioServer = async (mcpOptions: McpOptions) => { - const server = await newMcpServer({ - stainlessApiKey: mcpOptions.stainlessApiKey, - customInstructionsPath: mcpOptions.customInstructionsPath, - }); - - await initMcpServer({ server, mcpOptions, stainlessApiKey: mcpOptions.stainlessApiKey }); - - const transport = new StdioServerTransport(); - await server.connect(transport); - getLogger().info('MCP Server running on stdio'); -}; diff --git a/packages/mcp-server/src/types.ts b/packages/mcp-server/src/types.ts deleted file mode 100644 index 78a48b07..00000000 --- a/packages/mcp-server/src/types.ts +++ /dev/null @@ -1,126 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -import HubSpot from '@hubspot/sdk'; -import { Tool } from '@modelcontextprotocol/sdk/types.js'; - -type TextContentBlock = { - type: 'text'; - text: string; -}; - -type ImageContentBlock = { - type: 'image'; - data: string; - mimeType: string; -}; - -type AudioContentBlock = { - type: 'audio'; - data: string; - mimeType: string; -}; - -type ResourceContentBlock = { - type: 'resource'; - resource: - | { - uri: string; - mimeType: string; - text: string; - } - | { - uri: string; - mimeType: string; - blob: string; - }; -}; - -export type ContentBlock = TextContentBlock | ImageContentBlock | AudioContentBlock | ResourceContentBlock; - -export type ToolCallResult = { - content: ContentBlock[]; - isError?: boolean; -}; - -export type McpRequestContext = { - client: HubSpot; - stainlessApiKey?: string | undefined; - upstreamClientEnvs?: Record | undefined; - mcpSessionId?: string | undefined; - mcpClientInfo?: { name: string; version: string } | undefined; -}; - -export type HandlerFunction = ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: Record | undefined; -}) => Promise; - -export function asTextContentResult(result: unknown): ToolCallResult { - return { - content: [ - { - type: 'text', - text: JSON.stringify(result, null, 2), - }, - ], - }; -} - -export async function asBinaryContentResult(response: Response): Promise { - const blob = await response.blob(); - const mimeType = blob.type; - const data = Buffer.from(await blob.arrayBuffer()).toString('base64'); - if (mimeType.startsWith('image/')) { - return { - content: [{ type: 'image', mimeType, data }], - }; - } else if (mimeType.startsWith('audio/')) { - return { - content: [{ type: 'audio', mimeType, data }], - }; - } else { - return { - content: [ - { - type: 'resource', - resource: { - // We must give a URI, even though this isn't actually an MCP resource. - uri: 'resource://tool-response', - mimeType, - blob: data, - }, - }, - ], - }; - } -} - -export function asErrorResult(message: string): ToolCallResult { - return { - content: [ - { - type: 'text', - text: message, - }, - ], - isError: true, - }; -} - -export type Metadata = { - resource: string; - operation: 'read' | 'write'; - tags: string[]; - httpMethod?: string; - httpPath?: string; - operationId?: string; -}; - -export type McpTool = { - metadata: Metadata; - tool: Tool; - handler: HandlerFunction; -}; diff --git a/packages/mcp-server/src/util.ts b/packages/mcp-server/src/util.ts deleted file mode 100644 index 069a2b47..00000000 --- a/packages/mcp-server/src/util.ts +++ /dev/null @@ -1,25 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -export const readEnv = (env: string): string | undefined => { - if (typeof (globalThis as any).process !== 'undefined') { - return (globalThis as any).process.env?.[env]?.trim() || undefined; - } else if (typeof (globalThis as any).Deno !== 'undefined') { - return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined; - } - return; -}; - -export const readEnvOrError = (env: string): string => { - let envValue = readEnv(env); - if (envValue === undefined) { - throw new Error(`Environment variable ${env} is not set`); - } - return envValue; -}; - -export const requireValue = (value: T | undefined, description: string): T => { - if (value === undefined) { - throw new Error(`Missing required value: ${description}`); - } - return value; -}; diff --git a/packages/mcp-server/tests/options.test.ts b/packages/mcp-server/tests/options.test.ts deleted file mode 100644 index 17306295..00000000 --- a/packages/mcp-server/tests/options.test.ts +++ /dev/null @@ -1,32 +0,0 @@ -import { parseCLIOptions } from '../src/options'; - -// Mock process.argv -const mockArgv = (args: string[]) => { - const originalArgv = process.argv; - process.argv = ['node', 'test.js', ...args]; - return () => { - process.argv = originalArgv; - }; -}; - -describe('parseCLIOptions', () => { - it('default parsing should be stdio', () => { - const cleanup = mockArgv([]); - - const result = parseCLIOptions(); - - expect(result.transport).toBe('stdio'); - - cleanup(); - }); - - it('using http transport with a port', () => { - const cleanup = mockArgv(['--transport=http', '--port=2222']); - - const result = parseCLIOptions(); - - expect(result.transport).toBe('http'); - expect(result.port).toBe(2222); - cleanup(); - }); -}); diff --git a/packages/mcp-server/tsc-multi.json b/packages/mcp-server/tsc-multi.json deleted file mode 100644 index 4facad5a..00000000 --- a/packages/mcp-server/tsc-multi.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "targets": [ - { "extname": ".js", "module": "commonjs" }, - { "extname": ".mjs", "module": "esnext" } - ], - "projects": ["tsconfig.build.json"] -} diff --git a/packages/mcp-server/tsconfig.build.json b/packages/mcp-server/tsconfig.build.json deleted file mode 100644 index ceb04135..00000000 --- a/packages/mcp-server/tsconfig.build.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "extends": "./tsconfig.json", - "include": ["dist/src"], - "exclude": [], - "compilerOptions": { - "rootDir": "./dist/src", - "paths": { - "@hubspot/sdk-mcp/*": ["./dist/src/*"], - "@hubspot/sdk-mcp": ["./dist/src/index.ts"] - }, - "noEmit": false, - "declaration": true, - "declarationMap": true, - "outDir": "dist", - "pretty": true, - "sourceMap": true - } -} diff --git a/packages/mcp-server/tsconfig.dist-src.json b/packages/mcp-server/tsconfig.dist-src.json deleted file mode 100644 index e9f2d70b..00000000 --- a/packages/mcp-server/tsconfig.dist-src.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - // this config is included in the published src directory to prevent TS errors - // from appearing when users go to source, and VSCode opens the source .ts file - // via declaration maps - "include": ["index.ts"], - "compilerOptions": { - "target": "es2015", - "lib": ["DOM"], - "moduleResolution": "node" - } -} diff --git a/packages/mcp-server/tsconfig.json b/packages/mcp-server/tsconfig.json deleted file mode 100644 index 3af4bd0c..00000000 --- a/packages/mcp-server/tsconfig.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "include": ["src", "tests", "examples"], - "exclude": [], - "compilerOptions": { - "target": "es2022", - "lib": ["es2022"], - "module": "commonjs", - "moduleResolution": "node", - "esModuleInterop": true, - "paths": { - "@hubspot/sdk-mcp/*": ["./src/*"], - "@hubspot/sdk-mcp": ["./src/index.ts"] - }, - "noEmit": true, - - "resolveJsonModule": true, - - "forceConsistentCasingInFileNames": true, - - "strict": true, - "noImplicitAny": true, - "strictNullChecks": true, - "strictFunctionTypes": true, - "strictBindCallApply": true, - "strictPropertyInitialization": true, - "noImplicitThis": true, - "noImplicitReturns": true, - "alwaysStrict": true, - "exactOptionalPropertyTypes": true, - "noUncheckedIndexedAccess": true, - "noImplicitOverride": true, - "noPropertyAccessFromIndexSignature": true, - - "skipLibCheck": true - } -} diff --git a/packages/mcp-server/yarn.lock b/packages/mcp-server/yarn.lock deleted file mode 100644 index c6b17b02..00000000 --- a/packages/mcp-server/yarn.lock +++ /dev/null @@ -1,4169 +0,0 @@ -# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -# yarn lockfile v1 - - -"@anthropic-ai/mcpb@^2.1.2": - version "2.1.2" - resolved "https://registry.yarnpkg.com/@anthropic-ai/mcpb/-/mcpb-2.1.2.tgz#cf02801929734b8810961f22e2eb72758c27d527" - integrity sha512-goRbBC8ySo7SWb7tRzr+tL6FxDc4JPTRCdgfD2omba7freofvjq5rom1lBnYHZHo6Mizs1jAHJeN53aZbDoy8A== - dependencies: - "@inquirer/prompts" "^6.0.1" - commander "^13.1.0" - fflate "^0.8.2" - galactus "^1.0.0" - ignore "^7.0.5" - node-forge "^1.3.2" - pretty-bytes "^5.6.0" - zod "^3.25.67" - zod-to-json-schema "^3.24.6" - -"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.28.6.tgz#72499312ec58b1e2245ba4a4f550c132be4982f7" - integrity sha512-JYgintcMjRiCvS8mMECzaEn+m3PfoQiyqukOMCCVQtoJGYJw8j/8LBJEiqkHLkfwCcs74E3pbAUFNg7d9VNJ+Q== - dependencies: - "@babel/helper-validator-identifier" "^7.28.5" - js-tokens "^4.0.0" - picocolors "^1.1.1" - -"@babel/compat-data@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.28.6.tgz#103f466803fa0f059e82ccac271475470570d74c" - integrity sha512-2lfu57JtzctfIrcGMz992hyLlByuzgIk58+hhGCxjKZ3rWI82NnVLjXcaTqkI2NvlcvOskZaiZ5kjUALo3Lpxg== - -"@babel/core@^7.11.6", "@babel/core@^7.12.3", "@babel/core@^7.23.9": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.28.6.tgz#531bf883a1126e53501ba46eb3bb414047af507f" - integrity sha512-H3mcG6ZDLTlYfaSNi0iOKkigqMFvkTKlGUYlD8GW7nNOYRrevuA46iTypPyv+06V3fEmvvazfntkBU34L0azAw== - dependencies: - "@babel/code-frame" "^7.28.6" - "@babel/generator" "^7.28.6" - "@babel/helper-compilation-targets" "^7.28.6" - "@babel/helper-module-transforms" "^7.28.6" - "@babel/helpers" "^7.28.6" - "@babel/parser" "^7.28.6" - "@babel/template" "^7.28.6" - "@babel/traverse" "^7.28.6" - "@babel/types" "^7.28.6" - "@jridgewell/remapping" "^2.3.5" - convert-source-map "^2.0.0" - debug "^4.1.0" - gensync "^1.0.0-beta.2" - json5 "^2.2.3" - semver "^6.3.1" - -"@babel/generator@^7.28.6", "@babel/generator@^7.7.2": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/generator/-/generator-7.28.6.tgz#48dcc65d98fcc8626a48f72b62e263d25fc3c3f1" - integrity sha512-lOoVRwADj8hjf7al89tvQ2a1lf53Z+7tiXMgpZJL3maQPDxh0DgLMN62B2MKUOFcoodBHLMbDM6WAbKgNy5Suw== - dependencies: - "@babel/parser" "^7.28.6" - "@babel/types" "^7.28.6" - "@jridgewell/gen-mapping" "^0.3.12" - "@jridgewell/trace-mapping" "^0.3.28" - jsesc "^3.0.2" - -"@babel/helper-compilation-targets@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz#32c4a3f41f12ed1532179b108a4d746e105c2b25" - integrity sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA== - dependencies: - "@babel/compat-data" "^7.28.6" - "@babel/helper-validator-option" "^7.27.1" - browserslist "^4.24.0" - lru-cache "^5.1.1" - semver "^6.3.1" - -"@babel/helper-globals@^7.28.0": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@babel/helper-globals/-/helper-globals-7.28.0.tgz#b9430df2aa4e17bc28665eadeae8aa1d985e6674" - integrity sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw== - -"@babel/helper-module-imports@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz#60632cbd6ffb70b22823187201116762a03e2d5c" - integrity sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw== - dependencies: - "@babel/traverse" "^7.28.6" - "@babel/types" "^7.28.6" - -"@babel/helper-module-transforms@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz#9312d9d9e56edc35aeb6e95c25d4106b50b9eb1e" - integrity sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA== - dependencies: - "@babel/helper-module-imports" "^7.28.6" - "@babel/helper-validator-identifier" "^7.28.5" - "@babel/traverse" "^7.28.6" - -"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.28.6", "@babel/helper-plugin-utils@^7.8.0": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz#6f13ea251b68c8532e985fd532f28741a8af9ac8" - integrity sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug== - -"@babel/helper-string-parser@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz#54da796097ab19ce67ed9f88b47bb2ec49367687" - integrity sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA== - -"@babel/helper-validator-identifier@^7.28.5": - version "7.28.5" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz#010b6938fab7cb7df74aa2bbc06aa503b8fe5fb4" - integrity sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q== - -"@babel/helper-validator-option@^7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz#fa52f5b1e7db1ab049445b421c4471303897702f" - integrity sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg== - -"@babel/helpers@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.28.6.tgz#fca903a313ae675617936e8998b814c415cbf5d7" - integrity sha512-xOBvwq86HHdB7WUDTfKfT/Vuxh7gElQ+Sfti2Cy6yIWNW05P8iUslOVcZ4/sKbE+/jQaukQAdz/gf3724kYdqw== - dependencies: - "@babel/template" "^7.28.6" - "@babel/types" "^7.28.6" - -"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.20.7", "@babel/parser@^7.23.9", "@babel/parser@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/parser/-/parser-7.28.6.tgz#f01a8885b7fa1e56dd8a155130226cd698ef13fd" - integrity sha512-TeR9zWR18BvbfPmGbLampPMW+uW1NZnJlRuuHso8i87QZNq2JRF9i6RgxRqtEq+wQGsS19NNTWr2duhnE49mfQ== - dependencies: - "@babel/types" "^7.28.6" - -"@babel/plugin-syntax-async-generators@^7.8.4": - version "7.8.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz#a983fb1aeb2ec3f6ed042a210f640e90e786fe0d" - integrity sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-bigint@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz#4c9a6f669f5d0cdf1b90a1671e9a146be5300cea" - integrity sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-class-properties@^7.12.13": - version "7.12.13" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz#b5c987274c4a3a82b89714796931a6b53544ae10" - integrity sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA== - dependencies: - "@babel/helper-plugin-utils" "^7.12.13" - -"@babel/plugin-syntax-class-static-block@^7.14.5": - version "7.14.5" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz#195df89b146b4b78b3bf897fd7a257c84659d406" - integrity sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw== - dependencies: - "@babel/helper-plugin-utils" "^7.14.5" - -"@babel/plugin-syntax-import-attributes@^7.24.7": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz#b71d5914665f60124e133696f17cd7669062c503" - integrity sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw== - dependencies: - "@babel/helper-plugin-utils" "^7.28.6" - -"@babel/plugin-syntax-import-meta@^7.10.4": - version "7.10.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz#ee601348c370fa334d2207be158777496521fd51" - integrity sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g== - dependencies: - "@babel/helper-plugin-utils" "^7.10.4" - -"@babel/plugin-syntax-json-strings@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz#01ca21b668cd8218c9e640cb6dd88c5412b2c96a" - integrity sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-jsx@^7.7.2": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.28.6.tgz#f8ca28bbd84883b5fea0e447c635b81ba73997ee" - integrity sha512-wgEmr06G6sIpqr8YDwA2dSRTE3bJ+V0IfpzfSY3Lfgd7YWOaAdlykvJi13ZKBt8cZHfgH1IXN+CL656W3uUa4w== - dependencies: - "@babel/helper-plugin-utils" "^7.28.6" - -"@babel/plugin-syntax-logical-assignment-operators@^7.10.4": - version "7.10.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz#ca91ef46303530448b906652bac2e9fe9941f699" - integrity sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig== - dependencies: - "@babel/helper-plugin-utils" "^7.10.4" - -"@babel/plugin-syntax-nullish-coalescing-operator@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz#167ed70368886081f74b5c36c65a88c03b66d1a9" - integrity sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-numeric-separator@^7.10.4": - version "7.10.4" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz#b9b070b3e33570cd9fd07ba7fa91c0dd37b9af97" - integrity sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug== - dependencies: - "@babel/helper-plugin-utils" "^7.10.4" - -"@babel/plugin-syntax-object-rest-spread@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz#60e225edcbd98a640332a2e72dd3e66f1af55871" - integrity sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-optional-catch-binding@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz#6111a265bcfb020eb9efd0fdfd7d26402b9ed6c1" - integrity sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-optional-chaining@^7.8.3": - version "7.8.3" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz#4f69c2ab95167e0180cd5336613f8c5788f7d48a" - integrity sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg== - dependencies: - "@babel/helper-plugin-utils" "^7.8.0" - -"@babel/plugin-syntax-private-property-in-object@^7.14.5": - version "7.14.5" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz#0dc6671ec0ea22b6e94a1114f857970cd39de1ad" - integrity sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg== - dependencies: - "@babel/helper-plugin-utils" "^7.14.5" - -"@babel/plugin-syntax-top-level-await@^7.14.5": - version "7.14.5" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz#c1cfdadc35a646240001f06138247b741c34d94c" - integrity sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw== - dependencies: - "@babel/helper-plugin-utils" "^7.14.5" - -"@babel/plugin-syntax-typescript@^7.7.2": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.28.6.tgz#c7b2ddf1d0a811145b1de800d1abd146af92e3a2" - integrity sha512-+nDNmQye7nlnuuHDboPbGm00Vqg3oO8niRRL27/4LYHUsHYh0zJ1xWOz0uRwNFmM1Avzk8wZbc6rdiYhomzv/A== - dependencies: - "@babel/helper-plugin-utils" "^7.28.6" - -"@babel/template@^7.28.6", "@babel/template@^7.3.3": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.28.6.tgz#0e7e56ecedb78aeef66ce7972b082fce76a23e57" - integrity sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ== - dependencies: - "@babel/code-frame" "^7.28.6" - "@babel/parser" "^7.28.6" - "@babel/types" "^7.28.6" - -"@babel/traverse@^7.28.6": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.28.6.tgz#871ddc79a80599a5030c53b1cc48cbe3a5583c2e" - integrity sha512-fgWX62k02qtjqdSNTAGxmKYY/7FSL9WAS1o2Hu5+I5m9T0yxZzr4cnrfXQ/MX0rIifthCSs6FKTlzYbJcPtMNg== - dependencies: - "@babel/code-frame" "^7.28.6" - "@babel/generator" "^7.28.6" - "@babel/helper-globals" "^7.28.0" - "@babel/parser" "^7.28.6" - "@babel/template" "^7.28.6" - "@babel/types" "^7.28.6" - debug "^4.3.1" - -"@babel/types@^7.0.0", "@babel/types@^7.20.7", "@babel/types@^7.28.2", "@babel/types@^7.28.6", "@babel/types@^7.3.3": - version "7.28.6" - resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.28.6.tgz#c3e9377f1b155005bcc4c46020e7e394e13089df" - integrity sha512-0ZrskXVEHSWIqZM/sQZ4EV3jZJXRkio/WCxaqKZP1g//CEWEPSfeZFcms4XeKBCHU0ZKnIkdJeU/kF+eRp5lBg== - dependencies: - "@babel/helper-string-parser" "^7.27.1" - "@babel/helper-validator-identifier" "^7.28.5" - -"@bcoe/v8-coverage@^0.2.3": - version "0.2.3" - resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39" - integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw== - -"@cloudflare/cabidela@^0.2.4": - version "0.2.4" - resolved "https://registry.yarnpkg.com/@cloudflare/cabidela/-/cabidela-0.2.4.tgz#9a3e9212e636a24d796a8f16741c24885b326a1a" - integrity sha512-u/1OwwqfcMvjmUFOcb6QtFzVVGpncHJxwl254wjzp0JC5CUlBkV6r5BbRrHI5ZYJEAgu8NeeorirxngmMFPZjQ== - -"@cspotcode/source-map-support@^0.8.0": - version "0.8.1" - resolved "https://registry.yarnpkg.com/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz#00629c35a688e05a88b1cda684fb9d5e73f000a1" - integrity sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw== - dependencies: - "@jridgewell/trace-mapping" "0.3.9" - -"@eslint-community/eslint-utils@^4.4.0", "@eslint-community/eslint-utils@^4.8.0": - version "4.9.1" - resolved "https://registry.yarnpkg.com/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz#4e90af67bc51ddee6cdef5284edf572ec376b595" - integrity sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ== - dependencies: - eslint-visitor-keys "^3.4.3" - -"@eslint-community/regexpp@^4.10.0", "@eslint-community/regexpp@^4.12.1": - version "4.12.2" - resolved "https://registry.yarnpkg.com/@eslint-community/regexpp/-/regexpp-4.12.2.tgz#bccdf615bcf7b6e8db830ec0b8d21c9a25de597b" - integrity sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew== - -"@eslint/config-array@^0.21.2": - version "0.21.2" - resolved "https://registry.yarnpkg.com/@eslint/config-array/-/config-array-0.21.2.tgz#f29e22057ad5316cf23836cee9a34c81fffcb7e6" - integrity sha512-nJl2KGTlrf9GjLimgIru+V/mzgSK0ABCDQRvxw5BjURL7WfH5uoWmizbH7QB6MmnMBd8cIC9uceWnezL1VZWWw== - dependencies: - "@eslint/object-schema" "^2.1.7" - debug "^4.3.1" - minimatch "^3.1.5" - -"@eslint/config-helpers@^0.4.2": - version "0.4.2" - resolved "https://registry.yarnpkg.com/@eslint/config-helpers/-/config-helpers-0.4.2.tgz#1bd006ceeb7e2e55b2b773ab318d300e1a66aeda" - integrity sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw== - dependencies: - "@eslint/core" "^0.17.0" - -"@eslint/core@^0.17.0": - version "0.17.0" - resolved "https://registry.yarnpkg.com/@eslint/core/-/core-0.17.0.tgz#77225820413d9617509da9342190a2019e78761c" - integrity sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ== - dependencies: - "@types/json-schema" "^7.0.15" - -"@eslint/eslintrc@^3.3.5": - version "3.3.5" - resolved "https://registry.yarnpkg.com/@eslint/eslintrc/-/eslintrc-3.3.5.tgz#c131793cfc1a7b96f24a83e0a8bbd4b881558c60" - integrity sha512-4IlJx0X0qftVsN5E+/vGujTRIFtwuLbNsVUe7TO6zYPDR1O6nFwvwhIKEKSrl6dZchmYBITazxKoUYOjdtjlRg== - dependencies: - ajv "^6.14.0" - debug "^4.3.2" - espree "^10.0.1" - globals "^14.0.0" - ignore "^5.2.0" - import-fresh "^3.2.1" - js-yaml "^4.1.1" - minimatch "^3.1.5" - strip-json-comments "^3.1.1" - -"@eslint/js@9.39.4": - version "9.39.4" - resolved "https://registry.yarnpkg.com/@eslint/js/-/js-9.39.4.tgz#a3f83bfc6fd9bf33a853dfacd0b49b398eb596c1" - integrity sha512-nE7DEIchvtiFTwBw4Lfbu59PG+kCofhjsKaCWzxTpt4lfRjRMqG6uMBzKXuEcyXhOHoUp9riAm7/aWYGhXZ9cw== - -"@eslint/object-schema@^2.1.7": - version "2.1.7" - resolved "https://registry.yarnpkg.com/@eslint/object-schema/-/object-schema-2.1.7.tgz#6e2126a1347e86a4dedf8706ec67ff8e107ebbad" - integrity sha512-VtAOaymWVfZcmZbp6E2mympDIHvyjXs/12LqWYjVw6qjrfF+VK+fyG33kChz3nnK+SU5/NeHOqrTEHS8sXO3OA== - -"@eslint/plugin-kit@^0.4.1": - version "0.4.1" - resolved "https://registry.yarnpkg.com/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz#9779e3fd9b7ee33571a57435cf4335a1794a6cb2" - integrity sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA== - dependencies: - "@eslint/core" "^0.17.0" - levn "^0.4.1" - -"@hono/node-server@^1.19.10", "@hono/node-server@^1.19.9": - version "1.19.11" - resolved "https://registry.yarnpkg.com/@hono/node-server/-/node-server-1.19.11.tgz#dc419f0826dd2504e9fc86ad289d5636a0444e2f" - integrity sha512-dr8/3zEaB+p0D2n/IUrlPF1HZm586qgJNXK1a9fhg/PzdtkK7Ksd5l312tJX2yBuALqDYBlG20QEbayqPyxn+g== - -"@humanfs/core@^0.19.1": - version "0.19.1" - resolved "https://registry.yarnpkg.com/@humanfs/core/-/core-0.19.1.tgz#17c55ca7d426733fe3c561906b8173c336b40a77" - integrity sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA== - -"@humanfs/node@^0.16.6": - version "0.16.7" - resolved "https://registry.yarnpkg.com/@humanfs/node/-/node-0.16.7.tgz#822cb7b3a12c5a240a24f621b5a2413e27a45f26" - integrity sha512-/zUx+yOsIrG4Y43Eh2peDeKCxlRt/gET6aHfaKpuq267qXdYDFViVHfMaLyygZOnl0kGWxFIgsBy8QFuTLUXEQ== - dependencies: - "@humanfs/core" "^0.19.1" - "@humanwhocodes/retry" "^0.4.0" - -"@humanwhocodes/module-importer@^1.0.1": - version "1.0.1" - resolved "https://registry.yarnpkg.com/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz#af5b2691a22b44be847b0ca81641c5fb6ad0172c" - integrity sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA== - -"@humanwhocodes/retry@^0.4.0", "@humanwhocodes/retry@^0.4.2": - version "0.4.3" - resolved "https://registry.yarnpkg.com/@humanwhocodes/retry/-/retry-0.4.3.tgz#c2b9d2e374ee62c586d3adbea87199b1d7a7a6ba" - integrity sha512-bV0Tgo9K4hfPCek+aMAn81RppFKv2ySDQeMoSZuvTASywNTnVJCArCZE2FWqpvIatKu7VMRLWlR1EazvVhDyhQ== - -"@inquirer/checkbox@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/checkbox/-/checkbox-3.0.1.tgz#0a57f704265f78c36e17f07e421b98efb4b9867b" - integrity sha512-0hm2nrToWUdD6/UHnel/UKGdk1//ke5zGUpHIvk5ZWmaKezlGxZkOJXNSWsdxO/rEqTkbB3lNC2J6nBElV2aAQ== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/figures" "^1.0.6" - "@inquirer/type" "^2.0.0" - ansi-escapes "^4.3.2" - yoctocolors-cjs "^2.1.2" - -"@inquirer/confirm@^4.0.1": - version "4.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/confirm/-/confirm-4.0.1.tgz#9106d6bffa0b2fdd0e4f60319b6f04f2e06e6e25" - integrity sha512-46yL28o2NJ9doViqOy0VDcoTzng7rAb6yPQKU7VDLqkmbCaH4JqK4yk4XqlzNWy9PVC5pG1ZUXPBQv+VqnYs2w== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - -"@inquirer/core@^9.2.1": - version "9.2.1" - resolved "https://registry.yarnpkg.com/@inquirer/core/-/core-9.2.1.tgz#677c49dee399c9063f31e0c93f0f37bddc67add1" - integrity sha512-F2VBt7W/mwqEU4bL0RnHNZmC/OxzNx9cOYxHqnXX3MP6ruYvZUZAW9imgN9+h/uBT/oP8Gh888J2OZSbjSeWcg== - dependencies: - "@inquirer/figures" "^1.0.6" - "@inquirer/type" "^2.0.0" - "@types/mute-stream" "^0.0.4" - "@types/node" "^22.5.5" - "@types/wrap-ansi" "^3.0.0" - ansi-escapes "^4.3.2" - cli-width "^4.1.0" - mute-stream "^1.0.0" - signal-exit "^4.1.0" - strip-ansi "^6.0.1" - wrap-ansi "^6.2.0" - yoctocolors-cjs "^2.1.2" - -"@inquirer/editor@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/editor/-/editor-3.0.1.tgz#d109f21e050af6b960725388cb1c04214ed7c7bc" - integrity sha512-VA96GPFaSOVudjKFraokEEmUQg/Lub6OXvbIEZU1SDCmBzRkHGhxoFAVaF30nyiB4m5cEbDgiI2QRacXZ2hw9Q== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - external-editor "^3.1.0" - -"@inquirer/expand@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/expand/-/expand-3.0.1.tgz#aed9183cac4d12811be47a4a895ea8e82a17e22c" - integrity sha512-ToG8d6RIbnVpbdPdiN7BCxZGiHOTomOX94C2FaT5KOHupV40tKEDozp12res6cMIfRKrXLJyexAZhWVHgbALSQ== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - yoctocolors-cjs "^2.1.2" - -"@inquirer/figures@^1.0.6": - version "1.0.15" - resolved "https://registry.yarnpkg.com/@inquirer/figures/-/figures-1.0.15.tgz#dbb49ed80df11df74268023b496ac5d9acd22b3a" - integrity sha512-t2IEY+unGHOzAaVM5Xx6DEWKeXlDDcNPeDyUpsRc6CUhBfU3VQOEl+Vssh7VNp1dR8MdUJBWhuObjXCsVpjN5g== - -"@inquirer/input@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/input/-/input-3.0.1.tgz#de63d49e516487388508d42049deb70f2cb5f28e" - integrity sha512-BDuPBmpvi8eMCxqC5iacloWqv+5tQSJlUafYWUe31ow1BVXjW2a5qe3dh4X/Z25Wp22RwvcaLCc2siHobEOfzg== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - -"@inquirer/number@^2.0.1": - version "2.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/number/-/number-2.0.1.tgz#b9863080d02ab7dc2e56e16433d83abea0f2a980" - integrity sha512-QpR8jPhRjSmlr/mD2cw3IR8HRO7lSVOnqUvQa8scv1Lsr3xoAMMworcYW3J13z3ppjBFBD2ef1Ci6AE5Qn8goQ== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - -"@inquirer/password@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/password/-/password-3.0.1.tgz#2a9a9143591088336bbd573bcb05d5bf080dbf87" - integrity sha512-haoeEPUisD1NeE2IanLOiFr4wcTXGWrBOyAyPZi1FfLJuXOzNmxCJPgUrGYKVh+Y8hfGJenIfz5Wb/DkE9KkMQ== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - ansi-escapes "^4.3.2" - -"@inquirer/prompts@^6.0.1": - version "6.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/prompts/-/prompts-6.0.1.tgz#43f5c0ed35c5ebfe52f1d43d46da2d363d950071" - integrity sha512-yl43JD/86CIj3Mz5mvvLJqAOfIup7ncxfJ0Btnl0/v5TouVUyeEdcpknfgc+yMevS/48oH9WAkkw93m7otLb/A== - dependencies: - "@inquirer/checkbox" "^3.0.1" - "@inquirer/confirm" "^4.0.1" - "@inquirer/editor" "^3.0.1" - "@inquirer/expand" "^3.0.1" - "@inquirer/input" "^3.0.1" - "@inquirer/number" "^2.0.1" - "@inquirer/password" "^3.0.1" - "@inquirer/rawlist" "^3.0.1" - "@inquirer/search" "^2.0.1" - "@inquirer/select" "^3.0.1" - -"@inquirer/rawlist@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/rawlist/-/rawlist-3.0.1.tgz#729def358419cc929045f264131878ed379e0af3" - integrity sha512-VgRtFIwZInUzTiPLSfDXK5jLrnpkuSOh1ctfaoygKAdPqjcjKYmGh6sCY1pb0aGnCGsmhUxoqLDUAU0ud+lGXQ== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/type" "^2.0.0" - yoctocolors-cjs "^2.1.2" - -"@inquirer/search@^2.0.1": - version "2.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/search/-/search-2.0.1.tgz#69b774a0a826de2e27b48981d01bc5ad81e73721" - integrity sha512-r5hBKZk3g5MkIzLVoSgE4evypGqtOannnB3PKTG9NRZxyFRKcfzrdxXXPcoJQsxJPzvdSU2Rn7pB7lw0GCmGAg== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/figures" "^1.0.6" - "@inquirer/type" "^2.0.0" - yoctocolors-cjs "^2.1.2" - -"@inquirer/select@^3.0.1": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@inquirer/select/-/select-3.0.1.tgz#1df9ed27fb85a5f526d559ac5ce7cc4e9dc4e7ec" - integrity sha512-lUDGUxPhdWMkN/fHy1Lk7pF3nK1fh/gqeyWXmctefhxLYxlDsc7vsPBEpxrfVGDsVdyYJsiJoD4bJ1b623cV1Q== - dependencies: - "@inquirer/core" "^9.2.1" - "@inquirer/figures" "^1.0.6" - "@inquirer/type" "^2.0.0" - ansi-escapes "^4.3.2" - yoctocolors-cjs "^2.1.2" - -"@inquirer/type@^2.0.0": - version "2.0.0" - resolved "https://registry.yarnpkg.com/@inquirer/type/-/type-2.0.0.tgz#08fa513dca2cb6264fe1b0a2fabade051444e3f6" - integrity sha512-XvJRx+2KR3YXyYtPUUy+qd9i7p+GO9Ko6VIIpWlBrpWwXDv8WLFeHTxz35CfQFUiBMLXlGHhGzys7lqit9gWag== - dependencies: - mute-stream "^1.0.0" - -"@istanbuljs/load-nyc-config@^1.0.0": - version "1.1.0" - resolved "https://registry.yarnpkg.com/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz#fd3db1d59ecf7cf121e80650bb86712f9b55eced" - integrity sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ== - dependencies: - camelcase "^5.3.1" - find-up "^4.1.0" - get-package-type "^0.1.0" - js-yaml "^3.13.1" - resolve-from "^5.0.0" - -"@istanbuljs/schema@^0.1.2", "@istanbuljs/schema@^0.1.3": - version "0.1.3" - resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.3.tgz#e45e384e4b8ec16bce2fd903af78450f6bf7ec98" - integrity sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== - -"@jest/console@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/console/-/console-29.7.0.tgz#cd4822dbdb84529265c5a2bdb529a3c9cc950ffc" - integrity sha512-5Ni4CU7XHQi32IJ398EEP4RrB8eV09sXP2ROqD4bksHrnTree52PsxvX8tpL8LvTZ3pFzXyPbNQReSN41CAhOg== - dependencies: - "@jest/types" "^29.6.3" - "@types/node" "*" - chalk "^4.0.0" - jest-message-util "^29.7.0" - jest-util "^29.7.0" - slash "^3.0.0" - -"@jest/core@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/core/-/core-29.7.0.tgz#b6cccc239f30ff36609658c5a5e2291757ce448f" - integrity sha512-n7aeXWKMnGtDA48y8TLWJPJmLmmZ642Ceo78cYWEpiD7FzDgmNDV/GCVRorPABdXLJZ/9wzzgZAlHjXjxDHGsg== - dependencies: - "@jest/console" "^29.7.0" - "@jest/reporters" "^29.7.0" - "@jest/test-result" "^29.7.0" - "@jest/transform" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - ansi-escapes "^4.2.1" - chalk "^4.0.0" - ci-info "^3.2.0" - exit "^0.1.2" - graceful-fs "^4.2.9" - jest-changed-files "^29.7.0" - jest-config "^29.7.0" - jest-haste-map "^29.7.0" - jest-message-util "^29.7.0" - jest-regex-util "^29.6.3" - jest-resolve "^29.7.0" - jest-resolve-dependencies "^29.7.0" - jest-runner "^29.7.0" - jest-runtime "^29.7.0" - jest-snapshot "^29.7.0" - jest-util "^29.7.0" - jest-validate "^29.7.0" - jest-watcher "^29.7.0" - micromatch "^4.0.4" - pretty-format "^29.7.0" - slash "^3.0.0" - strip-ansi "^6.0.0" - -"@jest/environment@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/environment/-/environment-29.7.0.tgz#24d61f54ff1f786f3cd4073b4b94416383baf2a7" - integrity sha512-aQIfHDq33ExsN4jP1NWGXhxgQ/wixs60gDiKO+XVMd8Mn0NWPWgc34ZQDTb2jKaUWQ7MuwoitXAsN2XVXNMpAw== - dependencies: - "@jest/fake-timers" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - jest-mock "^29.7.0" - -"@jest/expect-utils@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/expect-utils/-/expect-utils-29.7.0.tgz#023efe5d26a8a70f21677d0a1afc0f0a44e3a1c6" - integrity sha512-GlsNBWiFQFCVi9QVSx7f5AgMeLxe9YCCs5PuP2O2LdjDAA8Jh9eX7lA1Jq/xdXw3Wb3hyvlFNfZIfcRetSzYcA== - dependencies: - jest-get-type "^29.6.3" - -"@jest/expect@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/expect/-/expect-29.7.0.tgz#76a3edb0cb753b70dfbfe23283510d3d45432bf2" - integrity sha512-8uMeAMycttpva3P1lBHB8VciS9V0XAr3GymPpipdyQXbBcuhkLQOSe8E/p92RyAdToS6ZD1tFkX+CkhoECE0dQ== - dependencies: - expect "^29.7.0" - jest-snapshot "^29.7.0" - -"@jest/fake-timers@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/fake-timers/-/fake-timers-29.7.0.tgz#fd91bf1fffb16d7d0d24a426ab1a47a49881a565" - integrity sha512-q4DH1Ha4TTFPdxLsqDXK1d3+ioSL7yL5oCMJZgDYm6i+6CygW5E5xVr/D1HdsGxjt1ZWSfUAs9OxSB/BNelWrQ== - dependencies: - "@jest/types" "^29.6.3" - "@sinonjs/fake-timers" "^10.0.2" - "@types/node" "*" - jest-message-util "^29.7.0" - jest-mock "^29.7.0" - jest-util "^29.7.0" - -"@jest/globals@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/globals/-/globals-29.7.0.tgz#8d9290f9ec47ff772607fa864ca1d5a2efae1d4d" - integrity sha512-mpiz3dutLbkW2MNFubUGUEVLkTGiqW6yLVTA+JbP6fI6J5iL9Y0Nlg8k95pcF8ctKwCS7WVxteBs29hhfAotzQ== - dependencies: - "@jest/environment" "^29.7.0" - "@jest/expect" "^29.7.0" - "@jest/types" "^29.6.3" - jest-mock "^29.7.0" - -"@jest/reporters@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/reporters/-/reporters-29.7.0.tgz#04b262ecb3b8faa83b0b3d321623972393e8f4c7" - integrity sha512-DApq0KJbJOEzAFYjHADNNxAE3KbhxQB1y5Kplb5Waqw6zVbuWatSnMjE5gs8FUgEPmNsnZA3NCWl9NG0ia04Pg== - dependencies: - "@bcoe/v8-coverage" "^0.2.3" - "@jest/console" "^29.7.0" - "@jest/test-result" "^29.7.0" - "@jest/transform" "^29.7.0" - "@jest/types" "^29.6.3" - "@jridgewell/trace-mapping" "^0.3.18" - "@types/node" "*" - chalk "^4.0.0" - collect-v8-coverage "^1.0.0" - exit "^0.1.2" - glob "^7.1.3" - graceful-fs "^4.2.9" - istanbul-lib-coverage "^3.0.0" - istanbul-lib-instrument "^6.0.0" - istanbul-lib-report "^3.0.0" - istanbul-lib-source-maps "^4.0.0" - istanbul-reports "^3.1.3" - jest-message-util "^29.7.0" - jest-util "^29.7.0" - jest-worker "^29.7.0" - slash "^3.0.0" - string-length "^4.0.1" - strip-ansi "^6.0.0" - v8-to-istanbul "^9.0.1" - -"@jest/schemas@^29.6.3": - version "29.6.3" - resolved "https://registry.yarnpkg.com/@jest/schemas/-/schemas-29.6.3.tgz#430b5ce8a4e0044a7e3819663305a7b3091c8e03" - integrity sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA== - dependencies: - "@sinclair/typebox" "^0.27.8" - -"@jest/source-map@^29.6.3": - version "29.6.3" - resolved "https://registry.yarnpkg.com/@jest/source-map/-/source-map-29.6.3.tgz#d90ba772095cf37a34a5eb9413f1b562a08554c4" - integrity sha512-MHjT95QuipcPrpLM+8JMSzFx6eHp5Bm+4XeFDJlwsvVBjmKNiIAvasGK2fxz2WbGRlnvqehFbh07MMa7n3YJnw== - dependencies: - "@jridgewell/trace-mapping" "^0.3.18" - callsites "^3.0.0" - graceful-fs "^4.2.9" - -"@jest/test-result@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/test-result/-/test-result-29.7.0.tgz#8db9a80aa1a097bb2262572686734baed9b1657c" - integrity sha512-Fdx+tv6x1zlkJPcWXmMDAG2HBnaR9XPSd5aDWQVsfrZmLVT3lU1cwyxLgRmXR9yrq4NBoEm9BMsfgFzTQAbJYA== - dependencies: - "@jest/console" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/istanbul-lib-coverage" "^2.0.0" - collect-v8-coverage "^1.0.0" - -"@jest/test-sequencer@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/test-sequencer/-/test-sequencer-29.7.0.tgz#6cef977ce1d39834a3aea887a1726628a6f072ce" - integrity sha512-GQwJ5WZVrKnOJuiYiAF52UNUJXgTZx1NHjFSEB0qEMmSZKAkdMoIzw/Cj6x6NF4AvV23AUqDpFzQkN/eYCYTxw== - dependencies: - "@jest/test-result" "^29.7.0" - graceful-fs "^4.2.9" - jest-haste-map "^29.7.0" - slash "^3.0.0" - -"@jest/transform@^29.7.0": - version "29.7.0" - resolved "https://registry.yarnpkg.com/@jest/transform/-/transform-29.7.0.tgz#df2dd9c346c7d7768b8a06639994640c642e284c" - integrity sha512-ok/BTPFzFKVMwO5eOHRrvnBVHdRy9IrsrW1GpMaQ9MCnilNLXQKmAX8s1YXDFaai9xJpac2ySzV0YeRRECr2Vw== - dependencies: - "@babel/core" "^7.11.6" - "@jest/types" "^29.6.3" - "@jridgewell/trace-mapping" "^0.3.18" - babel-plugin-istanbul "^6.1.1" - chalk "^4.0.0" - convert-source-map "^2.0.0" - fast-json-stable-stringify "^2.1.0" - graceful-fs "^4.2.9" - jest-haste-map "^29.7.0" - jest-regex-util "^29.6.3" - jest-util "^29.7.0" - micromatch "^4.0.4" - pirates "^4.0.4" - slash "^3.0.0" - write-file-atomic "^4.0.2" - -"@jest/types@^29.6.3": - version "29.6.3" - resolved "https://registry.yarnpkg.com/@jest/types/-/types-29.6.3.tgz#1131f8cf634e7e84c5e77bab12f052af585fba59" - integrity sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw== - dependencies: - "@jest/schemas" "^29.6.3" - "@types/istanbul-lib-coverage" "^2.0.0" - "@types/istanbul-reports" "^3.0.0" - "@types/node" "*" - "@types/yargs" "^17.0.8" - chalk "^4.0.0" - -"@jridgewell/gen-mapping@^0.3.12", "@jridgewell/gen-mapping@^0.3.5": - version "0.3.13" - resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz#6342a19f44347518c93e43b1ac69deb3c4656a1f" - integrity sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA== - dependencies: - "@jridgewell/sourcemap-codec" "^1.5.0" - "@jridgewell/trace-mapping" "^0.3.24" - -"@jridgewell/remapping@^2.3.5": - version "2.3.5" - resolved "https://registry.yarnpkg.com/@jridgewell/remapping/-/remapping-2.3.5.tgz#375c476d1972947851ba1e15ae8f123047445aa1" - integrity sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ== - dependencies: - "@jridgewell/gen-mapping" "^0.3.5" - "@jridgewell/trace-mapping" "^0.3.24" - -"@jridgewell/resolve-uri@^3.0.3", "@jridgewell/resolve-uri@^3.1.0": - version "3.1.2" - resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6" - integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw== - -"@jridgewell/sourcemap-codec@^1.4.10", "@jridgewell/sourcemap-codec@^1.4.14", "@jridgewell/sourcemap-codec@^1.5.0": - version "1.5.5" - resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz#6912b00d2c631c0d15ce1a7ab57cd657f2a8f8ba" - integrity sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og== - -"@jridgewell/trace-mapping@0.3.9": - version "0.3.9" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz#6534fd5933a53ba7cbf3a17615e273a0d1273ff9" - integrity sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ== - dependencies: - "@jridgewell/resolve-uri" "^3.0.3" - "@jridgewell/sourcemap-codec" "^1.4.10" - -"@jridgewell/trace-mapping@^0.3.12", "@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.28": - version "0.3.31" - resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz#db15d6781c931f3a251a3dac39501c98a6082fd0" - integrity sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw== - dependencies: - "@jridgewell/resolve-uri" "^3.1.0" - "@jridgewell/sourcemap-codec" "^1.4.14" - -"@modelcontextprotocol/sdk@^1.27.1": - version "1.27.1" - resolved "https://registry.yarnpkg.com/@modelcontextprotocol/sdk/-/sdk-1.27.1.tgz#a602cf823bf8a68e13e7112f50aeb02b09fb83b9" - integrity sha512-sr6GbP+4edBwFndLbM60gf07z0FQ79gaExpnsjMGePXqFcSSb7t6iscpjk9DhFhwd+mTEQrzNafGP8/iGGFYaA== - dependencies: - "@hono/node-server" "^1.19.9" - ajv "^8.17.1" - ajv-formats "^3.0.1" - content-type "^1.0.5" - cors "^2.8.5" - cross-spawn "^7.0.5" - eventsource "^3.0.2" - eventsource-parser "^3.0.0" - express "^5.2.1" - express-rate-limit "^8.2.1" - hono "^4.11.4" - jose "^6.1.3" - json-schema-typed "^8.0.2" - pkce-challenge "^5.0.0" - raw-body "^3.0.0" - zod "^3.25 || ^4.0" - zod-to-json-schema "^3.25.1" - -"@nodelib/fs.scandir@2.1.5": - version "2.1.5" - resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" - integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== - dependencies: - "@nodelib/fs.stat" "2.0.5" - run-parallel "^1.1.9" - -"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": - version "2.0.5" - resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" - integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== - -"@nodelib/fs.walk@^1.2.3": - version "1.2.8" - resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" - integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== - dependencies: - "@nodelib/fs.scandir" "2.1.5" - fastq "^1.6.0" - -"@pinojs/redact@^0.4.0": - version "0.4.0" - resolved "https://registry.yarnpkg.com/@pinojs/redact/-/redact-0.4.0.tgz#c3de060dd12640dcc838516aa2a6803cc7b2e9d6" - integrity sha512-k2ENnmBugE/rzQfEcdWHcCY+/FM3VLzH9cYEsbdsoqrvzAKRhUZeRNhAZvB8OitQJ1TBed3yqWtdjzS6wJKBwg== - -"@pkgr/core@^0.2.9": - version "0.2.9" - resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.2.9.tgz#d229a7b7f9dac167a156992ef23c7f023653f53b" - integrity sha512-QNqXyfVS2wm9hweSYD2O7F0G06uurj9kZ96TRQE5Y9hU7+tgdZwIkbAKc5Ocy1HxEY2kuDQa6cQ1WRs/O5LFKA== - -"@sinclair/typebox@^0.27.8": - version "0.27.8" - resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" - integrity sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA== - -"@sinonjs/commons@^3.0.0": - version "3.0.1" - resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-3.0.1.tgz#1029357e44ca901a615585f6d27738dbc89084cd" - integrity sha512-K3mCHKQ9sVh8o1C9cxkwxaOmXoAMlDxC1mYyHrjqOWEcBjYr76t96zL2zlj5dUGZ3HSw240X1qgH3Mjf1yJWpQ== - dependencies: - type-detect "4.0.8" - -"@sinonjs/fake-timers@^10.0.2": - version "10.3.0" - resolved "https://registry.yarnpkg.com/@sinonjs/fake-timers/-/fake-timers-10.3.0.tgz#55fdff1ecab9f354019129daf4df0dd4d923ea66" - integrity sha512-V4BG07kuYSUkTCSBHG8G8TNhM+F19jXFWnQtzj+we8DrkpSBCee9Z3Ms8yiGer/dlmhe35/Xdgyo3/0rQKg7YA== - dependencies: - "@sinonjs/commons" "^3.0.0" - -"@ts-morph/common@~0.20.0": - version "0.20.0" - resolved "https://registry.yarnpkg.com/@ts-morph/common/-/common-0.20.0.tgz#3f161996b085ba4519731e4d24c35f6cba5b80af" - integrity sha512-7uKjByfbPpwuzkstL3L5MQyuXPSKdoNG93Fmi2JoDcTf3pEP731JdRFAduRVkOs8oqxPsXKA+ScrWkdQ8t/I+Q== - dependencies: - fast-glob "^3.2.12" - minimatch "^7.4.3" - mkdirp "^2.1.6" - path-browserify "^1.0.1" - -"@tsconfig/node10@^1.0.7": - version "1.0.12" - resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.12.tgz#be57ceac1e4692b41be9de6be8c32a106636dba4" - integrity sha512-UCYBaeFvM11aU2y3YPZ//O5Rhj+xKyzy7mvcIoAjASbigy8mHMryP5cK7dgjlz2hWxh1g5pLw084E0a/wlUSFQ== - -"@tsconfig/node12@^1.0.7": - version "1.0.11" - resolved "https://registry.yarnpkg.com/@tsconfig/node12/-/node12-1.0.11.tgz#ee3def1f27d9ed66dac6e46a295cffb0152e058d" - integrity sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag== - -"@tsconfig/node14@^1.0.0": - version "1.0.3" - resolved "https://registry.yarnpkg.com/@tsconfig/node14/-/node14-1.0.3.tgz#e4386316284f00b98435bf40f72f75a09dabf6c1" - integrity sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow== - -"@tsconfig/node16@^1.0.2": - version "1.0.4" - resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.4.tgz#0b92dcc0cc1c81f6f306a381f28e31b1a56536e9" - integrity sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA== - -"@types/babel__core@^7.1.14": - version "7.20.5" - resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.20.5.tgz#3df15f27ba85319caa07ba08d0721889bb39c017" - integrity sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA== - dependencies: - "@babel/parser" "^7.20.7" - "@babel/types" "^7.20.7" - "@types/babel__generator" "*" - "@types/babel__template" "*" - "@types/babel__traverse" "*" - -"@types/babel__generator@*": - version "7.27.0" - resolved "https://registry.yarnpkg.com/@types/babel__generator/-/babel__generator-7.27.0.tgz#b5819294c51179957afaec341442f9341e4108a9" - integrity sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg== - dependencies: - "@babel/types" "^7.0.0" - -"@types/babel__template@*": - version "7.4.4" - resolved "https://registry.yarnpkg.com/@types/babel__template/-/babel__template-7.4.4.tgz#5672513701c1b2199bc6dad636a9d7491586766f" - integrity sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A== - dependencies: - "@babel/parser" "^7.1.0" - "@babel/types" "^7.0.0" - -"@types/babel__traverse@*", "@types/babel__traverse@^7.0.6": - version "7.28.0" - resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.28.0.tgz#07d713d6cce0d265c9849db0cbe62d3f61f36f74" - integrity sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q== - dependencies: - "@babel/types" "^7.28.2" - -"@types/body-parser@*": - version "1.19.6" - resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.19.6.tgz#1859bebb8fd7dac9918a45d54c1971ab8b5af474" - integrity sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g== - dependencies: - "@types/connect" "*" - "@types/node" "*" - -"@types/connect@*": - version "3.4.38" - resolved "https://registry.yarnpkg.com/@types/connect/-/connect-3.4.38.tgz#5ba7f3bc4fbbdeaff8dded952e5ff2cc53f8d858" - integrity sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug== - dependencies: - "@types/node" "*" - -"@types/cookie-parser@^1.4.10": - version "1.4.10" - resolved "https://registry.yarnpkg.com/@types/cookie-parser/-/cookie-parser-1.4.10.tgz#a045272a383a30597a01955d4f9c790018f214e4" - integrity sha512-B4xqkqfZ8Wek+rCOeRxsjMS9OgvzebEzzLYw7NHYuvzb7IdxOkI0ZHGgeEBX4PUM7QGVvNSK60T3OvWj3YfBRg== - -"@types/cors@^2.8.19": - version "2.8.19" - resolved "https://registry.yarnpkg.com/@types/cors/-/cors-2.8.19.tgz#d93ea2673fd8c9f697367f5eeefc2bbfa94f0342" - integrity sha512-mFNylyeyqN93lfe/9CSxOGREz8cpzAhH+E93xJ4xWQf62V8sQ/24reV2nyzUWM6H6Xji+GGHpkbLe7pVoUEskg== - dependencies: - "@types/node" "*" - -"@types/estree@^1.0.6": - version "1.0.8" - resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" - integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== - -"@types/express-serve-static-core@^5.0.0": - version "5.1.1" - resolved "https://registry.yarnpkg.com/@types/express-serve-static-core/-/express-serve-static-core-5.1.1.tgz#1a77faffee9572d39124933259be2523837d7eaa" - integrity sha512-v4zIMr/cX7/d2BpAEX3KNKL/JrT1s43s96lLvvdTmza1oEvDudCqK9aF/djc/SWgy8Yh0h30TZx5VpzqFCxk5A== - dependencies: - "@types/node" "*" - "@types/qs" "*" - "@types/range-parser" "*" - "@types/send" "*" - -"@types/express@^5.0.3": - version "5.0.6" - resolved "https://registry.yarnpkg.com/@types/express/-/express-5.0.6.tgz#2d724b2c990dcb8c8444063f3580a903f6d500cc" - integrity sha512-sKYVuV7Sv9fbPIt/442koC7+IIwK5olP1KWeD88e/idgoJqDm3JV/YUiPwkoKK92ylff2MGxSz1CSjsXelx0YA== - dependencies: - "@types/body-parser" "*" - "@types/express-serve-static-core" "^5.0.0" - "@types/serve-static" "^2" - -"@types/graceful-fs@^4.1.3": - version "4.1.9" - resolved "https://registry.yarnpkg.com/@types/graceful-fs/-/graceful-fs-4.1.9.tgz#2a06bc0f68a20ab37b3e36aa238be6abdf49e8b4" - integrity sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ== - dependencies: - "@types/node" "*" - -"@types/http-errors@*": - version "2.0.5" - resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.5.tgz#5b749ab2b16ba113423feb1a64a95dcd30398472" - integrity sha512-r8Tayk8HJnX0FztbZN7oVqGccWgw98T/0neJphO91KkmOzug1KkofZURD4UaD5uH8AqcFLfdPErnBod0u71/qg== - -"@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0", "@types/istanbul-lib-coverage@^2.0.1": - version "2.0.6" - resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz#7739c232a1fee9b4d3ce8985f314c0c6d33549d7" - integrity sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w== - -"@types/istanbul-lib-report@*": - version "3.0.3" - resolved "https://registry.yarnpkg.com/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz#53047614ae72e19fc0401d872de3ae2b4ce350bf" - integrity sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA== - dependencies: - "@types/istanbul-lib-coverage" "*" - -"@types/istanbul-reports@^3.0.0": - version "3.0.4" - resolved "https://registry.yarnpkg.com/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz#0f03e3d2f670fbdac586e34b433783070cc16f54" - integrity sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ== - dependencies: - "@types/istanbul-lib-report" "*" - -"@types/jest@^29.4.0": - version "29.5.14" - resolved "https://registry.yarnpkg.com/@types/jest/-/jest-29.5.14.tgz#2b910912fa1d6856cadcd0c1f95af7df1d6049e5" - integrity sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ== - dependencies: - expect "^29.0.0" - pretty-format "^29.0.0" - -"@types/json-schema@^7.0.15": - version "7.0.15" - resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.15.tgz#596a1747233694d50f6ad8a7869fcb6f56cf5841" - integrity sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA== - -"@types/mute-stream@^0.0.4": - version "0.0.4" - resolved "https://registry.yarnpkg.com/@types/mute-stream/-/mute-stream-0.0.4.tgz#77208e56a08767af6c5e1237be8888e2f255c478" - integrity sha512-CPM9nzrCPPJHQNA9keH9CVkVI+WR5kMa+7XEs5jcGQ0VoAGnLv242w8lIVgwAEfmE4oufJRaTc9PNLQl0ioAow== - dependencies: - "@types/node" "*" - -"@types/node@*": - version "25.0.8" - resolved "https://registry.yarnpkg.com/@types/node/-/node-25.0.8.tgz#e54e00f94fe1db2497b3e42d292b8376a2678c8d" - integrity sha512-powIePYMmC3ibL0UJ2i2s0WIbq6cg6UyVFQxSCpaPxxzAaziRfimGivjdF943sSGV6RADVbk0Nvlm5P/FB44Zg== - dependencies: - undici-types "~7.16.0" - -"@types/node@^22.5.5": - version "22.19.6" - resolved "https://registry.yarnpkg.com/@types/node/-/node-22.19.6.tgz#0e9d80ebcd2dfce03265768c17a1212d4eb07e82" - integrity sha512-qm+G8HuG6hOHQigsi7VGuLjUVu6TtBo/F05zvX04Mw2uCg9Dv0Qxy3Qw7j41SidlTcl5D/5yg0SEZqOB+EqZnQ== - dependencies: - undici-types "~6.21.0" - -"@types/qs@*", "@types/qs@^6.14.0": - version "6.14.0" - resolved "https://registry.yarnpkg.com/@types/qs/-/qs-6.14.0.tgz#d8b60cecf62f2db0fb68e5e006077b9178b85de5" - integrity sha512-eOunJqu0K1923aExK6y8p6fsihYEn/BYuQ4g0CxAAgFc4b/ZLN4CrsRZ55srTdqoiLzU2B2evC+apEIxprEzkQ== - -"@types/range-parser@*": - version "1.2.7" - resolved "https://registry.yarnpkg.com/@types/range-parser/-/range-parser-1.2.7.tgz#50ae4353eaaddc04044279812f52c8c65857dbcb" - integrity sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ== - -"@types/send@*": - version "1.2.1" - resolved "https://registry.yarnpkg.com/@types/send/-/send-1.2.1.tgz#6a784e45543c18c774c049bff6d3dbaf045c9c74" - integrity sha512-arsCikDvlU99zl1g69TcAB3mzZPpxgw0UQnaHeC1Nwb015xp8bknZv5rIfri9xTOcMuaVgvabfIRA7PSZVuZIQ== - dependencies: - "@types/node" "*" - -"@types/serve-static@^2": - version "2.2.0" - resolved "https://registry.yarnpkg.com/@types/serve-static/-/serve-static-2.2.0.tgz#d4a447503ead0d1671132d1ab6bd58b805d8de6a" - integrity sha512-8mam4H1NHLtu7nmtalF7eyBH14QyOASmcxHhSfEoRyr0nP/YdoesEtU+uSRvMe96TW/HPTtkoKqQLl53N7UXMQ== - dependencies: - "@types/http-errors" "*" - "@types/node" "*" - -"@types/stack-utils@^2.0.0": - version "2.0.3" - resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.3.tgz#6209321eb2c1712a7e7466422b8cb1fc0d9dd5d8" - integrity sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw== - -"@types/wrap-ansi@^3.0.0": - version "3.0.0" - resolved "https://registry.yarnpkg.com/@types/wrap-ansi/-/wrap-ansi-3.0.0.tgz#18b97a972f94f60a679fd5c796d96421b9abb9fd" - integrity sha512-ltIpx+kM7g/MLRZfkbL7EsCEjfzCcScLpkg37eXEtx5kmrAKBkTJwd1GIAjDSL8wTpM6Hzn5YO4pSb91BEwu1g== - -"@types/yargs-parser@*": - version "21.0.3" - resolved "https://registry.yarnpkg.com/@types/yargs-parser/-/yargs-parser-21.0.3.tgz#815e30b786d2e8f0dcd85fd5bcf5e1a04d008f15" - integrity sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ== - -"@types/yargs@^17.0.8": - version "17.0.35" - resolved "https://registry.yarnpkg.com/@types/yargs/-/yargs-17.0.35.tgz#07013e46aa4d7d7d50a49e15604c1c5340d4eb24" - integrity sha512-qUHkeCyQFxMXg79wQfTtfndEC+N9ZZg76HJftDJp+qH2tV7Gj4OJi7l+PiWwJ+pWtW8GwSmqsDj/oymhrTWXjg== - dependencies: - "@types/yargs-parser" "*" - -"@typescript-eslint/eslint-plugin@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.31.1.tgz#62f1befe59647524994e89de4516d8dcba7a850a" - integrity sha512-oUlH4h1ABavI4F0Xnl8/fOtML/eu8nI2A1nYd+f+55XI0BLu+RIqKoCiZKNo6DtqZBEQm5aNKA20G3Z5w3R6GQ== - dependencies: - "@eslint-community/regexpp" "^4.10.0" - "@typescript-eslint/scope-manager" "8.31.1" - "@typescript-eslint/type-utils" "8.31.1" - "@typescript-eslint/utils" "8.31.1" - "@typescript-eslint/visitor-keys" "8.31.1" - graphemer "^1.4.0" - ignore "^5.3.1" - natural-compare "^1.4.0" - ts-api-utils "^2.0.1" - -"@typescript-eslint/parser@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-8.31.1.tgz#e9b0ccf30d37dde724ee4d15f4dbc195995cce1b" - integrity sha512-oU/OtYVydhXnumd0BobL9rkJg7wFJ9bFFPmSmB/bf/XWN85hlViji59ko6bSKBXyseT9V8l+CN1nwmlbiN0G7Q== - dependencies: - "@typescript-eslint/scope-manager" "8.31.1" - "@typescript-eslint/types" "8.31.1" - "@typescript-eslint/typescript-estree" "8.31.1" - "@typescript-eslint/visitor-keys" "8.31.1" - debug "^4.3.4" - -"@typescript-eslint/scope-manager@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-8.31.1.tgz#1eb52e76878f545e4add142e0d8e3e97e7aa443b" - integrity sha512-BMNLOElPxrtNQMIsFHE+3P0Yf1z0dJqV9zLdDxN/xLlWMlXK/ApEsVEKzpizg9oal8bAT5Sc7+ocal7AC1HCVw== - dependencies: - "@typescript-eslint/types" "8.31.1" - "@typescript-eslint/visitor-keys" "8.31.1" - -"@typescript-eslint/type-utils@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-8.31.1.tgz#be0f438fb24b03568e282a0aed85f776409f970c" - integrity sha512-fNaT/m9n0+dpSp8G/iOQ05GoHYXbxw81x+yvr7TArTuZuCA6VVKbqWYVZrV5dVagpDTtj/O8k5HBEE/p/HM5LA== - dependencies: - "@typescript-eslint/typescript-estree" "8.31.1" - "@typescript-eslint/utils" "8.31.1" - debug "^4.3.4" - ts-api-utils "^2.0.1" - -"@typescript-eslint/types@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-8.31.1.tgz#478ed6f7e8aee1be7b63a60212b6bffe1423b5d4" - integrity sha512-SfepaEFUDQYRoA70DD9GtytljBePSj17qPxFHA/h3eg6lPTqGJ5mWOtbXCk1YrVU1cTJRd14nhaXWFu0l2troQ== - -"@typescript-eslint/typescript-estree@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-8.31.1.tgz#37792fe7ef4d3021c7580067c8f1ae66daabacdf" - integrity sha512-kaA0ueLe2v7KunYOyWYtlf/QhhZb7+qh4Yw6Ni5kgukMIG+iP773tjgBiLWIXYumWCwEq3nLW+TUywEp8uEeag== - dependencies: - "@typescript-eslint/types" "8.31.1" - "@typescript-eslint/visitor-keys" "8.31.1" - debug "^4.3.4" - fast-glob "^3.3.2" - is-glob "^4.0.3" - minimatch "^9.0.4" - semver "^7.6.0" - ts-api-utils "^2.0.1" - -"@typescript-eslint/utils@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.31.1.tgz#5628ea0393598a0b2f143d0fc6d019f0dee9dd14" - integrity sha512-2DSI4SNfF5T4oRveQ4nUrSjUqjMND0nLq9rEkz0gfGr3tg0S5KB6DhwR+WZPCjzkZl3cH+4x2ce3EsL50FubjQ== - dependencies: - "@eslint-community/eslint-utils" "^4.4.0" - "@typescript-eslint/scope-manager" "8.31.1" - "@typescript-eslint/types" "8.31.1" - "@typescript-eslint/typescript-estree" "8.31.1" - -"@typescript-eslint/visitor-keys@8.31.1": - version "8.31.1" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-8.31.1.tgz#6742b0e3ba1e0c1e35bdaf78c03e759eb8dd8e75" - integrity sha512-I+/rgqOVBn6f0o7NDTmAPWWC6NuqhV174lfYvAm9fUaWeiefLdux9/YI3/nLugEn9L8fcSi0XmpKi/r5u0nmpw== - dependencies: - "@typescript-eslint/types" "8.31.1" - eslint-visitor-keys "^4.2.0" - -"@valtown/deno-http-worker@^0.0.21": - version "0.0.21" - resolved "https://registry.yarnpkg.com/@valtown/deno-http-worker/-/deno-http-worker-0.0.21.tgz#9ce3b5c1d0db211fe7ea8297881fe551838474ad" - integrity sha512-16kFuUykann75lNytnXXIQlmpzreZjzdyT27ebT3yNGCS3kKaS1iZYWHc3Si9An54Cphwr4qEcviChQkEeJBlA== - -accepts@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/accepts/-/accepts-2.0.0.tgz#bbcf4ba5075467f3f2131eab3cffc73c2f5d7895" - integrity sha512-5cvg6CtKwfgdmVqY1WIiXKc3Q1bkRqGLi+2W/6ao+6Y7gu/RCwRuAhGEzh5B4KlszSuTLgZYuqFqo5bImjNKng== - dependencies: - mime-types "^3.0.0" - negotiator "^1.0.0" - -acorn-jsx@^5.3.2: - version "5.3.2" - resolved "https://registry.yarnpkg.com/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" - integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== - -acorn-walk@^8.1.1: - version "8.3.4" - resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7" - integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g== - dependencies: - acorn "^8.11.0" - -acorn@^8.11.0, acorn@^8.4.1: - version "8.15.0" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816" - integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg== - -acorn@^8.15.0: - version "8.16.0" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.16.0.tgz#4ce79c89be40afe7afe8f3adb902a1f1ce9ac08a" - integrity sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw== - -aggregate-error@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" - integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== - dependencies: - clean-stack "^2.0.0" - indent-string "^4.0.0" - -ajv-formats@^3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/ajv-formats/-/ajv-formats-3.0.1.tgz#3d5dc762bca17679c3c2ea7e90ad6b7532309578" - integrity sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ== - dependencies: - ajv "^8.0.0" - -ajv@^6.14.0: - version "6.14.0" - resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.14.0.tgz#fd067713e228210636ebb08c60bd3765d6dbe73a" - integrity sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw== - dependencies: - fast-deep-equal "^3.1.1" - fast-json-stable-stringify "^2.0.0" - json-schema-traverse "^0.4.1" - uri-js "^4.2.2" - -ajv@^8.0.0, ajv@^8.17.1: - version "8.17.1" - resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.17.1.tgz#37d9a5c776af6bc92d7f4f9510eba4c0a60d11a6" - integrity sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g== - dependencies: - fast-deep-equal "^3.1.3" - fast-uri "^3.0.1" - json-schema-traverse "^1.0.0" - require-from-string "^2.0.2" - -ajv@^8.18.0: - version "8.18.0" - resolved "https://registry.yarnpkg.com/ajv/-/ajv-8.18.0.tgz#8864186b6738d003eb3a933172bb3833e10cefbc" - integrity sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A== - dependencies: - fast-deep-equal "^3.1.3" - fast-uri "^3.0.1" - json-schema-traverse "^1.0.0" - require-from-string "^2.0.2" - -ansi-escapes@^4.2.1, ansi-escapes@^4.3.2: - version "4.3.2" - resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" - integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== - dependencies: - type-fest "^0.21.3" - -ansi-regex@^5.0.1: - version "5.0.1" - resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" - integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== - -ansi-styles@^4.0.0, ansi-styles@^4.1.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" - integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== - dependencies: - color-convert "^2.0.1" - -ansi-styles@^5.0.0: - version "5.2.0" - resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-5.2.0.tgz#07449690ad45777d1924ac2abb2fc8895dba836b" - integrity sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA== - -anymatch@^3.0.3: - version "3.1.3" - resolved "https://registry.yarnpkg.com/anymatch/-/anymatch-3.1.3.tgz#790c58b19ba1720a84205b57c618d5ad8524973e" - integrity sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw== - dependencies: - normalize-path "^3.0.0" - picomatch "^2.0.4" - -arg@^4.1.0: - version "4.1.3" - resolved "https://registry.yarnpkg.com/arg/-/arg-4.1.3.tgz#269fc7ad5b8e42cb63c896d5666017261c144089" - integrity sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA== - -argparse@^1.0.7: - version "1.0.10" - resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" - integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== - dependencies: - sprintf-js "~1.0.2" - -argparse@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" - integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== - -atomic-sleep@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/atomic-sleep/-/atomic-sleep-1.0.0.tgz#eb85b77a601fc932cfe432c5acd364a9e2c9075b" - integrity sha512-kNOjDqAh7px0XWNI+4QbzoiR/nTkHAWNud2uvnJquD1/x5a7EQZMJT0AczqK0Qn67oY/TTQ1LbUKajZpp3I9tQ== - -babel-jest@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/babel-jest/-/babel-jest-29.7.0.tgz#f4369919225b684c56085998ac63dbd05be020d5" - integrity sha512-BrvGY3xZSwEcCzKvKsCi2GgHqDqsYkOP4/by5xCgIwGXQxIEh+8ew3gmrE1y7XRR6LHZIj6yLYnUi/mm2KXKBg== - dependencies: - "@jest/transform" "^29.7.0" - "@types/babel__core" "^7.1.14" - babel-plugin-istanbul "^6.1.1" - babel-preset-jest "^29.6.3" - chalk "^4.0.0" - graceful-fs "^4.2.9" - slash "^3.0.0" - -babel-plugin-istanbul@^6.1.1: - version "6.1.1" - resolved "https://registry.yarnpkg.com/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz#fa88ec59232fd9b4e36dbbc540a8ec9a9b47da73" - integrity sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA== - dependencies: - "@babel/helper-plugin-utils" "^7.0.0" - "@istanbuljs/load-nyc-config" "^1.0.0" - "@istanbuljs/schema" "^0.1.2" - istanbul-lib-instrument "^5.0.4" - test-exclude "^6.0.0" - -babel-plugin-jest-hoist@^29.6.3: - version "29.6.3" - resolved "https://registry.yarnpkg.com/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-29.6.3.tgz#aadbe943464182a8922c3c927c3067ff40d24626" - integrity sha512-ESAc/RJvGTFEzRwOTT4+lNDk/GNHMkKbNzsvT0qKRfDyyYTskxB5rnU2njIDYVxXCBHHEI1c0YwHob3WaYujOg== - dependencies: - "@babel/template" "^7.3.3" - "@babel/types" "^7.3.3" - "@types/babel__core" "^7.1.14" - "@types/babel__traverse" "^7.0.6" - -babel-preset-current-node-syntax@^1.0.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz#20730d6cdc7dda5d89401cab10ac6a32067acde6" - integrity sha512-E/VlAEzRrsLEb2+dv8yp3bo4scof3l9nR4lrld+Iy5NyVqgVYUJnDAmunkhPMisRI32Qc4iRiz425d8vM++2fg== - dependencies: - "@babel/plugin-syntax-async-generators" "^7.8.4" - "@babel/plugin-syntax-bigint" "^7.8.3" - "@babel/plugin-syntax-class-properties" "^7.12.13" - "@babel/plugin-syntax-class-static-block" "^7.14.5" - "@babel/plugin-syntax-import-attributes" "^7.24.7" - "@babel/plugin-syntax-import-meta" "^7.10.4" - "@babel/plugin-syntax-json-strings" "^7.8.3" - "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" - "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.3" - "@babel/plugin-syntax-numeric-separator" "^7.10.4" - "@babel/plugin-syntax-object-rest-spread" "^7.8.3" - "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" - "@babel/plugin-syntax-optional-chaining" "^7.8.3" - "@babel/plugin-syntax-private-property-in-object" "^7.14.5" - "@babel/plugin-syntax-top-level-await" "^7.14.5" - -babel-preset-jest@^29.6.3: - version "29.6.3" - resolved "https://registry.yarnpkg.com/babel-preset-jest/-/babel-preset-jest-29.6.3.tgz#fa05fa510e7d493896d7b0dd2033601c840f171c" - integrity sha512-0B3bhxR6snWXJZtR/RliHTDPRgn1sNHOR0yVtq/IiQFyuOVjFS+wuio/R4gSNkyYmKmJB4wGZv2NZanmKmTnNA== - dependencies: - babel-plugin-jest-hoist "^29.6.3" - babel-preset-current-node-syntax "^1.0.0" - -balanced-match@^1.0.0: - version "1.0.2" - resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" - integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== - -baseline-browser-mapping@^2.9.0: - version "2.9.14" - resolved "https://registry.yarnpkg.com/baseline-browser-mapping/-/baseline-browser-mapping-2.9.14.tgz#3b6af0bc032445bca04de58caa9a87cfe921cbb3" - integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg== - -body-parser@^2.2.1: - version "2.2.2" - resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-2.2.2.tgz#1a32cdb966beaf68de50a9dfbe5b58f83cb8890c" - integrity sha512-oP5VkATKlNwcgvxi0vM0p/D3n2C3EReYVX+DNYs5TjZFn/oQt2j+4sVJtSMr18pdRr8wjTcBl6LoV+FUwzPmNA== - dependencies: - bytes "^3.1.2" - content-type "^1.0.5" - debug "^4.4.3" - http-errors "^2.0.0" - iconv-lite "^0.7.0" - on-finished "^2.4.1" - qs "^6.14.1" - raw-body "^3.0.1" - type-is "^2.0.1" - -brace-expansion@^1.1.7: - version "1.1.12" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.12.tgz#ab9b454466e5a8cc3a187beaad580412a9c5b843" - integrity sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg== - dependencies: - balanced-match "^1.0.0" - concat-map "0.0.1" - -brace-expansion@^2.0.1: - version "2.0.2" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" - integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== - dependencies: - balanced-match "^1.0.0" - -braces@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.3.tgz#490332f40919452272d55a8480adc0c441358789" - integrity sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA== - dependencies: - fill-range "^7.1.1" - -browserslist@^4.24.0: - version "4.28.1" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.28.1.tgz#7f534594628c53c63101079e27e40de490456a95" - integrity sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA== - dependencies: - baseline-browser-mapping "^2.9.0" - caniuse-lite "^1.0.30001759" - electron-to-chromium "^1.5.263" - node-releases "^2.0.27" - update-browserslist-db "^1.2.0" - -bs-logger@^0.2.6: - version "0.2.6" - resolved "https://registry.yarnpkg.com/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8" - integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog== - dependencies: - fast-json-stable-stringify "2.x" - -bser@2.1.1: - version "2.1.1" - resolved "https://registry.yarnpkg.com/bser/-/bser-2.1.1.tgz#e6787da20ece9d07998533cfd9de6f5c38f4bc05" - integrity sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ== - dependencies: - node-int64 "^0.4.0" - -buffer-from@^1.0.0: - version "1.1.2" - resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" - integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== - -bytes@^3.1.2, bytes@~3.1.2: - version "3.1.2" - resolved "https://registry.yarnpkg.com/bytes/-/bytes-3.1.2.tgz#8b0beeb98605adf1b128fa4386403c009e0221a5" - integrity sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg== - -call-bind-apply-helpers@^1.0.1, call-bind-apply-helpers@^1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz#4b5428c222be985d79c3d82657479dbe0b59b2d6" - integrity sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ== - dependencies: - es-errors "^1.3.0" - function-bind "^1.1.2" - -call-bound@^1.0.2: - version "1.0.4" - resolved "https://registry.yarnpkg.com/call-bound/-/call-bound-1.0.4.tgz#238de935d2a2a692928c538c7ccfa91067fd062a" - integrity sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg== - dependencies: - call-bind-apply-helpers "^1.0.2" - get-intrinsic "^1.3.0" - -callsites@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" - integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== - -camelcase@^5.3.1: - version "5.3.1" - resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" - integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== - -camelcase@^6.2.0: - version "6.3.0" - resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" - integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== - -caniuse-lite@^1.0.30001759: - version "1.0.30001764" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001764.tgz#03206c56469f236103b90f9ae10bcb8b9e1f6005" - integrity sha512-9JGuzl2M+vPL+pz70gtMF9sHdMFbY9FJaQBi186cHKH3pSzDvzoUJUPV6fqiKIMyXbud9ZLg4F3Yza1vJ1+93g== - -chalk@^4.0.0: - version "4.1.2" - resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" - integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== - dependencies: - ansi-styles "^4.1.0" - supports-color "^7.1.0" - -char-regex@^1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" - integrity sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw== - -chardet@^0.7.0: - version "0.7.0" - resolved "https://registry.yarnpkg.com/chardet/-/chardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e" - integrity sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA== - -ci-info@^3.2.0: - version "3.9.0" - resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-3.9.0.tgz#4279a62028a7b1f262f3473fc9605f5e218c59b4" - integrity sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ== - -cjs-module-lexer@^1.0.0: - version "1.4.3" - resolved "https://registry.yarnpkg.com/cjs-module-lexer/-/cjs-module-lexer-1.4.3.tgz#0f79731eb8cfe1ec72acd4066efac9d61991b00d" - integrity sha512-9z8TZaGM1pfswYeXrUpzPrkx8UnWYdhJclsiYMm6x/w5+nN+8Tf/LnAgfLGQCm59qAOxU8WwHEq2vNwF6i4j+Q== - -clean-stack@^2.0.0: - version "2.2.0" - resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" - integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== - -cli-width@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/cli-width/-/cli-width-4.1.0.tgz#42daac41d3c254ef38ad8ac037672130173691c5" - integrity sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ== - -cliui@^8.0.1: - version "8.0.1" - resolved "https://registry.yarnpkg.com/cliui/-/cliui-8.0.1.tgz#0c04b075db02cbfe60dc8e6cf2f5486b1a3608aa" - integrity sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ== - dependencies: - string-width "^4.2.0" - strip-ansi "^6.0.1" - wrap-ansi "^7.0.0" - -co@^4.6.0: - version "4.6.0" - resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184" - integrity sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ== - -code-block-writer@^12.0.0: - version "12.0.0" - resolved "https://registry.yarnpkg.com/code-block-writer/-/code-block-writer-12.0.0.tgz#4dd58946eb4234105aff7f0035977b2afdc2a770" - integrity sha512-q4dMFMlXtKR3XNBHyMHt/3pwYNA69EDk00lloMOaaUMKPUXBw6lpXtbu3MMVG6/uOihGnRDOlkyqsONEUj60+w== - -collect-v8-coverage@^1.0.0: - version "1.0.3" - resolved "https://registry.yarnpkg.com/collect-v8-coverage/-/collect-v8-coverage-1.0.3.tgz#cc1f01eb8d02298cbc9a437c74c70ab4e5210b80" - integrity sha512-1L5aqIkwPfiodaMgQunkF1zRhNqifHBmtbbbxcr6yVxxBnliw4TDOW6NxpO8DJLgJ16OT+Y4ztZqP6p/FtXnAw== - -color-convert@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" - integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== - dependencies: - color-name "~1.1.4" - -color-name@~1.1.4: - version "1.1.4" - resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" - integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== - -colorette@^2.0.7: - version "2.0.20" - resolved "https://registry.yarnpkg.com/colorette/-/colorette-2.0.20.tgz#9eb793e6833067f7235902fcd3b09917a000a95a" - integrity sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w== - -commander@^13.1.0: - version "13.1.0" - resolved "https://registry.yarnpkg.com/commander/-/commander-13.1.0.tgz#776167db68c78f38dcce1f9b8d7b8b9a488abf46" - integrity sha512-/rFeCpNJQbhSZjGVwO9RFV3xPqbnERS8MmIQzCtD/zl6gpJuV/bMLuN92oG3F7d8oDEHHRrujSXNUr8fpjntKw== - -concat-map@0.0.1: - version "0.0.1" - resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" - integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg== - -content-disposition@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/content-disposition/-/content-disposition-1.0.1.tgz#a8b7bbeb2904befdfb6787e5c0c086959f605f9b" - integrity sha512-oIXISMynqSqm241k6kcQ5UwttDILMK4BiurCfGEREw6+X9jkkpEe5T9FZaApyLGGOnFuyMWZpdolTXMtvEJ08Q== - -content-type@^1.0.5: - version "1.0.5" - resolved "https://registry.yarnpkg.com/content-type/-/content-type-1.0.5.tgz#8b773162656d1d1086784c8f23a54ce6d73d7918" - integrity sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA== - -convert-source-map@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/convert-source-map/-/convert-source-map-2.0.0.tgz#4b560f649fc4e918dd0ab75cf4961e8bc882d82a" - integrity sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg== - -cookie-parser@^1.4.6: - version "1.4.7" - resolved "https://registry.yarnpkg.com/cookie-parser/-/cookie-parser-1.4.7.tgz#e2125635dfd766888ffe90d60c286404fa0e7b26" - integrity sha512-nGUvgXnotP3BsjiLX2ypbQnWoGUPIIfHQNZkkC668ntrzGWEZVW70HDEB1qnNGMicPje6EttlIgzo51YSwNQGw== - dependencies: - cookie "0.7.2" - cookie-signature "1.0.6" - -cookie-signature@1.0.6: - version "1.0.6" - resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.0.6.tgz#e303a882b342cc3ee8ca513a79999734dab3ae2c" - integrity sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ== - -cookie-signature@^1.2.1: - version "1.2.2" - resolved "https://registry.yarnpkg.com/cookie-signature/-/cookie-signature-1.2.2.tgz#57c7fc3cc293acab9fec54d73e15690ebe4a1793" - integrity sha512-D76uU73ulSXrD1UXF4KE2TMxVVwhsnCgfAyTg9k8P6KGZjlXKrOLe4dJQKI3Bxi5wjesZoFXJWElNWBjPZMbhg== - -cookie@0.7.2, cookie@^0.7.1: - version "0.7.2" - resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.7.2.tgz#556369c472a2ba910f2979891b526b3436237ed7" - integrity sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w== - -cors@^2.8.5: - version "2.8.5" - resolved "https://registry.yarnpkg.com/cors/-/cors-2.8.5.tgz#eac11da51592dd86b9f06f6e7ac293b3df875d29" - integrity sha512-KIHbLJqu73RGr/hnbrO9uBeixNGuvSQjul/jdFvS/KFSIH1hWVd1ng7zOHx+YrEfInLG7q4n6GHQ9cDtxv/P6g== - dependencies: - object-assign "^4" - vary "^1" - -create-jest@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/create-jest/-/create-jest-29.7.0.tgz#a355c5b3cb1e1af02ba177fe7afd7feee49a5320" - integrity sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q== - dependencies: - "@jest/types" "^29.6.3" - chalk "^4.0.0" - exit "^0.1.2" - graceful-fs "^4.2.9" - jest-config "^29.7.0" - jest-util "^29.7.0" - prompts "^2.0.1" - -create-require@^1.1.0: - version "1.1.1" - resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333" - integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ== - -cross-spawn@^7.0.3, cross-spawn@^7.0.5, cross-spawn@^7.0.6: - version "7.0.6" - resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f" - integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA== - dependencies: - path-key "^3.1.0" - shebang-command "^2.0.0" - which "^2.0.1" - -dateformat@^4.6.3: - version "4.6.3" - resolved "https://registry.yarnpkg.com/dateformat/-/dateformat-4.6.3.tgz#556fa6497e5217fedb78821424f8a1c22fa3f4b5" - integrity sha512-2P0p0pFGzHS5EMnhdxQi7aJN+iMheud0UhG4dlE1DLAlvL8JHjJJTX/CSm4JXwV0Ka5nGk3zC5mcb5bUQUxxMA== - -debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4, debug@^4.3.7, debug@^4.4.0, debug@^4.4.3: - version "4.4.3" - resolved "https://registry.yarnpkg.com/debug/-/debug-4.4.3.tgz#c6ae432d9bd9662582fce08709b038c58e9e3d6a" - integrity sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA== - dependencies: - ms "^2.1.3" - -dedent@^1.0.0: - version "1.7.1" - resolved "https://registry.yarnpkg.com/dedent/-/dedent-1.7.1.tgz#364661eea3d73f3faba7089214420ec2f8f13e15" - integrity sha512-9JmrhGZpOlEgOLdQgSm0zxFaYoQon408V1v49aqTWuXENVlnCuY9JBZcXZiCsZQWDjTm5Qf/nIvAy77mXDAjEg== - -deep-is@^0.1.3: - version "0.1.4" - resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.4.tgz#a6f2dce612fadd2ef1f519b73551f17e85199831" - integrity sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ== - -deepmerge@^4.2.2: - version "4.3.1" - resolved "https://registry.yarnpkg.com/deepmerge/-/deepmerge-4.3.1.tgz#44b5f2147cd3b00d4b56137685966f26fd25dd4a" - integrity sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A== - -depd@^2.0.0, depd@~2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/depd/-/depd-2.0.0.tgz#b696163cc757560d09cf22cc8fad1571b79e76df" - integrity sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw== - -detect-newline@^3.0.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/detect-newline/-/detect-newline-3.1.0.tgz#576f5dfc63ae1a192ff192d8ad3af6308991b651" - integrity sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA== - -diff-sequences@^29.6.3: - version "29.6.3" - resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-29.6.3.tgz#4deaf894d11407c51efc8418012f9e70b84ea921" - integrity sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q== - -diff@^4.0.1: - version "4.0.2" - resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d" - integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A== - -dunder-proto@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/dunder-proto/-/dunder-proto-1.0.1.tgz#d7ae667e1dc83482f8b70fd0f6eefc50da30f58a" - integrity sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A== - dependencies: - call-bind-apply-helpers "^1.0.1" - es-errors "^1.3.0" - gopd "^1.2.0" - -ee-first@1.1.1: - version "1.1.1" - resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" - integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== - -electron-to-chromium@^1.5.263: - version "1.5.267" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.267.tgz#5d84f2df8cdb6bfe7e873706bb21bd4bfb574dc7" - integrity sha512-0Drusm6MVRXSOJpGbaSVgcQsuB4hEkMpHXaVstcPmhu5LIedxs1xNK/nIxmQIU/RPC0+1/o0AVZfBTkTNJOdUw== - -emittery@^0.13.1: - version "0.13.1" - resolved "https://registry.yarnpkg.com/emittery/-/emittery-0.13.1.tgz#c04b8c3457490e0847ae51fced3af52d338e3dad" - integrity sha512-DeWwawk6r5yR9jFgnDKYt4sLS0LmHJJi3ZOnb5/JdbYwj3nW+FxQnHIjhBKz8YLC7oRNPVM9NQ47I3CVx34eqQ== - -emoji-regex@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" - integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== - -encodeurl@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" - integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== - -end-of-stream@^1.1.0: - version "1.4.5" - resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.5.tgz#7344d711dea40e0b74abc2ed49778743ccedb08c" - integrity sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg== - dependencies: - once "^1.4.0" - -error-ex@^1.3.1: - version "1.3.4" - resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" - integrity sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ== - dependencies: - is-arrayish "^0.2.1" - -es-define-property@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/es-define-property/-/es-define-property-1.0.1.tgz#983eb2f9a6724e9303f61addf011c72e09e0b0fa" - integrity sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g== - -es-errors@^1.3.0: - version "1.3.0" - resolved "https://registry.yarnpkg.com/es-errors/-/es-errors-1.3.0.tgz#05f75a25dab98e4fb1dcd5e1472c0546d5057c8f" - integrity sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw== - -es-object-atoms@^1.0.0, es-object-atoms@^1.1.1: - version "1.1.1" - resolved "https://registry.yarnpkg.com/es-object-atoms/-/es-object-atoms-1.1.1.tgz#1c4f2c4837327597ce69d2ca190a7fdd172338c1" - integrity sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA== - dependencies: - es-errors "^1.3.0" - -escalade@^3.1.1, escalade@^3.2.0: - version "3.2.0" - resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.2.0.tgz#011a3f69856ba189dffa7dc8fcce99d2a87903e5" - integrity sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA== - -escape-html@^1.0.3: - version "1.0.3" - resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988" - integrity sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow== - -escape-string-regexp@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz#a30304e99daa32e23b2fd20f51babd07cffca344" - integrity sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w== - -escape-string-regexp@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" - integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== - -eslint-plugin-prettier@^5.4.1: - version "5.5.5" - resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-5.5.5.tgz#9eae11593faa108859c26f9a9c367d619a0769c0" - integrity sha512-hscXkbqUZ2sPithAuLm5MXL+Wph+U7wHngPBv9OMWwlP8iaflyxpjTYZkmdgB4/vPIhemRlBEoLrH7UC1n7aUw== - dependencies: - prettier-linter-helpers "^1.0.1" - synckit "^0.11.12" - -eslint-plugin-unused-imports@^4.1.4: - version "4.4.1" - resolved "https://registry.yarnpkg.com/eslint-plugin-unused-imports/-/eslint-plugin-unused-imports-4.4.1.tgz#a831f0a2937d7631eba30cb87091ab7d3a5da0e1" - integrity sha512-oZGYUz1X3sRMGUB+0cZyK2VcvRX5lm/vB56PgNNcU+7ficUCKm66oZWKUubXWnOuPjQ8PvmXtCViXBMONPe7tQ== - -eslint-scope@^8.4.0: - version "8.4.0" - resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-8.4.0.tgz#88e646a207fad61436ffa39eb505147200655c82" - integrity sha512-sNXOfKCn74rt8RICKMvJS7XKV/Xk9kA7DyJr8mJik3S7Cwgy3qlkkmyS2uQB3jiJg6VNdZd/pDBJu0nvG2NlTg== - dependencies: - esrecurse "^4.3.0" - estraverse "^5.2.0" - -eslint-visitor-keys@^3.4.3: - version "3.4.3" - resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz#0cd72fe8550e3c2eae156a96a4dddcd1c8ac5800" - integrity sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag== - -eslint-visitor-keys@^4.2.0, eslint-visitor-keys@^4.2.1: - version "4.2.1" - resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-4.2.1.tgz#4cfea60fe7dd0ad8e816e1ed026c1d5251b512c1" - integrity sha512-Uhdk5sfqcee/9H/rCOJikYz67o0a2Tw2hGRPOG2Y1R2dg7brRe1uG0yaNQDHu+TO/uQPF/5eCapvYSmHUjt7JQ== - -eslint@^9.39.1: - version "9.39.4" - resolved "https://registry.yarnpkg.com/eslint/-/eslint-9.39.4.tgz#855da1b2e2ad66dc5991195f35e262bcec8117b5" - integrity sha512-XoMjdBOwe/esVgEvLmNsD3IRHkm7fbKIUGvrleloJXUZgDHig2IPWNniv+GwjyJXzuNqVjlr5+4yVUZjycJwfQ== - dependencies: - "@eslint-community/eslint-utils" "^4.8.0" - "@eslint-community/regexpp" "^4.12.1" - "@eslint/config-array" "^0.21.2" - "@eslint/config-helpers" "^0.4.2" - "@eslint/core" "^0.17.0" - "@eslint/eslintrc" "^3.3.5" - "@eslint/js" "9.39.4" - "@eslint/plugin-kit" "^0.4.1" - "@humanfs/node" "^0.16.6" - "@humanwhocodes/module-importer" "^1.0.1" - "@humanwhocodes/retry" "^0.4.2" - "@types/estree" "^1.0.6" - ajv "^6.14.0" - chalk "^4.0.0" - cross-spawn "^7.0.6" - debug "^4.3.2" - escape-string-regexp "^4.0.0" - eslint-scope "^8.4.0" - eslint-visitor-keys "^4.2.1" - espree "^10.4.0" - esquery "^1.5.0" - esutils "^2.0.2" - fast-deep-equal "^3.1.3" - file-entry-cache "^8.0.0" - find-up "^5.0.0" - glob-parent "^6.0.2" - ignore "^5.2.0" - imurmurhash "^0.1.4" - is-glob "^4.0.0" - json-stable-stringify-without-jsonify "^1.0.1" - lodash.merge "^4.6.2" - minimatch "^3.1.5" - natural-compare "^1.4.0" - optionator "^0.9.3" - -espree@^10.0.1, espree@^10.4.0: - version "10.4.0" - resolved "https://registry.yarnpkg.com/espree/-/espree-10.4.0.tgz#d54f4949d4629005a1fa168d937c3ff1f7e2a837" - integrity sha512-j6PAQ2uUr79PZhBjP5C5fhl8e39FmRnOjsD5lGnWrFU8i2G776tBK7+nP8KuQUTTyAZUwfQqXAgrVH5MbH9CYQ== - dependencies: - acorn "^8.15.0" - acorn-jsx "^5.3.2" - eslint-visitor-keys "^4.2.1" - -esprima@^4.0.0: - version "4.0.1" - resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" - integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== - -esquery@^1.5.0: - version "1.7.0" - resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.7.0.tgz#08d048f261f0ddedb5bae95f46809463d9c9496d" - integrity sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g== - dependencies: - estraverse "^5.1.0" - -esrecurse@^4.3.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" - integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== - dependencies: - estraverse "^5.2.0" - -estraverse@^5.1.0, estraverse@^5.2.0: - version "5.3.0" - resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" - integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== - -esutils@^2.0.2: - version "2.0.3" - resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" - integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== - -etag@^1.8.1: - version "1.8.1" - resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887" - integrity sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg== - -eventsource-parser@^3.0.0, eventsource-parser@^3.0.1: - version "3.0.6" - resolved "https://registry.yarnpkg.com/eventsource-parser/-/eventsource-parser-3.0.6.tgz#292e165e34cacbc936c3c92719ef326d4aeb4e90" - integrity sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg== - -eventsource@^3.0.2: - version "3.0.7" - resolved "https://registry.yarnpkg.com/eventsource/-/eventsource-3.0.7.tgz#1157622e2f5377bb6aef2114372728ba0c156989" - integrity sha512-CRT1WTyuQoD771GW56XEZFQ/ZoSfWid1alKGDYMmkt2yl8UXrVR4pspqWNEcqKvVIzg6PAltWjxcSSPrboA4iA== - dependencies: - eventsource-parser "^3.0.1" - -execa@^5.0.0: - version "5.1.1" - resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" - integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== - dependencies: - cross-spawn "^7.0.3" - get-stream "^6.0.0" - human-signals "^2.1.0" - is-stream "^2.0.0" - merge-stream "^2.0.0" - npm-run-path "^4.0.1" - onetime "^5.1.2" - signal-exit "^3.0.3" - strip-final-newline "^2.0.0" - -exit@^0.1.2: - version "0.1.2" - resolved "https://registry.yarnpkg.com/exit/-/exit-0.1.2.tgz#0632638f8d877cc82107d30a0fff1a17cba1cd0c" - integrity sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ== - -expect@^29.0.0, expect@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/expect/-/expect-29.7.0.tgz#578874590dcb3214514084c08115d8aee61e11bc" - integrity sha512-2Zks0hf1VLFYI1kbh0I5jP3KHHyCHpkfyHBzsSXRFgl/Bg9mWYfMW8oD+PdMPlEwy5HNsR9JutYy6pMeOh61nw== - dependencies: - "@jest/expect-utils" "^29.7.0" - jest-get-type "^29.6.3" - jest-matcher-utils "^29.7.0" - jest-message-util "^29.7.0" - jest-util "^29.7.0" - -express-rate-limit@^8.2.1: - version "8.3.1" - resolved "https://registry.yarnpkg.com/express-rate-limit/-/express-rate-limit-8.3.1.tgz#0aaba098eadd40f6737f30a98e6b16fa1a29edfb" - integrity sha512-D1dKN+cmyPWuvB+G2SREQDzPY1agpBIcTa9sJxOPMCNeH3gwzhqJRDWCXW3gg0y//+LQ/8j52JbMROWyrKdMdw== - dependencies: - ip-address "10.1.0" - -express@^5.1.0, express@^5.2.1: - version "5.2.1" - resolved "https://registry.yarnpkg.com/express/-/express-5.2.1.tgz#8f21d15b6d327f92b4794ecf8cb08a72f956ac04" - integrity sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw== - dependencies: - accepts "^2.0.0" - body-parser "^2.2.1" - content-disposition "^1.0.0" - content-type "^1.0.5" - cookie "^0.7.1" - cookie-signature "^1.2.1" - debug "^4.4.0" - depd "^2.0.0" - encodeurl "^2.0.0" - escape-html "^1.0.3" - etag "^1.8.1" - finalhandler "^2.1.0" - fresh "^2.0.0" - http-errors "^2.0.0" - merge-descriptors "^2.0.0" - mime-types "^3.0.0" - on-finished "^2.4.1" - once "^1.4.0" - parseurl "^1.3.3" - proxy-addr "^2.0.7" - qs "^6.14.0" - range-parser "^1.2.1" - router "^2.2.0" - send "^1.1.0" - serve-static "^2.2.0" - statuses "^2.0.1" - type-is "^2.0.1" - vary "^1.1.2" - -external-editor@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-3.1.0.tgz#cb03f740befae03ea4d283caed2741a83f335495" - integrity sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew== - dependencies: - chardet "^0.7.0" - iconv-lite "^0.4.24" - tmp "^0.0.33" - -fast-copy@^4.0.0: - version "4.0.2" - resolved "https://registry.yarnpkg.com/fast-copy/-/fast-copy-4.0.2.tgz#57f14115e1edbec274f69090072a480aa29cbedd" - integrity sha512-ybA6PDXIXOXivLJK/z9e+Otk7ve13I4ckBvGO5I2RRmBU1gMHLVDJYEuJYhGwez7YNlYji2M2DvVU+a9mSFDlw== - -fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: - version "3.1.3" - resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" - integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== - -fast-diff@^1.1.2: - version "1.3.0" - resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.3.0.tgz#ece407fa550a64d638536cd727e129c61616e0f0" - integrity sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw== - -fast-glob@^3.2.12, fast-glob@^3.3.2: - version "3.3.3" - resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.3.tgz#d06d585ce8dba90a16b0505c543c3ccfb3aeb818" - integrity sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg== - dependencies: - "@nodelib/fs.stat" "^2.0.2" - "@nodelib/fs.walk" "^1.2.3" - glob-parent "^5.1.2" - merge2 "^1.3.0" - micromatch "^4.0.8" - -fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0, fast-json-stable-stringify@^2.1.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" - integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== - -fast-levenshtein@^2.0.6: - version "2.0.6" - resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" - integrity sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw== - -fast-safe-stringify@^2.1.1: - version "2.1.1" - resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz#c406a83b6e70d9e35ce3b30a81141df30aeba884" - integrity sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA== - -fast-uri@^3.0.1: - version "3.1.0" - resolved "https://registry.yarnpkg.com/fast-uri/-/fast-uri-3.1.0.tgz#66eecff6c764c0df9b762e62ca7edcfb53b4edfa" - integrity sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA== - -fastq@^1.6.0: - version "1.20.1" - resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.20.1.tgz#ca750a10dc925bc8b18839fd203e3ef4b3ced675" - integrity sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw== - dependencies: - reusify "^1.0.4" - -fb-watchman@^2.0.0: - version "2.0.2" - resolved "https://registry.yarnpkg.com/fb-watchman/-/fb-watchman-2.0.2.tgz#e9524ee6b5c77e9e5001af0f85f3adbb8623255c" - integrity sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA== - dependencies: - bser "2.1.1" - -fflate@^0.8.2: - version "0.8.2" - resolved "https://registry.yarnpkg.com/fflate/-/fflate-0.8.2.tgz#fc8631f5347812ad6028bbe4a2308b2792aa1dea" - integrity sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A== - -file-entry-cache@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/file-entry-cache/-/file-entry-cache-8.0.0.tgz#7787bddcf1131bffb92636c69457bbc0edd6d81f" - integrity sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ== - dependencies: - flat-cache "^4.0.0" - -fill-range@^7.1.1: - version "7.1.1" - resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.1.1.tgz#44265d3cac07e3ea7dc247516380643754a05292" - integrity sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg== - dependencies: - to-regex-range "^5.0.1" - -finalhandler@^2.1.0: - version "2.1.1" - resolved "https://registry.yarnpkg.com/finalhandler/-/finalhandler-2.1.1.tgz#a2c517a6559852bcdb06d1f8bd7f51b68fad8099" - integrity sha512-S8KoZgRZN+a5rNwqTxlZZePjT/4cnm0ROV70LedRHZ0p8u9fRID0hJUZQpkKLzro8LfmC8sx23bY6tVNxv8pQA== - dependencies: - debug "^4.4.0" - encodeurl "^2.0.0" - escape-html "^1.0.3" - on-finished "^2.4.1" - parseurl "^1.3.3" - statuses "^2.0.1" - -find-up@^4.0.0, find-up@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" - integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== - dependencies: - locate-path "^5.0.0" - path-exists "^4.0.0" - -find-up@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/find-up/-/find-up-5.0.0.tgz#4c92819ecb7083561e4f4a240a86be5198f536fc" - integrity sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng== - dependencies: - locate-path "^6.0.0" - path-exists "^4.0.0" - -flat-cache@^4.0.0: - version "4.0.1" - resolved "https://registry.yarnpkg.com/flat-cache/-/flat-cache-4.0.1.tgz#0ece39fcb14ee012f4b0410bd33dd9c1f011127c" - integrity sha512-f7ccFPK3SXFHpx15UIGyRJ/FJQctuKZ0zVuN3frBo4HnK3cay9VEW0R6yPYFHC0AgqhukPzKjq22t5DmAyqGyw== - dependencies: - flatted "^3.2.9" - keyv "^4.5.4" - -flatted@^3.2.9: - version "3.3.3" - resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.3.3.tgz#67c8fad95454a7c7abebf74bb78ee74a44023358" - integrity sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg== - -flora-colossus@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/flora-colossus/-/flora-colossus-2.0.0.tgz#af1e85db0a8256ef05f3fb531c1235236c97220a" - integrity sha512-dz4HxH6pOvbUzZpZ/yXhafjbR2I8cenK5xL0KtBFb7U2ADsR+OwXifnxZjij/pZWF775uSCMzWVd+jDik2H2IA== - dependencies: - debug "^4.3.4" - fs-extra "^10.1.0" - -forwarded@0.2.0: - version "0.2.0" - resolved "https://registry.yarnpkg.com/forwarded/-/forwarded-0.2.0.tgz#2269936428aad4c15c7ebe9779a84bf0b2a81811" - integrity sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow== - -fresh@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/fresh/-/fresh-2.0.0.tgz#8dd7df6a1b3a1b3a5cf186c05a5dd267622635a4" - integrity sha512-Rx/WycZ60HOaqLKAi6cHRKKI7zxWbJ31MhntmtwMoaTeF7XFH9hhBp8vITaMidfljRQ6eYWCKkaTK+ykVJHP2A== - -fs-extra@^10.1.0: - version "10.1.0" - resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.1.0.tgz#02873cfbc4084dde127eaa5f9905eef2325d1abf" - integrity sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ== - dependencies: - graceful-fs "^4.2.0" - jsonfile "^6.0.1" - universalify "^2.0.0" - -fs.realpath@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" - integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== - -fsevents@^2.3.2: - version "2.3.3" - resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6" - integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== - -function-bind@^1.1.2: - version "1.1.2" - resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.2.tgz#2c02d864d97f3ea6c8830c464cbd11ab6eab7a1c" - integrity sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA== - -fuse.js@^7.1.0: - version "7.1.0" - resolved "https://registry.yarnpkg.com/fuse.js/-/fuse.js-7.1.0.tgz#306228b4befeee11e05b027087c2744158527d09" - integrity sha512-trLf4SzuuUxfusZADLINj+dE8clK1frKdmqiJNb1Es75fmI5oY6X2mxLVUciLLjxqw/xr72Dhy+lER6dGd02FQ== - -galactus@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/galactus/-/galactus-1.0.0.tgz#c2615182afa0c6d0859b92e56ae36d052827db7e" - integrity sha512-R1fam6D4CyKQGNlvJne4dkNF+PvUUl7TAJInvTGa9fti9qAv95quQz29GXapA4d8Ec266mJJxFVh82M4GIIGDQ== - dependencies: - debug "^4.3.4" - flora-colossus "^2.0.0" - fs-extra "^10.1.0" - -gensync@^1.0.0-beta.2: - version "1.0.0-beta.2" - resolved "https://registry.yarnpkg.com/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" - integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== - -get-caller-file@^2.0.5: - version "2.0.5" - resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" - integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== - -get-intrinsic@^1.2.5, get-intrinsic@^1.3.0: - version "1.3.0" - resolved "https://registry.yarnpkg.com/get-intrinsic/-/get-intrinsic-1.3.0.tgz#743f0e3b6964a93a5491ed1bffaae054d7f98d01" - integrity sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ== - dependencies: - call-bind-apply-helpers "^1.0.2" - es-define-property "^1.0.1" - es-errors "^1.3.0" - es-object-atoms "^1.1.1" - function-bind "^1.1.2" - get-proto "^1.0.1" - gopd "^1.2.0" - has-symbols "^1.1.0" - hasown "^2.0.2" - math-intrinsics "^1.1.0" - -get-package-type@^0.1.0: - version "0.1.0" - resolved "https://registry.yarnpkg.com/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a" - integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q== - -get-proto@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/get-proto/-/get-proto-1.0.1.tgz#150b3f2743869ef3e851ec0c49d15b1d14d00ee1" - integrity sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g== - dependencies: - dunder-proto "^1.0.1" - es-object-atoms "^1.0.0" - -get-stdin@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-8.0.0.tgz#cbad6a73feb75f6eeb22ba9e01f89aa28aa97a53" - integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== - -get-stream@^6.0.0: - version "6.0.1" - resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" - integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== - -glob-parent@^5.1.2: - version "5.1.2" - resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" - integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== - dependencies: - is-glob "^4.0.1" - -glob-parent@^6.0.2: - version "6.0.2" - resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" - integrity sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== - dependencies: - is-glob "^4.0.3" - -glob@^7.1.3, glob@^7.1.4: - version "7.2.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" - integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== - dependencies: - fs.realpath "^1.0.0" - inflight "^1.0.4" - inherits "2" - minimatch "^3.1.1" - once "^1.3.0" - path-is-absolute "^1.0.0" - -globals@^14.0.0: - version "14.0.0" - resolved "https://registry.yarnpkg.com/globals/-/globals-14.0.0.tgz#898d7413c29babcf6bafe56fcadded858ada724e" - integrity sha512-oahGvuMGQlPw/ivIYBjVSrWAfWLBeku5tpPE2fOPLi+WHffIWbuh2tCjhyQhTBPMf5E9jDEH4FOmTYgYwbKwtQ== - -gopd@^1.2.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/gopd/-/gopd-1.2.0.tgz#89f56b8217bdbc8802bd299df6d7f1081d7e51a1" - integrity sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg== - -graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.9: - version "4.2.11" - resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" - integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== - -graphemer@^1.4.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/graphemer/-/graphemer-1.4.0.tgz#fb2f1d55e0e3a1849aeffc90c4fa0dd53a0e66c6" - integrity sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag== - -handlebars@^4.7.8: - version "4.7.8" - resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.8.tgz#41c42c18b1be2365439188c77c6afae71c0cd9e9" - integrity sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ== - dependencies: - minimist "^1.2.5" - neo-async "^2.6.2" - source-map "^0.6.1" - wordwrap "^1.0.0" - optionalDependencies: - uglify-js "^3.1.4" - -has-flag@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" - integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== - -has-symbols@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/has-symbols/-/has-symbols-1.1.0.tgz#fc9c6a783a084951d0b971fe1018de813707a338" - integrity sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ== - -hasown@^2.0.2: - version "2.0.2" - resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.2.tgz#003eaf91be7adc372e84ec59dc37252cedb80003" - integrity sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ== - dependencies: - function-bind "^1.1.2" - -help-me@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/help-me/-/help-me-5.0.0.tgz#b1ebe63b967b74060027c2ac61f9be12d354a6f6" - integrity sha512-7xgomUX6ADmcYzFik0HzAxh/73YlKR9bmFzf51CZwR+b6YtzU2m0u49hQCqV6SvlqIqsaxovfwdvbnsw3b/zpg== - -hono@^4.11.4, hono@^4.12.4: - version "4.12.7" - resolved "https://registry.yarnpkg.com/hono/-/hono-4.12.7.tgz#ca000956e965c2b3d791e43540498e616d6c6442" - integrity sha512-jq9l1DM0zVIvsm3lv9Nw9nlJnMNPOcAtsbsgiUhWcFzPE99Gvo6yRTlszSLLYacMeQ6quHD6hMfId8crVHvexw== - -html-escaper@^2.0.0: - version "2.0.2" - resolved "https://registry.yarnpkg.com/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" - integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== - -http-errors@^2.0.0, http-errors@^2.0.1, http-errors@~2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/http-errors/-/http-errors-2.0.1.tgz#36d2f65bc909c8790018dd36fb4d93da6caae06b" - integrity sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ== - dependencies: - depd "~2.0.0" - inherits "~2.0.4" - setprototypeof "~1.2.0" - statuses "~2.0.2" - toidentifier "~1.0.1" - -human-signals@^2.1.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" - integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== - -iconv-lite@^0.4.24: - version "0.4.24" - resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" - integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== - dependencies: - safer-buffer ">= 2.1.2 < 3" - -iconv-lite@^0.7.0, iconv-lite@~0.7.0: - version "0.7.2" - resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.7.2.tgz#d0bdeac3f12b4835b7359c2ad89c422a4d1cc72e" - integrity sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw== - dependencies: - safer-buffer ">= 2.1.2 < 3.0.0" - -ignore@^5.2.0, ignore@^5.3.1: - version "5.3.2" - resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.3.2.tgz#3cd40e729f3643fd87cb04e50bf0eb722bc596f5" - integrity sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g== - -ignore@^7.0.5: - version "7.0.5" - resolved "https://registry.yarnpkg.com/ignore/-/ignore-7.0.5.tgz#4cb5f6cd7d4c7ab0365738c7aea888baa6d7efd9" - integrity sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg== - -import-fresh@^3.2.1: - version "3.3.1" - resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.3.1.tgz#9cecb56503c0ada1f2741dbbd6546e4b13b57ccf" - integrity sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ== - dependencies: - parent-module "^1.0.0" - resolve-from "^4.0.0" - -import-local@^3.0.2: - version "3.2.0" - resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.2.0.tgz#c3d5c745798c02a6f8b897726aba5100186ee260" - integrity sha512-2SPlun1JUPWoM6t3F0dw0FkCF/jWY8kttcY4f599GLTSjh2OCuuhdTkJQsEcZzBqbXZGKMK2OqW1oZsjtf/gQA== - dependencies: - pkg-dir "^4.2.0" - resolve-cwd "^3.0.0" - -imurmurhash@^0.1.4: - version "0.1.4" - resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" - integrity sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA== - -indent-string@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" - integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== - -inflight@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" - integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== - dependencies: - once "^1.3.0" - wrappy "1" - -inherits@2, inherits@^2.0.3, inherits@~2.0.4: - version "2.0.4" - resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== - -ip-address@10.1.0: - version "10.1.0" - resolved "https://registry.yarnpkg.com/ip-address/-/ip-address-10.1.0.tgz#d8dcffb34d0e02eb241427444a6e23f5b0595aa4" - integrity sha512-XXADHxXmvT9+CRxhXg56LJovE+bmWnEWB78LB83VZTprKTmaC5QfruXocxzTZ2Kl0DNwKuBdlIhjL8LeY8Sf8Q== - -ipaddr.js@1.9.1: - version "1.9.1" - resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-1.9.1.tgz#bff38543eeb8984825079ff3a2a8e6cbd46781b3" - integrity sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g== - -is-arrayish@^0.2.1: - version "0.2.1" - resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" - integrity sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg== - -is-core-module@^2.16.1: - version "2.16.1" - resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.16.1.tgz#2a98801a849f43e2add644fbb6bc6229b19a4ef4" - integrity sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w== - dependencies: - hasown "^2.0.2" - -is-extglob@^2.1.1: - version "2.1.1" - resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" - integrity sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ== - -is-fullwidth-code-point@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" - integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== - -is-generator-fn@^2.0.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/is-generator-fn/-/is-generator-fn-2.1.0.tgz#7d140adc389aaf3011a8f2a2a4cfa6faadffb118" - integrity sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ== - -is-glob@^4.0.0, is-glob@^4.0.1, is-glob@^4.0.3: - version "4.0.3" - resolved "https://registry.yarnpkg.com/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" - integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== - dependencies: - is-extglob "^2.1.1" - -is-number@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" - integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== - -is-promise@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/is-promise/-/is-promise-4.0.0.tgz#42ff9f84206c1991d26debf520dd5c01042dd2f3" - integrity sha512-hvpoI6korhJMnej285dSg6nu1+e6uxs7zG3BYAm5byqDsgJNWwxzM6z6iZiAgQR4TJ30JmBTOwqZUw3WlyH3AQ== - -is-stream@^2.0.0: - version "2.0.1" - resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" - integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== - -isexe@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" - integrity sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw== - -istanbul-lib-coverage@^3.0.0, istanbul-lib-coverage@^3.2.0: - version "3.2.2" - resolved "https://registry.yarnpkg.com/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz#2d166c4b0644d43a39f04bf6c2edd1e585f31756" - integrity sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg== - -istanbul-lib-instrument@^5.0.4: - version "5.2.1" - resolved "https://registry.yarnpkg.com/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz#d10c8885c2125574e1c231cacadf955675e1ce3d" - integrity sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg== - dependencies: - "@babel/core" "^7.12.3" - "@babel/parser" "^7.14.7" - "@istanbuljs/schema" "^0.1.2" - istanbul-lib-coverage "^3.2.0" - semver "^6.3.0" - -istanbul-lib-instrument@^6.0.0: - version "6.0.3" - resolved "https://registry.yarnpkg.com/istanbul-lib-instrument/-/istanbul-lib-instrument-6.0.3.tgz#fa15401df6c15874bcb2105f773325d78c666765" - integrity sha512-Vtgk7L/R2JHyyGW07spoFlB8/lpjiOLTjMdms6AFMraYt3BaJauod/NGrfnVG/y4Ix1JEuMRPDPEj2ua+zz1/Q== - dependencies: - "@babel/core" "^7.23.9" - "@babel/parser" "^7.23.9" - "@istanbuljs/schema" "^0.1.3" - istanbul-lib-coverage "^3.2.0" - semver "^7.5.4" - -istanbul-lib-report@^3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz#908305bac9a5bd175ac6a74489eafd0fc2445a7d" - integrity sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw== - dependencies: - istanbul-lib-coverage "^3.0.0" - make-dir "^4.0.0" - supports-color "^7.1.0" - -istanbul-lib-source-maps@^4.0.0: - version "4.0.1" - resolved "https://registry.yarnpkg.com/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz#895f3a709fcfba34c6de5a42939022f3e4358551" - integrity sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw== - dependencies: - debug "^4.1.1" - istanbul-lib-coverage "^3.0.0" - source-map "^0.6.1" - -istanbul-reports@^3.1.3: - version "3.2.0" - resolved "https://registry.yarnpkg.com/istanbul-reports/-/istanbul-reports-3.2.0.tgz#cb4535162b5784aa623cee21a7252cf2c807ac93" - integrity sha512-HGYWWS/ehqTV3xN10i23tkPkpH46MLCIMFNCaaKNavAXTF1RkqxawEPtnjnGZ6XKSInBKkiOA5BKS+aZiY3AvA== - dependencies: - html-escaper "^2.0.0" - istanbul-lib-report "^3.0.0" - -jest-changed-files@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-29.7.0.tgz#1c06d07e77c78e1585d020424dedc10d6e17ac3a" - integrity sha512-fEArFiwf1BpQ+4bXSprcDc3/x4HSzL4al2tozwVpDFpsxALjLYdyiIK4e5Vz66GQJIbXJ82+35PtysofptNX2w== - dependencies: - execa "^5.0.0" - jest-util "^29.7.0" - p-limit "^3.1.0" - -jest-circus@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-circus/-/jest-circus-29.7.0.tgz#b6817a45fcc835d8b16d5962d0c026473ee3668a" - integrity sha512-3E1nCMgipcTkCocFwM90XXQab9bS+GMsjdpmPrlelaxwD93Ad8iVEjX/vvHPdLPnFf+L40u+5+iutRdA1N9myw== - dependencies: - "@jest/environment" "^29.7.0" - "@jest/expect" "^29.7.0" - "@jest/test-result" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - chalk "^4.0.0" - co "^4.6.0" - dedent "^1.0.0" - is-generator-fn "^2.0.0" - jest-each "^29.7.0" - jest-matcher-utils "^29.7.0" - jest-message-util "^29.7.0" - jest-runtime "^29.7.0" - jest-snapshot "^29.7.0" - jest-util "^29.7.0" - p-limit "^3.1.0" - pretty-format "^29.7.0" - pure-rand "^6.0.0" - slash "^3.0.0" - stack-utils "^2.0.3" - -jest-cli@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-cli/-/jest-cli-29.7.0.tgz#5592c940798e0cae677eec169264f2d839a37995" - integrity sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg== - dependencies: - "@jest/core" "^29.7.0" - "@jest/test-result" "^29.7.0" - "@jest/types" "^29.6.3" - chalk "^4.0.0" - create-jest "^29.7.0" - exit "^0.1.2" - import-local "^3.0.2" - jest-config "^29.7.0" - jest-util "^29.7.0" - jest-validate "^29.7.0" - yargs "^17.3.1" - -jest-config@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-config/-/jest-config-29.7.0.tgz#bcbda8806dbcc01b1e316a46bb74085a84b0245f" - integrity sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ== - dependencies: - "@babel/core" "^7.11.6" - "@jest/test-sequencer" "^29.7.0" - "@jest/types" "^29.6.3" - babel-jest "^29.7.0" - chalk "^4.0.0" - ci-info "^3.2.0" - deepmerge "^4.2.2" - glob "^7.1.3" - graceful-fs "^4.2.9" - jest-circus "^29.7.0" - jest-environment-node "^29.7.0" - jest-get-type "^29.6.3" - jest-regex-util "^29.6.3" - jest-resolve "^29.7.0" - jest-runner "^29.7.0" - jest-util "^29.7.0" - jest-validate "^29.7.0" - micromatch "^4.0.4" - parse-json "^5.2.0" - pretty-format "^29.7.0" - slash "^3.0.0" - strip-json-comments "^3.1.1" - -jest-diff@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-29.7.0.tgz#017934a66ebb7ecf6f205e84699be10afd70458a" - integrity sha512-LMIgiIrhigmPrs03JHpxUh2yISK3vLFPkAodPeo0+BuF7wA2FoQbkEg1u8gBYBThncu7e1oEDUfIXVuTqLRUjw== - dependencies: - chalk "^4.0.0" - diff-sequences "^29.6.3" - jest-get-type "^29.6.3" - pretty-format "^29.7.0" - -jest-docblock@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-29.7.0.tgz#8fddb6adc3cdc955c93e2a87f61cfd350d5d119a" - integrity sha512-q617Auw3A612guyaFgsbFeYpNP5t2aoUNLwBUbc/0kD1R4t9ixDbyFTHd1nok4epoVFpr7PmeWHrhvuV3XaJ4g== - dependencies: - detect-newline "^3.0.0" - -jest-each@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-each/-/jest-each-29.7.0.tgz#162a9b3f2328bdd991beaabffbb74745e56577d1" - integrity sha512-gns+Er14+ZrEoC5fhOfYCY1LOHHr0TI+rQUHZS8Ttw2l7gl+80eHc/gFf2Ktkw0+SIACDTeWvpFcv3B04VembQ== - dependencies: - "@jest/types" "^29.6.3" - chalk "^4.0.0" - jest-get-type "^29.6.3" - jest-util "^29.7.0" - pretty-format "^29.7.0" - -jest-environment-node@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-environment-node/-/jest-environment-node-29.7.0.tgz#0b93e111dda8ec120bc8300e6d1fb9576e164376" - integrity sha512-DOSwCRqXirTOyheM+4d5YZOrWcdu0LNZ87ewUoywbcb2XR4wKgqiG8vNeYwhjFMbEkfju7wx2GYH0P2gevGvFw== - dependencies: - "@jest/environment" "^29.7.0" - "@jest/fake-timers" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - jest-mock "^29.7.0" - jest-util "^29.7.0" - -jest-get-type@^29.6.3: - version "29.6.3" - resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-29.6.3.tgz#36f499fdcea197c1045a127319c0481723908fd1" - integrity sha512-zrteXnqYxfQh7l5FHyL38jL39di8H8rHoecLH3JNxH3BwOrBsNeabdap5e0I23lD4HHI8W5VFBZqG4Eaq5LNcw== - -jest-haste-map@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-29.7.0.tgz#3c2396524482f5a0506376e6c858c3bbcc17b104" - integrity sha512-fP8u2pyfqx0K1rGn1R9pyE0/KTn+G7PxktWidOBTqFPLYX0b9ksaMFkhK5vrS3DVun09pckLdlx90QthlW7AmA== - dependencies: - "@jest/types" "^29.6.3" - "@types/graceful-fs" "^4.1.3" - "@types/node" "*" - anymatch "^3.0.3" - fb-watchman "^2.0.0" - graceful-fs "^4.2.9" - jest-regex-util "^29.6.3" - jest-util "^29.7.0" - jest-worker "^29.7.0" - micromatch "^4.0.4" - walker "^1.0.8" - optionalDependencies: - fsevents "^2.3.2" - -jest-leak-detector@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-29.7.0.tgz#5b7ec0dadfdfec0ca383dc9aa016d36b5ea4c728" - integrity sha512-kYA8IJcSYtST2BY9I+SMC32nDpBT3J2NvWJx8+JCuCdl/CR1I4EKUJROiP8XtCcxqgTTBGJNdbB1A8XRKbTetw== - dependencies: - jest-get-type "^29.6.3" - pretty-format "^29.7.0" - -jest-matcher-utils@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-matcher-utils/-/jest-matcher-utils-29.7.0.tgz#ae8fec79ff249fd592ce80e3ee474e83a6c44f12" - integrity sha512-sBkD+Xi9DtcChsI3L3u0+N0opgPYnCRPtGcQYrgXmR+hmt/fYfWAL0xRXYU8eWOdfuLgBe0YCW3AFtnRLagq/g== - dependencies: - chalk "^4.0.0" - jest-diff "^29.7.0" - jest-get-type "^29.6.3" - pretty-format "^29.7.0" - -jest-message-util@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-message-util/-/jest-message-util-29.7.0.tgz#8bc392e204e95dfe7564abbe72a404e28e51f7f3" - integrity sha512-GBEV4GRADeP+qtB2+6u61stea8mGcOT4mCtrYISZwfu9/ISHFJ/5zOMXYbpBE9RsS5+Gb63DW4FgmnKJ79Kf6w== - dependencies: - "@babel/code-frame" "^7.12.13" - "@jest/types" "^29.6.3" - "@types/stack-utils" "^2.0.0" - chalk "^4.0.0" - graceful-fs "^4.2.9" - micromatch "^4.0.4" - pretty-format "^29.7.0" - slash "^3.0.0" - stack-utils "^2.0.3" - -jest-mock@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-mock/-/jest-mock-29.7.0.tgz#4e836cf60e99c6fcfabe9f99d017f3fdd50a6347" - integrity sha512-ITOMZn+UkYS4ZFh83xYAOzWStloNzJFO2s8DWrE4lhtGD+AorgnbkiKERe4wQVBydIGPx059g6riW5Btp6Llnw== - dependencies: - "@jest/types" "^29.6.3" - "@types/node" "*" - jest-util "^29.7.0" - -jest-pnp-resolver@^1.2.2: - version "1.2.3" - resolved "https://registry.yarnpkg.com/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz#930b1546164d4ad5937d5540e711d4d38d4cad2e" - integrity sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w== - -jest-regex-util@^29.6.3: - version "29.6.3" - resolved "https://registry.yarnpkg.com/jest-regex-util/-/jest-regex-util-29.6.3.tgz#4a556d9c776af68e1c5f48194f4d0327d24e8a52" - integrity sha512-KJJBsRCyyLNWCNBOvZyRDnAIfUiRJ8v+hOBQYGn8gDyF3UegwiP4gwRR3/SDa42g1YbVycTidUF3rKjyLFDWbg== - -jest-resolve-dependencies@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-resolve-dependencies/-/jest-resolve-dependencies-29.7.0.tgz#1b04f2c095f37fc776ff40803dc92921b1e88428" - integrity sha512-un0zD/6qxJ+S0et7WxeI3H5XSe9lTBBR7bOHCHXkKR6luG5mwDDlIzVQ0V5cZCuoTgEdcdwzTghYkTWfubi+nA== - dependencies: - jest-regex-util "^29.6.3" - jest-snapshot "^29.7.0" - -jest-resolve@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-resolve/-/jest-resolve-29.7.0.tgz#64d6a8992dd26f635ab0c01e5eef4399c6bcbc30" - integrity sha512-IOVhZSrg+UvVAshDSDtHyFCCBUl/Q3AAJv8iZ6ZjnZ74xzvwuzLXid9IIIPgTnY62SJjfuupMKZsZQRsCvxEgA== - dependencies: - chalk "^4.0.0" - graceful-fs "^4.2.9" - jest-haste-map "^29.7.0" - jest-pnp-resolver "^1.2.2" - jest-util "^29.7.0" - jest-validate "^29.7.0" - resolve "^1.20.0" - resolve.exports "^2.0.0" - slash "^3.0.0" - -jest-runner@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-runner/-/jest-runner-29.7.0.tgz#809af072d408a53dcfd2e849a4c976d3132f718e" - integrity sha512-fsc4N6cPCAahybGBfTRcq5wFR6fpLznMg47sY5aDpsoejOcVYFb07AHuSnR0liMcPTgBsA3ZJL6kFOjPdoNipQ== - dependencies: - "@jest/console" "^29.7.0" - "@jest/environment" "^29.7.0" - "@jest/test-result" "^29.7.0" - "@jest/transform" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - chalk "^4.0.0" - emittery "^0.13.1" - graceful-fs "^4.2.9" - jest-docblock "^29.7.0" - jest-environment-node "^29.7.0" - jest-haste-map "^29.7.0" - jest-leak-detector "^29.7.0" - jest-message-util "^29.7.0" - jest-resolve "^29.7.0" - jest-runtime "^29.7.0" - jest-util "^29.7.0" - jest-watcher "^29.7.0" - jest-worker "^29.7.0" - p-limit "^3.1.0" - source-map-support "0.5.13" - -jest-runtime@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-runtime/-/jest-runtime-29.7.0.tgz#efecb3141cf7d3767a3a0cc8f7c9990587d3d817" - integrity sha512-gUnLjgwdGqW7B4LvOIkbKs9WGbn+QLqRQQ9juC6HndeDiezIwhDP+mhMwHWCEcfQ5RUXa6OPnFF8BJh5xegwwQ== - dependencies: - "@jest/environment" "^29.7.0" - "@jest/fake-timers" "^29.7.0" - "@jest/globals" "^29.7.0" - "@jest/source-map" "^29.6.3" - "@jest/test-result" "^29.7.0" - "@jest/transform" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - chalk "^4.0.0" - cjs-module-lexer "^1.0.0" - collect-v8-coverage "^1.0.0" - glob "^7.1.3" - graceful-fs "^4.2.9" - jest-haste-map "^29.7.0" - jest-message-util "^29.7.0" - jest-mock "^29.7.0" - jest-regex-util "^29.6.3" - jest-resolve "^29.7.0" - jest-snapshot "^29.7.0" - jest-util "^29.7.0" - slash "^3.0.0" - strip-bom "^4.0.0" - -jest-snapshot@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-snapshot/-/jest-snapshot-29.7.0.tgz#c2c574c3f51865da1bb329036778a69bf88a6be5" - integrity sha512-Rm0BMWtxBcioHr1/OX5YCP8Uov4riHvKPknOGs804Zg9JGZgmIBkbtlxJC/7Z4msKYVbIJtfU+tKb8xlYNfdkw== - dependencies: - "@babel/core" "^7.11.6" - "@babel/generator" "^7.7.2" - "@babel/plugin-syntax-jsx" "^7.7.2" - "@babel/plugin-syntax-typescript" "^7.7.2" - "@babel/types" "^7.3.3" - "@jest/expect-utils" "^29.7.0" - "@jest/transform" "^29.7.0" - "@jest/types" "^29.6.3" - babel-preset-current-node-syntax "^1.0.0" - chalk "^4.0.0" - expect "^29.7.0" - graceful-fs "^4.2.9" - jest-diff "^29.7.0" - jest-get-type "^29.6.3" - jest-matcher-utils "^29.7.0" - jest-message-util "^29.7.0" - jest-util "^29.7.0" - natural-compare "^1.4.0" - pretty-format "^29.7.0" - semver "^7.5.3" - -jest-util@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-util/-/jest-util-29.7.0.tgz#23c2b62bfb22be82b44de98055802ff3710fc0bc" - integrity sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA== - dependencies: - "@jest/types" "^29.6.3" - "@types/node" "*" - chalk "^4.0.0" - ci-info "^3.2.0" - graceful-fs "^4.2.9" - picomatch "^2.2.3" - -jest-validate@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-validate/-/jest-validate-29.7.0.tgz#7bf705511c64da591d46b15fce41400d52147d9c" - integrity sha512-ZB7wHqaRGVw/9hST/OuFUReG7M8vKeq0/J2egIGLdvjHCmYqGARhzXmtgi+gVeZ5uXFF219aOc3Ls2yLg27tkw== - dependencies: - "@jest/types" "^29.6.3" - camelcase "^6.2.0" - chalk "^4.0.0" - jest-get-type "^29.6.3" - leven "^3.1.0" - pretty-format "^29.7.0" - -jest-watcher@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-watcher/-/jest-watcher-29.7.0.tgz#7810d30d619c3a62093223ce6bb359ca1b28a2f2" - integrity sha512-49Fg7WXkU3Vl2h6LbLtMQ/HyB6rXSIX7SqvBLQmssRBGN9I0PNvPmAmCWSOY6SOvrjhI/F7/bGAv9RtnsPA03g== - dependencies: - "@jest/test-result" "^29.7.0" - "@jest/types" "^29.6.3" - "@types/node" "*" - ansi-escapes "^4.2.1" - chalk "^4.0.0" - emittery "^0.13.1" - jest-util "^29.7.0" - string-length "^4.0.1" - -jest-worker@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-29.7.0.tgz#acad073acbbaeb7262bd5389e1bcf43e10058d4a" - integrity sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw== - dependencies: - "@types/node" "*" - jest-util "^29.7.0" - merge-stream "^2.0.0" - supports-color "^8.0.0" - -jest@^29.4.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/jest/-/jest-29.7.0.tgz#994676fc24177f088f1c5e3737f5697204ff2613" - integrity sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw== - dependencies: - "@jest/core" "^29.7.0" - "@jest/types" "^29.6.3" - import-local "^3.0.2" - jest-cli "^29.7.0" - -jose@^6.1.3: - version "6.2.1" - resolved "https://registry.yarnpkg.com/jose/-/jose-6.2.1.tgz#7a6b1de83816deaee9055a558e1278a7b2b9ea1b" - integrity sha512-jUaKr1yrbfaImV7R2TN/b3IcZzsw38/chqMpo2XJ7i2F8AfM/lA4G1goC3JVEwg0H7UldTmSt3P68nt31W7/mw== - -joycon@^3.1.1: - version "3.1.1" - resolved "https://registry.yarnpkg.com/joycon/-/joycon-3.1.1.tgz#bce8596d6ae808f8b68168f5fc69280996894f03" - integrity sha512-34wB/Y7MW7bzjKRjUKTa46I2Z7eV62Rkhva+KkopW7Qvv/OSWBqvkSY7vusOPrNuZcUG3tApvdVgNB8POj3SPw== - -"jq-web@https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz": - version "0.8.8" - resolved "https://github.com/stainless-api/jq-web/releases/download/v0.8.8/jq-web.tar.gz#7849ef64bdfc28f70cbfc9888f886860e96da10d" - -js-tokens@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" - integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== - -js-yaml@^3.13.1: - version "3.14.2" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.2.tgz#77485ce1dd7f33c061fd1b16ecea23b55fcb04b0" - integrity sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg== - dependencies: - argparse "^1.0.7" - esprima "^4.0.0" - -js-yaml@^4.1.1: - version "4.1.1" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.1.tgz#854c292467705b699476e1a2decc0c8a3458806b" - integrity sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA== - dependencies: - argparse "^2.0.1" - -jsesc@^3.0.2: - version "3.1.0" - resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-3.1.0.tgz#74d335a234f67ed19907fdadfac7ccf9d409825d" - integrity sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA== - -json-buffer@3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" - integrity sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ== - -json-parse-even-better-errors@^2.3.0: - version "2.3.1" - resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" - integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== - -json-schema-traverse@^0.4.1: - version "0.4.1" - resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" - integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== - -json-schema-traverse@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" - integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== - -json-schema-typed@^8.0.2: - version "8.0.2" - resolved "https://registry.yarnpkg.com/json-schema-typed/-/json-schema-typed-8.0.2.tgz#e98ee7b1899ff4a184534d1f167c288c66bbeff4" - integrity sha512-fQhoXdcvc3V28x7C7BMs4P5+kNlgUURe2jmUT1T//oBRMDrqy1QPelJimwZGo7Hg9VPV3EQV5Bnq4hbFy2vetA== - -json-stable-stringify-without-jsonify@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651" - integrity sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw== - -json5@^2.2.2, json5@^2.2.3: - version "2.2.3" - resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" - integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== - -jsonfile@^6.0.1: - version "6.2.0" - resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.2.0.tgz#7c265bd1b65de6977478300087c99f1c84383f62" - integrity sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg== - dependencies: - universalify "^2.0.0" - optionalDependencies: - graceful-fs "^4.1.6" - -keyv@^4.5.4: - version "4.5.4" - resolved "https://registry.yarnpkg.com/keyv/-/keyv-4.5.4.tgz#a879a99e29452f942439f2a405e3af8b31d4de93" - integrity sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw== - dependencies: - json-buffer "3.0.1" - -kleur@^3.0.3: - version "3.0.3" - resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" - integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== - -leven@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" - integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== - -levn@^0.4.1: - version "0.4.1" - resolved "https://registry.yarnpkg.com/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade" - integrity sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ== - dependencies: - prelude-ls "^1.2.1" - type-check "~0.4.0" - -lines-and-columns@^1.1.6: - version "1.2.4" - resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" - integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== - -locate-path@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" - integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== - dependencies: - p-locate "^4.1.0" - -locate-path@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-6.0.0.tgz#55321eb309febbc59c4801d931a72452a681d286" - integrity sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw== - dependencies: - p-locate "^5.0.0" - -lodash.memoize@^4.1.2: - version "4.1.2" - resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" - integrity sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag== - -lodash.merge@^4.6.2: - version "4.6.2" - resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a" - integrity sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ== - -lru-cache@^5.1.1: - version "5.1.1" - resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" - integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== - dependencies: - yallist "^3.0.2" - -make-dir@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-4.0.0.tgz#c3c2307a771277cd9638305f915c29ae741b614e" - integrity sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw== - dependencies: - semver "^7.5.3" - -make-error@^1.1.1, make-error@^1.3.6: - version "1.3.6" - resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2" - integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw== - -makeerror@1.0.12: - version "1.0.12" - resolved "https://registry.yarnpkg.com/makeerror/-/makeerror-1.0.12.tgz#3e5dd2079a82e812e983cc6610c4a2cb0eaa801a" - integrity sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg== - dependencies: - tmpl "1.0.5" - -math-intrinsics@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/math-intrinsics/-/math-intrinsics-1.1.0.tgz#a0dd74be81e2aa5c2f27e65ce283605ee4e2b7f9" - integrity sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g== - -media-typer@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-1.1.0.tgz#6ab74b8f2d3320f2064b2a87a38e7931ff3a5561" - integrity sha512-aisnrDP4GNe06UcKFnV5bfMNPBUw4jsLGaWwWfnH3v02GnBuXX2MCVn5RbrWo0j3pczUilYblq7fQ7Nw2t5XKw== - -merge-descriptors@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/merge-descriptors/-/merge-descriptors-2.0.0.tgz#ea922f660635a2249ee565e0449f951e6b603808" - integrity sha512-Snk314V5ayFLhp3fkUREub6WtjBfPdCPY1Ln8/8munuLuiYhsABgBVWsozAG+MWMbVEvcdcpbi9R7ww22l9Q3g== - -merge-stream@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" - integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== - -merge2@^1.3.0: - version "1.4.1" - resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" - integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== - -micromatch@^4.0.4, micromatch@^4.0.8: - version "4.0.8" - resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202" - integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA== - dependencies: - braces "^3.0.3" - picomatch "^2.3.1" - -mime-db@^1.54.0: - version "1.54.0" - resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.54.0.tgz#cddb3ee4f9c64530dff640236661d42cb6a314f5" - integrity sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ== - -mime-types@^3.0.0, mime-types@^3.0.2: - version "3.0.2" - resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-3.0.2.tgz#39002d4182575d5af036ffa118100f2524b2e2ab" - integrity sha512-Lbgzdk0h4juoQ9fCKXW4by0UJqj+nOOrI9MJ1sSj4nI8aI2eo1qmvQEie4VD1glsS250n15LsWsYtCugiStS5A== - dependencies: - mime-db "^1.54.0" - -mimic-fn@^2.1.0: - version "2.1.0" - resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" - integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== - -minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.5: - version "3.1.5" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.5.tgz#580c88f8d5445f2bd6aa8f3cadefa0de79fbd69e" - integrity sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w== - dependencies: - brace-expansion "^1.1.7" - -minimatch@^7.4.3: - version "7.4.6" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.6.tgz#845d6f254d8f4a5e4fd6baf44d5f10c8448365fb" - integrity sha512-sBz8G/YjVniEz6lKPNpKxXwazJe4c19fEfV2GDMX6AjFz+MX9uDWIZW8XreVhkFW3fkIdTv/gxWr/Kks5FFAVw== - dependencies: - brace-expansion "^2.0.1" - -minimatch@^9.0.4: - version "9.0.5" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" - integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== - dependencies: - brace-expansion "^2.0.1" - -minimist@^1.2.5, minimist@^1.2.6: - version "1.2.8" - resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" - integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== - -mkdirp@^2.1.6: - version "2.1.6" - resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-2.1.6.tgz#964fbcb12b2d8c5d6fbc62a963ac95a273e2cc19" - integrity sha512-+hEnITedc8LAtIP9u3HJDFIdcLV2vXP33sqLLIzkv1Db1zO/1OxbvYf0Y1OC/S/Qo5dxHXepofhmxL02PsKe+A== - -ms@^2.1.3: - version "2.1.3" - resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" - integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== - -mute-stream@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-1.0.0.tgz#e31bd9fe62f0aed23520aa4324ea6671531e013e" - integrity sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA== - -natural-compare@^1.4.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" - integrity sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw== - -negotiator@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-1.0.0.tgz#b6c91bb47172d69f93cfd7c357bbb529019b5f6a" - integrity sha512-8Ofs/AUQh8MaEcrlq5xOX0CQ9ypTF5dl78mjlMNfOK08fzpgTHQRQPBxcPlEtIw0yRpws+Zo/3r+5WRby7u3Gg== - -neo-async@^2.6.2: - version "2.6.2" - resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" - integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== - -node-forge@^1.3.2: - version "1.3.3" - resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-1.3.3.tgz#0ad80f6333b3a0045e827ac20b7f735f93716751" - integrity sha512-rLvcdSyRCyouf6jcOIPe/BgwG/d7hKjzMKOas33/pHEr6gbq18IK9zV7DiPvzsz0oBJPme6qr6H6kGZuI9/DZg== - -node-int64@^0.4.0: - version "0.4.0" - resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" - integrity sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw== - -node-releases@^2.0.27: - version "2.0.27" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.27.tgz#eedca519205cf20f650f61d56b070db111231e4e" - integrity sha512-nmh3lCkYZ3grZvqcCH+fjmQ7X+H0OeZgP40OierEaAptX4XofMh5kwNbWh7lBduUzCcV/8kZ+NDLCwm2iorIlA== - -normalize-path@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" - integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== - -npm-run-path@^4.0.1: - version "4.0.1" - resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" - integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== - dependencies: - path-key "^3.0.0" - -object-assign@^4: - version "4.1.1" - resolved "https://registry.yarnpkg.com/object-assign/-/object-assign-4.1.1.tgz#2109adc7965887cfc05cbbd442cac8bfbb360863" - integrity sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg== - -object-inspect@^1.13.3: - version "1.13.4" - resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.4.tgz#8375265e21bc20d0fa582c22e1b13485d6e00213" - integrity sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew== - -on-exit-leak-free@^2.1.0: - version "2.1.2" - resolved "https://registry.yarnpkg.com/on-exit-leak-free/-/on-exit-leak-free-2.1.2.tgz#fed195c9ebddb7d9e4c3842f93f281ac8dadd3b8" - integrity sha512-0eJJY6hXLGf1udHwfNftBqH+g73EU4B504nZeKpz1sYRKafAghwxEJunB2O7rDZkL4PGfsMVnTXZ2EjibbqcsA== - -on-finished@^2.4.1: - version "2.4.1" - resolved "https://registry.yarnpkg.com/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f" - integrity sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg== - dependencies: - ee-first "1.1.1" - -once@^1.3.0, once@^1.3.1, once@^1.4.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" - integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== - dependencies: - wrappy "1" - -onetime@^5.1.2: - version "5.1.2" - resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" - integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== - dependencies: - mimic-fn "^2.1.0" - -optionator@^0.9.3: - version "0.9.4" - resolved "https://registry.yarnpkg.com/optionator/-/optionator-0.9.4.tgz#7ea1c1a5d91d764fb282139c88fe11e182a3a734" - integrity sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g== - dependencies: - deep-is "^0.1.3" - fast-levenshtein "^2.0.6" - levn "^0.4.1" - prelude-ls "^1.2.1" - type-check "^0.4.0" - word-wrap "^1.2.5" - -os-tmpdir@~1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/os-tmpdir/-/os-tmpdir-1.0.2.tgz#bbe67406c79aa85c5cfec766fe5734555dfa1274" - integrity sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g== - -p-all@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/p-all/-/p-all-3.0.0.tgz#077c023c37e75e760193badab2bad3ccd5782bfb" - integrity sha512-qUZbvbBFVXm6uJ7U/WDiO0fv6waBMbjlCm4E66oZdRR+egswICarIdHyVSZZHudH8T5SF8x/JG0q0duFzPnlBw== - dependencies: - p-map "^4.0.0" - -p-limit@^2.2.0: - version "2.3.0" - resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" - integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== - dependencies: - p-try "^2.0.0" - -p-limit@^3.0.2, p-limit@^3.1.0: - version "3.1.0" - resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-3.1.0.tgz#e1daccbe78d0d1388ca18c64fea38e3e57e3706b" - integrity sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ== - dependencies: - yocto-queue "^0.1.0" - -p-locate@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" - integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== - dependencies: - p-limit "^2.2.0" - -p-locate@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-5.0.0.tgz#83c8315c6785005e3bd021839411c9e110e6d834" - integrity sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw== - dependencies: - p-limit "^3.0.2" - -p-map@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" - integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== - dependencies: - aggregate-error "^3.0.0" - -p-try@^2.0.0: - version "2.2.0" - resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" - integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== - -parent-module@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" - integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== - dependencies: - callsites "^3.0.0" - -parse-json@^5.2.0: - version "5.2.0" - resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" - integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== - dependencies: - "@babel/code-frame" "^7.0.0" - error-ex "^1.3.1" - json-parse-even-better-errors "^2.3.0" - lines-and-columns "^1.1.6" - -parseurl@^1.3.3: - version "1.3.3" - resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.3.tgz#9da19e7bee8d12dff0513ed5b76957793bc2e8d4" - integrity sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ== - -path-browserify@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/path-browserify/-/path-browserify-1.0.1.tgz#d98454a9c3753d5790860f16f68867b9e46be1fd" - integrity sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g== - -path-exists@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" - integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== - -path-is-absolute@^1.0.0: - version "1.0.1" - resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" - integrity sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg== - -path-key@^3.0.0, path-key@^3.1.0: - version "3.1.1" - resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" - integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== - -path-parse@^1.0.7: - version "1.0.7" - resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" - integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== - -path-to-regexp@^8.0.0: - version "8.3.0" - resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-8.3.0.tgz#aa818a6981f99321003a08987d3cec9c3474cd1f" - integrity sha512-7jdwVIRtsP8MYpdXSwOS0YdD0Du+qOoF/AEPIt88PcCFrZCzx41oxku1jD88hZBwbNUIEfpqvuhjFaMAqMTWnA== - -picocolors@^1.1.1: - version "1.1.1" - resolved "https://registry.yarnpkg.com/picocolors/-/picocolors-1.1.1.tgz#3d321af3eab939b083c8f929a1d12cda81c26b6b" - integrity sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA== - -picomatch@^2.0.4, picomatch@^2.2.3, picomatch@^2.3.1: - version "2.3.1" - resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" - integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== - -pino-abstract-transport@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-3.0.0.tgz#b21e5f33a297e8c4c915c62b3ce5dd4a87a52c23" - integrity sha512-wlfUczU+n7Hy/Ha5j9a/gZNy7We5+cXp8YL+X+PG8S0KXxw7n/JXA3c46Y0zQznIJ83URJiwy7Lh56WLokNuxg== - dependencies: - split2 "^4.0.0" - -pino-http@^11.0.0: - version "11.0.0" - resolved "https://registry.yarnpkg.com/pino-http/-/pino-http-11.0.0.tgz#ebadef4694fc59aadab9be7e5939aea625b4615f" - integrity sha512-wqg5XIAGRRIWtTk8qPGxkbrfiwEWz1lgedVLvhLALudKXvg1/L2lTFgTGPJ4Z2e3qcRmxoFxDuSdMdMGNM6I1g== - dependencies: - get-caller-file "^2.0.5" - pino "^10.0.0" - pino-std-serializers "^7.0.0" - process-warning "^5.0.0" - -pino-pretty@^13.1.3: - version "13.1.3" - resolved "https://registry.yarnpkg.com/pino-pretty/-/pino-pretty-13.1.3.tgz#2274cccda925dd355c104079a5029f6598d0381b" - integrity sha512-ttXRkkOz6WWC95KeY9+xxWL6AtImwbyMHrL1mSwqwW9u+vLp/WIElvHvCSDg0xO/Dzrggz1zv3rN5ovTRVowKg== - dependencies: - colorette "^2.0.7" - dateformat "^4.6.3" - fast-copy "^4.0.0" - fast-safe-stringify "^2.1.1" - help-me "^5.0.0" - joycon "^3.1.1" - minimist "^1.2.6" - on-exit-leak-free "^2.1.0" - pino-abstract-transport "^3.0.0" - pump "^3.0.0" - secure-json-parse "^4.0.0" - sonic-boom "^4.0.1" - strip-json-comments "^5.0.2" - -pino-std-serializers@^7.0.0: - version "7.1.0" - resolved "https://registry.yarnpkg.com/pino-std-serializers/-/pino-std-serializers-7.1.0.tgz#a7b0cd65225f29e92540e7853bd73b07479893fc" - integrity sha512-BndPH67/JxGExRgiX1dX0w1FvZck5Wa4aal9198SrRhZjH3GxKQUKIBnYJTdj2HDN3UQAS06HlfcSbQj2OHmaw== - -pino@^10.0.0, pino@^10.3.1: - version "10.3.1" - resolved "https://registry.yarnpkg.com/pino/-/pino-10.3.1.tgz#6552c8f8d8481844c9e452e7bf0be90bff1939ce" - integrity sha512-r34yH/GlQpKZbU1BvFFqOjhISRo1MNx1tWYsYvmj6KIRHSPMT2+yHOEb1SG6NMvRoHRF0a07kCOox/9yakl1vg== - dependencies: - "@pinojs/redact" "^0.4.0" - atomic-sleep "^1.0.0" - on-exit-leak-free "^2.1.0" - pino-abstract-transport "^3.0.0" - pino-std-serializers "^7.0.0" - process-warning "^5.0.0" - quick-format-unescaped "^4.0.3" - real-require "^0.2.0" - safe-stable-stringify "^2.3.1" - sonic-boom "^4.0.1" - thread-stream "^4.0.0" - -pirates@^4.0.4: - version "4.0.7" - resolved "https://registry.yarnpkg.com/pirates/-/pirates-4.0.7.tgz#643b4a18c4257c8a65104b73f3049ce9a0a15e22" - integrity sha512-TfySrs/5nm8fQJDcBDuUng3VOUKsd7S+zqvbOTiGXHfxX4wK31ard+hoNuvkicM/2YFzlpDgABOevKSsB4G/FA== - -pkce-challenge@^5.0.0: - version "5.0.1" - resolved "https://registry.yarnpkg.com/pkce-challenge/-/pkce-challenge-5.0.1.tgz#3b4446865b17b1745e9ace2016a31f48ddf6230d" - integrity sha512-wQ0b/W4Fr01qtpHlqSqspcj3EhBvimsdh0KlHhH8HRZnMsEa0ea2fTULOXOS9ccQr3om+GcGRk4e+isrZWV8qQ== - -pkg-dir@^4.2.0: - version "4.2.0" - resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" - integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== - dependencies: - find-up "^4.0.0" - -prelude-ls@^1.2.1: - version "1.2.1" - resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" - integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== - -prettier-linter-helpers@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.1.tgz#6a31f88a4bad6c7adda253de12ba4edaea80ebcd" - integrity sha512-SxToR7P8Y2lWmv/kTzVLC1t/GDI2WGjMwNhLLE9qtH8Q13C+aEmuRlzDst4Up4s0Wc8sF2M+J57iB3cMLqftfg== - dependencies: - fast-diff "^1.1.2" - -prettier@^3.0.0: - version "3.7.4" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.7.4.tgz#d2f8335d4b1cec47e1c8098645411b0c9dff9c0f" - integrity sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA== - -pretty-bytes@^5.6.0: - version "5.6.0" - resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-5.6.0.tgz#356256f643804773c82f64723fe78c92c62beaeb" - integrity sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg== - -pretty-format@^29.0.0, pretty-format@^29.7.0: - version "29.7.0" - resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-29.7.0.tgz#ca42c758310f365bfa71a0bda0a807160b776812" - integrity sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ== - dependencies: - "@jest/schemas" "^29.6.3" - ansi-styles "^5.0.0" - react-is "^18.0.0" - -process-warning@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/process-warning/-/process-warning-5.0.0.tgz#566e0bf79d1dff30a72d8bbbe9e8ecefe8d378d7" - integrity sha512-a39t9ApHNx2L4+HBnQKqxxHNs1r7KF+Intd8Q/g1bUh6q0WIp9voPXJ/x0j+ZL45KF1pJd9+q2jLIRMfvEshkA== - -prompts@^2.0.1: - version "2.4.2" - resolved "https://registry.yarnpkg.com/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" - integrity sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== - dependencies: - kleur "^3.0.3" - sisteransi "^1.0.5" - -proxy-addr@^2.0.7: - version "2.0.7" - resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025" - integrity sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg== - dependencies: - forwarded "0.2.0" - ipaddr.js "1.9.1" - -pump@^3.0.0: - version "3.0.4" - resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.4.tgz#1f313430527fa8b905622ebd22fe1444e757ab3c" - integrity sha512-VS7sjc6KR7e1ukRFhQSY5LM2uBWAUPiOPa/A3mkKmiMwSmRFUITt0xuj+/lesgnCv+dPIEYlkzrcyXgquIHMcA== - dependencies: - end-of-stream "^1.1.0" - once "^1.3.1" - -punycode@^2.1.0: - version "2.3.1" - resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" - integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg== - -pure-rand@^6.0.0: - version "6.1.0" - resolved "https://registry.yarnpkg.com/pure-rand/-/pure-rand-6.1.0.tgz#d173cf23258231976ccbdb05247c9787957604f2" - integrity sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA== - -qs@^6.14.0, qs@^6.14.1: - version "6.14.1" - resolved "https://registry.yarnpkg.com/qs/-/qs-6.14.1.tgz#a41d85b9d3902f31d27861790506294881871159" - integrity sha512-4EK3+xJl8Ts67nLYNwqw/dsFVnCf+qR7RgXSK9jEEm9unao3njwMDdmsdvoKBKHzxd7tCYz5e5M+SnMjdtXGQQ== - dependencies: - side-channel "^1.1.0" - -queue-microtask@^1.2.2: - version "1.2.3" - resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" - integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== - -quick-format-unescaped@^4.0.3: - version "4.0.4" - resolved "https://registry.yarnpkg.com/quick-format-unescaped/-/quick-format-unescaped-4.0.4.tgz#93ef6dd8d3453cbc7970dd614fad4c5954d6b5a7" - integrity sha512-tYC1Q1hgyRuHgloV/YXs2w15unPVh8qfu/qCTfhTYamaw7fyhumKa2yGpdSo87vY32rIclj+4fWYQXUMs9EHvg== - -range-parser@^1.2.1: - version "1.2.1" - resolved "https://registry.yarnpkg.com/range-parser/-/range-parser-1.2.1.tgz#3cf37023d199e1c24d1a55b84800c2f3e6468031" - integrity sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg== - -raw-body@^3.0.0, raw-body@^3.0.1: - version "3.0.2" - resolved "https://registry.yarnpkg.com/raw-body/-/raw-body-3.0.2.tgz#3e3ada5ae5568f9095d84376fd3a49b8fb000a51" - integrity sha512-K5zQjDllxWkf7Z5xJdV0/B0WTNqx6vxG70zJE4N0kBs4LovmEYWJzQGxC9bS9RAKu3bgM40lrd5zoLJ12MQ5BA== - dependencies: - bytes "~3.1.2" - http-errors "~2.0.1" - iconv-lite "~0.7.0" - unpipe "~1.0.0" - -react-is@^18.0.0: - version "18.3.1" - resolved "https://registry.yarnpkg.com/react-is/-/react-is-18.3.1.tgz#e83557dc12eae63a99e003a46388b1dcbb44db7e" - integrity sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg== - -readable-stream@^3.4.0: - version "3.6.2" - resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.2.tgz#56a9b36ea965c00c5a93ef31eb111a0f11056967" - integrity sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA== - dependencies: - inherits "^2.0.3" - string_decoder "^1.1.1" - util-deprecate "^1.0.1" - -real-require@^0.2.0: - version "0.2.0" - resolved "https://registry.yarnpkg.com/real-require/-/real-require-0.2.0.tgz#209632dea1810be2ae063a6ac084fee7e33fba78" - integrity sha512-57frrGM/OCTLqLOAh0mhVA9VBMHd+9U7Zb2THMGdBUoZVOtGbJzjxsYGDJ3A9AYYCP4hn6y1TVbaOfzWtm5GFg== - -require-directory@^2.1.1: - version "2.1.1" - resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" - integrity sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q== - -require-from-string@^2.0.2: - version "2.0.2" - resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" - integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== - -resolve-cwd@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d" - integrity sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg== - dependencies: - resolve-from "^5.0.0" - -resolve-from@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" - integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== - -resolve-from@^5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-5.0.0.tgz#c35225843df8f776df21c57557bc087e9dfdfc69" - integrity sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== - -resolve.exports@^2.0.0: - version "2.0.3" - resolved "https://registry.yarnpkg.com/resolve.exports/-/resolve.exports-2.0.3.tgz#41955e6f1b4013b7586f873749a635dea07ebe3f" - integrity sha512-OcXjMsGdhL4XnbShKpAcSqPMzQoYkYyhbEaeSko47MjRP9NfEQMhZkXL1DoFlt9LWQn4YttrdnV6X2OiyzBi+A== - -resolve@^1.20.0: - version "1.22.11" - resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.11.tgz#aad857ce1ffb8bfa9b0b1ac29f1156383f68c262" - integrity sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ== - dependencies: - is-core-module "^2.16.1" - path-parse "^1.0.7" - supports-preserve-symlinks-flag "^1.0.0" - -reusify@^1.0.4: - version "1.1.0" - resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.1.0.tgz#0fe13b9522e1473f51b558ee796e08f11f9b489f" - integrity sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw== - -router@^2.2.0: - version "2.2.0" - resolved "https://registry.yarnpkg.com/router/-/router-2.2.0.tgz#019be620b711c87641167cc79b99090f00b146ef" - integrity sha512-nLTrUKm2UyiL7rlhapu/Zl45FwNgkZGaCpZbIHajDYgwlJCOzLSk+cIPAnsEqV955GjILJnKbdQC1nVPz+gAYQ== - dependencies: - debug "^4.4.0" - depd "^2.0.0" - is-promise "^4.0.0" - parseurl "^1.3.3" - path-to-regexp "^8.0.0" - -run-parallel@^1.1.9: - version "1.2.0" - resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" - integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== - dependencies: - queue-microtask "^1.2.2" - -safe-buffer@~5.2.0: - version "5.2.1" - resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" - integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== - -safe-stable-stringify@^2.3.1: - version "2.5.0" - resolved "https://registry.yarnpkg.com/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz#4ca2f8e385f2831c432a719b108a3bf7af42a1dd" - integrity sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA== - -"safer-buffer@>= 2.1.2 < 3", "safer-buffer@>= 2.1.2 < 3.0.0": - version "2.1.2" - resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" - integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== - -secure-json-parse@^4.0.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/secure-json-parse/-/secure-json-parse-4.1.0.tgz#4f1ab41c67a13497ea1b9131bb4183a22865477c" - integrity sha512-l4KnYfEyqYJxDwlNVyRfO2E4NTHfMKAWdUuA8J0yve2Dz/E/PdBepY03RvyJpssIpRFwJoCD55wA+mEDs6ByWA== - -semver@^6.3.0, semver@^6.3.1: - version "6.3.1" - resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4" - integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA== - -semver@^7.5.3, semver@^7.5.4, semver@^7.6.0, semver@^7.7.3: - version "7.7.3" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.7.3.tgz#4b5f4143d007633a8dc671cd0a6ef9147b8bb946" - integrity sha512-SdsKMrI9TdgjdweUSR9MweHA4EJ8YxHn8DFaDisvhVlUOe4BF1tLD7GAj0lIqWVl+dPb/rExr0Btby5loQm20Q== - -send@^1.1.0, send@^1.2.0: - version "1.2.1" - resolved "https://registry.yarnpkg.com/send/-/send-1.2.1.tgz#9eab743b874f3550f40a26867bf286ad60d3f3ed" - integrity sha512-1gnZf7DFcoIcajTjTwjwuDjzuz4PPcY2StKPlsGAQ1+YH20IRVrBaXSWmdjowTJ6u8Rc01PoYOGHXfP1mYcZNQ== - dependencies: - debug "^4.4.3" - encodeurl "^2.0.0" - escape-html "^1.0.3" - etag "^1.8.1" - fresh "^2.0.0" - http-errors "^2.0.1" - mime-types "^3.0.2" - ms "^2.1.3" - on-finished "^2.4.1" - range-parser "^1.2.1" - statuses "^2.0.2" - -serve-static@^2.2.0: - version "2.2.1" - resolved "https://registry.yarnpkg.com/serve-static/-/serve-static-2.2.1.tgz#7f186a4a4e5f5b663ad7a4294ff1bf37cf0e98a9" - integrity sha512-xRXBn0pPqQTVQiC8wyQrKs2MOlX24zQ0POGaj0kultvoOCstBQM5yvOhAVSUwOMjQtTvsPWoNCHfPGwaaQJhTw== - dependencies: - encodeurl "^2.0.0" - escape-html "^1.0.3" - parseurl "^1.3.3" - send "^1.2.0" - -setprototypeof@~1.2.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.2.0.tgz#66c9a24a73f9fc28cbe66b09fed3d33dcaf1b424" - integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw== - -shebang-command@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" - integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== - dependencies: - shebang-regex "^3.0.0" - -shebang-regex@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" - integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== - -side-channel-list@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/side-channel-list/-/side-channel-list-1.0.0.tgz#10cb5984263115d3b7a0e336591e290a830af8ad" - integrity sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA== - dependencies: - es-errors "^1.3.0" - object-inspect "^1.13.3" - -side-channel-map@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/side-channel-map/-/side-channel-map-1.0.1.tgz#d6bb6b37902c6fef5174e5f533fab4c732a26f42" - integrity sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA== - dependencies: - call-bound "^1.0.2" - es-errors "^1.3.0" - get-intrinsic "^1.2.5" - object-inspect "^1.13.3" - -side-channel-weakmap@^1.0.2: - version "1.0.2" - resolved "https://registry.yarnpkg.com/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz#11dda19d5368e40ce9ec2bdc1fb0ecbc0790ecea" - integrity sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A== - dependencies: - call-bound "^1.0.2" - es-errors "^1.3.0" - get-intrinsic "^1.2.5" - object-inspect "^1.13.3" - side-channel-map "^1.0.1" - -side-channel@^1.1.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.1.0.tgz#c3fcff9c4da932784873335ec9765fa94ff66bc9" - integrity sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw== - dependencies: - es-errors "^1.3.0" - object-inspect "^1.13.3" - side-channel-list "^1.0.0" - side-channel-map "^1.0.1" - side-channel-weakmap "^1.0.2" - -signal-exit@^3.0.3, signal-exit@^3.0.7: - version "3.0.7" - resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" - integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== - -signal-exit@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-4.1.0.tgz#952188c1cbd546070e2dd20d0f41c0ae0530cb04" - integrity sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw== - -sisteransi@^1.0.5: - version "1.0.5" - resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed" - integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== - -slash@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" - integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== - -sonic-boom@^4.0.1: - version "4.2.1" - resolved "https://registry.yarnpkg.com/sonic-boom/-/sonic-boom-4.2.1.tgz#28598250df4899c0ac572d7e2f0460690ba6a030" - integrity sha512-w6AxtubXa2wTXAUsZMMWERrsIRAdrK0Sc+FUytWvYAhBJLyuI4llrMIC1DtlNSdI99EI86KZum2MMq3EAZlF9Q== - dependencies: - atomic-sleep "^1.0.0" - -source-map-support@0.5.13: - version "0.5.13" - resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.13.tgz#31b24a9c2e73c2de85066c0feb7d44767ed52932" - integrity sha512-SHSKFHadjVA5oR4PPqhtAVdcBWwRYVd6g6cAXnIbRiIwc2EhPrTuKUBdSLvlEKyIP3GCf89fltvcZiP9MMFA1w== - dependencies: - buffer-from "^1.0.0" - source-map "^0.6.0" - -source-map@^0.6.0, source-map@^0.6.1: - version "0.6.1" - resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" - integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== - -split2@^4.0.0: - version "4.2.0" - resolved "https://registry.yarnpkg.com/split2/-/split2-4.2.0.tgz#c9c5920904d148bab0b9f67145f245a86aadbfa4" - integrity sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg== - -sprintf-js@~1.0.2: - version "1.0.3" - resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" - integrity sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g== - -stack-utils@^2.0.3: - version "2.0.6" - resolved "https://registry.yarnpkg.com/stack-utils/-/stack-utils-2.0.6.tgz#aaf0748169c02fc33c8232abccf933f54a1cc34f" - integrity sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ== - dependencies: - escape-string-regexp "^2.0.0" - -statuses@^2.0.1, statuses@^2.0.2, statuses@~2.0.2: - version "2.0.2" - resolved "https://registry.yarnpkg.com/statuses/-/statuses-2.0.2.tgz#8f75eecef765b5e1cfcdc080da59409ed424e382" - integrity sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw== - -string-length@^4.0.1: - version "4.0.2" - resolved "https://registry.yarnpkg.com/string-length/-/string-length-4.0.2.tgz#a8a8dc7bd5c1a82b9b3c8b87e125f66871b6e57a" - integrity sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ== - dependencies: - char-regex "^1.0.2" - strip-ansi "^6.0.0" - -string-to-stream@^3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/string-to-stream/-/string-to-stream-3.0.1.tgz#480e6fb4d5476d31cb2221f75307a5dcb6638a42" - integrity sha512-Hl092MV3USJuUCC6mfl9sPzGloA3K5VwdIeJjYIkXY/8K+mUvaeEabWJgArp+xXrsWxCajeT2pc4axbVhIZJyg== - dependencies: - readable-stream "^3.4.0" - -string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: - version "4.2.3" - resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" - integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== - dependencies: - emoji-regex "^8.0.0" - is-fullwidth-code-point "^3.0.0" - strip-ansi "^6.0.1" - -string_decoder@^1.1.1: - version "1.3.0" - resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" - integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== - dependencies: - safe-buffer "~5.2.0" - -strip-ansi@^6.0.0, strip-ansi@^6.0.1: - version "6.0.1" - resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" - integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== - dependencies: - ansi-regex "^5.0.1" - -strip-bom@^3.0.0: - version "3.0.0" - resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-3.0.0.tgz#2334c18e9c759f7bdd56fdef7e9ae3d588e68ed3" - integrity sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA== - -strip-bom@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/strip-bom/-/strip-bom-4.0.0.tgz#9c3505c1db45bcedca3d9cf7a16f5c5aa3901878" - integrity sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w== - -strip-final-newline@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" - integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== - -strip-json-comments@^3.1.1: - version "3.1.1" - resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" - integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== - -strip-json-comments@^5.0.2: - version "5.0.3" - resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-5.0.3.tgz#b7304249dd402ee67fd518ada993ab3593458bcf" - integrity sha512-1tB5mhVo7U+ETBKNf92xT4hrQa3pm0MZ0PQvuDnWgAAGHDsfp4lPSpiS6psrSiet87wyGPh9ft6wmhOMQ0hDiw== - -superstruct@^1.0.4: - version "1.0.4" - resolved "https://registry.yarnpkg.com/superstruct/-/superstruct-1.0.4.tgz#0adb99a7578bd2f1c526220da6571b2d485d91ca" - integrity sha512-7JpaAoX2NGyoFlI9NBh66BQXGONc+uE+MRS5i2iOBKuS4e+ccgMDjATgZldkah+33DakBxDHiss9kvUcGAO8UQ== - -supports-color@^7.1.0: - version "7.2.0" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" - integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== - dependencies: - has-flag "^4.0.0" - -supports-color@^8.0.0: - version "8.1.1" - resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" - integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== - dependencies: - has-flag "^4.0.0" - -supports-preserve-symlinks-flag@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" - integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== - -synckit@^0.11.12: - version "0.11.12" - resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.11.12.tgz#abe74124264fbc00a48011b0d98bdc1cffb64a7b" - integrity sha512-Bh7QjT8/SuKUIfObSXNHNSK6WHo6J1tHCqJsuaFDP7gP0fkzSfTxI8y85JrppZ0h8l0maIgc2tfuZQ6/t3GtnQ== - dependencies: - "@pkgr/core" "^0.2.9" - -test-exclude@^6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" - integrity sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w== - dependencies: - "@istanbuljs/schema" "^0.1.2" - glob "^7.1.4" - minimatch "^3.0.4" - -thread-stream@^4.0.0: - version "4.0.0" - resolved "https://registry.yarnpkg.com/thread-stream/-/thread-stream-4.0.0.tgz#732f007c24da7084f729d6e3a7e3f5934a7380b7" - integrity sha512-4iMVL6HAINXWf1ZKZjIPcz5wYaOdPhtO8ATvZ+Xqp3BTdaqtAwQkNmKORqcIo5YkQqGXq5cwfswDwMqqQNrpJA== - dependencies: - real-require "^0.2.0" - -tmp@^0.0.33: - version "0.0.33" - resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.0.33.tgz#6d34335889768d21b2bcda0aa277ced3b1bfadf9" - integrity sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw== - dependencies: - os-tmpdir "~1.0.2" - -tmpl@1.0.5: - version "1.0.5" - resolved "https://registry.yarnpkg.com/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc" - integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw== - -to-regex-range@^5.0.1: - version "5.0.1" - resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" - integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== - dependencies: - is-number "^7.0.0" - -toidentifier@~1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/toidentifier/-/toidentifier-1.0.1.tgz#3be34321a88a820ed1bd80dfaa33e479fbb8dd35" - integrity sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA== - -ts-api-utils@^2.0.1: - version "2.4.0" - resolved "https://registry.yarnpkg.com/ts-api-utils/-/ts-api-utils-2.4.0.tgz#2690579f96d2790253bdcf1ca35d569ad78f9ad8" - integrity sha512-3TaVTaAv2gTiMB35i3FiGJaRfwb3Pyn/j3m/bfAvGe8FB7CF6u+LMYqYlDh7reQf7UNvoTvdfAqHGmPGOSsPmA== - -ts-jest@^29.1.0: - version "29.4.6" - resolved "https://registry.yarnpkg.com/ts-jest/-/ts-jest-29.4.6.tgz#51cb7c133f227396818b71297ad7409bb77106e9" - integrity sha512-fSpWtOO/1AjSNQguk43hb/JCo16oJDnMJf3CdEGNkqsEX3t0KX96xvyX1D7PfLCpVoKu4MfVrqUkFyblYoY4lA== - dependencies: - bs-logger "^0.2.6" - fast-json-stable-stringify "^2.1.0" - handlebars "^4.7.8" - json5 "^2.2.3" - lodash.memoize "^4.1.2" - make-error "^1.3.6" - semver "^7.7.3" - type-fest "^4.41.0" - yargs-parser "^21.1.1" - -ts-morph@^19.0.0: - version "19.0.0" - resolved "https://registry.yarnpkg.com/ts-morph/-/ts-morph-19.0.0.tgz#43e95fb0156c3fe3c77c814ac26b7d0be2f93169" - integrity sha512-D6qcpiJdn46tUqV45vr5UGM2dnIEuTGNxVhg0sk5NX11orcouwj6i1bMqZIz2mZTZB1Hcgy7C3oEVhAT+f6mbQ== - dependencies: - "@ts-morph/common" "~0.20.0" - code-block-writer "^12.0.0" - -ts-node@^10.5.0: - version "10.9.2" - resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f" - integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ== - dependencies: - "@cspotcode/source-map-support" "^0.8.0" - "@tsconfig/node10" "^1.0.7" - "@tsconfig/node12" "^1.0.7" - "@tsconfig/node14" "^1.0.0" - "@tsconfig/node16" "^1.0.2" - acorn "^8.4.1" - acorn-walk "^8.1.1" - arg "^4.1.0" - create-require "^1.1.0" - diff "^4.0.1" - make-error "^1.1.1" - v8-compile-cache-lib "^3.0.1" - yn "3.1.1" - -"tsc-multi@https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz": - version "1.1.11" - resolved "https://github.com/stainless-api/tsc-multi/releases/download/v1.1.11/tsc-multi.tgz#010247051be13b55abdc98f787c017285149f4f2" - dependencies: - debug "^4.3.7" - fast-glob "^3.3.2" - get-stdin "^8.0.0" - p-all "^3.0.0" - picocolors "^1.1.1" - signal-exit "^3.0.7" - string-to-stream "^3.0.1" - superstruct "^1.0.4" - tslib "^2.8.1" - yargs "^17.7.2" - -tsconfig-paths@^4.0.0: - version "4.2.0" - resolved "https://registry.yarnpkg.com/tsconfig-paths/-/tsconfig-paths-4.2.0.tgz#ef78e19039133446d244beac0fd6a1632e2d107c" - integrity sha512-NoZ4roiN7LnbKn9QqE1amc9DJfzvZXxF4xDavcOWt1BPkdx+m+0gJuPM+S0vCe7zTJMYUP0R8pO2XMr+Y8oLIg== - dependencies: - json5 "^2.2.2" - minimist "^1.2.6" - strip-bom "^3.0.0" - -tslib@^2.8.1: - version "2.8.1" - resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" - integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== - -type-check@^0.4.0, type-check@~0.4.0: - version "0.4.0" - resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.4.0.tgz#07b8203bfa7056c0657050e3ccd2c37730bab8f1" - integrity sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew== - dependencies: - prelude-ls "^1.2.1" - -type-detect@4.0.8: - version "4.0.8" - resolved "https://registry.yarnpkg.com/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c" - integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g== - -type-fest@^0.21.3: - version "0.21.3" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" - integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== - -type-fest@^4.41.0: - version "4.41.0" - resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.41.0.tgz#6ae1c8e5731273c2bf1f58ad39cbae2c91a46c58" - integrity sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA== - -type-is@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/type-is/-/type-is-2.0.1.tgz#64f6cf03f92fce4015c2b224793f6bdd4b068c97" - integrity sha512-OZs6gsjF4vMp32qrCbiVSkrFmXtG/AZhY3t0iAMrMBiAZyV9oALtXO8hsrHbMXF9x6L3grlFuwW2oAz7cav+Gw== - dependencies: - content-type "^1.0.5" - media-typer "^1.1.0" - mime-types "^3.0.0" - -typescript@5.8.3: - version "5.8.3" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.8.3.tgz#92f8a3e5e3cf497356f4178c34cd65a7f5e8440e" - integrity sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ== - -uglify-js@^3.1.4: - version "3.19.3" - resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.19.3.tgz#82315e9bbc6f2b25888858acd1fff8441035b77f" - integrity sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ== - -undici-types@~6.21.0: - version "6.21.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.21.0.tgz#691d00af3909be93a7faa13be61b3a5b50ef12cb" - integrity sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ== - -undici-types@~7.16.0: - version "7.16.0" - resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-7.16.0.tgz#ffccdff36aea4884cbfce9a750a0580224f58a46" - integrity sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw== - -universalify@^2.0.0: - version "2.0.1" - resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.1.tgz#168efc2180964e6386d061e094df61afe239b18d" - integrity sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw== - -unpipe@~1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" - integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== - -update-browserslist-db@^1.2.0: - version "1.2.3" - resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz#64d76db58713136acbeb4c49114366cc6cc2e80d" - integrity sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w== - dependencies: - escalade "^3.2.0" - picocolors "^1.1.1" - -uri-js@^4.2.2: - version "4.4.1" - resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" - integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== - dependencies: - punycode "^2.1.0" - -util-deprecate@^1.0.1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" - integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw== - -v8-compile-cache-lib@^3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf" - integrity sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg== - -v8-to-istanbul@^9.0.1: - version "9.3.0" - resolved "https://registry.yarnpkg.com/v8-to-istanbul/-/v8-to-istanbul-9.3.0.tgz#b9572abfa62bd556c16d75fdebc1a411d5ff3175" - integrity sha512-kiGUalWN+rgBJ/1OHZsBtU4rXZOfj/7rKQxULKlIzwzQSvMJUUNgPwJEEh7gU6xEVxC0ahoOBvN2YI8GH6FNgA== - dependencies: - "@jridgewell/trace-mapping" "^0.3.12" - "@types/istanbul-lib-coverage" "^2.0.1" - convert-source-map "^2.0.0" - -vary@^1, vary@^1.1.2: - version "1.1.2" - resolved "https://registry.yarnpkg.com/vary/-/vary-1.1.2.tgz#2299f02c6ded30d4a5961b0b9f74524a18f634fc" - integrity sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg== - -walker@^1.0.8: - version "1.0.8" - resolved "https://registry.yarnpkg.com/walker/-/walker-1.0.8.tgz#bd498db477afe573dc04185f011d3ab8a8d7653f" - integrity sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ== - dependencies: - makeerror "1.0.12" - -which@^2.0.1: - version "2.0.2" - resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" - integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== - dependencies: - isexe "^2.0.0" - -word-wrap@^1.2.5: - version "1.2.5" - resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.5.tgz#d2c45c6dd4fbce621a66f136cbe328afd0410b34" - integrity sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA== - -wordwrap@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" - integrity sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q== - -wrap-ansi@^6.2.0: - version "6.2.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" - integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - -wrap-ansi@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" - integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== - dependencies: - ansi-styles "^4.0.0" - string-width "^4.1.0" - strip-ansi "^6.0.0" - -wrappy@1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" - integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== - -write-file-atomic@^4.0.2: - version "4.0.2" - resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-4.0.2.tgz#a9df01ae5b77858a027fd2e80768ee433555fcfd" - integrity sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg== - dependencies: - imurmurhash "^0.1.4" - signal-exit "^3.0.7" - -y18n@^5.0.5: - version "5.0.8" - resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" - integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== - -yallist@^3.0.2: - version "3.1.1" - resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" - integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== - -yargs-parser@^21.1.1: - version "21.1.1" - resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.1.1.tgz#9096bceebf990d21bb31fa9516e0ede294a77d35" - integrity sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw== - -yargs@^17.3.1, yargs@^17.7.2: - version "17.7.2" - resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.7.2.tgz#991df39aca675a192b816e1e0363f9d75d2aa269" - integrity sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w== - dependencies: - cliui "^8.0.1" - escalade "^3.1.1" - get-caller-file "^2.0.5" - require-directory "^2.1.1" - string-width "^4.2.3" - y18n "^5.0.5" - yargs-parser "^21.1.1" - -yn@3.1.1: - version "3.1.1" - resolved "https://registry.yarnpkg.com/yn/-/yn-3.1.1.tgz#1e87401a09d767c1d5eab26a6e4c185182d2eb50" - integrity sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q== - -yocto-queue@^0.1.0: - version "0.1.0" - resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" - integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q== - -yoctocolors-cjs@^2.1.2: - version "2.1.3" - resolved "https://registry.yarnpkg.com/yoctocolors-cjs/-/yoctocolors-cjs-2.1.3.tgz#7e4964ea8ec422b7a40ac917d3a344cfd2304baa" - integrity sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw== - -zod-to-json-schema@^3.24.5, zod-to-json-schema@^3.24.6, zod-to-json-schema@^3.25.1: - version "3.25.1" - resolved "https://registry.yarnpkg.com/zod-to-json-schema/-/zod-to-json-schema-3.25.1.tgz#7f24962101a439ddade2bf1aeab3c3bfec7d84ba" - integrity sha512-pM/SU9d3YAggzi6MtR4h7ruuQlqKtad8e9S0fmxcMi+ueAK5Korys/aWcV9LIIHTVbj01NdzxcnXSN+O74ZIVA== - -zod-validation-error@^4.0.1: - version "4.0.2" - resolved "https://registry.yarnpkg.com/zod-validation-error/-/zod-validation-error-4.0.2.tgz#bc605eba49ce0fcd598c127fee1c236be3f22918" - integrity sha512-Q6/nZLe6jxuU80qb/4uJ4t5v2VEZ44lzQjPDhYJNztRQ4wyWc6VF3D3Kb/fAuPetZQnhS3hnajCf9CsWesghLQ== - -"zod@^3.25 || ^4.0": - version "4.3.5" - resolved "https://registry.yarnpkg.com/zod/-/zod-4.3.5.tgz#aeb269a6f9fc259b1212c348c7c5432aaa474d2a" - integrity sha512-k7Nwx6vuWx1IJ9Bjuf4Zt1PEllcwe7cls3VNzm4CQ1/hgtFUK2bRNG3rvnpPUhFjmqJKAKtjV576KnUkHocg/g== - -zod@^3.25.20, zod@^3.25.67: - version "3.25.76" - resolved "https://registry.yarnpkg.com/zod/-/zod-3.25.76.tgz#26841c3f6fd22a6a2760e7ccb719179768471e34" - integrity sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ== diff --git a/release-please-config.json b/release-please-config.json index 9b042792..1ebd0bde 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -60,19 +60,5 @@ } ], "release-type": "node", - "extra-files": [ - "src/version.ts", - "README.md", - "packages/mcp-server/yarn.lock", - { - "type": "json", - "path": "packages/mcp-server/package.json", - "jsonpath": "$.version" - }, - { - "type": "json", - "path": "packages/mcp-server/manifest.json", - "jsonpath": "$.version" - } - ] + "extra-files": ["src/version.ts", "README.md"] } diff --git a/scripts/build b/scripts/build index bb31f229..76462cfc 100755 --- a/scripts/build +++ b/scripts/build @@ -49,9 +49,3 @@ if [ -e ./scripts/build-deno ] then ./scripts/build-deno fi -# build all sub-packages -for dir in packages/*; do - if [ -d "$dir" ]; then - (cd "$dir" && yarn install && yarn build) - fi -done diff --git a/scripts/build-all b/scripts/build-all deleted file mode 100755 index 4e5ac01f..00000000 --- a/scripts/build-all +++ /dev/null @@ -1,5 +0,0 @@ -#!/usr/bin/env bash - -# build-all is deprecated, use build instead - -bash ./scripts/build diff --git a/scripts/publish-packages.ts b/scripts/publish-packages.ts deleted file mode 100644 index 50e93fef..00000000 --- a/scripts/publish-packages.ts +++ /dev/null @@ -1,102 +0,0 @@ -/** - * Called from the `create-releases.yml` workflow with the output - * of the release please action as the first argument. - * - * Example JSON input: - * - * ```json - { - "releases_created": "true", - "release_created": "true", - "id": "137967744", - "name": "sdk: v0.14.5", - "tag_name": "sdk-v0.14.5", - "sha": "7cc2ba5c694e76a117f731d4cf0b06f8b8361f2e", - "body": "## 0.14.5 (2024-01-22)\n\n...", - "html_url": "https://github.com/$org/$repo/releases/tag/sdk-v0.14.5", - "draft": "false", - "upload_url": "https://uploads.github.com/repos/$org/$repo/releases/137967744/assets{?name,label}", - "path": ".", - "version": "0.14.5", - "major": "0", - "minor": "14", - "patch": "5", - "packages/additional-sdk--release_created": "true", - "packages/additional-sdk--id": "137967756", - "packages/additional-sdk--name": "additional-sdk: v0.5.2", - "packages/additional-sdk--tag_name": "additional-sdk-v0.5.2", - "packages/additional-sdk--sha": "7cc2ba5c694e76a117f731d4cf0b06f8b8361f2e", - "packages/additional-sdk--body": "## 0.5.2 (2024-01-22)\n\n...", - "packages/additional-sdk--html_url": "https://github.com/$org/$repo/releases/tag/additional-sdk-v0.5.2", - "packages/additional-sdk--draft": "false", - "packages/additional-sdk--upload_url": "https://uploads.github.com/repos/$org/$repo/releases/137967756/assets{?name,label}", - "packages/additional-sdk--path": "packages/additional-sdk", - "packages/additional-sdk--version": "0.5.2", - "packages/additional-sdk--major": "0", - "packages/additional-sdk--minor": "5", - "packages/additional-sdk--patch": "2", - "paths_released": "[\".\",\"packages/additional-sdk\"]" - } - ``` - */ - -import { execSync } from 'child_process'; -import path from 'path'; - -function main() { - const data = process.argv[2] ?? process.env['DATA']; - if (!data) { - throw new Error(`Usage: publish-packages.ts '{"json": "obj"}'`); - } - - const rootDir = path.join(__dirname, '..'); - console.log('root dir', rootDir); - console.log(`publish-packages called with ${data}`); - - const outputs = JSON.parse(data); - - const rawPaths = outputs.paths_released; - - if (!rawPaths) { - console.error(JSON.stringify(outputs, null, 2)); - throw new Error('Expected outputs to contain a truthy `paths_released` property'); - } - if (typeof rawPaths !== 'string') { - console.error(JSON.stringify(outputs, null, 2)); - throw new Error('Expected outputs `paths_released` property to be a JSON string'); - } - - const paths = JSON.parse(rawPaths); - if (!Array.isArray(paths)) { - console.error(JSON.stringify(outputs, null, 2)); - throw new Error('Expected outputs `paths_released` property to be an array'); - } - if (!paths.length) { - console.error(JSON.stringify(outputs, null, 2)); - throw new Error('Expected outputs `paths_released` property to contain at least one entry'); - } - - const publishScriptPath = path.join(rootDir, 'bin', 'publish-npm'); - console.log('Using publish script at', publishScriptPath); - - console.log('Ensuring root package is built'); - console.log(`$ yarn build`); - execSync(`yarn build`, { cwd: rootDir, encoding: 'utf8', stdio: 'inherit' }); - - for (const relPackagePath of paths) { - console.log('\n'); - - const packagePath = path.join(rootDir, relPackagePath); - console.log(`Publishing in directory: ${packagePath}`); - - console.log(`$ yarn install`); - execSync(`yarn install`, { cwd: packagePath, encoding: 'utf8', stdio: 'inherit' }); - - console.log(`$ bash ${publishScriptPath}`); - execSync(`bash ${publishScriptPath}`, { cwd: packagePath, encoding: 'utf8', stdio: 'inherit' }); - } - - console.log('Finished publishing packages'); -} - -main(); diff --git a/scripts/utils/make-dist-package-json.cjs b/scripts/utils/make-dist-package-json.cjs index 4d6634ea..7c24f56e 100644 --- a/scripts/utils/make-dist-package-json.cjs +++ b/scripts/utils/make-dist-package-json.cjs @@ -12,14 +12,6 @@ processExportMap(pkgJson.exports); for (const key of ['types', 'main', 'module']) { if (typeof pkgJson[key] === 'string') pkgJson[key] = pkgJson[key].replace(/^(\.\/)?dist\//, './'); } -// Fix bin paths if present -if (pkgJson.bin) { - for (const key in pkgJson.bin) { - if (typeof pkgJson.bin[key] === 'string') { - pkgJson.bin[key] = pkgJson.bin[key].replace(/^(\.\/)?dist\//, './'); - } - } -} delete pkgJson.devDependencies; delete pkgJson.scripts.prepack; From b69a1bca2d05b92d248f4ced6b5844c3d0fde4ba Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 25 May 2026 11:30:12 +0000 Subject: [PATCH 4/6] feat(api): manual updates --- .stats.yml | 8 +- api.md | 22 + src/client.ts | 25 + src/resources/auth/api.md | 5 +- src/resources/auth/auth.ts | 6 + src/resources/auth/index.ts | 3 + src/resources/auth/oauth.ts | 53 +- src/resources/automation/actions/actions.ts | 14 +- src/resources/cms/api.md | 6 +- src/resources/cms/cms.ts | 6 +- src/resources/cms/index.ts | 3 +- .../cms/media-bridge/media-bridge.ts | 4 + src/resources/cms/site-search.ts | 975 ------------------ src/resources/cms/url-redirects.ts | 107 ++ .../custom-channels/custom-channels.ts | 1 + .../conversations/visitor-identification.ts | 4 + src/resources/crm/api.md | 8 +- src/resources/crm/crm.ts | 52 +- src/resources/crm/exports.ts | 240 ++++- src/resources/crm/index.ts | 4 - src/resources/crm/lists.ts | 188 ---- src/resources/index.ts | 1 + src/resources/scheduler/meetings/meetings.ts | 2 + src/resources/shared.ts | 453 ++++++++ src/resources/webhooks-journal.ts | 3 + src/resources/webhooks-journal/api.md | 69 ++ src/resources/webhooks-journal/index.ts | 18 + .../webhooks-journal/journal-local.ts | 3 + .../webhooks-journal/journal-local/batch.ts | 111 ++ .../webhooks-journal/journal-local/index.ts | 16 + .../journal-local/journal-local.ts | 125 +++ src/resources/webhooks-journal/journal.ts | 3 + .../webhooks-journal/journal/batch.ts | 137 +++ .../webhooks-journal/journal/index.ts | 16 + .../webhooks-journal/journal/journal.ts | 106 ++ src/resources/webhooks-journal/snapshots.ts | 39 + .../webhooks-journal/subscriptions.ts | 3 + .../webhooks-journal/subscriptions/filters.ts | 82 ++ .../webhooks-journal/subscriptions/index.ts | 4 + .../subscriptions/subscriptions.ts | 218 ++++ .../webhooks-journal/webhooks-journal.ts | 195 ++++ src/resources/webhooks/api.md | 24 +- src/resources/webhooks/webhooks.ts | 878 +++++----------- tests/api-resources/auth/oauth.test.ts | 12 + .../automation/actions/definitions.test.ts | 4 +- tests/api-resources/cms/url-redirects.test.ts | 31 + .../visitor-identification.test.ts | 6 +- tests/api-resources/crm/exports.test.ts | 59 +- tests/api-resources/crm/lists.test.ts | 93 +- .../journal-local/batch.test.ts | 93 ++ .../journal-local/journal-local.test.ts | 77 ++ .../webhooks-journal/journal/batch.test.ts | 117 +++ .../webhooks-journal/journal/journal.test.ts | 64 ++ .../webhooks-journal/snapshots.test.ts | 64 ++ .../subscriptions/filters.test.ts | 108 ++ .../subscriptions/subscriptions.test.ts | 108 ++ tests/api-resources/webhooks.test.ts | 23 +- yarn.lock | 6 +- 58 files changed, 3109 insertions(+), 1996 deletions(-) create mode 100644 src/resources/webhooks-journal.ts create mode 100644 src/resources/webhooks-journal/api.md create mode 100644 src/resources/webhooks-journal/index.ts create mode 100644 src/resources/webhooks-journal/journal-local.ts create mode 100644 src/resources/webhooks-journal/journal-local/batch.ts create mode 100644 src/resources/webhooks-journal/journal-local/index.ts create mode 100644 src/resources/webhooks-journal/journal-local/journal-local.ts create mode 100644 src/resources/webhooks-journal/journal.ts create mode 100644 src/resources/webhooks-journal/journal/batch.ts create mode 100644 src/resources/webhooks-journal/journal/index.ts create mode 100644 src/resources/webhooks-journal/journal/journal.ts create mode 100644 src/resources/webhooks-journal/snapshots.ts create mode 100644 src/resources/webhooks-journal/subscriptions.ts create mode 100644 src/resources/webhooks-journal/subscriptions/filters.ts create mode 100644 src/resources/webhooks-journal/subscriptions/index.ts create mode 100644 src/resources/webhooks-journal/subscriptions/subscriptions.ts create mode 100644 src/resources/webhooks-journal/webhooks-journal.ts create mode 100644 tests/api-resources/webhooks-journal/journal-local/batch.test.ts create mode 100644 tests/api-resources/webhooks-journal/journal-local/journal-local.test.ts create mode 100644 tests/api-resources/webhooks-journal/journal/batch.test.ts create mode 100644 tests/api-resources/webhooks-journal/journal/journal.test.ts create mode 100644 tests/api-resources/webhooks-journal/snapshots.test.ts create mode 100644 tests/api-resources/webhooks-journal/subscriptions/filters.test.ts create mode 100644 tests/api-resources/webhooks-journal/subscriptions/subscriptions.test.ts diff --git a/.stats.yml b/.stats.yml index c94373b3..60d51403 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 955 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-45b4e4548d5c629c40a55d10db6d924a20591a47a25928c3eeb82b3a7e1b640e.yml -openapi_spec_hash: 47d20b6496315d47f4f64441d4682f47 -config_hash: 997f7d3ccb889010d92f2906d731d7d1 +configured_endpoints: 959 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-5471b42def181422e461f5657935bcc5d80f62e169b34b60d017257cab8ed6a7.yml +openapi_spec_hash: 93b8671a542b331e067319184c943fdd +config_hash: 42a440e814378897b5ca0c2ad29c7f99 diff --git a/api.md b/api.md index cfff18d8..031b9100 100644 --- a/api.md +++ b/api.md @@ -3,21 +3,39 @@ Types: - AbTestCreateRequestVNext +- ActionOverrideRequest - ActionResponse +- AppLifecycleEventSubscriptionUpsertRequest - AssociationDefinition - AssociationDefinitionEgg - AssociationSpec +- AssociationSubscriptionUpsertRequest - AutomationActionsOption - BatchInputPropertyCreate - BatchInputPropertyName - BatchInputPublicObjectID - BatchInputString - BatchReadInputPropertyName +- BatchResponseJournalFetchResponse +- BatchResponseJournalFetchResponseWithErrors - CollectionResponsePropertyGroupNoPaging +- Condition +- CrmObjectSnapshotBatchRequest +- CrmObjectSnapshotBatchResponse +- CrmObjectSnapshotRequest +- CrmObjectSnapshotResponse - ErrorData - ErrorDetail +- Filter +- FilterCreateRequest +- FilterCreateResponse +- FilterResponse - ForwardPaging +- GdprPrivacyDeletionSubscriptionUpsertRequest +- JournalFetchResponse +- ListMembershipSubscriptionUpsertRequest - NextPage +- ObjectSubscriptionUpsertRequest - ObjectTypeDefinition - ObjectTypeDefinitionLabels - ObjectTypeDefinitionPatch @@ -34,7 +52,9 @@ Types: - PropertyName - PropertyValue - PublicObjectID +- SnapshotStatusResponse - StandardError +- SubscriptionUpsertRequest - TaskLocator - VersionUser @@ -67,3 +87,5 @@ Types: # [Settings](src/resources/settings/api.md) # [Webhooks](src/resources/webhooks/api.md) + +# [WebhooksJournal](src/resources/webhooks-journal/api.md) diff --git a/src/client.ts b/src/client.ts index 48cfe174..1f0f9a3f 100644 --- a/src/client.ts +++ b/src/client.ts @@ -33,6 +33,7 @@ import { Marketing } from './resources/marketing/marketing'; import { Meta } from './resources/meta/meta'; import { Scheduler } from './resources/scheduler/scheduler'; import { Settings } from './resources/settings/settings'; +import { WebhooksJournal } from './resources/webhooks-journal/webhooks-journal'; import { Webhooks } from './resources/webhooks/webhooks'; import { type Fetch } from './internal/builtin-types'; import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers'; @@ -793,6 +794,7 @@ export class HubSpot extends BaseHubSpot { scheduler: API.Scheduler = new API.Scheduler(this); settings: API.Settings = new API.Settings(this); webhooks: API.Webhooks = new API.Webhooks(this); + webhooksJournal: API.WebhooksJournal = new API.WebhooksJournal(this); } HubSpot.Account = Account; @@ -810,6 +812,7 @@ HubSpot.Meta = Meta; HubSpot.Scheduler = Scheduler; HubSpot.Settings = Settings; HubSpot.Webhooks = Webhooks; +HubSpot.WebhooksJournal = WebhooksJournal; export declare namespace HubSpot { export type RequestOptions = Opts.RequestOptions; @@ -847,22 +850,42 @@ export declare namespace HubSpot { export { Webhooks as Webhooks }; + export { WebhooksJournal as WebhooksJournal }; + export type AbTestCreateRequestVNext = API.AbTestCreateRequestVNext; + export type ActionOverrideRequest = API.ActionOverrideRequest; export type ActionResponse = API.ActionResponse; + export type AppLifecycleEventSubscriptionUpsertRequest = API.AppLifecycleEventSubscriptionUpsertRequest; export type AssociationDefinition = API.AssociationDefinition; export type AssociationDefinitionEgg = API.AssociationDefinitionEgg; export type AssociationSpec = API.AssociationSpec; + export type AssociationSubscriptionUpsertRequest = API.AssociationSubscriptionUpsertRequest; export type AutomationActionsOption = API.AutomationActionsOption; export type BatchInputPropertyCreate = API.BatchInputPropertyCreate; export type BatchInputPropertyName = API.BatchInputPropertyName; export type BatchInputPublicObjectID = API.BatchInputPublicObjectID; export type BatchInputString = API.BatchInputString; export type BatchReadInputPropertyName = API.BatchReadInputPropertyName; + export type BatchResponseJournalFetchResponse = API.BatchResponseJournalFetchResponse; + export type BatchResponseJournalFetchResponseWithErrors = API.BatchResponseJournalFetchResponseWithErrors; export type CollectionResponsePropertyGroupNoPaging = API.CollectionResponsePropertyGroupNoPaging; + export type Condition = API.Condition; + export type CrmObjectSnapshotBatchRequest = API.CrmObjectSnapshotBatchRequest; + export type CrmObjectSnapshotBatchResponse = API.CrmObjectSnapshotBatchResponse; + export type CrmObjectSnapshotRequest = API.CrmObjectSnapshotRequest; + export type CrmObjectSnapshotResponse = API.CrmObjectSnapshotResponse; export type ErrorData = API.ErrorData; export type ErrorDetail = API.ErrorDetail; + export type Filter = API.Filter; + export type FilterCreateRequest = API.FilterCreateRequest; + export type FilterCreateResponse = API.FilterCreateResponse; + export type FilterResponse = API.FilterResponse; export type ForwardPaging = API.ForwardPaging; + export type GdprPrivacyDeletionSubscriptionUpsertRequest = API.GdprPrivacyDeletionSubscriptionUpsertRequest; + export type JournalFetchResponse = API.JournalFetchResponse; + export type ListMembershipSubscriptionUpsertRequest = API.ListMembershipSubscriptionUpsertRequest; export type NextPage = API.NextPage; + export type ObjectSubscriptionUpsertRequest = API.ObjectSubscriptionUpsertRequest; export type ObjectTypeDefinition = API.ObjectTypeDefinition; export type ObjectTypeDefinitionLabels = API.ObjectTypeDefinitionLabels; export type ObjectTypeDefinitionPatch = API.ObjectTypeDefinitionPatch; @@ -879,7 +902,9 @@ export declare namespace HubSpot { export type PropertyName = API.PropertyName; export type PropertyValue = API.PropertyValue; export type PublicObjectID = API.PublicObjectID; + export type SnapshotStatusResponse = API.SnapshotStatusResponse; export type StandardError = API.StandardError; + export type SubscriptionUpsertRequest = API.SubscriptionUpsertRequest; export type TaskLocator = API.TaskLocator; export type VersionUser = API.VersionUser; } diff --git a/src/resources/auth/api.md b/src/resources/auth/api.md index ee3ab28c..43aefc9f 100644 --- a/src/resources/auth/api.md +++ b/src/resources/auth/api.md @@ -4,13 +4,16 @@ Types: +- AccessTokenResponse +- ClientCredentialsTokenResponse - PublicAccessTokenInfoResponse - PublicRefreshTokenInfoResponse - SignedAccessToken - TokenInfoResponseBaseIf +- TokenResponseIf Methods: -- client.auth.oauth.createToken({ ...params }) -> Response +- client.auth.oauth.createToken({ ...params }) -> TokenResponseIf - client.auth.oauth.introspectToken({ ...params }) -> TokenInfoResponseBaseIf - client.auth.oauth.revokeToken({ ...params }) -> Response diff --git a/src/resources/auth/auth.ts b/src/resources/auth/auth.ts index b59efef1..899742f5 100644 --- a/src/resources/auth/auth.ts +++ b/src/resources/auth/auth.ts @@ -3,7 +3,9 @@ import { APIResource } from '../../core/resource'; import * as OAuthAPI from './oauth'; import { + AccessTokenResponse, BaseOAuth, + ClientCredentialsTokenResponse, OAuth, OAuthCreateTokenParams, OAuthIntrospectTokenParams, @@ -12,6 +14,7 @@ import { PublicRefreshTokenInfoResponse, SignedAccessToken, TokenInfoResponseBaseIf, + TokenResponseIf, } from './oauth'; export class BaseAuth extends APIResource { @@ -28,10 +31,13 @@ export declare namespace Auth { export { OAuth as OAuth, BaseOAuth as BaseOAuth, + type AccessTokenResponse as AccessTokenResponse, + type ClientCredentialsTokenResponse as ClientCredentialsTokenResponse, type PublicAccessTokenInfoResponse as PublicAccessTokenInfoResponse, type PublicRefreshTokenInfoResponse as PublicRefreshTokenInfoResponse, type SignedAccessToken as SignedAccessToken, type TokenInfoResponseBaseIf as TokenInfoResponseBaseIf, + type TokenResponseIf as TokenResponseIf, type OAuthCreateTokenParams as OAuthCreateTokenParams, type OAuthIntrospectTokenParams as OAuthIntrospectTokenParams, type OAuthRevokeTokenParams as OAuthRevokeTokenParams, diff --git a/src/resources/auth/index.ts b/src/resources/auth/index.ts index 69e56298..c63664d5 100644 --- a/src/resources/auth/index.ts +++ b/src/resources/auth/index.ts @@ -4,10 +4,13 @@ export { Auth, BaseAuth } from './auth'; export { OAuth, BaseOAuth, + type AccessTokenResponse, + type ClientCredentialsTokenResponse, type PublicAccessTokenInfoResponse, type PublicRefreshTokenInfoResponse, type SignedAccessToken, type TokenInfoResponseBaseIf, + type TokenResponseIf, type OAuthCreateTokenParams, type OAuthIntrospectTokenParams, type OAuthRevokeTokenParams, diff --git a/src/resources/auth/oauth.ts b/src/resources/auth/oauth.ts index 13a0cad6..84b6ce21 100644 --- a/src/resources/auth/oauth.ts +++ b/src/resources/auth/oauth.ts @@ -14,15 +14,11 @@ export class BaseOAuth extends APIResource { createToken( body: OAuthCreateTokenParams | null | undefined = {}, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/oauth/2026-03/token', { body, ...options, - headers: buildHeaders([ - { 'Content-Type': 'application/x-www-form-urlencoded', Accept: '*/*' }, - options?.headers, - ]), - __binaryResponse: true, + headers: buildHeaders([{ 'Content-Type': 'application/x-www-form-urlencoded' }, options?.headers]), }); } @@ -60,6 +56,44 @@ export class BaseOAuth extends APIResource { } export class OAuth extends BaseOAuth {} +export interface AccessTokenResponse { + access_token: string; + + expires_in: number; + + refresh_token: string; + + token_type: string; + + token_use: 'access_token'; + + hub_id?: number; + + id_token?: string; + + scopes?: Array; + + user_id?: number; +} + +export interface ClientCredentialsTokenResponse { + access_token: string; + + expires_in: number; + + token_type: string; + + token_use: 'client_credentials'; + + hub_id?: number; + + id_token?: string; + + scopes?: Array; + + user_id?: number; +} + export interface PublicAccessTokenInfoResponse { token: string; @@ -148,6 +182,8 @@ export interface SignedAccessToken { export type TokenInfoResponseBaseIf = PublicAccessTokenInfoResponse | PublicRefreshTokenInfoResponse; +export type TokenResponseIf = AccessTokenResponse | ClientCredentialsTokenResponse; + export interface OAuthCreateTokenParams { client_id?: string; @@ -157,7 +193,7 @@ export interface OAuthCreateTokenParams { code_verifier?: string; - grant_type?: 'authorization_code' | 'refresh_token'; + grant_type?: 'authorization_code' | 'client_credentials' | 'refresh_token'; redirect_uri?: string; @@ -188,10 +224,13 @@ export interface OAuthRevokeTokenParams { export declare namespace OAuth { export { + type AccessTokenResponse as AccessTokenResponse, + type ClientCredentialsTokenResponse as ClientCredentialsTokenResponse, type PublicAccessTokenInfoResponse as PublicAccessTokenInfoResponse, type PublicRefreshTokenInfoResponse as PublicRefreshTokenInfoResponse, type SignedAccessToken as SignedAccessToken, type TokenInfoResponseBaseIf as TokenInfoResponseBaseIf, + type TokenResponseIf as TokenResponseIf, type OAuthCreateTokenParams as OAuthCreateTokenParams, type OAuthIntrospectTokenParams as OAuthIntrospectTokenParams, type OAuthRevokeTokenParams as OAuthRevokeTokenParams, diff --git a/src/resources/automation/actions/actions.ts b/src/resources/automation/actions/actions.ts index c0489ec1..d4e942bb 100644 --- a/src/resources/automation/actions/actions.ts +++ b/src/resources/automation/actions/actions.ts @@ -86,7 +86,7 @@ export interface ArrayFieldSchema { /** * Specifies that the field is of type 'ARRAY'. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'ARRAY'; } export interface BatchInputCallbackCompletionBatchRequest { @@ -98,7 +98,7 @@ export interface BooleanFieldSchema { * Specifies the field type as BOOLEAN, indicating that the field can hold a true * or false value. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'BOOLEAN'; } export interface CallbackCompletionBatchRequest { @@ -302,7 +302,7 @@ export interface DoubleFieldSchema { /** * Indicates the field type as DOUBLE. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'DOUBLE'; /** * The maximum allowable value for the double field. @@ -581,7 +581,7 @@ export interface IntegerFieldSchema { /** * The type of the field, which is set to INTEGER. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'INTEGER'; /** * The maximum value allowed for the integer field. @@ -598,7 +598,7 @@ export interface LongFieldSchema { /** * The type of the field, which is LONG by default. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'LONG'; /** * The maximum value allowed for the long field. @@ -620,7 +620,7 @@ export interface ObjectFieldSchema { /** * Specifies the type of the field, which is 'OBJECT' by default. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'OBJECT'; } export interface OutputFieldDefinition { @@ -1001,7 +1001,7 @@ export interface StringFieldSchema { /** * Indicates that the type is a string, with the default value being STRING. */ - type: 'ARRAY' | 'BOOLEAN' | 'DOUBLE' | 'INTEGER' | 'LONG' | 'OBJECT' | 'STRING'; + type: 'STRING'; /** * Specifies the format of the string, with accepted values: DATE, DATE_TIME, diff --git a/src/resources/cms/api.md b/src/resources/cms/api.md index f8f82e8f..455ba170 100644 --- a/src/resources/cms/api.md +++ b/src/resources/cms/api.md @@ -630,10 +630,8 @@ Methods: Types: -- ContentSearchResult - IndexedData - IndexedField -- PublicSearchResults Methods: @@ -678,4 +676,8 @@ Methods: - client.cms.urlRedirects.update(urlRedirectID, { ...params }) -> URLMapping - client.cms.urlRedirects.list({ ...params }) -> URLMappingsPage - client.cms.urlRedirects.delete(urlRedirectID) -> void +- client.cms.urlRedirects.createURLMapping({ ...params }) -> Response +- client.cms.urlRedirects.deleteURLMapping(id) -> void - client.cms.urlRedirects.get(urlRedirectID) -> URLMapping +- client.cms.urlRedirects.getURLMapping(id) -> Response +- client.cms.urlRedirects.listURLMappings() -> Response diff --git a/src/resources/cms/cms.ts b/src/resources/cms/cms.ts index 4eb11233..d1f0f6ae 100644 --- a/src/resources/cms/cms.ts +++ b/src/resources/cms/cms.ts @@ -25,10 +25,8 @@ import { import * as SiteSearchAPI from './site-search'; import { BaseSiteSearch, - ContentSearchResult, IndexedData, IndexedField, - PublicSearchResults, SiteSearch, SiteSearchGetIndexedDataParams, } from './site-search'; @@ -50,6 +48,7 @@ import { URLMappingCreateRequestBody, URLMappingsPage, URLRedirectCreateParams, + URLRedirectCreateURLMappingParams, URLRedirectListParams, URLRedirectUpdateParams, URLRedirects, @@ -3511,10 +3510,8 @@ export declare namespace Cms { export { SiteSearch as SiteSearch, BaseSiteSearch as BaseSiteSearch, - type ContentSearchResult as ContentSearchResult, type IndexedData as IndexedData, type IndexedField as IndexedField, - type PublicSearchResults as PublicSearchResults, type SiteSearchGetIndexedDataParams as SiteSearchGetIndexedDataParams, }; @@ -3543,5 +3540,6 @@ export declare namespace Cms { type URLRedirectCreateParams as URLRedirectCreateParams, type URLRedirectUpdateParams as URLRedirectUpdateParams, type URLRedirectListParams as URLRedirectListParams, + type URLRedirectCreateURLMappingParams as URLRedirectCreateURLMappingParams, }; } diff --git a/src/resources/cms/index.ts b/src/resources/cms/index.ts index b9751c25..23d590ac 100644 --- a/src/resources/cms/index.ts +++ b/src/resources/cms/index.ts @@ -248,10 +248,8 @@ export { export { SiteSearch, BaseSiteSearch, - type ContentSearchResult, type IndexedData, type IndexedField, - type PublicSearchResults, type SiteSearchGetIndexedDataParams, } from './site-search'; export { @@ -276,5 +274,6 @@ export { type URLRedirectCreateParams, type URLRedirectUpdateParams, type URLRedirectListParams, + type URLRedirectCreateURLMappingParams, type URLMappingsPage, } from './url-redirects'; diff --git a/src/resources/cms/media-bridge/media-bridge.ts b/src/resources/cms/media-bridge/media-bridge.ts index a7251333..e7a74c06 100644 --- a/src/resources/cms/media-bridge/media-bridge.ts +++ b/src/resources/cms/media-bridge/media-bridge.ts @@ -1119,6 +1119,10 @@ export interface InboundDBObjectType { status?: 'Deprecated' | 'In development' | 'Live'; + visibilities?: Array< + 'Customer-facing' | 'Internal only' | 'Customer-facing UI' | 'Customer-facing public API' + >; + visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; writeScopeName?: string; diff --git a/src/resources/cms/site-search.ts b/src/resources/cms/site-search.ts index 45730b6a..b6e4f772 100644 --- a/src/resources/cms/site-search.ts +++ b/src/resources/cms/site-search.ts @@ -26,950 +26,6 @@ export class BaseSiteSearch extends APIResource { } export class SiteSearch extends BaseSiteSearch {} -export interface ContentSearchResult { - /** - * The ID of the content. - */ - id: number; - - /** - * The domain the document is hosted on. - */ - domain: string; - - /** - * The matching score of the document. - */ - score: number; - - /** - * The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, - * `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`. - */ - type: - | 'BLOG_POST' - | 'KNOWLEDGE_ARTICLE' - | 'LANDING_PAGE' - | 'LISTING_PAGE' - | 'SITE_PAGE' - | 'STRUCTURED_CONTENT'; - - /** - * The url of the document. - */ - url: string; - - /** - * Name of the author. - */ - authorFullName?: string; - - /** - * The error category - */ - category?: string; - - /** - * The ID of the document in HubSpot. - */ - combinedId?: string; - - contentType?: string; - - /** - * The result's description. The content will be determined by the value of - * `length` in the request. - */ - description?: string; - - /** - * URL of the featured image. - */ - featuredImageUrl?: string; - - inBeta?: boolean; - - isPrivate?: boolean; - - /** - * The document's language. - */ - language?: - | 'aa' - | 'ab' - | 'ae' - | 'af' - | 'af-na' - | 'af-za' - | 'agq' - | 'agq-cm' - | 'ak' - | 'ak-gh' - | 'am' - | 'am-et' - | 'an' - | 'ann' - | 'ann-ng' - | 'ar' - | 'ar-001' - | 'ar-ae' - | 'ar-bh' - | 'ar-dj' - | 'ar-dz' - | 'ar-eg' - | 'ar-eh' - | 'ar-er' - | 'ar-il' - | 'ar-iq' - | 'ar-jo' - | 'ar-km' - | 'ar-kw' - | 'ar-lb' - | 'ar-ly' - | 'ar-ma' - | 'ar-mr' - | 'ar-om' - | 'ar-ps' - | 'ar-qa' - | 'ar-sa' - | 'ar-sd' - | 'ar-so' - | 'ar-ss' - | 'ar-sy' - | 'ar-td' - | 'ar-tn' - | 'ar-ye' - | 'as' - | 'as-in' - | 'asa' - | 'asa-tz' - | 'ast' - | 'ast-es' - | 'av' - | 'ay' - | 'az' - | 'az-az' - | 'ba' - | 'bas' - | 'bas-cm' - | 'be' - | 'be-by' - | 'bem' - | 'bem-zm' - | 'bez' - | 'bez-tz' - | 'bg' - | 'bg-bg' - | 'bgc' - | 'bgc-in' - | 'bho' - | 'bho-in' - | 'bi' - | 'bm' - | 'bm-ml' - | 'bn' - | 'bn-bd' - | 'bn-in' - | 'bo' - | 'bo-cn' - | 'bo-in' - | 'br' - | 'br-fr' - | 'brx' - | 'brx-in' - | 'bs' - | 'bs-ba' - | 'ca' - | 'ca-ad' - | 'ca-es' - | 'ca-fr' - | 'ca-it' - | 'ccp' - | 'ccp-bd' - | 'ccp-in' - | 'ce' - | 'ce-ru' - | 'ceb' - | 'ceb-ph' - | 'cgg' - | 'cgg-ug' - | 'ch' - | 'chr' - | 'chr-us' - | 'ckb' - | 'ckb-iq' - | 'ckb-ir' - | 'co' - | 'cr' - | 'cs' - | 'cs-cz' - | 'cu' - | 'cu-ru' - | 'cv' - | 'cv-ru' - | 'cy' - | 'cy-gb' - | 'da' - | 'da-dk' - | 'da-gl' - | 'dav' - | 'dav-ke' - | 'de' - | 'de-at' - | 'de-be' - | 'de-ch' - | 'de-de' - | 'de-gr' - | 'de-it' - | 'de-li' - | 'de-lu' - | 'dje' - | 'dje-ne' - | 'doi' - | 'doi-in' - | 'dsb' - | 'dsb-de' - | 'dua' - | 'dua-cm' - | 'dv' - | 'dyo' - | 'dyo-sn' - | 'dz' - | 'dz-bt' - | 'ebu' - | 'ebu-ke' - | 'ee' - | 'ee-gh' - | 'ee-tg' - | 'el' - | 'el-cy' - | 'el-gr' - | 'en' - | 'en-001' - | 'en-150' - | 'en-ae' - | 'en-ag' - | 'en-ai' - | 'en-as' - | 'en-at' - | 'en-au' - | 'en-bb' - | 'en-be' - | 'en-bi' - | 'en-bm' - | 'en-bs' - | 'en-bw' - | 'en-bz' - | 'en-ca' - | 'en-cc' - | 'en-ch' - | 'en-ck' - | 'en-cm' - | 'en-cn' - | 'en-cx' - | 'en-cy' - | 'en-de' - | 'en-dg' - | 'en-dk' - | 'en-dm' - | 'en-ee' - | 'en-eg' - | 'en-er' - | 'en-es' - | 'en-fi' - | 'en-fj' - | 'en-fk' - | 'en-fm' - | 'en-fr' - | 'en-gb' - | 'en-gd' - | 'en-gg' - | 'en-gh' - | 'en-gi' - | 'en-gm' - | 'en-gu' - | 'en-gy' - | 'en-hk' - | 'en-id' - | 'en-ie' - | 'en-il' - | 'en-im' - | 'en-in' - | 'en-io' - | 'en-je' - | 'en-jm' - | 'en-ke' - | 'en-ki' - | 'en-kn' - | 'en-ky' - | 'en-lc' - | 'en-lr' - | 'en-ls' - | 'en-lu' - | 'en-mg' - | 'en-mh' - | 'en-mo' - | 'en-mp' - | 'en-ms' - | 'en-mt' - | 'en-mu' - | 'en-mv' - | 'en-mw' - | 'en-mx' - | 'en-my' - | 'en-na' - | 'en-nf' - | 'en-ng' - | 'en-nl' - | 'en-nr' - | 'en-nu' - | 'en-nz' - | 'en-pg' - | 'en-ph' - | 'en-pk' - | 'en-pn' - | 'en-pr' - | 'en-pt' - | 'en-pw' - | 'en-rw' - | 'en-sb' - | 'en-sc' - | 'en-sd' - | 'en-se' - | 'en-sg' - | 'en-sh' - | 'en-si' - | 'en-sl' - | 'en-ss' - | 'en-sx' - | 'en-sz' - | 'en-tc' - | 'en-th' - | 'en-tk' - | 'en-tn' - | 'en-to' - | 'en-tt' - | 'en-tv' - | 'en-tz' - | 'en-ug' - | 'en-um' - | 'en-us' - | 'en-vc' - | 'en-vg' - | 'en-vi' - | 'en-vn' - | 'en-vu' - | 'en-ws' - | 'en-za' - | 'en-zm' - | 'en-zw' - | 'eo' - | 'eo-001' - | 'es' - | 'es-419' - | 'es-ar' - | 'es-bo' - | 'es-br' - | 'es-bz' - | 'es-cl' - | 'es-co' - | 'es-cr' - | 'es-cu' - | 'es-do' - | 'es-ea' - | 'es-ec' - | 'es-es' - | 'es-gq' - | 'es-gt' - | 'es-hn' - | 'es-ic' - | 'es-mx' - | 'es-ni' - | 'es-pa' - | 'es-pe' - | 'es-ph' - | 'es-pr' - | 'es-py' - | 'es-sv' - | 'es-us' - | 'es-uy' - | 'es-ve' - | 'et' - | 'et-ee' - | 'eu' - | 'eu-es' - | 'ewo' - | 'ewo-cm' - | 'fa' - | 'fa-af' - | 'fa-ir' - | 'ff' - | 'ff-bf' - | 'ff-cm' - | 'ff-gh' - | 'ff-gm' - | 'ff-gn' - | 'ff-gw' - | 'ff-lr' - | 'ff-mr' - | 'ff-ne' - | 'ff-ng' - | 'ff-sl' - | 'ff-sn' - | 'fi' - | 'fi-fi' - | 'fil' - | 'fil-ph' - | 'fj' - | 'fo' - | 'fo-dk' - | 'fo-fo' - | 'fr' - | 'fr-be' - | 'fr-bf' - | 'fr-bi' - | 'fr-bj' - | 'fr-bl' - | 'fr-ca' - | 'fr-cd' - | 'fr-cf' - | 'fr-cg' - | 'fr-ch' - | 'fr-ci' - | 'fr-cm' - | 'fr-dj' - | 'fr-dz' - | 'fr-fr' - | 'fr-ga' - | 'fr-gf' - | 'fr-gn' - | 'fr-gp' - | 'fr-gq' - | 'fr-ht' - | 'fr-km' - | 'fr-lu' - | 'fr-ma' - | 'fr-mc' - | 'fr-mf' - | 'fr-mg' - | 'fr-ml' - | 'fr-mq' - | 'fr-mr' - | 'fr-mu' - | 'fr-nc' - | 'fr-ne' - | 'fr-pf' - | 'fr-pm' - | 'fr-re' - | 'fr-rw' - | 'fr-sc' - | 'fr-sn' - | 'fr-sy' - | 'fr-td' - | 'fr-tg' - | 'fr-tn' - | 'fr-vu' - | 'fr-wf' - | 'fr-yt' - | 'frr' - | 'frr-de' - | 'fur' - | 'fur-it' - | 'fy' - | 'fy-nl' - | 'ga' - | 'ga-gb' - | 'ga-ie' - | 'gd' - | 'gd-gb' - | 'gl' - | 'gl-es' - | 'gn' - | 'gsw' - | 'gsw-ch' - | 'gsw-fr' - | 'gsw-li' - | 'gu' - | 'gu-in' - | 'guz' - | 'guz-ke' - | 'gv' - | 'gv-im' - | 'ha' - | 'ha-gh' - | 'ha-ne' - | 'ha-ng' - | 'haw' - | 'haw-us' - | 'he' - | 'he-il' - | 'hi' - | 'hi-in' - | 'hmn' - | 'ho' - | 'hr' - | 'hr-ba' - | 'hr-hr' - | 'hsb' - | 'hsb-de' - | 'ht' - | 'hu' - | 'hu-hu' - | 'hy' - | 'hy-am' - | 'hz' - | 'ia' - | 'ia-001' - | 'id' - | 'id-id' - | 'ie' - | 'ig' - | 'ig-ng' - | 'ii' - | 'ii-cn' - | 'ik' - | 'io' - | 'is' - | 'is-is' - | 'it' - | 'it-ch' - | 'it-it' - | 'it-sm' - | 'it-va' - | 'iu' - | 'ja' - | 'ja-jp' - | 'jgo' - | 'jgo-cm' - | 'jmc' - | 'jmc-tz' - | 'jv' - | 'jv-id' - | 'ka' - | 'ka-ge' - | 'kab' - | 'kab-dz' - | 'kam' - | 'kam-ke' - | 'kar' - | 'kde' - | 'kde-tz' - | 'kea' - | 'kea-cv' - | 'kg' - | 'kgp' - | 'kgp-br' - | 'kh' - | 'khq' - | 'khq-ml' - | 'ki' - | 'ki-ke' - | 'kj' - | 'kk' - | 'kk-kz' - | 'kkj' - | 'kkj-cm' - | 'kl' - | 'kl-gl' - | 'kln' - | 'kln-ke' - | 'km' - | 'km-kh' - | 'kn' - | 'kn-in' - | 'ko' - | 'ko-kp' - | 'ko-kr' - | 'kok' - | 'kok-in' - | 'kr' - | 'ks' - | 'ks-in' - | 'ksb' - | 'ksb-tz' - | 'ksf' - | 'ksf-cm' - | 'ksh' - | 'ksh-de' - | 'ku' - | 'ku-tr' - | 'kv' - | 'kw' - | 'kw-gb' - | 'ky' - | 'ky-kg' - | 'la' - | 'lag' - | 'lag-tz' - | 'lb' - | 'lb-lu' - | 'lg' - | 'lg-ug' - | 'li' - | 'lkt' - | 'lkt-us' - | 'ln' - | 'ln-ao' - | 'ln-cd' - | 'ln-cf' - | 'ln-cg' - | 'lo' - | 'lo-la' - | 'lrc' - | 'lrc-iq' - | 'lrc-ir' - | 'lt' - | 'lt-lt' - | 'lu' - | 'lu-cd' - | 'luo' - | 'luo-ke' - | 'luy' - | 'luy-ke' - | 'lv' - | 'lv-lv' - | 'mai' - | 'mai-in' - | 'mas' - | 'mas-ke' - | 'mas-tz' - | 'mdf' - | 'mdf-ru' - | 'mer' - | 'mer-ke' - | 'mfe' - | 'mfe-mu' - | 'mg' - | 'mg-mg' - | 'mgh' - | 'mgh-mz' - | 'mgo' - | 'mgo-cm' - | 'mh' - | 'mi' - | 'mi-nz' - | 'mk' - | 'mk-mk' - | 'ml' - | 'ml-in' - | 'mn' - | 'mn-mn' - | 'mni' - | 'mni-in' - | 'mr' - | 'mr-in' - | 'ms' - | 'ms-bn' - | 'ms-id' - | 'ms-my' - | 'ms-sg' - | 'mt' - | 'mt-mt' - | 'mua' - | 'mua-cm' - | 'my' - | 'my-mm' - | 'mzn' - | 'mzn-ir' - | 'na' - | 'naq' - | 'naq-na' - | 'nb' - | 'nb-no' - | 'nb-sj' - | 'nd' - | 'nd-zw' - | 'nds' - | 'nds-de' - | 'nds-nl' - | 'ne' - | 'ne-in' - | 'ne-np' - | 'ng' - | 'nl' - | 'nl-aw' - | 'nl-be' - | 'nl-bq' - | 'nl-ch' - | 'nl-cw' - | 'nl-lu' - | 'nl-nl' - | 'nl-sr' - | 'nl-sx' - | 'nmg' - | 'nmg-cm' - | 'nn' - | 'nn-no' - | 'nnh' - | 'nnh-cm' - | 'no' - | 'no-no' - | 'nr' - | 'nus' - | 'nus-ss' - | 'nv' - | 'ny' - | 'nyn' - | 'nyn-ug' - | 'oc' - | 'oc-es' - | 'oc-fr' - | 'oj' - | 'om' - | 'om-et' - | 'om-ke' - | 'or' - | 'or-in' - | 'os' - | 'os-ge' - | 'os-ru' - | 'pa' - | 'pa-in' - | 'pa-pk' - | 'pcm' - | 'pcm-ng' - | 'pi' - | 'pis' - | 'pis-sb' - | 'pl' - | 'pl-pl' - | 'prg' - | 'prg-001' - | 'ps' - | 'ps-af' - | 'ps-pk' - | 'pt' - | 'pt-ao' - | 'pt-br' - | 'pt-ch' - | 'pt-cv' - | 'pt-gq' - | 'pt-gw' - | 'pt-lu' - | 'pt-mo' - | 'pt-mz' - | 'pt-pt' - | 'pt-st' - | 'pt-tl' - | 'qu' - | 'qu-bo' - | 'qu-ec' - | 'qu-pe' - | 'raj' - | 'raj-in' - | 'rm' - | 'rm-ch' - | 'rn' - | 'rn-bi' - | 'ro' - | 'ro-md' - | 'ro-ro' - | 'rof' - | 'rof-tz' - | 'ru' - | 'ru-by' - | 'ru-kg' - | 'ru-kz' - | 'ru-md' - | 'ru-ru' - | 'ru-ua' - | 'rw' - | 'rw-rw' - | 'rwk' - | 'rwk-tz' - | 'sa' - | 'sa-in' - | 'sah' - | 'sah-ru' - | 'saq' - | 'saq-ke' - | 'sat' - | 'sat-in' - | 'sbp' - | 'sbp-tz' - | 'sc' - | 'sc-it' - | 'sd' - | 'sd-in' - | 'sd-pk' - | 'se' - | 'se-fi' - | 'se-no' - | 'se-se' - | 'seh' - | 'seh-mz' - | 'ses' - | 'ses-ml' - | 'sg' - | 'sg-cf' - | 'shi' - | 'shi-ma' - | 'si' - | 'si-lk' - | 'sk' - | 'sk-sk' - | 'sl' - | 'sl-si' - | 'sm' - | 'smn' - | 'smn-fi' - | 'sms' - | 'sms-fi' - | 'sn' - | 'sn-zw' - | 'so' - | 'so-dj' - | 'so-et' - | 'so-ke' - | 'so-so' - | 'sq' - | 'sq-al' - | 'sq-mk' - | 'sq-xk' - | 'sr' - | 'sr-ba' - | 'sr-cs' - | 'sr-me' - | 'sr-rs' - | 'sr-xk' - | 'ss' - | 'st' - | 'su' - | 'su-id' - | 'sv' - | 'sv-ax' - | 'sv-fi' - | 'sv-se' - | 'sw' - | 'sw-cd' - | 'sw-ke' - | 'sw-tz' - | 'sw-ug' - | 'sy' - | 'ta' - | 'ta-in' - | 'ta-lk' - | 'ta-my' - | 'ta-sg' - | 'te' - | 'te-in' - | 'teo' - | 'teo-ke' - | 'teo-ug' - | 'tg' - | 'tg-tj' - | 'th' - | 'th-th' - | 'ti' - | 'ti-er' - | 'ti-et' - | 'tk' - | 'tk-tm' - | 'tl' - | 'tn' - | 'to' - | 'to-to' - | 'tok' - | 'tok-001' - | 'tr' - | 'tr-cy' - | 'tr-tr' - | 'ts' - | 'tt' - | 'tt-ru' - | 'tw' - | 'twq' - | 'twq-ne' - | 'ty' - | 'tzm' - | 'tzm-ma' - | 'ug' - | 'ug-cn' - | 'uk' - | 'uk-ua' - | 'ur' - | 'ur-in' - | 'ur-pk' - | 'uz' - | 'uz-af' - | 'uz-uz' - | 'vai' - | 'vai-lr' - | 've' - | 'vi' - | 'vi-vn' - | 'vo' - | 'vo-001' - | 'vun' - | 'vun-tz' - | 'wa' - | 'wae' - | 'wae-ch' - | 'wo' - | 'wo-sn' - | 'xh' - | 'xh-za' - | 'xog' - | 'xog-ug' - | 'yav' - | 'yav-cm' - | 'yi' - | 'yi-001' - | 'yo' - | 'yo-bj' - | 'yo-ng' - | 'yrl' - | 'yrl-br' - | 'yrl-co' - | 'yrl-ve' - | 'yue' - | 'yue-cn' - | 'yue-hk' - | 'za' - | 'zgh' - | 'zgh-ma' - | 'zh' - | 'zh-cn' - | 'zh-hans' - | 'zh-hant' - | 'zh-hk' - | 'zh-mo' - | 'zh-sg' - | 'zh-tw' - | 'zu' - | 'zu-za'; - - /** - * The date the content was published. - */ - publishedDate?: number; - - /** - * If a dynamic page, the row ID in the HubDB table. - */ - rowId?: number; - - /** - * For knowledge articles, the subcategory of the article. - */ - subcategory?: string; - - /** - * If a dynamic page, the ID of the HubDB table. - */ - tableId?: number; - - /** - * If a blog post, the tags associated with it. - */ - tags?: Array; - - /** - * The title of the returned document. - */ - title?: string; -} - export interface IndexedData { /** * The ID of the document in HubSpot. @@ -1013,45 +69,14 @@ export interface IndexedField { values: Array; } -export interface PublicSearchResults { - /** - * The number of results returned in a single response. - */ - limit: number; - - /** - * The starting point for the next set of results in pagination. - */ - offset: number; - - /** - * The current page number in the paginated results. - */ - page: number; - - results: Array; - - /** - * The total number of results found for the search term. - */ - total: number; - - /** - * The term used in the search query. - */ - searchTerm?: string; -} - export interface SiteSearchGetIndexedDataParams { type?: string; } export declare namespace SiteSearch { export { - type ContentSearchResult as ContentSearchResult, type IndexedData as IndexedData, type IndexedField as IndexedField, - type PublicSearchResults as PublicSearchResults, type SiteSearchGetIndexedDataParams as SiteSearchGetIndexedDataParams, }; } diff --git a/src/resources/cms/url-redirects.ts b/src/resources/cms/url-redirects.ts index 3fe02107..a5189b5d 100644 --- a/src/resources/cms/url-redirects.ts +++ b/src/resources/cms/url-redirects.ts @@ -58,12 +58,44 @@ export class BaseURLRedirects extends APIResource { }); } + createURLMapping(body: URLRedirectCreateURLMappingParams, options?: RequestOptions): APIPromise { + return this._client.post('/cms/url-redirects/2026-03/url-mappings', { + body, + ...options, + headers: buildHeaders([{ 'Content-Type': '*/*', Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + deleteURLMapping(id: number, options?: RequestOptions): APIPromise { + return this._client.delete(path`/cms/url-redirects/2026-03/url-mappings/${id}`, { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + }); + } + /** * Returns the details for a single existing URL redirect by ID. */ get(urlRedirectID: string, options?: RequestOptions): APIPromise { return this._client.get(path`/cms/url-redirects/2026-03/${urlRedirectID}`, options); } + + getURLMapping(id: number, options?: RequestOptions): APIPromise { + return this._client.get(path`/cms/url-redirects/2026-03/url-mappings/${id}`, { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + listURLMappings(options?: RequestOptions): APIPromise { + return this._client.get('/cms/url-redirects/2026-03/url-mappings', { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } } export class URLRedirects extends BaseURLRedirects {} @@ -370,6 +402,80 @@ export interface URLRedirectListParams extends PageParams { updatedBefore?: string; } +export interface URLRedirectCreateURLMappingParams { + /** + * The unique ID of this URL redirect. + */ + id: string; + + /** + * The date and time when the URL mapping was initially created. + */ + created: string; + + /** + * The destination URL, where the target URL should be redirected if it matches the + * `routePrefix`. + */ + destination: string; + + /** + * Whether the `routePrefix` should match on the entire URL, including the domain. + */ + isMatchFullUrl: boolean; + + /** + * Whether the `routePrefix` should match on the entire URL path, including the + * query string. + */ + isMatchQueryString: boolean; + + /** + * Whether the URL redirect mapping should apply only if a live page on the URL + * isn't found. If False, the URL redirect mapping will take precedence over any + * existing page. + */ + isOnlyAfterNotFound: boolean; + + /** + * Whether the `routePrefix` should match based on pattern. + */ + isPattern: boolean; + + /** + * Whether the `routePrefix` should match both HTTP and HTTPS protocols. + */ + isProtocolAgnostic: boolean; + + /** + * Whether a trailing slash will be ignored. + */ + isTrailingSlashOptional: boolean; + + /** + * Used to prioritize URL redirection. If a given URL matches more than one + * redirect, the one with the **lower** precedence will be used. + */ + precedence: number; + + /** + * The type of redirect to create. Options include: 301 (permanent), 302 + * (temporary), or 305 (proxy). Find more details + * [here](https://knowledge.hubspot.com/cos-general/how-to-redirect-a-hubspot-page). + */ + redirectStyle: number; + + /** + * The target incoming URL, path, or pattern to match for redirection. + */ + routePrefix: string; + + /** + * The date and time when the URL mapping was last modified. + */ + updated: string; +} + export declare namespace URLRedirects { export { type CollectionResponseWithTotalURLMappingForwardPaging as CollectionResponseWithTotalURLMappingForwardPaging, @@ -379,5 +485,6 @@ export declare namespace URLRedirects { type URLRedirectCreateParams as URLRedirectCreateParams, type URLRedirectUpdateParams as URLRedirectUpdateParams, type URLRedirectListParams as URLRedirectListParams, + type URLRedirectCreateURLMappingParams as URLRedirectCreateURLMappingParams, }; } diff --git a/src/resources/conversations/custom-channels/custom-channels.ts b/src/resources/conversations/custom-channels/custom-channels.ts index 072a097f..8a1287b9 100644 --- a/src/resources/conversations/custom-channels/custom-channels.ts +++ b/src/resources/conversations/custom-channels/custom-channels.ts @@ -541,6 +541,7 @@ export interface PreResolvedContact { | 'hs_social_twitter_clicks' | 'hs_source_object_id' | 'hs_source_portal_id' + | 'hs_sourced_contact_origin' | 'hs_state_code' | 'hs_sub_role' | 'hs_testpurge' diff --git a/src/resources/conversations/visitor-identification.ts b/src/resources/conversations/visitor-identification.ts index 771dc895..7bcb74ff 100644 --- a/src/resources/conversations/visitor-identification.ts +++ b/src/resources/conversations/visitor-identification.ts @@ -32,6 +32,8 @@ export interface IdentificationTokenGenerationRequest { */ email: string; + hsCustomerAgentContext: { [key: string]: string }; + /** * The first name of the visitor that you wish to identify. This value will only be * set in HubSpot for new contacts and existing contacts where first name is @@ -61,6 +63,8 @@ export interface VisitorIdentificationGenerateTokenParams { */ email: string; + hsCustomerAgentContext: { [key: string]: string }; + /** * The first name of the visitor that you wish to identify. This value will only be * set in HubSpot for new contacts and existing contacts where first name is diff --git a/src/resources/crm/api.md b/src/resources/crm/api.md index 40fd661d..f6100055 100644 --- a/src/resources/crm/api.md +++ b/src/resources/crm/api.md @@ -14,8 +14,8 @@ Types: - BatchResponsePublicDefaultAssociation - CollectionResponseMultiAssociatedObjectWithLabelForwardPaging - CollectionResponseWithTotalSimplePublicObject +- CrmFilter - DateTime -- Filter - FilterGroup - LabelsBetweenObjectPair - MultiAssociatedObjectWithLabel @@ -128,7 +128,7 @@ Types: Methods: -- client.crm.exports.createAsync() -> TaskLocator +- client.crm.exports.createAsync({ ...params }) -> TaskLocator - client.crm.exports.get(exportID) -> PublicExportResponse - client.crm.exports.getStatus(taskID) -> ActionResponseWithSingleResultUri @@ -362,7 +362,6 @@ Types: - PublicBatchMigrationMapping - PublicBoolPropertyOperation - PublicCalendarDatePropertyOperation -- PublicCampaignInfluencedFilter - PublicCommunicationSubscriptionFilter - PublicComparativeDatePropertyOperation - PublicComparativePropertyUpdatedOperation @@ -398,7 +397,6 @@ Types: - PublicNotAllFilterBranch - PublicNotAnyFilterBranch - PublicNowReference -- PublicNumAssociationsFilter - PublicNumOccurrencesRefineBy - PublicNumberPropertyOperation - PublicObjectList @@ -406,8 +404,6 @@ Types: - PublicOrFilterBranch - PublicPageViewAnalyticsFilter - PublicPrivacyAnalyticsFilter -- PublicPropertyAssociationFilterBranch -- PublicPropertyAssociationInListFilter - PublicPropertyFilter - PublicPropertyReferencedTime - PublicQuarterReference diff --git a/src/resources/crm/crm.ts b/src/resources/crm/crm.ts index 0cf9ea5d..41988815 100644 --- a/src/resources/crm/crm.ts +++ b/src/resources/crm/crm.ts @@ -120,7 +120,6 @@ import { PublicBatchMigrationMapping, PublicBoolPropertyOperation, PublicCalendarDatePropertyOperation, - PublicCampaignInfluencedFilter, PublicCommunicationSubscriptionFilter, PublicComparativeDatePropertyOperation, PublicComparativePropertyUpdatedOperation, @@ -156,7 +155,6 @@ import { PublicNotAllFilterBranch, PublicNotAnyFilterBranch, PublicNowReference, - PublicNumAssociationsFilter, PublicNumOccurrencesRefineBy, PublicNumberPropertyOperation, PublicObjectList, @@ -164,8 +162,6 @@ import { PublicOrFilterBranch, PublicPageViewAnalyticsFilter, PublicPrivacyAnalyticsFilter, - PublicPropertyAssociationFilterBranch, - PublicPropertyAssociationInListFilter, PublicPropertyFilter, PublicPropertyReferencedTime, PublicQuarterReference, @@ -614,31 +610,12 @@ export interface CollectionResponseWithTotalSimplePublicObject { paging?: Shared.Paging; } -export interface DateTime { - /** - * Indicates whether the DateTime value represents only a date without a time - * component. - */ - dateOnly: boolean; - - /** - * The integer value representing the shift in minutes from UTC for the DateTime - * value. - */ - timeZoneShift: number; - - /** - * The integer value representing a specific point in time. - */ - value: number; -} - /** * Defines a single condition for searching CRM objects, specifying the property to * filter on, the operator to use (such as equals, greater than, or contains), and * the value(s) to compare against. */ -export interface Filter { +export interface CrmFilter { /** * The comparison operator used in the filter, such as "EQ" or "GT". */ @@ -678,8 +655,27 @@ export interface Filter { values?: Array; } +export interface DateTime { + /** + * Indicates whether the DateTime value represents only a date without a time + * component. + */ + dateOnly: boolean; + + /** + * The integer value representing the shift in minutes from UTC for the DateTime + * value. + */ + timeZoneShift: number; + + /** + * The integer value representing a specific point in time. + */ + value: number; +} + export interface FilterGroup { - filters: Array; + filters: Array; } /** @@ -985,8 +981,8 @@ export declare namespace Crm { type BatchResponsePublicDefaultAssociation as BatchResponsePublicDefaultAssociation, type CollectionResponseMultiAssociatedObjectWithLabelForwardPaging as CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, type CollectionResponseWithTotalSimplePublicObject as CollectionResponseWithTotalSimplePublicObject, + type CrmFilter as CrmFilter, type DateTime as DateTime, - type Filter as Filter, type FilterGroup as FilterGroup, type LabelsBetweenObjectPair as LabelsBetweenObjectPair, type MultiAssociatedObjectWithLabel as MultiAssociatedObjectWithLabel, @@ -1159,7 +1155,6 @@ export declare namespace Crm { type PublicBatchMigrationMapping as PublicBatchMigrationMapping, type PublicBoolPropertyOperation as PublicBoolPropertyOperation, type PublicCalendarDatePropertyOperation as PublicCalendarDatePropertyOperation, - type PublicCampaignInfluencedFilter as PublicCampaignInfluencedFilter, type PublicCommunicationSubscriptionFilter as PublicCommunicationSubscriptionFilter, type PublicComparativeDatePropertyOperation as PublicComparativeDatePropertyOperation, type PublicComparativePropertyUpdatedOperation as PublicComparativePropertyUpdatedOperation, @@ -1195,7 +1190,6 @@ export declare namespace Crm { type PublicNotAllFilterBranch as PublicNotAllFilterBranch, type PublicNotAnyFilterBranch as PublicNotAnyFilterBranch, type PublicNowReference as PublicNowReference, - type PublicNumAssociationsFilter as PublicNumAssociationsFilter, type PublicNumOccurrencesRefineBy as PublicNumOccurrencesRefineBy, type PublicNumberPropertyOperation as PublicNumberPropertyOperation, type PublicObjectList as PublicObjectList, @@ -1203,8 +1197,6 @@ export declare namespace Crm { type PublicOrFilterBranch as PublicOrFilterBranch, type PublicPageViewAnalyticsFilter as PublicPageViewAnalyticsFilter, type PublicPrivacyAnalyticsFilter as PublicPrivacyAnalyticsFilter, - type PublicPropertyAssociationFilterBranch as PublicPropertyAssociationFilterBranch, - type PublicPropertyAssociationInListFilter as PublicPropertyAssociationInListFilter, type PublicPropertyFilter as PublicPropertyFilter, type PublicPropertyReferencedTime as PublicPropertyReferencedTime, type PublicQuarterReference as PublicQuarterReference, diff --git a/src/resources/crm/exports.ts b/src/resources/crm/exports.ts index 23081c9a..3063e37b 100644 --- a/src/resources/crm/exports.ts +++ b/src/resources/crm/exports.ts @@ -78,7 +78,7 @@ export interface ActionResponseWithSingleResultUri { export interface PublicCrmSearchRequest { filterGroups: Array; - filters: Array; + filters: Array; /** * Defines the order in which the CRM records should be returned. @@ -100,30 +100,58 @@ export interface PublicExportListRequest { exportType: 'LIST'; - format: 'XLS' | 'XLSX' | 'CSV'; + format: 'CSV' | 'XLS' | 'XLSX'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: - | 'EN' + | 'AF_ZA' + | 'AR_EG' + | 'BG' + | 'BN' + | 'CA_ES' + | 'CS' + | 'DA_DK' | 'DE' + | 'EL_GR' + | 'EN' + | 'EN_GB' | 'ES' + | 'ES_MX' + | 'ET_EE' + | 'FI' | 'FR' + | 'FR_CA' + | 'HE_IL' + | 'HI_IN' + | 'HR' + | 'HU' + | 'ID' + | 'IT' | 'JA' + | 'KO_KR' + | 'LT_LT' + | 'MS' | 'NL' - | 'PT_BR' - | 'IT' + | 'NO' | 'PL' + | 'PT_BR' + | 'PT_PT' + | 'RO' + | 'RU' + | 'SK_SK' + | 'SL' | 'SV' - | 'FI' - | 'ZH_TW' - | 'DA_DK' - | 'NO' - | 'KO_KR' | 'TH' - | 'ZH_CN'; + | 'TL' + | 'TR' + | 'UK' + | 'VI_VN' + | 'ZH_CN' + | 'ZH_HK' + | 'ZH_TW'; listId: string; @@ -201,30 +229,58 @@ export interface PublicExportViewRequest { exportType: 'VIEW'; - format: 'XLS' | 'XLSX' | 'CSV'; + format: 'CSV' | 'XLS' | 'XLSX'; includeLabeledAssociations: boolean; includePrimaryDisplayPropertyForAssociatedObjects: boolean; language: - | 'EN' + | 'AF_ZA' + | 'AR_EG' + | 'BG' + | 'BN' + | 'CA_ES' + | 'CS' + | 'DA_DK' | 'DE' + | 'EL_GR' + | 'EN' + | 'EN_GB' | 'ES' + | 'ES_MX' + | 'ET_EE' + | 'FI' | 'FR' + | 'FR_CA' + | 'HE_IL' + | 'HI_IN' + | 'HR' + | 'HU' + | 'ID' + | 'IT' | 'JA' + | 'KO_KR' + | 'LT_LT' + | 'MS' | 'NL' - | 'PT_BR' - | 'IT' + | 'NO' | 'PL' + | 'PT_BR' + | 'PT_PT' + | 'RO' + | 'RU' + | 'SK_SK' + | 'SL' | 'SV' - | 'FI' - | 'ZH_TW' - | 'DA_DK' - | 'NO' - | 'KO_KR' | 'TH' - | 'ZH_CN'; + | 'TL' + | 'TR' + | 'UK' + | 'VI_VN' + | 'ZH_CN' + | 'ZH_HK' + | 'ZH_TW'; objectProperties: Array; @@ -240,9 +296,147 @@ export type ExportCreateAsyncParams = | ExportCreateAsyncParams.PublicExportListRequest; export declare namespace ExportCreateAsyncParams { - export interface PublicExportViewRequest {} + export interface PublicExportViewRequest { + associatedObjectType: Array; + + exportInternalValuesOptions: Array<'NAMES' | 'VALUES'>; + + exportName: string; + + exportType: 'VIEW'; + + format: 'CSV' | 'XLS' | 'XLSX'; + + includeLabeledAssociations: boolean; + + includePrimaryDisplayPropertyForAssociatedObjects: boolean; + + language: + | 'AF_ZA' + | 'AR_EG' + | 'BG' + | 'BN' + | 'CA_ES' + | 'CS' + | 'DA_DK' + | 'DE' + | 'EL_GR' + | 'EN' + | 'EN_GB' + | 'ES' + | 'ES_MX' + | 'ET_EE' + | 'FI' + | 'FR' + | 'FR_CA' + | 'HE_IL' + | 'HI_IN' + | 'HR' + | 'HU' + | 'ID' + | 'IT' + | 'JA' + | 'KO_KR' + | 'LT_LT' + | 'MS' + | 'NL' + | 'NO' + | 'PL' + | 'PT_BR' + | 'PT_PT' + | 'RO' + | 'RU' + | 'SK_SK' + | 'SL' + | 'SV' + | 'TH' + | 'TL' + | 'TR' + | 'UK' + | 'VI_VN' + | 'ZH_CN' + | 'ZH_HK' + | 'ZH_TW'; + + objectProperties: Array; + + objectType: string; + + overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; + + publicCrmSearchRequest?: PublicCrmSearchRequest; + } - export interface PublicExportListRequest {} + export interface PublicExportListRequest { + associatedObjectType: Array; + + exportInternalValuesOptions: Array<'NAMES' | 'VALUES'>; + + exportName: string; + + exportType: 'LIST'; + + format: 'CSV' | 'XLS' | 'XLSX'; + + includeLabeledAssociations: boolean; + + includePrimaryDisplayPropertyForAssociatedObjects: boolean; + + language: + | 'AF_ZA' + | 'AR_EG' + | 'BG' + | 'BN' + | 'CA_ES' + | 'CS' + | 'DA_DK' + | 'DE' + | 'EL_GR' + | 'EN' + | 'EN_GB' + | 'ES' + | 'ES_MX' + | 'ET_EE' + | 'FI' + | 'FR' + | 'FR_CA' + | 'HE_IL' + | 'HI_IN' + | 'HR' + | 'HU' + | 'ID' + | 'IT' + | 'JA' + | 'KO_KR' + | 'LT_LT' + | 'MS' + | 'NL' + | 'NO' + | 'PL' + | 'PT_BR' + | 'PT_PT' + | 'RO' + | 'RU' + | 'SK_SK' + | 'SL' + | 'SV' + | 'TH' + | 'TL' + | 'TR' + | 'UK' + | 'VI_VN' + | 'ZH_CN' + | 'ZH_HK' + | 'ZH_TW'; + + listId: string; + + objectProperties: Array; + + objectType: string; + + overrideAssociatedObjectsPerDefinitionPerRowLimit: boolean; + } } export declare namespace Exports { diff --git a/src/resources/crm/index.ts b/src/resources/crm/index.ts index c943c8f5..88ae1278 100644 --- a/src/resources/crm/index.ts +++ b/src/resources/crm/index.ts @@ -149,7 +149,6 @@ export { type PublicBatchMigrationMapping, type PublicBoolPropertyOperation, type PublicCalendarDatePropertyOperation, - type PublicCampaignInfluencedFilter, type PublicCommunicationSubscriptionFilter, type PublicComparativeDatePropertyOperation, type PublicComparativePropertyUpdatedOperation, @@ -185,7 +184,6 @@ export { type PublicNotAllFilterBranch, type PublicNotAnyFilterBranch, type PublicNowReference, - type PublicNumAssociationsFilter, type PublicNumOccurrencesRefineBy, type PublicNumberPropertyOperation, type PublicObjectList, @@ -193,8 +191,6 @@ export { type PublicOrFilterBranch, type PublicPageViewAnalyticsFilter, type PublicPrivacyAnalyticsFilter, - type PublicPropertyAssociationFilterBranch, - type PublicPropertyAssociationInListFilter, type PublicPropertyFilter, type PublicPropertyReferencedTime, type PublicQuarterReference, diff --git a/src/resources/crm/lists.ts b/src/resources/crm/lists.ts index a4415e7e..b703303d 100644 --- a/src/resources/crm/lists.ts +++ b/src/resources/crm/lists.ts @@ -375,7 +375,6 @@ export interface ListCreateRequest { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch; /** @@ -408,7 +407,6 @@ export interface ListFilterUpdateRequest { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch; } @@ -683,7 +681,6 @@ export interface PublicAndFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -708,7 +705,6 @@ export interface PublicAndFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -717,9 +713,7 @@ export interface PublicAndFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; } @@ -743,7 +737,6 @@ export interface PublicAssociationFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -768,7 +761,6 @@ export interface PublicAssociationFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -777,9 +769,7 @@ export interface PublicAssociationFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; @@ -933,18 +923,6 @@ export interface PublicCalendarDatePropertyOperation { useFiscalYear?: boolean; } -export interface PublicCampaignInfluencedFilter { - /** - * The ID of the campaign that influences the filter. - */ - campaignId: string; - - /** - * Indicates the type of filter (CAMPAIGN_INFLUENCED). - */ - filterType: 'CAMPAIGN_INFLUENCED'; -} - export interface PublicCommunicationSubscriptionFilter { acceptedOptStates: Array; @@ -1885,7 +1863,6 @@ export interface PublicNotAllFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -1910,7 +1887,6 @@ export interface PublicNotAllFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -1919,9 +1895,7 @@ export interface PublicNotAllFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; } @@ -1934,7 +1908,6 @@ export interface PublicNotAnyFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -1960,7 +1933,6 @@ export interface PublicNotAnyFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -1969,9 +1941,7 @@ export interface PublicNotAnyFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; } @@ -2003,38 +1973,6 @@ export interface PublicNowReference { second?: number; } -export interface PublicNumAssociationsFilter { - /** - * Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, - * INTEGRATOR_DEFINED, WORK). - */ - associationCategory: string; - - /** - * The ID representing the type of association being filtered. - */ - associationTypeId: number; - - /** - * Specifies the criteria for refining the association filter. - */ - coalescingRefineBy: - | PublicNumOccurrencesRefineBy - | PublicSetOccurrencesRefineBy - | PublicRelativeComparativeTimestampRefineBy - | PublicRelativeRangedTimestampRefineBy - | PublicAbsoluteComparativeTimestampRefineBy - | PublicAbsoluteRangedTimestampRefineBy - | PublicAllHistoryRefineBy - | PublicTimePointOperation - | PublicRangedTimeOperation; - - /** - * Indicates the type of filter being applied (NUM_ASSOCIATIONS). - */ - filterType: 'NUM_ASSOCIATIONS'; -} - export interface PublicNumOccurrencesRefineBy { /** * The type of refinement (NUM_OCCURRENCES). @@ -2135,7 +2073,6 @@ export interface PublicObjectList { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch; /** @@ -2239,7 +2176,6 @@ export interface PublicOrFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -2264,7 +2200,6 @@ export interface PublicOrFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -2273,9 +2208,7 @@ export interface PublicOrFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; } @@ -2350,113 +2283,6 @@ export interface PublicPrivacyAnalyticsFilter { privacyName: string; } -export interface PublicPropertyAssociationFilterBranch { - filterBranches: Array< - | PublicOrFilterBranch - | PublicAndFilterBranch - | PublicNotAllFilterBranch - | PublicNotAnyFilterBranch - | PublicRestrictedFilterBranch - | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch - | PublicAssociationFilterBranch - >; - - /** - * The logical operator used to combine filters within the branch. - */ - filterBranchOperator: string; - - /** - * The type of the filter branch (PROPERTY_ASSOCIATION). - */ - filterBranchType: 'PROPERTY_ASSOCIATION'; - - filters: Array< - | PublicPropertyFilter - | PublicAssociationInListFilter - | PublicPageViewAnalyticsFilter - | PublicCtaAnalyticsFilter - | PublicEventAnalyticsFilter - | PublicFormSubmissionFilter - | PublicFormSubmissionOnPageFilter - | PublicIntegrationEventFilter - | PublicEmailSubscriptionFilter - | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter - | PublicSurveyMonkeyFilter - | PublicSurveyMonkeyValueFilter - | PublicWebinarFilter - | PublicEmailEventFilter - | PublicPrivacyAnalyticsFilter - | PublicAdsSearchFilter - | PublicAdsTimeFilter - | PublicInListFilter - | PublicNumAssociationsFilter - | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter - | PublicConstantFilter - >; - - /** - * The ID representing the type of object associated with the filter branch. - */ - objectTypeId: string; - - /** - * Defines the operation to be applied within the filter branch (IN_LIST, - * NOT_IN_LIST). - */ - operator: string; - - /** - * The property that is associated with the object ID in the filter branch. - */ - propertyWithObjectId: string; -} - -export interface PublicPropertyAssociationInListFilter { - /** - * Specifies the criteria for refining the filter by coalescing. - */ - coalescingRefineBy: - | PublicNumOccurrencesRefineBy - | PublicSetOccurrencesRefineBy - | PublicRelativeComparativeTimestampRefineBy - | PublicRelativeRangedTimestampRefineBy - | PublicAbsoluteComparativeTimestampRefineBy - | PublicAbsoluteRangedTimestampRefineBy - | PublicAllHistoryRefineBy - | PublicTimePointOperation - | PublicRangedTimeOperation; - - /** - * Indicates the type of filter being applied (PROPERTY_ASSOCIATION). - */ - filterType: 'PROPERTY_ASSOCIATION'; - - /** - * The ID of the list used in the property association filter. - */ - listId: string; - - /** - * Defines the operation to be applied by the filter (IN_LIST, NOT_IN_LIST). - */ - operator: string; - - /** - * The property associated with the object ID in the filter. - */ - propertyWithObjectId: string; - - /** - * The ID representing the type of object that the property association filter is - * targeting. - */ - toObjectTypeId?: string; -} - export interface PublicPropertyFilter { /** * Indicates that the filter (PROPERTY). @@ -2709,7 +2535,6 @@ export interface PublicRestrictedFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -2735,7 +2560,6 @@ export interface PublicRestrictedFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -2744,9 +2568,7 @@ export interface PublicRestrictedFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; } @@ -3056,7 +2878,6 @@ export interface PublicUnifiedEventsFilterBranch { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch >; @@ -3081,7 +2902,6 @@ export interface PublicUnifiedEventsFilterBranch { | PublicIntegrationEventFilter | PublicEmailSubscriptionFilter | PublicCommunicationSubscriptionFilter - | PublicCampaignInfluencedFilter | PublicSurveyMonkeyFilter | PublicSurveyMonkeyValueFilter | PublicWebinarFilter @@ -3090,9 +2910,7 @@ export interface PublicUnifiedEventsFilterBranch { | PublicAdsSearchFilter | PublicAdsTimeFilter | PublicInListFilter - | PublicNumAssociationsFilter | PublicUnifiedEventsFilter - | PublicPropertyAssociationInListFilter | PublicConstantFilter >; @@ -3291,7 +3109,6 @@ export interface ListCreateParams { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch; /** @@ -3474,7 +3291,6 @@ export interface ListUpdateListFiltersParams { | PublicNotAnyFilterBranch | PublicRestrictedFilterBranch | PublicUnifiedEventsFilterBranch - | PublicPropertyAssociationFilterBranch | PublicAssociationFilterBranch; /** @@ -3572,7 +3388,6 @@ export declare namespace Lists { type PublicBatchMigrationMapping as PublicBatchMigrationMapping, type PublicBoolPropertyOperation as PublicBoolPropertyOperation, type PublicCalendarDatePropertyOperation as PublicCalendarDatePropertyOperation, - type PublicCampaignInfluencedFilter as PublicCampaignInfluencedFilter, type PublicCommunicationSubscriptionFilter as PublicCommunicationSubscriptionFilter, type PublicComparativeDatePropertyOperation as PublicComparativeDatePropertyOperation, type PublicComparativePropertyUpdatedOperation as PublicComparativePropertyUpdatedOperation, @@ -3608,7 +3423,6 @@ export declare namespace Lists { type PublicNotAllFilterBranch as PublicNotAllFilterBranch, type PublicNotAnyFilterBranch as PublicNotAnyFilterBranch, type PublicNowReference as PublicNowReference, - type PublicNumAssociationsFilter as PublicNumAssociationsFilter, type PublicNumOccurrencesRefineBy as PublicNumOccurrencesRefineBy, type PublicNumberPropertyOperation as PublicNumberPropertyOperation, type PublicObjectList as PublicObjectList, @@ -3616,8 +3430,6 @@ export declare namespace Lists { type PublicOrFilterBranch as PublicOrFilterBranch, type PublicPageViewAnalyticsFilter as PublicPageViewAnalyticsFilter, type PublicPrivacyAnalyticsFilter as PublicPrivacyAnalyticsFilter, - type PublicPropertyAssociationFilterBranch as PublicPropertyAssociationFilterBranch, - type PublicPropertyAssociationInListFilter as PublicPropertyAssociationInListFilter, type PublicPropertyFilter as PublicPropertyFilter, type PublicPropertyReferencedTime as PublicPropertyReferencedTime, type PublicQuarterReference as PublicQuarterReference, diff --git a/src/resources/index.ts b/src/resources/index.ts index 68bd4cac..5333b8a5 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -19,3 +19,4 @@ export { Meta, BaseMeta } from './meta/meta'; export { Scheduler, BaseScheduler } from './scheduler/scheduler'; export { Settings, BaseSettings } from './settings/settings'; export { Webhooks, BaseWebhooks } from './webhooks'; +export { WebhooksJournal, BaseWebhooksJournal } from './webhooks-journal/webhooks-journal'; diff --git a/src/resources/scheduler/meetings/meetings.ts b/src/resources/scheduler/meetings/meetings.ts index 84620c99..df54916c 100644 --- a/src/resources/scheduler/meetings/meetings.ts +++ b/src/resources/scheduler/meetings/meetings.ts @@ -288,6 +288,7 @@ export interface ExternalCalendarMeetingEventResponseProperties { | 'BIDEN' | 'BILLING' | 'BOT' + | 'BREEZE_AGENT' | 'CALCULATED' | 'CENTRAL_EXCHANGE_RATES' | 'CHATSPOT' @@ -312,6 +313,7 @@ export interface ExternalCalendarMeetingEventResponseProperties { | 'DEALS' | 'DEFAULT' | 'DELETE_OBJECTS' + | 'DI_WRITE_TO_CRM' | 'EMAIL' | 'EMAIL_INBOX_IMPORT' | 'EMAIL_INTEGRATION' diff --git a/src/resources/shared.ts b/src/resources/shared.ts index 80b66816..2355b2c8 100644 --- a/src/resources/shared.ts +++ b/src/resources/shared.ts @@ -12,6 +12,32 @@ export interface AbTestCreateRequestVNext { variationName: string; } +export interface ActionOverrideRequest { + /** + * An array of strings, each representing an associated object type ID relevant to + * the action override. + */ + associatedObjectTypeIds?: Array; + + /** + * An array of integers representing list IDs that are associated with the action + * override. The integers are in int64 format. + */ + listIds?: Array; + + /** + * An array of integers, each representing an object ID for which the action + * override is applicable. The integers are in int64 format. + */ + objectIds?: Array; + + /** + * An array of strings representing the properties to be overridden in the action. + * Each string corresponds to a property name. + */ + properties?: Array; +} + export interface ActionResponse { /** * The timestamp indicating when the action was completed. @@ -41,6 +67,14 @@ export interface ActionResponse { requestedAt?: string; } +export interface AppLifecycleEventSubscriptionUpsertRequest { + eventTypeId: string; + + properties: Array; + + subscriptionType: 'APP_LIFECYCLE_EVENT'; +} + /** * The definition of an association */ @@ -101,6 +135,34 @@ export interface AssociationSpec { associationTypeId: number; } +export interface AssociationSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + associatedObjectTypeIds: Array; + + objectIds: Array; + + objectTypeId: string; + + portalId: number; + + subscriptionType: 'ASSOCIATION'; +} + /** * A HubSpot property option */ @@ -171,10 +233,204 @@ export interface BatchReadInputPropertyName { inputs: Array; } +export interface BatchResponseJournalFetchResponse { + /** + * The date and time when the batch operation was completed, in ISO 8601 format. + */ + completedAt: string; + + /** + * An array of results from the batch operation, each represented as a + * JournalFetchResponse object. + */ + results: Array; + + /** + * The date and time when the batch operation started, in ISO 8601 format. + */ + startedAt: string; + + /** + * The current status of the batch operation. Valid values include 'PENDING', + * 'PROCESSING', 'CANCELED', and 'COMPLETE'. + */ + status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; + + /** + * A map of link names to associated URIs related to the batch operation. + */ + links?: { [key: string]: string }; + + /** + * The date and time when the batch operation was requested, in ISO 8601 format. + */ + requestedAt?: string; +} + +export interface BatchResponseJournalFetchResponseWithErrors { + /** + * The date and time when the batch process was completed, in ISO 8601 format. + */ + completedAt: string; + + /** + * An array of journal fetch responses, each representing a result from the batch + * process. + */ + results: Array; + + /** + * The date and time when the batch process started, in ISO 8601 format. + */ + startedAt: string; + + /** + * The current status of the batch process. Valid values include 'PENDING', + * 'PROCESSING', 'CANCELED', and 'COMPLETE'. + */ + status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; + + /** + * An array of standard errors that occurred during the batch process, providing + * details about each error. + */ + errors?: Array; + + /** + * A map of link names to associated URIs, providing additional context or actions + * related to the batch process. + */ + links?: { [key: string]: string }; + + /** + * The number of errors that occurred during the batch process. + */ + numErrors?: number; + + /** + * The date and time when the batch request was made, in ISO 8601 format. + */ + requestedAt?: string; +} + export interface CollectionResponsePropertyGroupNoPaging { results: Array; } +export interface Condition { + /** + * A string indicating the type of filter being applied. Valid value is + * 'CRM_OBJECT_PROPERTY'. + */ + filterType: 'CRM_OBJECT_PROPERTY'; + + /** + * A string specifying the operation to be performed in the condition. Valid values + * include 'EQ', 'N_EQ', 'LT', 'GT', 'LTE', 'GTE', 'CONTAINS', 'STARTS_WITH', + * 'ENDS_WITH', 'IN', 'NOT_IN', 'IS_EMPTY', and 'IS_NOT_EMPTY'. + */ + operator: + | 'CONTAINS' + | 'ENDS_WITH' + | 'EQ' + | 'GT' + | 'GTE' + | 'IN' + | 'IS_EMPTY' + | 'IS_NOT_EMPTY' + | 'LT' + | 'LTE' + | 'N_EQ' + | 'NOT_IN' + | 'STARTS_WITH'; + + /** + * A string representing the specific property of the CRM object that the condition + * applies to. + */ + property: string; + + /** + * A string representing the value to be compared against the specified property + * when using single-value operators. + */ + value?: string; + + /** + * An array of strings used to specify multiple values for comparison when using + * operators that support multiple values, such as 'IN' or 'NOT_IN'. + */ + values?: Array; +} + +export interface CrmObjectSnapshotBatchRequest { + /** + * An array of CrmObjectSnapshotRequest objects, each representing a request to + * create a snapshot for a specific CRM object. This property is required. + */ + snapshotRequests: Array; +} + +export interface CrmObjectSnapshotBatchResponse { + /** + * An array of CrmObjectSnapshotResponse objects, each representing the result of a + * snapshot operation for a specific CRM object. This property is required. + */ + snapshotResponses: Array; +} + +export interface CrmObjectSnapshotRequest { + /** + * An integer representing the unique identifier of the CRM object for which the + * snapshot is requested. + */ + objectId: number; + + /** + * A string representing the type identifier of the CRM object, specifying what + * kind of object it is within HubSpot. + */ + objectTypeId: string; + + /** + * An integer representing the unique identifier of the HubSpot account (portal) + * where the CRM object resides. + */ + portalId: number; + + /** + * An array of strings, each representing a property of the CRM object that should + * be included in the snapshot. + */ + properties: Array; +} + +export interface CrmObjectSnapshotResponse { + /** + * An integer representing the unique identifier of the CRM object for which the + * snapshot is taken. + */ + objectId: number; + + /** + * A string indicating the type of the CRM object, such as contact, company, or + * deal. + */ + objectTypeId: string; + + /** + * An integer representing the unique identifier of the HubSpot portal associated + * with the CRM object. + */ + portalId: number; + + /** + * A UUID string representing the status identifier of the snapshot request, + * indicating the current state of the snapshot process. + */ + snapshotStatusId: string; +} + export interface ErrorData { /** * The error category @@ -243,6 +499,61 @@ export interface ErrorDetail { subCategory?: string; } +/** + * Defines a single condition for searching CRM objects, specifying the property to + * filter on, the operator to use (such as equals, greater than, or contains), and + * the value(s) to compare against. + */ +export interface Filter { + /** + * An array of conditions that define the criteria for the filter. Each condition + * specifies a property, an operator, and optionally a value or values. + */ + conditions: Array; +} + +export interface FilterCreateRequest { + /** + * Defines a single condition for searching CRM objects, specifying the property to + * filter on, the operator to use (such as equals, greater than, or contains), and + * the value(s) to compare against. + */ + filter: Filter; + + /** + * The unique identifier of the subscription to which the filter will be applied. + * It is an integer formatted as int64. + */ + subscriptionId: number; +} + +export interface FilterCreateResponse { + /** + * The unique identifier for the created filter. It is an integer formatted as + * int64. + */ + filterId: number; +} + +export interface FilterResponse { + /** + * The unique identifier for the filter. It is an integer in int64 format. + */ + id: number; + + /** + * A Unix timestamp in milliseconds indicating when the filter was created. + */ + createdAt: number; + + /** + * Defines a single condition for searching CRM objects, specifying the property to + * filter on, the operator to use (such as equals, greater than, or contains), and + * the value(s) to compare against. + */ + filter: Filter; +} + export interface ForwardPaging { /** * Specifies the paging information needed to retrieve the next set of results in a @@ -251,6 +562,74 @@ export interface ForwardPaging { next?: NextPage; } +export interface GdprPrivacyDeletionSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectTypeId: string; + + portalId: number; + + subscriptionType: 'GDPR_PRIVACY_DELETION'; +} + +export interface JournalFetchResponse { + /** + * The unique identifier for the current offset of the journal entry, formatted as + * a UUID. + */ + currentOffset: string; + + /** + * The date and time when the URL will expire, in ISO 8601 format. + */ + expiresAt: string; + + /** + * The URL where the journal entry can be accessed. It is a string. + */ + url: string; +} + +export interface ListMembershipSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + listIds: Array; + + objectIds: Array; + + portalId: number; + + subscriptionType: 'LIST_MEMBERSHIP'; +} + /** * Specifies the paging information needed to retrieve the next set of results in a * paginated API response @@ -267,6 +646,34 @@ export interface NextPage { link?: string; } +export interface ObjectSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectIds: Array; + + objectTypeId: string; + + portalId: number; + + properties: Array; + + subscriptionType: 'OBJECT'; +} + export interface ObjectTypeDefinition { id: string; @@ -725,6 +1132,7 @@ export interface PropertyValue { | 'BIDEN' | 'BILLING' | 'BOT' + | 'BREEZE_AGENT' | 'CALCULATED' | 'CENTRAL_EXCHANGE_RATES' | 'CHATSPOT' @@ -749,6 +1157,7 @@ export interface PropertyValue { | 'DEALS' | 'DEFAULT' | 'DELETE_OBJECTS' + | 'DI_WRITE_TO_CRM' | 'EMAIL' | 'EMAIL_INBOX_IMPORT' | 'EMAIL_INTEGRATION' @@ -877,6 +1286,43 @@ export interface PublicObjectID { id: string; } +export interface SnapshotStatusResponse { + /** + * The unique identifier for the snapshot operation, represented as a UUID. + */ + id: string; + + /** + * The timestamp indicating when the snapshot operation was initiated, represented + * as a Unix timestamp in milliseconds. + */ + initiatedAt: number; + + /** + * The current status of the snapshot. Valid values include 'PENDING', + * 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'. + */ + status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; + + /** + * The timestamp indicating when the snapshot operation was completed, represented + * as a Unix timestamp in milliseconds. + */ + completedAt?: number; + + /** + * A code representing the error that occurred, if any. Possible values are + * 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'. + */ + errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; + + /** + * A descriptive message providing additional information about the snapshot + * operation or error. + */ + message?: string; +} + /** * Ye olde error */ @@ -922,6 +1368,13 @@ export interface StandardError { subCategory?: unknown; } +export type SubscriptionUpsertRequest = + | ObjectSubscriptionUpsertRequest + | AssociationSubscriptionUpsertRequest + | AppLifecycleEventSubscriptionUpsertRequest + | ListMembershipSubscriptionUpsertRequest + | GdprPrivacyDeletionSubscriptionUpsertRequest; + export interface TaskLocator { /** * The unique identifier for the task. diff --git a/src/resources/webhooks-journal.ts b/src/resources/webhooks-journal.ts new file mode 100644 index 00000000..95c935ec --- /dev/null +++ b/src/resources/webhooks-journal.ts @@ -0,0 +1,3 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export * from './webhooks-journal/index'; diff --git a/src/resources/webhooks-journal/api.md b/src/resources/webhooks-journal/api.md new file mode 100644 index 00000000..348a89fe --- /dev/null +++ b/src/resources/webhooks-journal/api.md @@ -0,0 +1,69 @@ +# WebhooksJournal + +Types: + +- CollectionResponseSubscriptionResponseNoPaging +- SubscriptionResponse + +## Journal + +Methods: + +- client.webhooksJournal.journal.getEarliest({ ...params }) -> Response +- client.webhooksJournal.journal.getNextFromOffset(offset, { ...params }) -> Response +- client.webhooksJournal.journal.getStatus(statusID) -> SnapshotStatusResponse + +### Batch + +Methods: + +- client.webhooksJournal.journal.batch.get({ ...params }) -> BatchResponseJournalFetchResponse +- client.webhooksJournal.journal.batch.getEarliest(count, { ...params }) -> BatchResponseJournalFetchResponse +- client.webhooksJournal.journal.batch.getFromOffset(count, { ...params }) -> BatchResponseJournalFetchResponse +- client.webhooksJournal.journal.batch.getLatest(count, { ...params }) -> BatchResponseJournalFetchResponse + +## JournalLocal + +Methods: + +- client.webhooksJournal.journalLocal.getEarliest({ ...params }) -> Response +- client.webhooksJournal.journalLocal.getLatest({ ...params }) -> Response +- client.webhooksJournal.journalLocal.getNextFromOffset(offset, { ...params }) -> Response +- client.webhooksJournal.journalLocal.getStatus(statusID) -> SnapshotStatusResponse + +### Batch + +Methods: + +- client.webhooksJournal.journalLocal.batch.get({ ...params }) -> BatchResponseJournalFetchResponse +- client.webhooksJournal.journalLocal.batch.getEarliest(count, { ...params }) -> BatchResponseJournalFetchResponse +- client.webhooksJournal.journalLocal.batch.getFromOffset(count, { ...params }) -> BatchResponseJournalFetchResponse + +## Snapshots + +Methods: + +- client.webhooksJournal.snapshots.create({ ...params }) -> CrmObjectSnapshotBatchResponse + +## Subscriptions + +Methods: + +- client.webhooksJournal.subscriptions.create({ ...params }) -> SubscriptionResponse +- client.webhooksJournal.subscriptions.list() -> CollectionResponseSubscriptionResponseNoPaging +- client.webhooksJournal.subscriptions.delete(subscriptionID) -> void +- client.webhooksJournal.subscriptions.deleteForPortal(portalID) -> void +- client.webhooksJournal.subscriptions.get(subscriptionID) -> SubscriptionResponse + +### Filters + +Types: + +- FilterListResponse + +Methods: + +- client.webhooksJournal.subscriptions.filters.create({ ...params }) -> FilterCreateResponse +- client.webhooksJournal.subscriptions.filters.list(subscriptionID) -> FilterListResponse +- client.webhooksJournal.subscriptions.filters.delete(filterID) -> void +- client.webhooksJournal.subscriptions.filters.get(filterID) -> FilterResponse diff --git a/src/resources/webhooks-journal/index.ts b/src/resources/webhooks-journal/index.ts new file mode 100644 index 00000000..74fef6b3 --- /dev/null +++ b/src/resources/webhooks-journal/index.ts @@ -0,0 +1,18 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export { + Journal, + BaseJournal, + type JournalGetEarliestParams, + type JournalGetNextFromOffsetParams, +} from './journal/index'; +export { + JournalLocal, + BaseJournalLocal, + type JournalLocalGetEarliestParams, + type JournalLocalGetLatestParams, + type JournalLocalGetNextFromOffsetParams, +} from './journal-local/index'; +export { Snapshots, BaseSnapshots, type SnapshotCreateParams } from './snapshots'; +export { Subscriptions, BaseSubscriptions, type SubscriptionCreateParams } from './subscriptions/index'; +export { WebhooksJournal, BaseWebhooksJournal } from './webhooks-journal'; diff --git a/src/resources/webhooks-journal/journal-local.ts b/src/resources/webhooks-journal/journal-local.ts new file mode 100644 index 00000000..35482e96 --- /dev/null +++ b/src/resources/webhooks-journal/journal-local.ts @@ -0,0 +1,3 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export * from './journal-local/index'; diff --git a/src/resources/webhooks-journal/journal-local/batch.ts b/src/resources/webhooks-journal/journal-local/batch.ts new file mode 100644 index 00000000..4a2e7c8a --- /dev/null +++ b/src/resources/webhooks-journal/journal-local/batch.ts @@ -0,0 +1,111 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as Shared from '../../shared'; +import { APIPromise } from '../../../core/api-promise'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseBatch extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'journalLocal', 'batch'] = Object.freeze([ + 'webhooksJournal', + 'journalLocal', + 'batch', + ] as const); + + /** + * Execute a batch read operation on the webhooks journal. This endpoint allows you + * to retrieve a batch of webhook journal entries by providing the necessary input + * data. It is useful for processing multiple records in a single request, + * streamlining data retrieval tasks. + */ + get( + params: BatchGetParams, + options?: RequestOptions, + ): APIPromise { + const { installPortalId, ...body } = params; + return this._client.post('/webhooks-journal/journal-local/2026-03/batch/read', { + query: { installPortalId }, + body, + ...options, + }); + } + + /** + * Retrieve the earliest batch of webhook journal entries. This endpoint is useful + * for accessing the oldest available data in the webhook journal, allowing users + * to process or analyze historical webhook events. The number of entries to fetch + * is specified by the 'count' path parameter. + */ + getEarliest( + count: number, + query: BatchGetEarliestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/webhooks-journal/journal-local/2026-03/batch/earliest/${count}`, { + query, + ...options, + }); + } + + /** + * Retrieve a batch of webhook journal entries starting from a specified offset. + * This endpoint is useful for paginating through large sets of webhook data. The + * number of entries returned is determined by the 'count' parameter. + */ + getFromOffset( + count: number, + params: BatchGetFromOffsetParams, + options?: RequestOptions, + ): APIPromise { + const { offset, ...query } = params; + return this._client.get(path`/webhooks-journal/journal-local/2026-03/batch/${offset}/next/${count}`, { + query, + ...options, + }); + } +} +export class Batch extends BaseBatch {} + +export interface BatchGetParams { + /** + * Body param: Strings to input. + */ + inputs: Array; + + /** + * Query param: The ID of the portal where the webhooks are installed. This + * parameter is optional and is used to specify the target portal for the + * operation. + */ + installPortalId?: number; +} + +export interface BatchGetEarliestParams { + /** + * The ID of the portal installation to filter the webhook journal entries. This is + * an optional integer parameter. + */ + installPortalId?: number; +} + +export interface BatchGetFromOffsetParams { + /** + * Path param: The starting point for the batch retrieval, specified as a string. + */ + offset: string; + + /** + * Query param: The ID of the portal where the webhooks are installed. This is an + * optional parameter. + */ + installPortalId?: number; +} + +export declare namespace Batch { + export { + type BatchGetParams as BatchGetParams, + type BatchGetEarliestParams as BatchGetEarliestParams, + type BatchGetFromOffsetParams as BatchGetFromOffsetParams, + }; +} diff --git a/src/resources/webhooks-journal/journal-local/index.ts b/src/resources/webhooks-journal/journal-local/index.ts new file mode 100644 index 00000000..de5c4a45 --- /dev/null +++ b/src/resources/webhooks-journal/journal-local/index.ts @@ -0,0 +1,16 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export { + Batch, + BaseBatch, + type BatchGetParams, + type BatchGetEarliestParams, + type BatchGetFromOffsetParams, +} from './batch'; +export { + JournalLocal, + BaseJournalLocal, + type JournalLocalGetEarliestParams, + type JournalLocalGetLatestParams, + type JournalLocalGetNextFromOffsetParams, +} from './journal-local'; diff --git a/src/resources/webhooks-journal/journal-local/journal-local.ts b/src/resources/webhooks-journal/journal-local/journal-local.ts new file mode 100644 index 00000000..e94f9062 --- /dev/null +++ b/src/resources/webhooks-journal/journal-local/journal-local.ts @@ -0,0 +1,125 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as Shared from '../../shared'; +import * as BatchAPI from './batch'; +import { BaseBatch, Batch, BatchGetEarliestParams, BatchGetFromOffsetParams, BatchGetParams } from './batch'; +import { APIPromise } from '../../../core/api-promise'; +import { buildHeaders } from '../../../internal/headers'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseJournalLocal extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'journalLocal'] = Object.freeze([ + 'webhooksJournal', + 'journalLocal', + ] as const); + + /** + * Retrieve the earliest webhook journal entries for the specified portal. This + * endpoint can be used to access the oldest records available in the webhook + * journal, which may be useful for auditing or historical analysis. + */ + getEarliest( + query: JournalLocalGetEarliestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/webhooks-journal/journal-local/2026-03/earliest', { + query, + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + /** + * Retrieve the latest entries from the webhooks journal for the specified portal. + * This endpoint is useful for accessing the most recent webhook events and their + * statuses, allowing you to monitor and debug webhook activity effectively. + */ + getLatest( + query: JournalLocalGetLatestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/webhooks-journal/journal/2026-03/latest', { + query, + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + /** + * Retrieve the next set of webhook journal entries starting from a specified + * offset. This endpoint is useful for paginating through large sets of webhook + * data, allowing you to continue from where a previous request left off. + */ + getNextFromOffset( + offset: string, + query: JournalLocalGetNextFromOffsetParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/webhooks-journal/journal-local/2026-03/offset/${offset}/next`, { + query, + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + /** + * Retrieve the status of a specific webhook journal entry using its unique status + * ID. This endpoint is useful for monitoring the progress or outcome of webhook + * journal entries, allowing you to check if an entry is pending, in progress, + * completed, failed, or expired. + */ + getStatus(statusID: string, options?: RequestOptions): APIPromise { + return this._client.get(path`/webhooks-journal/journal-local/2026-03/status/${statusID}`, options); + } +} +export class JournalLocal extends BaseJournalLocal { + batch: BatchAPI.Batch = new BatchAPI.Batch(this._client); +} + +export interface JournalLocalGetEarliestParams { + /** + * The ID of the portal for which to retrieve the earliest webhook journal entries. + * This parameter is optional and should be an integer. + */ + installPortalId?: number; +} + +export interface JournalLocalGetLatestParams { + /** + * The unique identifier of the portal installation for which to retrieve the + * latest journal entries. This parameter is optional and should be an integer. + */ + installPortalId?: number; +} + +export interface JournalLocalGetNextFromOffsetParams { + /** + * The ID of the portal installation to filter the webhook journal entries. This is + * an integer value. + */ + installPortalId?: number; +} + +JournalLocal.Batch = Batch; +JournalLocal.BaseBatch = BaseBatch; + +export declare namespace JournalLocal { + export { + type JournalLocalGetEarliestParams as JournalLocalGetEarliestParams, + type JournalLocalGetLatestParams as JournalLocalGetLatestParams, + type JournalLocalGetNextFromOffsetParams as JournalLocalGetNextFromOffsetParams, + }; + + export { + Batch as Batch, + BaseBatch as BaseBatch, + type BatchGetParams as BatchGetParams, + type BatchGetEarliestParams as BatchGetEarliestParams, + type BatchGetFromOffsetParams as BatchGetFromOffsetParams, + }; +} diff --git a/src/resources/webhooks-journal/journal.ts b/src/resources/webhooks-journal/journal.ts new file mode 100644 index 00000000..87915e27 --- /dev/null +++ b/src/resources/webhooks-journal/journal.ts @@ -0,0 +1,3 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export * from './journal/index'; diff --git a/src/resources/webhooks-journal/journal/batch.ts b/src/resources/webhooks-journal/journal/batch.ts new file mode 100644 index 00000000..fb1504e1 --- /dev/null +++ b/src/resources/webhooks-journal/journal/batch.ts @@ -0,0 +1,137 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as Shared from '../../shared'; +import { APIPromise } from '../../../core/api-promise'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseBatch extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'journal', 'batch'] = Object.freeze([ + 'webhooksJournal', + 'journal', + 'batch', + ] as const); + + /** + * Execute a batch read operation on the webhooks journal for the specified date, + * 2026-03. This endpoint allows you to retrieve multiple entries from the webhooks + * journal in a single request, which can be useful for processing large amounts of + * data efficiently. Ensure that the request body is provided in the required + * format. + */ + get( + params: BatchGetParams, + options?: RequestOptions, + ): APIPromise { + const { installPortalId, ...body } = params; + return this._client.post('/webhooks-journal/journal/2026-03/batch/read', { + query: { installPortalId }, + body, + ...options, + }); + } + + /** + * Retrieve the earliest batch of webhook journal entries for a specified count. + * This endpoint is useful for accessing historical webhook data in batches, + * allowing you to process or analyze older entries. The number of entries + * retrieved is determined by the count parameter. + */ + getEarliest( + count: number, + query: BatchGetEarliestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/webhooks-journal/journal/2026-03/batch/earliest/${count}`, { + query, + ...options, + }); + } + + /** + * Retrieve a batch of webhook journal entries starting from a specified offset. + * This endpoint allows you to fetch a defined number of entries, which can be + * useful for processing large datasets in manageable chunks. + */ + getFromOffset( + count: number, + params: BatchGetFromOffsetParams, + options?: RequestOptions, + ): APIPromise { + const { offset, ...query } = params; + return this._client.get(path`/webhooks-journal/journal/2026-03/batch/${offset}/next/${count}`, { + query, + ...options, + }); + } + + /** + * Retrieve the latest batch of webhook journal entries up to the specified count. + * This endpoint is useful for fetching recent webhook data for analysis or + * processing. The count parameter determines the maximum number of entries to + * return. + */ + getLatest( + count: number, + query: BatchGetLatestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/webhooks-journal/journal/2026-03/batch/latest/${count}`, { + query, + ...options, + }); + } +} +export class Batch extends BaseBatch {} + +export interface BatchGetParams { + /** + * Body param: Strings to input. + */ + inputs: Array; + + /** + * Query param: An integer representing the ID of the portal installation for which + * the webhooks journal data should be retrieved. + */ + installPortalId?: number; +} + +export interface BatchGetEarliestParams { + /** + * The ID of the portal installation. This is an integer value that specifies which + * portal's data to access. + */ + installPortalId?: number; +} + +export interface BatchGetFromOffsetParams { + /** + * Path param: The starting point for fetching the journal entries. This is a + * string value. + */ + offset: string; + + /** + * Query param: The ID of the portal installation. This is an integer value. + */ + installPortalId?: number; +} + +export interface BatchGetLatestParams { + /** + * The ID of the portal installation. This is an integer value used to specify the + * portal context for the request. + */ + installPortalId?: number; +} + +export declare namespace Batch { + export { + type BatchGetParams as BatchGetParams, + type BatchGetEarliestParams as BatchGetEarliestParams, + type BatchGetFromOffsetParams as BatchGetFromOffsetParams, + type BatchGetLatestParams as BatchGetLatestParams, + }; +} diff --git a/src/resources/webhooks-journal/journal/index.ts b/src/resources/webhooks-journal/journal/index.ts new file mode 100644 index 00000000..96dbdd18 --- /dev/null +++ b/src/resources/webhooks-journal/journal/index.ts @@ -0,0 +1,16 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export { + Batch, + BaseBatch, + type BatchGetParams, + type BatchGetEarliestParams, + type BatchGetFromOffsetParams, + type BatchGetLatestParams, +} from './batch'; +export { + Journal, + BaseJournal, + type JournalGetEarliestParams, + type JournalGetNextFromOffsetParams, +} from './journal'; diff --git a/src/resources/webhooks-journal/journal/journal.ts b/src/resources/webhooks-journal/journal/journal.ts new file mode 100644 index 00000000..7b1fed95 --- /dev/null +++ b/src/resources/webhooks-journal/journal/journal.ts @@ -0,0 +1,106 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as Shared from '../../shared'; +import * as BatchAPI from './batch'; +import { + BaseBatch, + Batch, + BatchGetEarliestParams, + BatchGetFromOffsetParams, + BatchGetLatestParams, + BatchGetParams, +} from './batch'; +import { APIPromise } from '../../../core/api-promise'; +import { buildHeaders } from '../../../internal/headers'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseJournal extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'journal'] = Object.freeze([ + 'webhooksJournal', + 'journal', + ] as const); + + /** + * Retrieve the earliest entry from the webhooks journal for the specified portal. + * This endpoint is useful for accessing the first recorded webhook event in the + * journal, which can be helpful for auditing or debugging purposes. + */ + getEarliest( + query: JournalGetEarliestParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/webhooks-journal/journal/2026-03/earliest', { + query, + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + /** + * Retrieve the next set of entries from the webhooks journal starting from a + * specified offset. This endpoint is useful for paginating through journal entries + * to process or analyze webhook events sequentially. + */ + getNextFromOffset( + offset: string, + query: JournalGetNextFromOffsetParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/webhooks-journal/journal/2026-03/offset/${offset}/next`, { + query, + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + __binaryResponse: true, + }); + } + + /** + * Retrieve the status of a specific webhook journal entry using its unique status + * ID. This endpoint provides detailed information about the status, including + * whether it is pending, in progress, completed, failed, or expired. It is useful + * for monitoring and managing the state of webhook journal entries. + */ + getStatus(statusID: string, options?: RequestOptions): APIPromise { + return this._client.get(path`/webhooks-journal/journal/2026-03/status/${statusID}`, options); + } +} +export class Journal extends BaseJournal { + batch: BatchAPI.Batch = new BatchAPI.Batch(this._client); +} + +export interface JournalGetEarliestParams { + /** + * The ID of the portal installation to filter the journal entries by. This is an + * integer value. + */ + installPortalId?: number; +} + +export interface JournalGetNextFromOffsetParams { + /** + * The ID of the portal where the webhooks are installed. This is an integer value. + */ + installPortalId?: number; +} + +Journal.Batch = Batch; +Journal.BaseBatch = BaseBatch; + +export declare namespace Journal { + export { + type JournalGetEarliestParams as JournalGetEarliestParams, + type JournalGetNextFromOffsetParams as JournalGetNextFromOffsetParams, + }; + + export { + Batch as Batch, + BaseBatch as BaseBatch, + type BatchGetParams as BatchGetParams, + type BatchGetEarliestParams as BatchGetEarliestParams, + type BatchGetFromOffsetParams as BatchGetFromOffsetParams, + type BatchGetLatestParams as BatchGetLatestParams, + }; +} diff --git a/src/resources/webhooks-journal/snapshots.ts b/src/resources/webhooks-journal/snapshots.ts new file mode 100644 index 00000000..e666a42b --- /dev/null +++ b/src/resources/webhooks-journal/snapshots.ts @@ -0,0 +1,39 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../core/resource'; +import * as Shared from '../shared'; +import { APIPromise } from '../../core/api-promise'; +import { RequestOptions } from '../../internal/request-options'; + +export class BaseSnapshots extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'snapshots'] = Object.freeze([ + 'webhooksJournal', + 'snapshots', + ] as const); + + /** + * Create a batch of CRM object snapshots in HubSpot. This endpoint is used to + * capture the current state of specified CRM objects for later reference or + * analysis. It requires a JSON payload containing the details of the CRM objects + * to snapshot. This operation is exempt from daily and ten-secondly rate limits. + */ + create( + body: SnapshotCreateParams, + options?: RequestOptions, + ): APIPromise { + return this._client.post('/webhooks-journal/snapshots/2026-03/crm', { body, ...options }); + } +} +export class Snapshots extends BaseSnapshots {} + +export interface SnapshotCreateParams { + /** + * An array of CrmObjectSnapshotRequest objects, each representing a request to + * create a snapshot for a specific CRM object. This property is required. + */ + snapshotRequests: Array; +} + +export declare namespace Snapshots { + export { type SnapshotCreateParams as SnapshotCreateParams }; +} diff --git a/src/resources/webhooks-journal/subscriptions.ts b/src/resources/webhooks-journal/subscriptions.ts new file mode 100644 index 00000000..2019b794 --- /dev/null +++ b/src/resources/webhooks-journal/subscriptions.ts @@ -0,0 +1,3 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export * from './subscriptions/index'; diff --git a/src/resources/webhooks-journal/subscriptions/filters.ts b/src/resources/webhooks-journal/subscriptions/filters.ts new file mode 100644 index 00000000..c29e75ce --- /dev/null +++ b/src/resources/webhooks-journal/subscriptions/filters.ts @@ -0,0 +1,82 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as Shared from '../../shared'; +import { APIPromise } from '../../../core/api-promise'; +import { buildHeaders } from '../../../internal/headers'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseFilters extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'subscriptions', 'filters'] = Object.freeze([ + 'webhooksJournal', + 'subscriptions', + 'filters', + ] as const); + + /** + * Create a new filter for a specific webhook subscription in the HubSpot account. + * This endpoint allows you to define conditions that determine when a webhook + * should be triggered. The filter is associated with a subscription identified by + * its ID, and the request must include the filter details. + */ + create(body: FilterCreateParams, options?: RequestOptions): APIPromise { + return this._client.post('/webhooks-journal/subscriptions/2026-03/filters', { body, ...options }); + } + + /** + * Retrieve the filters associated with a specific webhook subscription. This + * endpoint allows you to view the filters applied to a subscription, which can + * help in managing and understanding the conditions set for webhook events. + */ + list(subscriptionID: number, options?: RequestOptions): APIPromise { + return this._client.get( + path`/webhooks-journal/subscriptions/2026-03/filters/subscription/${subscriptionID}`, + options, + ); + } + + /** + * Remove a specific filter from the webhooks journal subscriptions. This operation + * is useful for managing and cleaning up filters that are no longer needed. Once + * deleted, the filter cannot be recovered. + */ + delete(filterID: number, options?: RequestOptions): APIPromise { + return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/filters/${filterID}`, { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + }); + } + + /** + * Retrieve a specific filter associated with a webhook journal subscription. This + * endpoint allows you to access the details of the filter identified by the + * filterId, which is useful for managing and understanding the conditions applied + * to webhook events. + */ + get(filterID: number, options?: RequestOptions): APIPromise { + return this._client.get(path`/webhooks-journal/subscriptions/2026-03/filters/${filterID}`, options); + } +} +export class Filters extends BaseFilters {} + +export type FilterListResponse = Array; + +export interface FilterCreateParams { + /** + * Defines a single condition for searching CRM objects, specifying the property to + * filter on, the operator to use (such as equals, greater than, or contains), and + * the value(s) to compare against. + */ + filter: Shared.Filter; + + /** + * The unique identifier of the subscription to which the filter will be applied. + * It is an integer formatted as int64. + */ + subscriptionId: number; +} + +export declare namespace Filters { + export { type FilterListResponse as FilterListResponse, type FilterCreateParams as FilterCreateParams }; +} diff --git a/src/resources/webhooks-journal/subscriptions/index.ts b/src/resources/webhooks-journal/subscriptions/index.ts new file mode 100644 index 00000000..dc53aa6f --- /dev/null +++ b/src/resources/webhooks-journal/subscriptions/index.ts @@ -0,0 +1,4 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +export { Filters, BaseFilters, type FilterListResponse, type FilterCreateParams } from './filters'; +export { Subscriptions, BaseSubscriptions, type SubscriptionCreateParams } from './subscriptions'; diff --git a/src/resources/webhooks-journal/subscriptions/subscriptions.ts b/src/resources/webhooks-journal/subscriptions/subscriptions.ts new file mode 100644 index 00000000..42b74ade --- /dev/null +++ b/src/resources/webhooks-journal/subscriptions/subscriptions.ts @@ -0,0 +1,218 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../../core/resource'; +import * as WebhooksJournalAPI from '../webhooks-journal'; +import * as FiltersAPI from './filters'; +import { BaseFilters, FilterCreateParams, FilterListResponse, Filters } from './filters'; +import { APIPromise } from '../../../core/api-promise'; +import { buildHeaders } from '../../../internal/headers'; +import { RequestOptions } from '../../../internal/request-options'; +import { path } from '../../../internal/utils/path'; + +export class BaseSubscriptions extends APIResource { + static override readonly _key: readonly ['webhooksJournal', 'subscriptions'] = Object.freeze([ + 'webhooksJournal', + 'subscriptions', + ] as const); + + /** + * Create a new subscription in the Webhooks Journal for the specified version. + * This endpoint allows you to define the subscription details by providing the + * necessary information in the request body. It supports various types of + * subscriptions, including object, association, event, app lifecycle event, list + * membership, and GDPR privacy deletion. Ensure that all required fields are + * included in the request to successfully create a subscription. + */ + create( + body: SubscriptionCreateParams, + options?: RequestOptions, + ): APIPromise { + return this._client.post('/webhooks-journal/subscriptions/2026-03', { body, ...options }); + } + + /** + * Retrieve a list of webhook journal subscriptions for the specified version. This + * endpoint allows you to view all active subscriptions without pagination. It is + * useful for monitoring and managing webhook subscriptions in your HubSpot + * account. + */ + list( + options?: RequestOptions, + ): APIPromise { + return this._client.get('/webhooks-journal/subscriptions/2026-03', options); + } + + /** + * Delete a specific webhook journal subscription using its unique identifier. This + * operation is useful for managing and cleaning up subscriptions that are no + * longer needed in your HubSpot account. + */ + delete(subscriptionID: number, options?: RequestOptions): APIPromise { + return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + }); + } + + /** + * Delete a webhook journal subscription for a specific portal. This operation + * removes the subscription associated with the given portalId, ensuring that no + * further webhook events are sent for this portal. Use this endpoint to manage and + * clean up subscriptions that are no longer needed. + */ + deleteForPortal(portalID: number, options?: RequestOptions): APIPromise { + return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/portals/${portalID}`, { + ...options, + headers: buildHeaders([{ Accept: '*/*' }, options?.headers]), + }); + } + + /** + * Retrieve details of a specific webhook subscription using its unique identifier. + * This endpoint is useful for obtaining information about a particular + * subscription, such as its actions, object type, and associated properties. + */ + get(subscriptionID: number, options?: RequestOptions): APIPromise { + return this._client.get(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, options); + } +} +export class Subscriptions extends BaseSubscriptions { + filters: FiltersAPI.Filters = new FiltersAPI.Filters(this._client); +} + +export type SubscriptionCreateParams = + | SubscriptionCreateParams.ObjectSubscriptionUpsertRequest + | SubscriptionCreateParams.AssociationSubscriptionUpsertRequest + | SubscriptionCreateParams.AppLifecycleEventSubscriptionUpsertRequest + | SubscriptionCreateParams.ListMembershipSubscriptionUpsertRequest + | SubscriptionCreateParams.GdprPrivacyDeletionSubscriptionUpsertRequest; + +export declare namespace SubscriptionCreateParams { + export interface ObjectSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectIds: Array; + + objectTypeId: string; + + portalId: number; + + properties: Array; + + subscriptionType: 'OBJECT'; + } + + export interface AssociationSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + associatedObjectTypeIds: Array; + + objectIds: Array; + + objectTypeId: string; + + portalId: number; + + subscriptionType: 'ASSOCIATION'; + } + + export interface AppLifecycleEventSubscriptionUpsertRequest { + eventTypeId: string; + + properties: Array; + + subscriptionType: 'APP_LIFECYCLE_EVENT'; + } + + export interface ListMembershipSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + listIds: Array; + + objectIds: Array; + + portalId: number; + + subscriptionType: 'LIST_MEMBERSHIP'; + } + + export interface GdprPrivacyDeletionSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectTypeId: string; + + portalId: number; + + subscriptionType: 'GDPR_PRIVACY_DELETION'; + } +} + +Subscriptions.Filters = Filters; +Subscriptions.BaseFilters = BaseFilters; + +export declare namespace Subscriptions { + export { type SubscriptionCreateParams as SubscriptionCreateParams }; + + export { + Filters as Filters, + BaseFilters as BaseFilters, + type FilterListResponse as FilterListResponse, + type FilterCreateParams as FilterCreateParams, + }; +} diff --git a/src/resources/webhooks-journal/webhooks-journal.ts b/src/resources/webhooks-journal/webhooks-journal.ts new file mode 100644 index 00000000..c812a38c --- /dev/null +++ b/src/resources/webhooks-journal/webhooks-journal.ts @@ -0,0 +1,195 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { APIResource } from '../../core/resource'; +import * as Shared from '../shared'; +import * as SnapshotsAPI from './snapshots'; +import { BaseSnapshots, SnapshotCreateParams, Snapshots } from './snapshots'; +import * as JournalLocalAPI from './journal-local/journal-local'; +import { + BaseJournalLocal, + JournalLocal, + JournalLocalGetEarliestParams, + JournalLocalGetLatestParams, + JournalLocalGetNextFromOffsetParams, +} from './journal-local/journal-local'; +import * as JournalAPI from './journal/journal'; +import { + BaseJournal, + Journal, + JournalGetEarliestParams, + JournalGetNextFromOffsetParams, +} from './journal/journal'; +import * as SubscriptionsAPI from './subscriptions/subscriptions'; +import { BaseSubscriptions, SubscriptionCreateParams, Subscriptions } from './subscriptions/subscriptions'; + +export class BaseWebhooksJournal extends APIResource { + static override readonly _key: readonly ['webhooksJournal'] = Object.freeze(['webhooksJournal'] as const); +} +export class WebhooksJournal extends BaseWebhooksJournal { + journal: JournalAPI.Journal = new JournalAPI.Journal(this._client); + journalLocal: JournalLocalAPI.JournalLocal = new JournalLocalAPI.JournalLocal(this._client); + snapshots: SnapshotsAPI.Snapshots = new SnapshotsAPI.Snapshots(this._client); + subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client); +} + +export interface CollectionResponseSubscriptionResponseNoPaging { + /** + * An array of subscription responses, where each item contains details about a + * specific subscription. Each item follows the SubscriptionResponse schema. + */ + results: Array; +} + +export interface SubscriptionResponse { + /** + * The unique identifier for the subscription, represented as an integer. + */ + id: number; + + /** + * An array of actions associated with the subscription. Valid actions include + * 'CREATE', 'UPDATE', 'DELETE', 'MERGE', 'RESTORE', 'ASSOCIATION_ADDED', + * 'ASSOCIATION_REMOVED', 'SNAPSHOT', 'APP_INSTALL', 'APP_UNINSTALL', + * 'ADDED_TO_LIST', 'REMOVED_FROM_LIST', and 'GDPR_DELETE'. + */ + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + /** + * The unique identifier for the app associated with the subscription, represented + * as an integer. + */ + appId: number; + + /** + * The date and time when the subscription was created, in ISO 8601 format. + */ + createdAt: string; + + /** + * The identifier for the type of object associated with the subscription, + * represented as a string. + */ + objectTypeId: string; + + /** + * The type of subscription, indicating the nature of events it pertains to. Valid + * values include 'OBJECT', 'ASSOCIATION', 'EVENT', 'APP_LIFECYCLE_EVENT', + * 'LIST_MEMBERSHIP', and 'GDPR_PRIVACY_DELETION'. + */ + subscriptionType: + | 'APP_LIFECYCLE_EVENT' + | 'ASSOCIATION' + | 'EVENT' + | 'GDPR_PRIVACY_DELETION' + | 'LIST_MEMBERSHIP' + | 'OBJECT'; + + /** + * The date and time when the subscription was last updated, in ISO 8601 format. + */ + updatedAt: string; + + /** + * An object containing overrides for actions, where each key is an action and the + * value is an ActionOverrideRequest object. + */ + actionOverrides?: { [key: string]: Shared.ActionOverrideRequest }; + + /** + * An array of strings representing the IDs of associated object types. + */ + associatedObjectTypeIds?: Array; + + /** + * The unique identifier of the user who created the subscription, represented as + * an integer. + */ + createdBy?: number; + + /** + * The date and time when the subscription was deleted, in ISO 8601 format, if + * applicable. + */ + deletedAt?: string; + + /** + * An array of integers representing the IDs of lists associated with the + * subscription. + */ + listIds?: Array; + + /** + * An array of integers representing the IDs of objects associated with the + * subscription. + */ + objectIds?: Array; + + /** + * The unique identifier for the portal associated with the subscription, + * represented as an integer. + */ + portalId?: number; + + /** + * An array of strings representing the properties associated with the + * subscription. + */ + properties?: Array; +} + +WebhooksJournal.Journal = Journal; +WebhooksJournal.BaseJournal = BaseJournal; +WebhooksJournal.JournalLocal = JournalLocal; +WebhooksJournal.BaseJournalLocal = BaseJournalLocal; +WebhooksJournal.Snapshots = Snapshots; +WebhooksJournal.BaseSnapshots = BaseSnapshots; +WebhooksJournal.Subscriptions = Subscriptions; +WebhooksJournal.BaseSubscriptions = BaseSubscriptions; + +export declare namespace WebhooksJournal { + export { + type CollectionResponseSubscriptionResponseNoPaging as CollectionResponseSubscriptionResponseNoPaging, + type SubscriptionResponse as SubscriptionResponse, + }; + + export { + Journal as Journal, + BaseJournal as BaseJournal, + type JournalGetEarliestParams as JournalGetEarliestParams, + type JournalGetNextFromOffsetParams as JournalGetNextFromOffsetParams, + }; + + export { + JournalLocal as JournalLocal, + BaseJournalLocal as BaseJournalLocal, + type JournalLocalGetEarliestParams as JournalLocalGetEarliestParams, + type JournalLocalGetLatestParams as JournalLocalGetLatestParams, + type JournalLocalGetNextFromOffsetParams as JournalLocalGetNextFromOffsetParams, + }; + + export { + Snapshots as Snapshots, + BaseSnapshots as BaseSnapshots, + type SnapshotCreateParams as SnapshotCreateParams, + }; + + export { + Subscriptions as Subscriptions, + BaseSubscriptions as BaseSubscriptions, + type SubscriptionCreateParams as SubscriptionCreateParams, + }; +} diff --git a/src/resources/webhooks/api.md b/src/resources/webhooks/api.md index bebda19c..4fe03ab5 100644 --- a/src/resources/webhooks/api.md +++ b/src/resources/webhooks/api.md @@ -2,38 +2,18 @@ Types: -- ActionOverrideRequest -- AppLifecycleEventSubscriptionUpsertRequest -- AssociationSubscriptionUpsertRequest - BatchInputSubscriptionBatchUpdateRequest -- BatchResponseJournalFetchResponse -- BatchResponseJournalFetchResponseWithErrors - BatchResponseSubscriptionResponse - BatchResponseSubscriptionResponseWithErrors - CollectionResponseSubscriptionResponseNoPaging -- Condition -- CrmObjectSnapshotBatchRequest -- CrmObjectSnapshotBatchResponse -- CrmObjectSnapshotRequest -- CrmObjectSnapshotResponse -- Filter -- FilterCreateRequest -- FilterCreateResponse -- FilterResponse -- GdprPrivacyDeletionSubscriptionUpsertRequest -- JournalFetchResponse -- ListMembershipSubscriptionUpsertRequest -- ObjectSubscriptionUpsertRequest - SettingsChangeRequest - SettingsResponse -- SnapshotStatusResponse - SubscriptionBatchUpdateRequest - SubscriptionCreateRequest - SubscriptionListResponse - SubscriptionPatchRequest - SubscriptionResponse - SubscriptionResponse1 -- SubscriptionUpsertRequest - ThrottlingSettings - WebhookListSubscriptionFiltersResponse @@ -42,7 +22,7 @@ Methods: - client.webhooks.createBatchEventSubscriptions(appID, { ...params }) -> BatchResponseSubscriptionResponse - client.webhooks.createCrmSnapshots({ ...params }) -> CrmObjectSnapshotBatchResponse - client.webhooks.createEventSubscription(appID, { ...params }) -> SubscriptionResponse -- client.webhooks.createJournalSubscription() -> SubscriptionResponse1 +- client.webhooks.createJournalSubscription({ ...params }) -> SubscriptionResponse - client.webhooks.createSubscriptionFilter({ ...params }) -> FilterCreateResponse - client.webhooks.deleteEventSubscription(subscriptionID, { ...params }) -> void - client.webhooks.deleteJournalSubscription(subscriptionID) -> void @@ -57,7 +37,7 @@ Methods: - client.webhooks.getJournalBatchByRequest({ ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getJournalBatchFromOffset(count, { ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getJournalStatus(statusID) -> SnapshotStatusResponse -- client.webhooks.getJournalSubscription(subscriptionID) -> SubscriptionResponse1 +- client.webhooks.getJournalSubscription(subscriptionID) -> SubscriptionResponse - client.webhooks.getLatestJournalBatch(count, { ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getLatestJournalEntry({ ...params }) -> Response - client.webhooks.getLatestLocalJournalBatch(count, { ...params }) -> BatchResponseJournalFetchResponse diff --git a/src/resources/webhooks/webhooks.ts b/src/resources/webhooks/webhooks.ts index 46c9b2b8..3f283a32 100644 --- a/src/resources/webhooks/webhooks.ts +++ b/src/resources/webhooks/webhooks.ts @@ -2,6 +2,7 @@ import { APIResource } from '../../core/resource'; import * as Shared from '../shared'; +import * as WebhooksJournalAPI from '../webhooks-journal/webhooks-journal'; import { APIPromise } from '../../core/api-promise'; import { buildHeaders } from '../../internal/headers'; import { RequestOptions } from '../../internal/request-options'; @@ -25,16 +26,15 @@ export class BaseWebhooks extends APIResource { } /** - * Create a batch of CRM object snapshots for the specified portal. This endpoint - * allows you to capture the state of CRM objects at a specific point in time, - * which can be useful for auditing or historical analysis. The request requires a - * list of CRM object snapshot requests, each specifying the portal ID, object ID, - * object type ID, and properties to include in the snapshot. + * Create a batch of CRM object snapshots in HubSpot. This endpoint is used to + * capture the current state of specified CRM objects for later reference or + * analysis. It requires a JSON payload containing the details of the CRM objects + * to snapshot. This operation is exempt from daily and ten-secondly rate limits. */ createCrmSnapshots( body: WebhookCreateCrmSnapshotsParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/webhooks-journal/snapshots/2026-03/crm', { body, ...options }); } @@ -50,29 +50,30 @@ export class BaseWebhooks extends APIResource { } /** - * Create a new webhook subscription for the specified portal in the HubSpot - * account. This endpoint allows you to define the subscription details, including - * the types of events you want to subscribe to. The request body must include the - * necessary subscription information as defined by the SubscriptionUpsertRequest - * schema. + * Create a new subscription in the Webhooks Journal for the specified version. + * This endpoint allows you to define the subscription details by providing the + * necessary information in the request body. It supports various types of + * subscriptions, including object, association, event, app lifecycle event, list + * membership, and GDPR privacy deletion. Ensure that all required fields are + * included in the request to successfully create a subscription. */ createJournalSubscription( body: WebhookCreateJournalSubscriptionParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/webhooks-journal/subscriptions/2026-03', { body, ...options }); } /** - * Create a new filter for a webhook subscription in your HubSpot account. This - * endpoint allows you to define specific conditions that a webhook event must meet - * to trigger the subscription. It is useful for managing and customizing the - * behavior of webhook subscriptions based on specific criteria. + * Create a new filter for a specific webhook subscription in the HubSpot account. + * This endpoint allows you to define conditions that determine when a webhook + * should be triggered. The filter is associated with a subscription identified by + * its ID, and the request must include the filter details. */ createSubscriptionFilter( body: WebhookCreateSubscriptionFilterParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/webhooks-journal/subscriptions/2026-03/filters', { body, ...options }); } @@ -94,7 +95,7 @@ export class BaseWebhooks extends APIResource { /** * Delete a specific webhook journal subscription using its unique identifier. This * operation is useful for managing and cleaning up subscriptions that are no - * longer needed or relevant. + * longer needed in your HubSpot account. */ deleteJournalSubscription(subscriptionID: number, options?: RequestOptions): APIPromise { return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, { @@ -105,8 +106,9 @@ export class BaseWebhooks extends APIResource { /** * Delete a webhook journal subscription for a specific portal. This operation - * removes the subscription associated with the given portalId, and no content is - * returned upon successful deletion. + * removes the subscription associated with the given portalId, ensuring that no + * further webhook events are sent for this portal. Use this endpoint to manage and + * clean up subscriptions that are no longer needed. */ deleteJournalSubscriptionForPortal(portalID: number, options?: RequestOptions): APIPromise { return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/portals/${portalID}`, { @@ -127,10 +129,9 @@ export class BaseWebhooks extends APIResource { } /** - * Delete a specific filter associated with a webhook journal subscription. This - * operation is useful for managing and cleaning up filters that are no longer - * needed in your subscription setup. The endpoint requires the unique identifier - * of the filter to be deleted. + * Remove a specific filter from the webhooks journal subscriptions. This operation + * is useful for managing and cleaning up filters that are no longer needed. Once + * deleted, the filter cannot be recovered. */ deleteSubscriptionFilter(filterID: number, options?: RequestOptions): APIPromise { return this._client.delete(path`/webhooks-journal/subscriptions/2026-03/filters/${filterID}`, { @@ -140,15 +141,16 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the earliest batch of webhook journal entries up to the specified - * count. This endpoint is useful for fetching historical webhook data in batches, - * allowing you to process or analyze the earliest entries first. + * Retrieve the earliest batch of webhook journal entries for a specified count. + * This endpoint is useful for accessing historical webhook data in batches, + * allowing you to process or analyze older entries. The number of entries + * retrieved is determined by the count parameter. */ getEarliestJournalBatch( count: number, query: WebhookGetEarliestJournalBatchParams | null | undefined = {}, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/journal/2026-03/batch/earliest/${count}`, { query, ...options, @@ -156,9 +158,9 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the earliest entry from the webhooks journal for the specified version. - * This endpoint is useful for accessing the oldest records available in the - * journal, which can be helpful for auditing or historical data analysis. + * Retrieve the earliest entry from the webhooks journal for the specified portal. + * This endpoint is useful for accessing the first recorded webhook event in the + * journal, which can be helpful for auditing or debugging purposes. */ getEarliestJournalEntry( query: WebhookGetEarliestJournalEntryParams | null | undefined = {}, @@ -173,15 +175,16 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the earliest batch of webhook journal entries based on the specified - * count. This endpoint is useful for fetching a specific number of the earliest - * entries in the webhook journal for analysis or processing. + * Retrieve the earliest batch of webhook journal entries. This endpoint is useful + * for accessing the oldest available data in the webhook journal, allowing users + * to process or analyze historical webhook events. The number of entries to fetch + * is specified by the 'count' path parameter. */ getEarliestLocalJournalBatch( count: number, query: WebhookGetEarliestLocalJournalBatchParams | null | undefined = {}, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/journal-local/2026-03/batch/earliest/${count}`, { query, ...options, @@ -189,9 +192,9 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the earliest entry from the webhooks journal for the specified portal. - * This endpoint is useful for accessing the oldest records in the journal, which - * can be helpful for auditing or tracking purposes. + * Retrieve the earliest webhook journal entries for the specified portal. This + * endpoint can be used to access the oldest records available in the webhook + * journal, which may be useful for auditing or historical analysis. */ getEarliestLocalJournalEntry( query: WebhookGetEarliestLocalJournalEntryParams | null | undefined = {}, @@ -218,15 +221,16 @@ export class BaseWebhooks extends APIResource { } /** - * Perform a batch read operation on the webhooks journal for the specified date. - * This endpoint allows you to retrieve multiple entries from the webhooks journal - * in a single request, which can be useful for processing large amounts of data - * efficiently. + * Execute a batch read operation on the webhooks journal for the specified date, + * 2026-03. This endpoint allows you to retrieve multiple entries from the webhooks + * journal in a single request, which can be useful for processing large amounts of + * data efficiently. Ensure that the request body is provided in the required + * format. */ getJournalBatchByRequest( params: WebhookGetJournalBatchByRequestParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { const { installPortalId, ...body } = params; return this._client.post('/webhooks-journal/journal/2026-03/batch/read', { query: { installPortalId }, @@ -237,14 +241,14 @@ export class BaseWebhooks extends APIResource { /** * Retrieve a batch of webhook journal entries starting from a specified offset. - * This endpoint allows you to fetch a specified number of entries, making it - * useful for paginating through large sets of webhook journal data. + * This endpoint allows you to fetch a defined number of entries, which can be + * useful for processing large datasets in manageable chunks. */ getJournalBatchFromOffset( count: number, params: WebhookGetJournalBatchFromOffsetParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { const { offset, ...query } = params; return this._client.get(path`/webhooks-journal/journal/2026-03/batch/${offset}/next/${count}`, { query, @@ -253,36 +257,38 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the status of a specific webhook journal entry using its status ID. - * This endpoint is useful for checking the current state of a webhook process, - * such as whether it is pending, in progress, completed, failed, or expired. + * Retrieve the status of a specific webhook journal entry using its unique status + * ID. This endpoint provides detailed information about the status, including + * whether it is pending, in progress, completed, failed, or expired. It is useful + * for monitoring and managing the state of webhook journal entries. */ - getJournalStatus(statusID: string, options?: RequestOptions): APIPromise { + getJournalStatus(statusID: string, options?: RequestOptions): APIPromise { return this._client.get(path`/webhooks-journal/journal/2026-03/status/${statusID}`, options); } /** * Retrieve details of a specific webhook subscription using its unique identifier. * This endpoint is useful for obtaining information about a particular - * subscription's configuration and status within the HubSpot account. + * subscription, such as its actions, object type, and associated properties. */ getJournalSubscription( subscriptionID: number, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, options); } /** - * Retrieve the latest batch of webhook journal entries. This endpoint allows you - * to specify the number of entries to fetch, providing a way to access recent - * webhook activity within your HubSpot account. + * Retrieve the latest batch of webhook journal entries up to the specified count. + * This endpoint is useful for fetching recent webhook data for analysis or + * processing. The count parameter determines the maximum number of entries to + * return. */ getLatestJournalBatch( count: number, query: WebhookGetLatestJournalBatchParams | null | undefined = {}, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/journal/2026-03/batch/latest/${count}`, { query, ...options, @@ -291,9 +297,8 @@ export class BaseWebhooks extends APIResource { /** * Retrieve the latest entries from the webhooks journal for the specified portal. - * This endpoint is useful for accessing the most recent webhook events processed - * by your HubSpot account. It allows you to filter the results by the portal ID to - * ensure you are retrieving data relevant to a specific installation. + * This endpoint is useful for accessing the most recent webhook events and their + * statuses, allowing you to monitor and debug webhook activity effectively. */ getLatestJournalEntry( query: WebhookGetLatestJournalEntryParams | null | undefined = {}, @@ -308,15 +313,15 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve the latest batch of webhook journal entries. This endpoint is useful - * for accessing the most recent data entries processed by the webhook journal. It - * requires specifying the number of entries to retrieve. + * Retrieve the latest batch of webhook journal entries. This endpoint allows you + * to specify the number of entries to fetch, providing a way to access the most + * recent webhook events processed by your HubSpot account. */ getLatestLocalJournalBatch( count: number, query: WebhookGetLatestLocalJournalBatchParams | null | undefined = {}, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/journal-local/2026-03/batch/latest/${count}`, { query, ...options, @@ -326,7 +331,8 @@ export class BaseWebhooks extends APIResource { /** * Retrieve the latest entries from the webhooks journal for the specified portal. * This endpoint is useful for accessing the most recent webhook events that have - * been logged, allowing you to process or analyze them as needed. + * been logged, allowing for real-time monitoring or debugging of webhook + * activities. */ getLatestLocalJournalEntry( query: WebhookGetLatestLocalJournalEntryParams | null | undefined = {}, @@ -341,16 +347,15 @@ export class BaseWebhooks extends APIResource { } /** - * Perform a batch read operation on the webhooks journal. This endpoint allows you - * to read multiple entries from the journal in a single request. It requires a - * JSON request body specifying the inputs to be read. The response includes the - * results of the batch read operation, and may return multiple statuses if there - * are errors. + * Execute a batch read operation on the webhooks journal. This endpoint allows you + * to retrieve a batch of webhook journal entries by providing the necessary input + * data. It is useful for processing multiple records in a single request, + * streamlining data retrieval tasks. */ getLocalJournalBatchByRequest( params: WebhookGetLocalJournalBatchByRequestParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { const { installPortalId, ...body } = params; return this._client.post('/webhooks-journal/journal-local/2026-03/batch/read', { query: { installPortalId }, @@ -361,14 +366,14 @@ export class BaseWebhooks extends APIResource { /** * Retrieve a batch of webhook journal entries starting from a specified offset. - * This endpoint allows you to fetch a defined number of entries, facilitating the - * processing of webhook data in manageable chunks. + * This endpoint is useful for paginating through large sets of webhook data. The + * number of entries returned is determined by the 'count' parameter. */ getLocalJournalBatchFromOffset( count: number, params: WebhookGetLocalJournalBatchFromOffsetParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { const { offset, ...query } = params; return this._client.get(path`/webhooks-journal/journal-local/2026-03/batch/${offset}/next/${count}`, { query, @@ -378,17 +383,21 @@ export class BaseWebhooks extends APIResource { /** * Retrieve the status of a specific webhook journal entry using its unique status - * ID. This endpoint is useful for monitoring the progress or completion of webhook - * processing tasks. + * ID. This endpoint is useful for monitoring the progress or outcome of webhook + * journal entries, allowing you to check if an entry is pending, in progress, + * completed, failed, or expired. */ - getLocalJournalStatus(statusID: string, options?: RequestOptions): APIPromise { + getLocalJournalStatus( + statusID: string, + options?: RequestOptions, + ): APIPromise { return this._client.get(path`/webhooks-journal/journal-local/2026-03/status/${statusID}`, options); } /** - * Retrieve the next batch of webhook journal entries starting from a specified - * offset. This endpoint is useful for paginating through large sets of webhook - * data, allowing you to continue fetching entries from where you last left off. + * Retrieve the next set of entries from the webhooks journal starting from a + * specified offset. This endpoint is useful for paginating through journal entries + * to process or analyze webhook events sequentially. */ getNextJournalEntries( offset: string, @@ -405,8 +414,8 @@ export class BaseWebhooks extends APIResource { /** * Retrieve the next set of webhook journal entries starting from a specified - * offset. This endpoint is useful for paginating through webhook journal data in a - * sequential manner, allowing you to fetch entries beyond a given point. + * offset. This endpoint is useful for paginating through large sets of webhook + * data, allowing you to continue from where a previous request left off. */ getNextLocalJournalEntries( offset: string, @@ -430,11 +439,12 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve details of a specific filter associated with a webhook subscription in - * the HubSpot account. This endpoint is useful for accessing the configuration and - * conditions of a filter by its unique identifier. + * Retrieve a specific filter associated with a webhook journal subscription. This + * endpoint allows you to access the details of the filter identified by the + * filterId, which is useful for managing and understanding the conditions applied + * to webhook events. */ - getSubscriptionFilter(filterID: number, options?: RequestOptions): APIPromise { + getSubscriptionFilter(filterID: number, options?: RequestOptions): APIPromise { return this._client.get(path`/webhooks-journal/subscriptions/2026-03/filters/${filterID}`, options); } @@ -446,22 +456,21 @@ export class BaseWebhooks extends APIResource { } /** - * Retrieve a list of webhook journal subscriptions for the specified API version. - * This endpoint provides details about each subscription, including actions, - * object types, and associated properties. It is useful for managing and reviewing - * current webhook subscriptions. + * Retrieve a list of webhook journal subscriptions for the specified version. This + * endpoint allows you to view all active subscriptions without pagination. It is + * useful for monitoring and managing webhook subscriptions in your HubSpot + * account. */ listJournalSubscriptions( options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get('/webhooks-journal/subscriptions/2026-03', options); } /** - * Retrieve the filters associated with a specific webhook subscription in the - * HubSpot account. This endpoint is useful for obtaining detailed information - * about the filters applied to a given subscription, identified by its - * subscription ID. + * Retrieve the filters associated with a specific webhook subscription. This + * endpoint allows you to view the filters applied to a subscription, which can + * help in managing and understanding the conditions set for webhook events. */ listSubscriptionFilters( subscriptionID: number, @@ -501,80 +510,6 @@ export class BaseWebhooks extends APIResource { } export class Webhooks extends BaseWebhooks {} -export interface ActionOverrideRequest { - /** - * An array of strings, each representing an associated object type ID relevant to - * the action override. - */ - associatedObjectTypeIds?: Array; - - /** - * An array of integers representing list IDs that are associated with the action - * override. The integers are in int64 format. - */ - listIds?: Array; - - /** - * An array of integers, each representing an object ID for which the action - * override is applicable. The integers are in int64 format. - */ - objectIds?: Array; - - /** - * An array of strings representing the properties to be overridden in the action. - * Each string corresponds to a property name. - */ - properties?: Array; -} - -export interface AppLifecycleEventSubscriptionUpsertRequest { - eventTypeId: string; - - properties: Array; - - subscriptionType: - | 'OBJECT' - | 'ASSOCIATION' - | 'EVENT' - | 'APP_LIFECYCLE_EVENT' - | 'LIST_MEMBERSHIP' - | 'GDPR_PRIVACY_DELETION'; -} - -export interface AssociationSubscriptionUpsertRequest { - actions: Array< - | 'CREATE' - | 'UPDATE' - | 'DELETE' - | 'MERGE' - | 'RESTORE' - | 'ASSOCIATION_ADDED' - | 'ASSOCIATION_REMOVED' - | 'SNAPSHOT' - | 'APP_INSTALL' - | 'APP_UNINSTALL' - | 'ADDED_TO_LIST' - | 'REMOVED_FROM_LIST' - | 'GDPR_DELETE' - >; - - associatedObjectTypeIds: Array; - - objectIds: Array; - - objectTypeId: string; - - portalId: number; - - subscriptionType: - | 'OBJECT' - | 'ASSOCIATION' - | 'EVENT' - | 'APP_LIFECYCLE_EVENT' - | 'LIST_MEMBERSHIP' - | 'GDPR_PRIVACY_DELETION'; -} - export interface BatchInputSubscriptionBatchUpdateRequest { /** * An array of SubscriptionBatchUpdateRequest objects, each representing a @@ -583,86 +518,6 @@ export interface BatchInputSubscriptionBatchUpdateRequest { inputs: Array; } -export interface BatchResponseJournalFetchResponse { - /** - * The date and time when the batch operation was completed, in ISO 8601 format. - */ - completedAt: string; - - /** - * An array of results from the batch operation, each represented as a - * JournalFetchResponse object. - */ - results: Array; - - /** - * The date and time when the batch operation started, in ISO 8601 format. - */ - startedAt: string; - - /** - * The current status of the batch operation. Valid values include 'PENDING', - * 'PROCESSING', 'CANCELED', and 'COMPLETE'. - */ - status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; - - /** - * A map of link names to associated URIs related to the batch operation. - */ - links?: { [key: string]: string }; - - /** - * The date and time when the batch operation was requested, in ISO 8601 format. - */ - requestedAt?: string; -} - -export interface BatchResponseJournalFetchResponseWithErrors { - /** - * The date and time when the batch process was completed, in ISO 8601 format. - */ - completedAt: string; - - /** - * An array of journal fetch responses, each representing a result from the batch - * process. - */ - results: Array; - - /** - * The date and time when the batch process started, in ISO 8601 format. - */ - startedAt: string; - - /** - * The current status of the batch process. Valid values include 'PENDING', - * 'PROCESSING', 'CANCELED', and 'COMPLETE'. - */ - status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING'; - - /** - * An array of standard errors that occurred during the batch process, providing - * details about each error. - */ - errors?: Array; - - /** - * A map of link names to associated URIs, providing additional context or actions - * related to the batch process. - */ - links?: { [key: string]: string }; - - /** - * The number of errors that occurred during the batch process. - */ - numErrors?: number; - - /** - * The date and time when the batch request was made, in ISO 8601 format. - */ - requestedAt?: string; -} - export interface BatchResponseSubscriptionResponse { /** * The date and time when the batch operation was completed, in ISO 8601 format. @@ -752,289 +607,6 @@ export interface CollectionResponseSubscriptionResponseNoPaging { results: Array; } -export interface Condition { - /** - * A string indicating the type of filter being applied. Valid value is - * 'CRM_OBJECT_PROPERTY'. - */ - filterType: 'CRM_OBJECT_PROPERTY'; - - /** - * A string specifying the operation to be performed in the condition. Valid values - * include 'EQ', 'N_EQ', 'LT', 'GT', 'LTE', 'GTE', 'CONTAINS', 'STARTS_WITH', - * 'ENDS_WITH', 'IN', 'NOT_IN', 'IS_EMPTY', and 'IS_NOT_EMPTY'. - */ - operator: - | 'CONTAINS' - | 'ENDS_WITH' - | 'EQ' - | 'GT' - | 'GTE' - | 'IN' - | 'IS_EMPTY' - | 'IS_NOT_EMPTY' - | 'LT' - | 'LTE' - | 'N_EQ' - | 'NOT_IN' - | 'STARTS_WITH'; - - /** - * A string representing the specific property of the CRM object that the condition - * applies to. - */ - property: string; - - /** - * A string representing the value to be compared against the specified property - * when using single-value operators. - */ - value?: string; - - /** - * An array of strings used to specify multiple values for comparison when using - * operators that support multiple values, such as 'IN' or 'NOT_IN'. - */ - values?: Array; -} - -export interface CrmObjectSnapshotBatchRequest { - /** - * An array of CrmObjectSnapshotRequest objects, each representing a request to - * create a snapshot for a specific CRM object. This property is required. - */ - snapshotRequests: Array; -} - -export interface CrmObjectSnapshotBatchResponse { - /** - * An array of CrmObjectSnapshotResponse objects, each representing the result of a - * snapshot operation for a specific CRM object. This property is required. - */ - snapshotResponses: Array; -} - -export interface CrmObjectSnapshotRequest { - /** - * An integer representing the unique identifier of the CRM object for which the - * snapshot is requested. - */ - objectId: number; - - /** - * A string representing the type identifier of the CRM object, specifying what - * kind of object it is within HubSpot. - */ - objectTypeId: string; - - /** - * An integer representing the unique identifier of the HubSpot account (portal) - * where the CRM object resides. - */ - portalId: number; - - /** - * An array of strings, each representing a property of the CRM object that should - * be included in the snapshot. - */ - properties: Array; -} - -export interface CrmObjectSnapshotResponse { - /** - * An integer representing the unique identifier of the CRM object for which the - * snapshot is taken. - */ - objectId: number; - - /** - * A string indicating the type of the CRM object, such as contact, company, or - * deal. - */ - objectTypeId: string; - - /** - * An integer representing the unique identifier of the HubSpot portal associated - * with the CRM object. - */ - portalId: number; - - /** - * A UUID string representing the status identifier of the snapshot request, - * indicating the current state of the snapshot process. - */ - snapshotStatusId: string; -} - -/** - * Defines a single condition for searching CRM objects, specifying the property to - * filter on, the operator to use (such as equals, greater than, or contains), and - * the value(s) to compare against. - */ -export interface Filter { - /** - * An array of conditions that define the criteria for the filter. Each condition - * specifies a property, an operator, and optionally a value or values. - */ - conditions: Array; -} - -export interface FilterCreateRequest { - /** - * Defines a single condition for searching CRM objects, specifying the property to - * filter on, the operator to use (such as equals, greater than, or contains), and - * the value(s) to compare against. - */ - filter: Filter; - - /** - * The unique identifier of the subscription to which the filter will be applied. - * It is an integer formatted as int64. - */ - subscriptionId: number; -} - -export interface FilterCreateResponse { - /** - * The unique identifier for the created filter. It is an integer formatted as - * int64. - */ - filterId: number; -} - -export interface FilterResponse { - /** - * The unique identifier for the filter. It is an integer in int64 format. - */ - id: number; - - /** - * A Unix timestamp in milliseconds indicating when the filter was created. - */ - createdAt: number; - - /** - * Defines a single condition for searching CRM objects, specifying the property to - * filter on, the operator to use (such as equals, greater than, or contains), and - * the value(s) to compare against. - */ - filter: Filter; -} - -export interface GdprPrivacyDeletionSubscriptionUpsertRequest { - actions: Array< - | 'CREATE' - | 'UPDATE' - | 'DELETE' - | 'MERGE' - | 'RESTORE' - | 'ASSOCIATION_ADDED' - | 'ASSOCIATION_REMOVED' - | 'SNAPSHOT' - | 'APP_INSTALL' - | 'APP_UNINSTALL' - | 'ADDED_TO_LIST' - | 'REMOVED_FROM_LIST' - | 'GDPR_DELETE' - >; - - objectTypeId: string; - - portalId: number; - - subscriptionType: - | 'OBJECT' - | 'ASSOCIATION' - | 'EVENT' - | 'APP_LIFECYCLE_EVENT' - | 'LIST_MEMBERSHIP' - | 'GDPR_PRIVACY_DELETION'; -} - -export interface JournalFetchResponse { - /** - * The unique identifier for the current offset of the journal entry, formatted as - * a UUID. - */ - currentOffset: string; - - /** - * The date and time when the URL will expire, in ISO 8601 format. - */ - expiresAt: string; - - /** - * The URL where the journal entry can be accessed. It is a string. - */ - url: string; -} - -export interface ListMembershipSubscriptionUpsertRequest { - actions: Array< - | 'CREATE' - | 'UPDATE' - | 'DELETE' - | 'MERGE' - | 'RESTORE' - | 'ASSOCIATION_ADDED' - | 'ASSOCIATION_REMOVED' - | 'SNAPSHOT' - | 'APP_INSTALL' - | 'APP_UNINSTALL' - | 'ADDED_TO_LIST' - | 'REMOVED_FROM_LIST' - | 'GDPR_DELETE' - >; - - listIds: Array; - - objectIds: Array; - - portalId: number; - - subscriptionType: - | 'OBJECT' - | 'ASSOCIATION' - | 'EVENT' - | 'APP_LIFECYCLE_EVENT' - | 'LIST_MEMBERSHIP' - | 'GDPR_PRIVACY_DELETION'; -} - -export interface ObjectSubscriptionUpsertRequest { - actions: Array< - | 'CREATE' - | 'UPDATE' - | 'DELETE' - | 'MERGE' - | 'RESTORE' - | 'ASSOCIATION_ADDED' - | 'ASSOCIATION_REMOVED' - | 'SNAPSHOT' - | 'APP_INSTALL' - | 'APP_UNINSTALL' - | 'ADDED_TO_LIST' - | 'REMOVED_FROM_LIST' - | 'GDPR_DELETE' - >; - - objectIds: Array; - - objectTypeId: string; - - portalId: number; - - properties: Array; - - subscriptionType: - | 'OBJECT' - | 'ASSOCIATION' - | 'EVENT' - | 'APP_LIFECYCLE_EVENT' - | 'LIST_MEMBERSHIP' - | 'GDPR_PRIVACY_DELETION'; -} - export interface SettingsChangeRequest { /** * The URL to which webhook events will be sent. It is a string. @@ -1064,43 +636,6 @@ export interface SettingsResponse { updatedAt?: string; } -export interface SnapshotStatusResponse { - /** - * The unique identifier for the snapshot operation, represented as a UUID. - */ - id: string; - - /** - * The timestamp indicating when the snapshot operation was initiated, represented - * as a Unix timestamp in milliseconds. - */ - initiatedAt: number; - - /** - * The current status of the snapshot. Valid values include 'PENDING', - * 'IN_PROGRESS', 'COMPLETED', 'FAILED', and 'EXPIRED'. - */ - status: 'COMPLETED' | 'EXPIRED' | 'FAILED' | 'IN_PROGRESS' | 'PENDING'; - - /** - * The timestamp indicating when the snapshot operation was completed, represented - * as a Unix timestamp in milliseconds. - */ - completedAt?: number; - - /** - * A code representing the error that occurred, if any. Possible values are - * 'TIMEOUT', 'VALIDATION_ERROR', 'INTERNAL_ERROR', and 'PERMISSION_DENIED'. - */ - errorCode?: 'INTERNAL_ERROR' | 'PERMISSION_DENIED' | 'TIMEOUT' | 'VALIDATION_ERROR'; - - /** - * A descriptive message providing additional information about the snapshot - * operation or error. - */ - message?: string; -} - export interface SubscriptionBatchUpdateRequest { /** * The unique identifier for the subscription. It is an integer. @@ -1368,7 +903,7 @@ export interface SubscriptionResponse1 { * An object containing action overrides, where each key is an action and the value * is an ActionOverrideRequest object. */ - actionOverrides?: { [key: string]: ActionOverrideRequest }; + actionOverrides?: { [key: string]: Shared.ActionOverrideRequest }; /** * A list of associated object type IDs. Each ID is a string. @@ -1412,13 +947,6 @@ export interface SubscriptionResponse1 { properties?: Array; } -export type SubscriptionUpsertRequest = - | ObjectSubscriptionUpsertRequest - | AssociationSubscriptionUpsertRequest - | AppLifecycleEventSubscriptionUpsertRequest - | ListMembershipSubscriptionUpsertRequest - | GdprPrivacyDeletionSubscriptionUpsertRequest; - export interface ThrottlingSettings { /** * The maximum number of concurrent requests allowed. This is an integer value. @@ -1426,7 +954,7 @@ export interface ThrottlingSettings { maxConcurrentRequests: number; } -export type WebhookListSubscriptionFiltersResponse = Array; +export type WebhookListSubscriptionFiltersResponse = Array; export interface WebhookCreateBatchEventSubscriptionsParams { /** @@ -1441,7 +969,7 @@ export interface WebhookCreateCrmSnapshotsParams { * An array of CrmObjectSnapshotRequest objects, each representing a request to * create a snapshot for a specific CRM object. This property is required. */ - snapshotRequests: Array; + snapshotRequests: Array; } export interface WebhookCreateEventSubscriptionParams { @@ -1531,15 +1059,119 @@ export type WebhookCreateJournalSubscriptionParams = | WebhookCreateJournalSubscriptionParams.GdprPrivacyDeletionSubscriptionUpsertRequest; export declare namespace WebhookCreateJournalSubscriptionParams { - export interface ObjectSubscriptionUpsertRequest {} + export interface ObjectSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectIds: Array; + + objectTypeId: string; + + portalId: number; + + properties: Array; + + subscriptionType: 'OBJECT'; + } - export interface AssociationSubscriptionUpsertRequest {} + export interface AssociationSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; - export interface AppLifecycleEventSubscriptionUpsertRequest {} + associatedObjectTypeIds: Array; - export interface ListMembershipSubscriptionUpsertRequest {} + objectIds: Array; - export interface GdprPrivacyDeletionSubscriptionUpsertRequest {} + objectTypeId: string; + + portalId: number; + + subscriptionType: 'ASSOCIATION'; + } + + export interface AppLifecycleEventSubscriptionUpsertRequest { + eventTypeId: string; + + properties: Array; + + subscriptionType: 'APP_LIFECYCLE_EVENT'; + } + + export interface ListMembershipSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + listIds: Array; + + objectIds: Array; + + portalId: number; + + subscriptionType: 'LIST_MEMBERSHIP'; + } + + export interface GdprPrivacyDeletionSubscriptionUpsertRequest { + actions: Array< + | 'CREATE' + | 'UPDATE' + | 'DELETE' + | 'MERGE' + | 'RESTORE' + | 'ASSOCIATION_ADDED' + | 'ASSOCIATION_REMOVED' + | 'SNAPSHOT' + | 'APP_INSTALL' + | 'APP_UNINSTALL' + | 'ADDED_TO_LIST' + | 'REMOVED_FROM_LIST' + | 'GDPR_DELETE' + >; + + objectTypeId: string; + + portalId: number; + + subscriptionType: 'GDPR_PRIVACY_DELETION'; + } } export interface WebhookCreateSubscriptionFilterParams { @@ -1548,7 +1180,7 @@ export interface WebhookCreateSubscriptionFilterParams { * filter on, the operator to use (such as equals, greater than, or contains), and * the value(s) to compare against. */ - filter: Filter; + filter: Shared.Filter; /** * The unique identifier of the subscription to which the filter will be applied. @@ -1566,31 +1198,32 @@ export interface WebhookDeleteEventSubscriptionParams { export interface WebhookGetEarliestJournalBatchParams { /** - * The ID of the portal installation to filter the webhook journal entries by. This - * is an integer value. + * The ID of the portal installation. This is an integer value that specifies which + * portal's data to access. */ installPortalId?: number; } export interface WebhookGetEarliestJournalEntryParams { /** - * The ID of the portal installation to filter the journal entries. It is an - * integer. + * The ID of the portal installation to filter the journal entries by. This is an + * integer value. */ installPortalId?: number; } export interface WebhookGetEarliestLocalJournalBatchParams { /** - * The ID of the portal where the webhooks are installed. This is an integer value. + * The ID of the portal installation to filter the webhook journal entries. This is + * an optional integer parameter. */ installPortalId?: number; } export interface WebhookGetEarliestLocalJournalEntryParams { /** - * The ID of the portal installation to filter the journal entries by. This - * parameter is optional and should be an integer. + * The ID of the portal for which to retrieve the earliest webhook journal entries. + * This parameter is optional and should be an integer. */ installPortalId?: number; } @@ -1609,54 +1242,53 @@ export interface WebhookGetJournalBatchByRequestParams { inputs: Array; /** - * Query param: The ID of the portal where the webhooks are installed. This is an - * integer value. + * Query param: An integer representing the ID of the portal installation for which + * the webhooks journal data should be retrieved. */ installPortalId?: number; } export interface WebhookGetJournalBatchFromOffsetParams { /** - * Path param: The starting point for fetching the next batch of journal entries. - * This is a string value that indicates the offset position. + * Path param: The starting point for fetching the journal entries. This is a + * string value. */ offset: string; /** - * Query param: The ID of the portal installation. This is an integer value used to - * specify the portal context for the request. + * Query param: The ID of the portal installation. This is an integer value. */ installPortalId?: number; } export interface WebhookGetLatestJournalBatchParams { /** - * The ID of the portal installation. This is an integer value used to identify the - * specific portal. + * The ID of the portal installation. This is an integer value used to specify the + * portal context for the request. */ installPortalId?: number; } export interface WebhookGetLatestJournalEntryParams { /** - * The ID of the portal installation to filter the journal entries. It is an - * integer value. + * The unique identifier of the portal installation for which to retrieve the + * latest journal entries. This parameter is optional and should be an integer. */ installPortalId?: number; } export interface WebhookGetLatestLocalJournalBatchParams { /** - * The ID of the portal installation. This parameter is optional and used to filter - * the journal entries by a specific portal. + * The ID of the portal where the webhook journal is installed. This parameter is + * optional and used to specify the target portal. */ installPortalId?: number; } export interface WebhookGetLatestLocalJournalEntryParams { /** - * The ID of the portal for which to retrieve the latest journal entries. This - * parameter is optional and should be an integer. + * The ID of the portal for which to retrieve the latest journal entries. This is + * an integer value. */ installPortalId?: number; } @@ -1669,36 +1301,36 @@ export interface WebhookGetLocalJournalBatchByRequestParams { /** * Query param: The ID of the portal where the webhooks are installed. This - * parameter is optional and is used to specify the target portal. + * parameter is optional and is used to specify the target portal for the + * operation. */ installPortalId?: number; } export interface WebhookGetLocalJournalBatchFromOffsetParams { /** - * Path param: The starting point for fetching the batch of journal entries. This - * is a string value that indicates the offset position. + * Path param: The starting point for the batch retrieval, specified as a string. */ offset: string; /** - * Query param: The ID of the portal installation. This is an integer value used to - * specify the portal context for the request. + * Query param: The ID of the portal where the webhooks are installed. This is an + * optional parameter. */ installPortalId?: number; } export interface WebhookGetNextJournalEntriesParams { /** - * The ID of the portal installation to filter the webhook journal entries. This is - * an optional parameter. + * The ID of the portal where the webhooks are installed. This is an integer value. */ installPortalId?: number; } export interface WebhookGetNextLocalJournalEntriesParams { /** - * The ID of the portal where the webhook is installed. This is an integer value. + * The ID of the portal installation to filter the webhook journal entries. This is + * an integer value. */ installPortalId?: number; } @@ -1727,38 +1359,18 @@ export interface WebhookUpdateSettingsParams { export declare namespace Webhooks { export { - type ActionOverrideRequest as ActionOverrideRequest, - type AppLifecycleEventSubscriptionUpsertRequest as AppLifecycleEventSubscriptionUpsertRequest, - type AssociationSubscriptionUpsertRequest as AssociationSubscriptionUpsertRequest, type BatchInputSubscriptionBatchUpdateRequest as BatchInputSubscriptionBatchUpdateRequest, - type BatchResponseJournalFetchResponse as BatchResponseJournalFetchResponse, - type BatchResponseJournalFetchResponseWithErrors as BatchResponseJournalFetchResponseWithErrors, type BatchResponseSubscriptionResponse as BatchResponseSubscriptionResponse, type BatchResponseSubscriptionResponseWithErrors as BatchResponseSubscriptionResponseWithErrors, type CollectionResponseSubscriptionResponseNoPaging as CollectionResponseSubscriptionResponseNoPaging, - type Condition as Condition, - type CrmObjectSnapshotBatchRequest as CrmObjectSnapshotBatchRequest, - type CrmObjectSnapshotBatchResponse as CrmObjectSnapshotBatchResponse, - type CrmObjectSnapshotRequest as CrmObjectSnapshotRequest, - type CrmObjectSnapshotResponse as CrmObjectSnapshotResponse, - type Filter as Filter, - type FilterCreateRequest as FilterCreateRequest, - type FilterCreateResponse as FilterCreateResponse, - type FilterResponse as FilterResponse, - type GdprPrivacyDeletionSubscriptionUpsertRequest as GdprPrivacyDeletionSubscriptionUpsertRequest, - type JournalFetchResponse as JournalFetchResponse, - type ListMembershipSubscriptionUpsertRequest as ListMembershipSubscriptionUpsertRequest, - type ObjectSubscriptionUpsertRequest as ObjectSubscriptionUpsertRequest, type SettingsChangeRequest as SettingsChangeRequest, type SettingsResponse as SettingsResponse, - type SnapshotStatusResponse as SnapshotStatusResponse, type SubscriptionBatchUpdateRequest as SubscriptionBatchUpdateRequest, type SubscriptionCreateRequest as SubscriptionCreateRequest, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionPatchRequest as SubscriptionPatchRequest, type SubscriptionResponse as SubscriptionResponse, type SubscriptionResponse1 as SubscriptionResponse1, - type SubscriptionUpsertRequest as SubscriptionUpsertRequest, type ThrottlingSettings as ThrottlingSettings, type WebhookListSubscriptionFiltersResponse as WebhookListSubscriptionFiltersResponse, type WebhookCreateBatchEventSubscriptionsParams as WebhookCreateBatchEventSubscriptionsParams, diff --git a/tests/api-resources/auth/oauth.test.ts b/tests/api-resources/auth/oauth.test.ts index 60de07e3..8dce46e2 100644 --- a/tests/api-resources/auth/oauth.test.ts +++ b/tests/api-resources/auth/oauth.test.ts @@ -24,6 +24,18 @@ const parentPartialClient = createClient({ }); const runTests = (client: PartialHubSpot<{ auth: { oauth: BaseOAuth } }>) => { + // Mock server tests are disabled + test.skip('createToken', async () => { + const responsePromise = client.auth.oauth.createToken(); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + // Mock server tests are disabled test.skip('createToken: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error diff --git a/tests/api-resources/automation/actions/definitions.test.ts b/tests/api-resources/automation/actions/definitions.test.ts index 166927b3..d220712e 100644 --- a/tests/api-resources/automation/actions/definitions.test.ts +++ b/tests/api-resources/automation/actions/definitions.test.ts @@ -134,7 +134,7 @@ const runTests = (client: PartialHubSpot<{ automation: { actions: { definitions: }, ], schema: { - type: 'ARRAY', + type: 'INTEGER', maximum: 0, minimum: 0, }, @@ -239,7 +239,7 @@ const runTests = (client: PartialHubSpot<{ automation: { actions: { definitions: }, ], schema: { - type: 'ARRAY', + type: 'INTEGER', maximum: 0, minimum: 0, }, diff --git a/tests/api-resources/cms/url-redirects.test.ts b/tests/api-resources/cms/url-redirects.test.ts index f15687ed..456211ec 100644 --- a/tests/api-resources/cms/url-redirects.test.ts +++ b/tests/api-resources/cms/url-redirects.test.ts @@ -147,6 +147,37 @@ const runTests = (client: PartialHubSpot<{ cms: { urlRedirects: BaseURLRedirects expect(dataAndResponse.response).toBe(rawResponse); }); + // Mock server tests are disabled + test.skip('createURLMapping: required and optional params', async () => { + const response = await client.cms.urlRedirects.createURLMapping({ + id: 'id', + created: '2019-12-27T18:11:19.117Z', + destination: 'destination', + isMatchFullUrl: true, + isMatchQueryString: true, + isOnlyAfterNotFound: true, + isPattern: true, + isProtocolAgnostic: true, + isTrailingSlashOptional: true, + precedence: 0, + redirectStyle: 0, + routePrefix: 'routePrefix', + updated: '2019-12-27T18:11:19.117Z', + }); + }); + + // Mock server tests are disabled + test.skip('deleteURLMapping', async () => { + const responsePromise = client.cms.urlRedirects.deleteURLMapping(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + // Mock server tests are disabled test.skip('get', async () => { const responsePromise = client.cms.urlRedirects.get('urlRedirectId'); diff --git a/tests/api-resources/conversations/visitor-identification.test.ts b/tests/api-resources/conversations/visitor-identification.test.ts index 5f820603..924c75cd 100644 --- a/tests/api-resources/conversations/visitor-identification.test.ts +++ b/tests/api-resources/conversations/visitor-identification.test.ts @@ -28,7 +28,10 @@ const runTests = ( ) => { // Mock server tests are disabled test.skip('generateToken: only required params', async () => { - const responsePromise = client.conversations.visitorIdentification.generateToken({ email: 'email' }); + const responsePromise = client.conversations.visitorIdentification.generateToken({ + email: 'email', + hsCustomerAgentContext: { foo: 'string' }, + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -42,6 +45,7 @@ const runTests = ( test.skip('generateToken: required and optional params', async () => { const response = await client.conversations.visitorIdentification.generateToken({ email: 'email', + hsCustomerAgentContext: { foo: 'string' }, firstName: 'firstName', lastName: 'lastName', }); diff --git a/tests/api-resources/crm/exports.test.ts b/tests/api-resources/crm/exports.test.ts index 3af17aa7..13dfd5e2 100644 --- a/tests/api-resources/crm/exports.test.ts +++ b/tests/api-resources/crm/exports.test.ts @@ -25,8 +25,20 @@ const parentPartialClient = createClient({ const runTests = (client: PartialHubSpot<{ crm: { exports: BaseExports } }>) => { // Mock server tests are disabled - test.skip('createAsync', async () => { - const responsePromise = client.crm.exports.createAsync({}); + test.skip('createAsync: only required params', async () => { + const responsePromise = client.crm.exports.createAsync({ + associatedObjectType: ['string'], + exportInternalValuesOptions: ['NAMES'], + exportName: 'exportName', + exportType: 'VIEW', + format: 'CSV', + includeLabeledAssociations: true, + includePrimaryDisplayPropertyForAssociatedObjects: true, + language: 'AF_ZA', + objectProperties: ['string'], + objectType: 'objectType', + overrideAssociatedObjectsPerDefinitionPerRowLimit: true, + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -36,6 +48,49 @@ const runTests = (client: PartialHubSpot<{ crm: { exports: BaseExports } }>) => expect(dataAndResponse.response).toBe(rawResponse); }); + // Mock server tests are disabled + test.skip('createAsync: required and optional params', async () => { + const response = await client.crm.exports.createAsync({ + associatedObjectType: ['string'], + exportInternalValuesOptions: ['NAMES'], + exportName: 'exportName', + exportType: 'VIEW', + format: 'CSV', + includeLabeledAssociations: true, + includePrimaryDisplayPropertyForAssociatedObjects: true, + language: 'AF_ZA', + objectProperties: ['string'], + objectType: 'objectType', + overrideAssociatedObjectsPerDefinitionPerRowLimit: true, + publicCrmSearchRequest: { + filterGroups: [ + { + filters: [ + { + operator: 'BETWEEN', + propertyName: 'propertyName', + highValue: 'highValue', + value: 'value', + values: ['string'], + }, + ], + }, + ], + filters: [ + { + operator: 'BETWEEN', + propertyName: 'propertyName', + highValue: 'highValue', + value: 'value', + values: ['string'], + }, + ], + sorts: ['string'], + query: 'query', + }, + }); + }); + // Mock server tests are disabled test.skip('get', async () => { const responsePromise = client.crm.exports.get(0); diff --git a/tests/api-resources/crm/lists.test.ts b/tests/api-resources/crm/lists.test.ts index 2ecd84d4..4d778411 100644 --- a/tests/api-resources/crm/lists.test.ts +++ b/tests/api-resources/crm/lists.test.ts @@ -61,31 +61,13 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { eventTypeId: 'eventTypeId', filterBranches: [ { + associationCategory: 'associationCategory', + associationTypeId: 0, filterBranches: [ { - associationCategory: 'associationCategory', - associationTypeId: 0, - filterBranches: [ - { - filterBranches: [], - filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'OR', - filters: [ - { - filterType: 'PROPERTY', - operation: { - includeObjectsWithNoValueSet: true, - operationType: 'BOOL', - operator: 'operator', - value: true, - }, - property: 'property', - }, - ], - }, - ], + filterBranches: [], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'ASSOCIATION', + filterBranchType: 'OR', filters: [ { filterType: 'PROPERTY', @@ -98,12 +80,10 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { property: 'property', }, ], - objectTypeId: 'objectTypeId', - operator: 'operator', }, ], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'PROPERTY_ASSOCIATION', + filterBranchType: 'ASSOCIATION', filters: [ { filterType: 'PROPERTY', @@ -118,7 +98,6 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { ], objectTypeId: 'objectTypeId', operator: 'operator', - propertyWithObjectId: 'propertyWithObjectId', }, ], filterBranchOperator: 'filterBranchOperator', @@ -745,31 +724,13 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { eventTypeId: 'eventTypeId', filterBranches: [ { + associationCategory: 'associationCategory', + associationTypeId: 0, filterBranches: [ { - associationCategory: 'associationCategory', - associationTypeId: 0, - filterBranches: [ - { - filterBranches: [], - filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'OR', - filters: [ - { - filterType: 'PROPERTY', - operation: { - includeObjectsWithNoValueSet: true, - operationType: 'BOOL', - operator: 'operator', - value: true, - }, - property: 'property', - }, - ], - }, - ], + filterBranches: [], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'ASSOCIATION', + filterBranchType: 'OR', filters: [ { filterType: 'PROPERTY', @@ -782,12 +743,10 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { property: 'property', }, ], - objectTypeId: 'objectTypeId', - operator: 'operator', }, ], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'PROPERTY_ASSOCIATION', + filterBranchType: 'ASSOCIATION', filters: [ { filterType: 'PROPERTY', @@ -802,7 +761,6 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { ], objectTypeId: 'objectTypeId', operator: 'operator', - propertyWithObjectId: 'propertyWithObjectId', }, ], filterBranchOperator: 'filterBranchOperator', @@ -928,31 +886,13 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { eventTypeId: 'eventTypeId', filterBranches: [ { + associationCategory: 'associationCategory', + associationTypeId: 0, filterBranches: [ { - associationCategory: 'associationCategory', - associationTypeId: 0, - filterBranches: [ - { - filterBranches: [], - filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'OR', - filters: [ - { - filterType: 'PROPERTY', - operation: { - includeObjectsWithNoValueSet: true, - operationType: 'BOOL', - operator: 'operator', - value: true, - }, - property: 'property', - }, - ], - }, - ], + filterBranches: [], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'ASSOCIATION', + filterBranchType: 'OR', filters: [ { filterType: 'PROPERTY', @@ -965,12 +905,10 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { property: 'property', }, ], - objectTypeId: 'objectTypeId', - operator: 'operator', }, ], filterBranchOperator: 'filterBranchOperator', - filterBranchType: 'PROPERTY_ASSOCIATION', + filterBranchType: 'ASSOCIATION', filters: [ { filterType: 'PROPERTY', @@ -985,7 +923,6 @@ const runTests = (client: PartialHubSpot<{ crm: { lists: BaseLists } }>) => { ], objectTypeId: 'objectTypeId', operator: 'operator', - propertyWithObjectId: 'propertyWithObjectId', }, ], filterBranchOperator: 'filterBranchOperator', diff --git a/tests/api-resources/webhooks-journal/journal-local/batch.test.ts b/tests/api-resources/webhooks-journal/journal-local/batch.test.ts new file mode 100644 index 00000000..42dcf17e --- /dev/null +++ b/tests/api-resources/webhooks-journal/journal-local/batch.test.ts @@ -0,0 +1,93 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { BaseBatch } from '@hubspot/sdk/resources/webhooks-journal/journal-local/batch'; +import { JournalLocal } from '@hubspot/sdk/resources/webhooks-journal/journal-local/journal-local'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseBatch], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [JournalLocal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { journalLocal: { batch: BaseBatch } } }>) => { + // Mock server tests are disabled + test.skip('get: only required params', async () => { + const responsePromise = client.webhooksJournal.journalLocal.batch.get({ inputs: ['string'] }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('get: required and optional params', async () => { + const response = await client.webhooksJournal.journalLocal.batch.get({ + inputs: ['string'], + installPortalId: 0, + }); + }); + + // Mock server tests are disabled + test.skip('getEarliest', async () => { + const responsePromise = client.webhooksJournal.journalLocal.batch.getEarliest(1); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('getEarliest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journalLocal.batch.getEarliest( + 1, + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getFromOffset: only required params', async () => { + const responsePromise = client.webhooksJournal.journalLocal.batch.getFromOffset(1, { offset: 'offset' }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('getFromOffset: required and optional params', async () => { + const response = await client.webhooksJournal.journalLocal.batch.getFromOffset(1, { + offset: 'offset', + installPortalId: 0, + }); + }); +}; +describe('resource batch', () => runTests(client)); +describe('resource batch (tree shakable, base)', () => runTests(partialClient)); +describe('resource batch (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/journal-local/journal-local.test.ts b/tests/api-resources/webhooks-journal/journal-local/journal-local.test.ts new file mode 100644 index 00000000..2eff4f8a --- /dev/null +++ b/tests/api-resources/webhooks-journal/journal-local/journal-local.test.ts @@ -0,0 +1,77 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { WebhooksJournal } from '@hubspot/sdk/resources/webhooks-journal/webhooks-journal'; +import { BaseJournalLocal } from '@hubspot/sdk/resources/webhooks-journal/journal-local/journal-local'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseJournalLocal], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [WebhooksJournal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { journalLocal: BaseJournalLocal } }>) => { + // Mock server tests are disabled + test.skip('getEarliest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journalLocal.getEarliest( + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getLatest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journalLocal.getLatest( + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getNextFromOffset: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journalLocal.getNextFromOffset( + 'offset', + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getStatus', async () => { + const responsePromise = client.webhooksJournal.journalLocal.getStatus( + '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + ); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); +}; +describe('resource journalLocal', () => runTests(client)); +describe('resource journalLocal (tree shakable, base)', () => runTests(partialClient)); +describe('resource journalLocal (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/journal/batch.test.ts b/tests/api-resources/webhooks-journal/journal/batch.test.ts new file mode 100644 index 00000000..da7d3d47 --- /dev/null +++ b/tests/api-resources/webhooks-journal/journal/batch.test.ts @@ -0,0 +1,117 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { BaseBatch } from '@hubspot/sdk/resources/webhooks-journal/journal/batch'; +import { Journal } from '@hubspot/sdk/resources/webhooks-journal/journal/journal'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseBatch], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [Journal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { journal: { batch: BaseBatch } } }>) => { + // Mock server tests are disabled + test.skip('get: only required params', async () => { + const responsePromise = client.webhooksJournal.journal.batch.get({ inputs: ['string'] }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('get: required and optional params', async () => { + const response = await client.webhooksJournal.journal.batch.get({ + inputs: ['string'], + installPortalId: 0, + }); + }); + + // Mock server tests are disabled + test.skip('getEarliest', async () => { + const responsePromise = client.webhooksJournal.journal.batch.getEarliest(1); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('getEarliest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journal.batch.getEarliest( + 1, + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getFromOffset: only required params', async () => { + const responsePromise = client.webhooksJournal.journal.batch.getFromOffset(1, { offset: 'offset' }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('getFromOffset: required and optional params', async () => { + const response = await client.webhooksJournal.journal.batch.getFromOffset(1, { + offset: 'offset', + installPortalId: 0, + }); + }); + + // Mock server tests are disabled + test.skip('getLatest', async () => { + const responsePromise = client.webhooksJournal.journal.batch.getLatest(1); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('getLatest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journal.batch.getLatest( + 1, + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); +}; +describe('resource batch', () => runTests(client)); +describe('resource batch (tree shakable, base)', () => runTests(partialClient)); +describe('resource batch (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/journal/journal.test.ts b/tests/api-resources/webhooks-journal/journal/journal.test.ts new file mode 100644 index 00000000..c9acc664 --- /dev/null +++ b/tests/api-resources/webhooks-journal/journal/journal.test.ts @@ -0,0 +1,64 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { WebhooksJournal } from '@hubspot/sdk/resources/webhooks-journal/webhooks-journal'; +import { BaseJournal } from '@hubspot/sdk/resources/webhooks-journal/journal/journal'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseJournal], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [WebhooksJournal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { journal: BaseJournal } }>) => { + // Mock server tests are disabled + test.skip('getEarliest: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journal.getEarliest( + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getNextFromOffset: request options and params are passed correctly', async () => { + // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error + await expect( + client.webhooksJournal.journal.getNextFromOffset( + 'offset', + { installPortalId: 0 }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(HubSpot.NotFoundError); + }); + + // Mock server tests are disabled + test.skip('getStatus', async () => { + const responsePromise = client.webhooksJournal.journal.getStatus('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); +}; +describe('resource journal', () => runTests(client)); +describe('resource journal (tree shakable, base)', () => runTests(partialClient)); +describe('resource journal (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/snapshots.test.ts b/tests/api-resources/webhooks-journal/snapshots.test.ts new file mode 100644 index 00000000..423f9292 --- /dev/null +++ b/tests/api-resources/webhooks-journal/snapshots.test.ts @@ -0,0 +1,64 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { BaseSnapshots } from '@hubspot/sdk/resources/webhooks-journal/snapshots'; +import { WebhooksJournal } from '@hubspot/sdk/resources/webhooks-journal/webhooks-journal'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseSnapshots], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [WebhooksJournal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { snapshots: BaseSnapshots } }>) => { + // Mock server tests are disabled + test.skip('create: only required params', async () => { + const responsePromise = client.webhooksJournal.snapshots.create({ + snapshotRequests: [ + { + objectId: 0, + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + }, + ], + }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('create: required and optional params', async () => { + const response = await client.webhooksJournal.snapshots.create({ + snapshotRequests: [ + { + objectId: 0, + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + }, + ], + }); + }); +}; +describe('resource snapshots', () => runTests(client)); +describe('resource snapshots (tree shakable, base)', () => runTests(partialClient)); +describe('resource snapshots (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/subscriptions/filters.test.ts b/tests/api-resources/webhooks-journal/subscriptions/filters.test.ts new file mode 100644 index 00000000..2ac982d7 --- /dev/null +++ b/tests/api-resources/webhooks-journal/subscriptions/filters.test.ts @@ -0,0 +1,108 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { BaseFilters } from '@hubspot/sdk/resources/webhooks-journal/subscriptions/filters'; +import { Subscriptions } from '@hubspot/sdk/resources/webhooks-journal/subscriptions/subscriptions'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseFilters], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [Subscriptions], +}); + +const runTests = ( + client: PartialHubSpot<{ webhooksJournal: { subscriptions: { filters: BaseFilters } } }>, +) => { + // Mock server tests are disabled + test.skip('create: only required params', async () => { + const responsePromise = client.webhooksJournal.subscriptions.filters.create({ + filter: { + conditions: [ + { + filterType: 'CRM_OBJECT_PROPERTY', + operator: 'CONTAINS', + property: 'property', + }, + ], + }, + subscriptionId: 0, + }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('create: required and optional params', async () => { + const response = await client.webhooksJournal.subscriptions.filters.create({ + filter: { + conditions: [ + { + filterType: 'CRM_OBJECT_PROPERTY', + operator: 'CONTAINS', + property: 'property', + value: 'value', + values: ['string'], + }, + ], + }, + subscriptionId: 0, + }); + }); + + // Mock server tests are disabled + test.skip('list', async () => { + const responsePromise = client.webhooksJournal.subscriptions.filters.list(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('delete', async () => { + const responsePromise = client.webhooksJournal.subscriptions.filters.delete(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('get', async () => { + const responsePromise = client.webhooksJournal.subscriptions.filters.get(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); +}; +describe('resource filters', () => runTests(client)); +describe('resource filters (tree shakable, base)', () => runTests(partialClient)); +describe('resource filters (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks-journal/subscriptions/subscriptions.test.ts b/tests/api-resources/webhooks-journal/subscriptions/subscriptions.test.ts new file mode 100644 index 00000000..85456ac1 --- /dev/null +++ b/tests/api-resources/webhooks-journal/subscriptions/subscriptions.test.ts @@ -0,0 +1,108 @@ +// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import { WebhooksJournal } from '@hubspot/sdk/resources/webhooks-journal/webhooks-journal'; +import { BaseSubscriptions } from '@hubspot/sdk/resources/webhooks-journal/subscriptions/subscriptions'; + +import HubSpot from '@hubspot/sdk'; +import { createClient, type PartialHubSpot } from '@hubspot/sdk/tree-shakable'; + +const client = new HubSpot({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', +}); + +const partialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [BaseSubscriptions], +}); + +const parentPartialClient = createClient({ + accessToken: 'My Access Token', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + resources: [WebhooksJournal], +}); + +const runTests = (client: PartialHubSpot<{ webhooksJournal: { subscriptions: BaseSubscriptions } }>) => { + // Mock server tests are disabled + test.skip('create: only required params', async () => { + const responsePromise = client.webhooksJournal.subscriptions.create({ + actions: ['CREATE'], + objectIds: [0], + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + subscriptionType: 'OBJECT', + }); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('create: required and optional params', async () => { + const response = await client.webhooksJournal.subscriptions.create({ + actions: ['CREATE'], + objectIds: [0], + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + subscriptionType: 'OBJECT', + }); + }); + + // Mock server tests are disabled + test.skip('list', async () => { + const responsePromise = client.webhooksJournal.subscriptions.list(); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('delete', async () => { + const responsePromise = client.webhooksJournal.subscriptions.delete(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('deleteForPortal', async () => { + const responsePromise = client.webhooksJournal.subscriptions.deleteForPortal(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); + + // Mock server tests are disabled + test.skip('get', async () => { + const responsePromise = client.webhooksJournal.subscriptions.get(0); + const rawResponse = await responsePromise.asResponse(); + expect(rawResponse).toBeInstanceOf(Response); + const response = await responsePromise; + expect(response).not.toBeInstanceOf(Response); + const dataAndResponse = await responsePromise.withResponse(); + expect(dataAndResponse.data).toBe(response); + expect(dataAndResponse.response).toBe(rawResponse); + }); +}; +describe('resource subscriptions', () => runTests(client)); +describe('resource subscriptions (tree shakable, base)', () => runTests(partialClient)); +describe('resource subscriptions (tree shakable, subresource)', () => runTests(parentPartialClient)); diff --git a/tests/api-resources/webhooks.test.ts b/tests/api-resources/webhooks.test.ts index 27b41b6e..89de49da 100644 --- a/tests/api-resources/webhooks.test.ts +++ b/tests/api-resources/webhooks.test.ts @@ -100,8 +100,15 @@ const runTests = (client: PartialHubSpot<{ webhooks: BaseWebhooks }>) => { }); // Mock server tests are disabled - test.skip('createJournalSubscription', async () => { - const responsePromise = client.webhooks.createJournalSubscription({}); + test.skip('createJournalSubscription: only required params', async () => { + const responsePromise = client.webhooks.createJournalSubscription({ + actions: ['CREATE'], + objectIds: [0], + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + subscriptionType: 'OBJECT', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -111,6 +118,18 @@ const runTests = (client: PartialHubSpot<{ webhooks: BaseWebhooks }>) => { expect(dataAndResponse.response).toBe(rawResponse); }); + // Mock server tests are disabled + test.skip('createJournalSubscription: required and optional params', async () => { + const response = await client.webhooks.createJournalSubscription({ + actions: ['CREATE'], + objectIds: [0], + objectTypeId: 'objectTypeId', + portalId: 0, + properties: ['string'], + subscriptionType: 'OBJECT', + }); + }); + // Mock server tests are disabled test.skip('createSubscriptionFilter: only required params', async () => { const responsePromise = client.webhooks.createSubscriptionFilter({ diff --git a/yarn.lock b/yarn.lock index 00842e32..06fc1085 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1215,9 +1215,9 @@ baseline-browser-mapping@^2.9.0: integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg== brace-expansion@^2.0.2: - version "2.1.0" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.0.tgz#4f41a41190216ee36067ec381526fe9539c4f0ae" - integrity sha512-TN1kCZAgdgweJhWWpgKYrQaMNHcDULHkWwQIspdtjV4Y5aurRdZpjAqn6yX3FPqTA9ngHCc4hJxMAMgGfve85w== + version "2.1.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.1.tgz#c68b1c4111c76aae3a6fba55d496cee10c39dad8" + integrity sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA== dependencies: balanced-match "^1.0.0" From e45d0b4366da37911312a9e24c97fa4579411553 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 26 May 2026 11:54:16 +0000 Subject: [PATCH 5/6] feat(api): manual updates --- .stats.yml | 4 ++-- src/resources/cms/media-bridge/media-bridge.ts | 6 +++--- src/resources/webhooks-journal/api.md | 10 +++++----- .../webhooks-journal/subscriptions/subscriptions.ts | 9 ++++++--- src/resources/webhooks-journal/webhooks-journal.ts | 10 +++++----- src/resources/webhooks/api.md | 6 +++--- src/resources/webhooks/webhooks.ts | 6 +++--- 7 files changed, 27 insertions(+), 24 deletions(-) diff --git a/.stats.yml b/.stats.yml index 60d51403..65bc8df1 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 959 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-5471b42def181422e461f5657935bcc5d80f62e169b34b60d017257cab8ed6a7.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hubspot/hubspot-sdk-3260c0cfb88ce2653c37c4c97e1dd39b965df4f2c14177677bc46d95b104525d.yml openapi_spec_hash: 93b8671a542b331e067319184c943fdd -config_hash: 42a440e814378897b5ca0c2ad29c7f99 +config_hash: 0bcc56e67986936da66e382674e17c79 diff --git a/src/resources/cms/media-bridge/media-bridge.ts b/src/resources/cms/media-bridge/media-bridge.ts index e7a74c06..9564f52a 100644 --- a/src/resources/cms/media-bridge/media-bridge.ts +++ b/src/resources/cms/media-bridge/media-bridge.ts @@ -1119,12 +1119,12 @@ export interface InboundDBObjectType { status?: 'Deprecated' | 'In development' | 'Live'; - visibilities?: Array< + visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; + + visibility_values?: Array< 'Customer-facing' | 'Internal only' | 'Customer-facing UI' | 'Customer-facing public API' >; - visibility?: 'Customer-facing' | 'Customer-facing public API' | 'Customer-facing UI' | 'Internal only'; - writeScopeName?: string; } diff --git a/src/resources/webhooks-journal/api.md b/src/resources/webhooks-journal/api.md index 348a89fe..4099c970 100644 --- a/src/resources/webhooks-journal/api.md +++ b/src/resources/webhooks-journal/api.md @@ -2,8 +2,8 @@ Types: -- CollectionResponseSubscriptionResponseNoPaging -- SubscriptionResponse +- JournalCollectionResponseSubscriptionResponseNoPaging +- JournalSubscriptionResponse ## Journal @@ -49,11 +49,11 @@ Methods: Methods: -- client.webhooksJournal.subscriptions.create({ ...params }) -> SubscriptionResponse -- client.webhooksJournal.subscriptions.list() -> CollectionResponseSubscriptionResponseNoPaging +- client.webhooksJournal.subscriptions.create({ ...params }) -> JournalSubscriptionResponse +- client.webhooksJournal.subscriptions.list() -> JournalCollectionResponseSubscriptionResponseNoPaging - client.webhooksJournal.subscriptions.delete(subscriptionID) -> void - client.webhooksJournal.subscriptions.deleteForPortal(portalID) -> void -- client.webhooksJournal.subscriptions.get(subscriptionID) -> SubscriptionResponse +- client.webhooksJournal.subscriptions.get(subscriptionID) -> JournalSubscriptionResponse ### Filters diff --git a/src/resources/webhooks-journal/subscriptions/subscriptions.ts b/src/resources/webhooks-journal/subscriptions/subscriptions.ts index 42b74ade..e0ca8915 100644 --- a/src/resources/webhooks-journal/subscriptions/subscriptions.ts +++ b/src/resources/webhooks-journal/subscriptions/subscriptions.ts @@ -26,7 +26,7 @@ export class BaseSubscriptions extends APIResource { create( body: SubscriptionCreateParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/webhooks-journal/subscriptions/2026-03', { body, ...options }); } @@ -38,7 +38,7 @@ export class BaseSubscriptions extends APIResource { */ list( options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get('/webhooks-journal/subscriptions/2026-03', options); } @@ -72,7 +72,10 @@ export class BaseSubscriptions extends APIResource { * This endpoint is useful for obtaining information about a particular * subscription, such as its actions, object type, and associated properties. */ - get(subscriptionID: number, options?: RequestOptions): APIPromise { + get( + subscriptionID: number, + options?: RequestOptions, + ): APIPromise { return this._client.get(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, options); } } diff --git a/src/resources/webhooks-journal/webhooks-journal.ts b/src/resources/webhooks-journal/webhooks-journal.ts index c812a38c..262e85a5 100644 --- a/src/resources/webhooks-journal/webhooks-journal.ts +++ b/src/resources/webhooks-journal/webhooks-journal.ts @@ -32,15 +32,15 @@ export class WebhooksJournal extends BaseWebhooksJournal { subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client); } -export interface CollectionResponseSubscriptionResponseNoPaging { +export interface JournalCollectionResponseSubscriptionResponseNoPaging { /** * An array of subscription responses, where each item contains details about a * specific subscription. Each item follows the SubscriptionResponse schema. */ - results: Array; + results: Array; } -export interface SubscriptionResponse { +export interface JournalSubscriptionResponse { /** * The unique identifier for the subscription, represented as an integer. */ @@ -162,8 +162,8 @@ WebhooksJournal.BaseSubscriptions = BaseSubscriptions; export declare namespace WebhooksJournal { export { - type CollectionResponseSubscriptionResponseNoPaging as CollectionResponseSubscriptionResponseNoPaging, - type SubscriptionResponse as SubscriptionResponse, + type JournalCollectionResponseSubscriptionResponseNoPaging as JournalCollectionResponseSubscriptionResponseNoPaging, + type JournalSubscriptionResponse as JournalSubscriptionResponse, }; export { diff --git a/src/resources/webhooks/api.md b/src/resources/webhooks/api.md index 4fe03ab5..8f66171f 100644 --- a/src/resources/webhooks/api.md +++ b/src/resources/webhooks/api.md @@ -22,7 +22,7 @@ Methods: - client.webhooks.createBatchEventSubscriptions(appID, { ...params }) -> BatchResponseSubscriptionResponse - client.webhooks.createCrmSnapshots({ ...params }) -> CrmObjectSnapshotBatchResponse - client.webhooks.createEventSubscription(appID, { ...params }) -> SubscriptionResponse -- client.webhooks.createJournalSubscription({ ...params }) -> SubscriptionResponse +- client.webhooks.createJournalSubscription({ ...params }) -> JournalSubscriptionResponse - client.webhooks.createSubscriptionFilter({ ...params }) -> FilterCreateResponse - client.webhooks.deleteEventSubscription(subscriptionID, { ...params }) -> void - client.webhooks.deleteJournalSubscription(subscriptionID) -> void @@ -37,7 +37,7 @@ Methods: - client.webhooks.getJournalBatchByRequest({ ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getJournalBatchFromOffset(count, { ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getJournalStatus(statusID) -> SnapshotStatusResponse -- client.webhooks.getJournalSubscription(subscriptionID) -> SubscriptionResponse +- client.webhooks.getJournalSubscription(subscriptionID) -> JournalSubscriptionResponse - client.webhooks.getLatestJournalBatch(count, { ...params }) -> BatchResponseJournalFetchResponse - client.webhooks.getLatestJournalEntry({ ...params }) -> Response - client.webhooks.getLatestLocalJournalBatch(count, { ...params }) -> BatchResponseJournalFetchResponse @@ -50,7 +50,7 @@ Methods: - client.webhooks.getSettings(appID) -> SettingsResponse - client.webhooks.getSubscriptionFilter(filterID) -> FilterResponse - client.webhooks.listEventSubscriptions(appID) -> SubscriptionListResponse -- client.webhooks.listJournalSubscriptions() -> CollectionResponseSubscriptionResponseNoPaging +- client.webhooks.listJournalSubscriptions() -> JournalCollectionResponseSubscriptionResponseNoPaging - client.webhooks.listSubscriptionFilters(subscriptionID) -> WebhookListSubscriptionFiltersResponse - client.webhooks.updateEventSubscription(subscriptionID, { ...params }) -> SubscriptionResponse - client.webhooks.updateSettings(appID, { ...params }) -> SettingsResponse diff --git a/src/resources/webhooks/webhooks.ts b/src/resources/webhooks/webhooks.ts index 3f283a32..b5494cab 100644 --- a/src/resources/webhooks/webhooks.ts +++ b/src/resources/webhooks/webhooks.ts @@ -60,7 +60,7 @@ export class BaseWebhooks extends APIResource { createJournalSubscription( body: WebhookCreateJournalSubscriptionParams, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.post('/webhooks-journal/subscriptions/2026-03', { body, ...options }); } @@ -274,7 +274,7 @@ export class BaseWebhooks extends APIResource { getJournalSubscription( subscriptionID: number, options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get(path`/webhooks-journal/subscriptions/2026-03/${subscriptionID}`, options); } @@ -463,7 +463,7 @@ export class BaseWebhooks extends APIResource { */ listJournalSubscriptions( options?: RequestOptions, - ): APIPromise { + ): APIPromise { return this._client.get('/webhooks-journal/subscriptions/2026-03', options); } From 60ef6ba0a5cea75fad9bc9a572920dfdda668c94 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 26 May 2026 11:54:43 +0000 Subject: [PATCH 6/6] release: 0.1.0-alpha.10 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 15 +++++++++++++++ package.json | 2 +- src/version.ts | 2 +- 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 347d8bf7..931fce1a 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.9" + ".": "0.1.0-alpha.10" } diff --git a/CHANGELOG.md b/CHANGELOG.md index c8c48583..ac878884 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +## 0.1.0-alpha.10 (2026-05-26) + +Full Changelog: [v0.1.0-alpha.9...v0.1.0-alpha.10](https://github.com/HubSpot/hubspot-sdk-typescript/compare/v0.1.0-alpha.9...v0.1.0-alpha.10) + +### Features + +* **api:** manual updates ([e45d0b4](https://github.com/HubSpot/hubspot-sdk-typescript/commit/e45d0b4366da37911312a9e24c97fa4579411553)) +* **api:** manual updates ([b69a1bc](https://github.com/HubSpot/hubspot-sdk-typescript/commit/b69a1bca2d05b92d248f4ced6b5844c3d0fde4ba)) +* **api:** manual updates ([3cdcc58](https://github.com/HubSpot/hubspot-sdk-typescript/commit/3cdcc58594135075c61b6e5732dd10c4848d8337)) + + +### Chores + +* configure new SDK language ([45a1eb1](https://github.com/HubSpot/hubspot-sdk-typescript/commit/45a1eb12ae407caf090294bc4bcb9645d82168a3)) + ## 0.1.0-alpha.9 (2026-05-19) Full Changelog: [v0.1.0-alpha.8...v0.1.0-alpha.9](https://github.com/HubSpot/hubspot-sdk-typescript/compare/v0.1.0-alpha.8...v0.1.0-alpha.9) diff --git a/package.json b/package.json index 9be9c670..04df2425 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hubspot/sdk", - "version": "0.1.0-alpha.9", + "version": "0.1.0-alpha.10", "description": "The official TypeScript library for the HubSpot API", "author": "HubSpot <>", "types": "dist/index.d.ts", diff --git a/src/version.ts b/src/version.ts index fdbf6896..5ed52cd1 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.1.0-alpha.9'; // x-release-please-version +export const VERSION = '0.1.0-alpha.10'; // x-release-please-version